4 * Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 #ifndef _I40E_ETHDEV_H_
35 #define _I40E_ETHDEV_H_
37 #include <rte_eth_ctrl.h>
39 #include <rte_kvargs.h>
41 #include <rte_flow_driver.h>
43 #define I40E_VLAN_TAG_SIZE 4
45 #define I40E_AQ_LEN 32
46 #define I40E_AQ_BUF_SZ 4096
47 /* Number of queues per TC should be one of 1, 2, 4, 8, 16, 32, 64 */
48 #define I40E_MAX_Q_PER_TC 64
49 #define I40E_NUM_DESC_DEFAULT 512
50 #define I40E_NUM_DESC_ALIGN 32
51 #define I40E_BUF_SIZE_MIN 1024
52 #define I40E_FRAME_SIZE_MAX 9728
53 #define I40E_QUEUE_BASE_ADDR_UNIT 128
54 /* number of VSIs and queue default setting */
55 #define I40E_MAX_QP_NUM_PER_VF 16
56 #define I40E_DEFAULT_QP_NUM_FDIR 1
57 #define I40E_UINT32_BIT_SIZE (CHAR_BIT * sizeof(uint32_t))
58 #define I40E_VFTA_SIZE (4096 / I40E_UINT32_BIT_SIZE)
59 /* Maximun number of MAC addresses */
60 #define I40E_NUM_MACADDR_MAX 64
61 /* Maximum number of VFs */
62 #define I40E_MAX_VF 128
65 * vlan_id is a 12 bit number.
66 * The VFTA array is actually a 4096 bit array, 128 of 32bit elements.
67 * 2^5 = 32. The val of lower 5 bits specifies the bit in the 32bit element.
68 * The higher 7 bit val specifies VFTA array index.
70 #define I40E_VFTA_BIT(vlan_id) (1 << ((vlan_id) & 0x1F))
71 #define I40E_VFTA_IDX(vlan_id) ((vlan_id) >> 5)
73 /* Default TC traffic in case DCB is not enabled */
74 #define I40E_DEFAULT_TCMAP 0x1
75 #define I40E_FDIR_QUEUE_ID 0
77 /* Always assign pool 0 to main VSI, VMDQ will start from 1 */
78 #define I40E_VMDQ_POOL_BASE 1
80 #define I40E_DEFAULT_RX_FREE_THRESH 32
81 #define I40E_DEFAULT_RX_PTHRESH 8
82 #define I40E_DEFAULT_RX_HTHRESH 8
83 #define I40E_DEFAULT_RX_WTHRESH 0
85 #define I40E_DEFAULT_TX_FREE_THRESH 32
86 #define I40E_DEFAULT_TX_PTHRESH 32
87 #define I40E_DEFAULT_TX_HTHRESH 0
88 #define I40E_DEFAULT_TX_WTHRESH 0
89 #define I40E_DEFAULT_TX_RSBIT_THRESH 32
91 /* Bit shift and mask */
92 #define I40E_4_BIT_WIDTH (CHAR_BIT / 2)
93 #define I40E_4_BIT_MASK RTE_LEN2MASK(I40E_4_BIT_WIDTH, uint8_t)
94 #define I40E_8_BIT_WIDTH CHAR_BIT
95 #define I40E_8_BIT_MASK UINT8_MAX
96 #define I40E_16_BIT_WIDTH (CHAR_BIT * 2)
97 #define I40E_16_BIT_MASK UINT16_MAX
98 #define I40E_32_BIT_WIDTH (CHAR_BIT * 4)
99 #define I40E_32_BIT_MASK UINT32_MAX
100 #define I40E_48_BIT_WIDTH (CHAR_BIT * 6)
101 #define I40E_48_BIT_MASK RTE_LEN2MASK(I40E_48_BIT_WIDTH, uint64_t)
103 /* Linux PF host with virtchnl version 1.1 */
104 #define PF_IS_V11(vf) \
105 (((vf)->version_major == I40E_VIRTCHNL_VERSION_MAJOR) && \
106 ((vf)->version_minor == 1))
108 /* index flex payload per layer */
109 enum i40e_flxpld_layer_idx {
110 I40E_FLXPLD_L2_IDX = 0,
111 I40E_FLXPLD_L3_IDX = 1,
112 I40E_FLXPLD_L4_IDX = 2,
113 I40E_MAX_FLXPLD_LAYER = 3,
115 #define I40E_MAX_FLXPLD_FIED 3 /* max number of flex payload fields */
116 #define I40E_FDIR_BITMASK_NUM_WORD 2 /* max number of bitmask words */
117 #define I40E_FDIR_MAX_FLEXWORD_NUM 8 /* max number of flexpayload words */
118 #define I40E_FDIR_MAX_FLEX_LEN 16 /* len in bytes of flex payload */
119 #define I40E_INSET_MASK_NUM_REG 2 /* number of input set mask registers */
122 #define I40E_FLAG_RSS (1ULL << 0)
123 #define I40E_FLAG_DCB (1ULL << 1)
124 #define I40E_FLAG_VMDQ (1ULL << 2)
125 #define I40E_FLAG_SRIOV (1ULL << 3)
126 #define I40E_FLAG_HEADER_SPLIT_DISABLED (1ULL << 4)
127 #define I40E_FLAG_HEADER_SPLIT_ENABLED (1ULL << 5)
128 #define I40E_FLAG_FDIR (1ULL << 6)
129 #define I40E_FLAG_VXLAN (1ULL << 7)
130 #define I40E_FLAG_RSS_AQ_CAPABLE (1ULL << 8)
131 #define I40E_FLAG_VF_MAC_BY_PF (1ULL << 9)
132 #define I40E_FLAG_ALL (I40E_FLAG_RSS | \
136 I40E_FLAG_HEADER_SPLIT_DISABLED | \
137 I40E_FLAG_HEADER_SPLIT_ENABLED | \
140 I40E_FLAG_RSS_AQ_CAPABLE | \
141 I40E_FLAG_VF_MAC_BY_PF)
143 #define I40E_RSS_OFFLOAD_ALL ( \
144 ETH_RSS_FRAG_IPV4 | \
145 ETH_RSS_NONFRAG_IPV4_TCP | \
146 ETH_RSS_NONFRAG_IPV4_UDP | \
147 ETH_RSS_NONFRAG_IPV4_SCTP | \
148 ETH_RSS_NONFRAG_IPV4_OTHER | \
149 ETH_RSS_FRAG_IPV6 | \
150 ETH_RSS_NONFRAG_IPV6_TCP | \
151 ETH_RSS_NONFRAG_IPV6_UDP | \
152 ETH_RSS_NONFRAG_IPV6_SCTP | \
153 ETH_RSS_NONFRAG_IPV6_OTHER | \
156 /* All bits of RSS hash enable for X722*/
157 #define I40E_RSS_HENA_ALL_X722 ( \
158 (1ULL << I40E_FILTER_PCTYPE_NONF_UNICAST_IPV4_UDP) | \
159 (1ULL << I40E_FILTER_PCTYPE_NONF_MULTICAST_IPV4_UDP) | \
160 (1ULL << I40E_FILTER_PCTYPE_NONF_IPV4_TCP_SYN_NO_ACK) | \
161 (1ULL << I40E_FILTER_PCTYPE_NONF_UNICAST_IPV6_UDP) | \
162 (1ULL << I40E_FILTER_PCTYPE_NONF_MULTICAST_IPV6_UDP) | \
163 (1ULL << I40E_FILTER_PCTYPE_NONF_IPV6_TCP_SYN_NO_ACK) | \
166 /* All bits of RSS hash enable */
167 #define I40E_RSS_HENA_ALL ( \
168 (1ULL << I40E_FILTER_PCTYPE_NONF_IPV4_UDP) | \
169 (1ULL << I40E_FILTER_PCTYPE_NONF_IPV4_TCP) | \
170 (1ULL << I40E_FILTER_PCTYPE_NONF_IPV4_SCTP) | \
171 (1ULL << I40E_FILTER_PCTYPE_NONF_IPV4_OTHER) | \
172 (1ULL << I40E_FILTER_PCTYPE_FRAG_IPV4) | \
173 (1ULL << I40E_FILTER_PCTYPE_NONF_IPV6_UDP) | \
174 (1ULL << I40E_FILTER_PCTYPE_NONF_IPV6_TCP) | \
175 (1ULL << I40E_FILTER_PCTYPE_NONF_IPV6_SCTP) | \
176 (1ULL << I40E_FILTER_PCTYPE_NONF_IPV6_OTHER) | \
177 (1ULL << I40E_FILTER_PCTYPE_FRAG_IPV6) | \
178 (1ULL << I40E_FILTER_PCTYPE_FCOE_OX) | \
179 (1ULL << I40E_FILTER_PCTYPE_FCOE_RX) | \
180 (1ULL << I40E_FILTER_PCTYPE_FCOE_OTHER) | \
181 (1ULL << I40E_FILTER_PCTYPE_L2_PAYLOAD))
183 #define I40E_MISC_VEC_ID RTE_INTR_VEC_ZERO_OFFSET
184 #define I40E_RX_VEC_START RTE_INTR_VEC_RXTX_OFFSET
186 /* Default queue interrupt throttling time in microseconds */
187 #define I40E_ITR_INDEX_DEFAULT 0
188 #define I40E_QUEUE_ITR_INTERVAL_DEFAULT 32 /* 32 us */
189 #define I40E_QUEUE_ITR_INTERVAL_MAX 8160 /* 8160 us */
191 /* Special FW support this floating VEB feature */
192 #define FLOATING_VEB_SUPPORTED_FW_MAJ 5
193 #define FLOATING_VEB_SUPPORTED_FW_MIN 0
195 #define I40E_GL_SWT_L2TAGCTRL(_i) (0x001C0A70 + ((_i) * 4))
196 #define I40E_GL_SWT_L2TAGCTRL_ETHERTYPE_SHIFT 16
197 #define I40E_GL_SWT_L2TAGCTRL_ETHERTYPE_MASK \
198 I40E_MASK(0xFFFF, I40E_GL_SWT_L2TAGCTRL_ETHERTYPE_SHIFT)
200 #define I40E_INSET_NONE 0x00000000000000000ULL
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
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
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
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
236 /* bit 48 ~ bit 55 */
237 #define I40E_INSET_LAST_ETHER_TYPE 0x0001000000000000ULL
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)
257 * MAC filter structure
259 struct i40e_mac_filter_info {
260 enum rte_mac_filter_type filter_type;
261 struct ether_addr mac_addr;
264 TAILQ_HEAD(i40e_mac_filter_list, i40e_mac_filter);
266 /* MAC filter list structure */
267 struct i40e_mac_filter {
268 TAILQ_ENTRY(i40e_mac_filter) next;
269 struct i40e_mac_filter_info mac_info;
272 TAILQ_HEAD(i40e_vsi_list_head, i40e_vsi_list);
276 /* VSI list structure */
277 struct i40e_vsi_list {
278 TAILQ_ENTRY(i40e_vsi_list) list;
279 struct i40e_vsi *vsi;
282 struct i40e_rx_queue;
283 struct i40e_tx_queue;
285 /* Bandwidth limit information */
286 struct i40e_bw_info {
287 uint16_t bw_limit; /* BW Limit (0 = disabled) */
288 uint8_t bw_max; /* Max BW limit if enabled */
290 /* Relative credits within same TC with respect to other VSIs or Comps */
291 uint8_t bw_ets_share_credits[I40E_MAX_TRAFFIC_CLASS];
292 /* Bandwidth limit per TC */
293 uint16_t bw_ets_credits[I40E_MAX_TRAFFIC_CLASS];
294 /* Max bandwidth limit per TC */
295 uint8_t bw_ets_max[I40E_MAX_TRAFFIC_CLASS];
298 /* Structure that defines a VEB */
300 struct i40e_vsi_list_head head;
301 struct i40e_vsi *associate_vsi; /* Associate VSI who owns the VEB */
302 struct i40e_pf *associate_pf; /* Associate PF who owns the VEB */
303 uint16_t seid; /* The seid of VEB itself */
304 uint16_t uplink_seid; /* The uplink seid of this VEB */
306 struct i40e_eth_stats stats;
307 uint8_t enabled_tc; /* The traffic class enabled */
308 struct i40e_bw_info bw_info; /* VEB bandwidth information */
311 /* i40e MACVLAN filter structure */
312 struct i40e_macvlan_filter {
313 struct ether_addr macaddr;
314 enum rte_mac_filter_type filter_type;
319 * Structure that defines a VSI, associated with a adapter.
322 struct i40e_adapter *adapter; /* Backreference to associated adapter */
323 struct i40e_aqc_vsi_properties_data info; /* VSI properties */
325 struct i40e_eth_stats eth_stats_offset;
326 struct i40e_eth_stats eth_stats;
328 * When drivers loaded, only a default main VSI exists. In case new VSI
329 * needs to add, HW needs to know the layout that VSIs are organized.
330 * Besides that, VSI isan element and can't switch packets, which needs
331 * to add new component VEB to perform switching. So, a new VSI needs
332 * to specify the the uplink VSI (Parent VSI) before created. The
333 * uplink VSI will check whether it had a VEB to switch packets. If no,
334 * it will try to create one. Then, uplink VSI will move the new VSI
335 * into its' sib_vsi_list to manage all the downlink VSI.
336 * sib_vsi_list: the VSI list that shared the same uplink VSI.
337 * parent_vsi : the uplink VSI. It's NULL for main VSI.
338 * veb : the VEB associates with the VSI.
340 struct i40e_vsi_list sib_vsi_list; /* sibling vsi list */
341 struct i40e_vsi *parent_vsi;
342 struct i40e_veb *veb; /* Associated veb, could be null */
343 struct i40e_veb *floating_veb; /* Associated floating veb */
345 enum i40e_vsi_type type; /* VSI types */
346 uint16_t vlan_num; /* Total VLAN number */
347 uint16_t mac_num; /* Total mac number */
348 uint32_t vfta[I40E_VFTA_SIZE]; /* VLAN bitmap */
349 struct i40e_mac_filter_list mac_list; /* macvlan filter list */
350 /* specific VSI-defined parameters, SRIOV stored the vf_id */
352 uint16_t seid; /* The seid of VSI itself */
353 uint16_t uplink_seid; /* The uplink seid of this VSI */
354 uint16_t nb_qps; /* Number of queue pairs VSI can occupy */
355 uint16_t nb_used_qps; /* Number of queue pairs VSI uses */
356 uint16_t max_macaddrs; /* Maximum number of MAC addresses */
357 uint16_t base_queue; /* The first queue index of this VSI */
359 * The offset to visit VSI related register, assigned by HW when
363 uint16_t msix_intr; /* The MSIX interrupt binds to VSI */
364 uint16_t nb_msix; /* The max number of msix vector */
365 uint8_t enabled_tc; /* The traffic class enabled */
366 uint8_t vlan_anti_spoof_on; /* The VLAN anti-spoofing enabled */
367 uint8_t vlan_filter_on; /* The VLAN filter enabled */
368 struct i40e_bw_info bw_info; /* VSI bandwidth information */
372 LIST_ENTRY(pool_entry) next;
377 LIST_HEAD(res_list, pool_entry);
379 struct i40e_res_pool_info {
380 uint32_t base; /* Resource start index */
381 uint32_t num_alloc; /* Allocated resource number */
382 uint32_t num_free; /* Total available resource number */
383 struct res_list alloc_list; /* Allocated resource list */
384 struct res_list free_list; /* Available resource list */
388 I40E_VF_INACTIVE = 0,
395 * Structure to store private data for PF host.
399 struct i40e_vsi *vsi;
400 enum I40E_VF_STATE state; /* The number of queue pairs availiable */
401 uint16_t vf_idx; /* VF index in pf->vfs */
402 uint16_t lan_nb_qps; /* Actual queues allocated */
403 uint16_t reset_cnt; /* Total vf reset times */
404 struct ether_addr mac_addr; /* Default MAC address */
408 * Structure to store private data for flow control.
410 struct i40e_fc_conf {
411 uint16_t pause_time; /* Flow control pause timer */
412 /* FC high water 0-7 for pfc and 8 for lfc unit:kilobytes */
413 uint32_t high_water[I40E_MAX_TRAFFIC_CLASS + 1];
414 /* FC low water 0-7 for pfc and 8 for lfc unit:kilobytes */
415 uint32_t low_water[I40E_MAX_TRAFFIC_CLASS + 1];
419 * Structure to store private data for VMDQ instance
421 struct i40e_vmdq_info {
423 struct i40e_vsi *vsi;
427 * Structure to store flex pit for flow diretor.
429 struct i40e_fdir_flex_pit {
430 uint8_t src_offset; /* offset in words from the beginning of payload */
431 uint8_t size; /* size in words */
432 uint8_t dst_offset; /* offset in words of flexible payload */
435 struct i40e_fdir_flex_mask {
436 uint8_t word_mask; /**< Bit i enables word i of flexible payload */
440 } bitmask[I40E_FDIR_BITMASK_NUM_WORD];
443 #define I40E_FILTER_PCTYPE_MAX 64
444 #define I40E_MAX_FDIR_FILTER_NUM (1024 * 8)
446 struct i40e_fdir_filter {
447 TAILQ_ENTRY(i40e_fdir_filter) rules;
448 struct rte_eth_fdir_filter fdir;
451 TAILQ_HEAD(i40e_fdir_filter_list, i40e_fdir_filter);
453 * A structure used to define fields of a FDIR related info.
455 struct i40e_fdir_info {
456 struct i40e_vsi *fdir_vsi; /* pointer to fdir VSI structure */
457 uint16_t match_counter_index; /* Statistic counter index used for fdir*/
458 struct i40e_tx_queue *txq;
459 struct i40e_rx_queue *rxq;
460 void *prg_pkt; /* memory for fdir program packet */
461 uint64_t dma_addr; /* physic address of packet memory*/
462 /* input set bits for each pctype */
463 uint64_t input_set[I40E_FILTER_PCTYPE_MAX];
465 * the rule how bytes stream is extracted as flexible payload
466 * for each payload layer, the setting can up to three elements
468 struct i40e_fdir_flex_pit flex_set[I40E_MAX_FLXPLD_LAYER * I40E_MAX_FLXPLD_FIED];
469 struct i40e_fdir_flex_mask flex_mask[I40E_FILTER_PCTYPE_MAX];
471 struct i40e_fdir_filter_list fdir_list;
472 struct i40e_fdir_filter **hash_map;
473 struct rte_hash *hash_table;
476 /* Ethertype filter number HW supports */
477 #define I40E_MAX_ETHERTYPE_FILTER_NUM 768
479 /* Ethertype filter struct */
480 struct i40e_ethertype_filter_input {
481 struct ether_addr mac_addr; /* Mac address to match */
482 uint16_t ether_type; /* Ether type to match */
485 struct i40e_ethertype_filter {
486 TAILQ_ENTRY(i40e_ethertype_filter) rules;
487 struct i40e_ethertype_filter_input input;
488 uint16_t flags; /* Flags from RTE_ETHTYPE_FLAGS_* */
489 uint16_t queue; /* Queue assigned to when match */
492 TAILQ_HEAD(i40e_ethertype_filter_list, i40e_ethertype_filter);
494 struct i40e_ethertype_rule {
495 struct i40e_ethertype_filter_list ethertype_list;
496 struct i40e_ethertype_filter **hash_map;
497 struct rte_hash *hash_table;
500 /* Tunnel filter number HW supports */
501 #define I40E_MAX_TUNNEL_FILTER_NUM 400
503 enum i40e_tunnel_iptype {
504 I40E_TUNNEL_IPTYPE_IPV4,
505 I40E_TUNNEL_IPTYPE_IPV6,
508 /* Tunnel filter struct */
509 struct i40e_tunnel_filter_input {
510 uint8_t outer_mac[6]; /* Outer mac address to match */
511 uint8_t inner_mac[6]; /* Inner mac address to match */
512 uint16_t inner_vlan; /* Inner vlan address to match */
513 enum i40e_tunnel_iptype ip_type;
514 uint16_t flags; /* Filter type flag */
515 uint32_t tenant_id; /* Tenant id to match */
518 struct i40e_tunnel_filter {
519 TAILQ_ENTRY(i40e_tunnel_filter) rules;
520 struct i40e_tunnel_filter_input input;
521 uint16_t queue; /* Queue assigned to when match */
524 TAILQ_HEAD(i40e_tunnel_filter_list, i40e_tunnel_filter);
526 struct i40e_tunnel_rule {
527 struct i40e_tunnel_filter_list tunnel_list;
528 struct i40e_tunnel_filter **hash_map;
529 struct rte_hash *hash_table;
532 #define I40E_MIRROR_MAX_ENTRIES_PER_RULE 64
533 #define I40E_MAX_MIRROR_RULES 64
535 * Mirror rule structure
537 struct i40e_mirror_rule {
538 TAILQ_ENTRY(i40e_mirror_rule) rules;
540 uint16_t index; /* the sw index of mirror rule */
541 uint16_t id; /* the rule id assigned by firmware */
542 uint16_t dst_vsi_seid; /* destination vsi for this mirror rule. */
543 uint16_t num_entries;
544 /* the info stores depend on the rule type.
545 If type is I40E_MIRROR_TYPE_VLAN, vlan ids are stored here.
546 If type is I40E_MIRROR_TYPE_VPORT_*, vsi's seid are stored.
548 uint16_t entries[I40E_MIRROR_MAX_ENTRIES_PER_RULE];
551 TAILQ_HEAD(i40e_mirror_rule_list, i40e_mirror_rule);
554 * Struct to store flow created.
557 TAILQ_ENTRY(rte_flow) node;
558 enum rte_filter_type filter_type;
562 TAILQ_HEAD(i40e_flow_list, rte_flow);
565 * Structure to store private data specific for PF instance.
568 struct i40e_adapter *adapter; /* The adapter this PF associate to */
569 struct i40e_vsi *main_vsi; /* pointer to main VSI structure */
570 uint16_t mac_seid; /* The seid of the MAC of this PF */
571 uint16_t main_vsi_seid; /* The seid of the main VSI */
572 uint16_t max_num_vsi;
573 struct i40e_res_pool_info qp_pool; /*Queue pair pool */
574 struct i40e_res_pool_info msix_pool; /* MSIX interrupt pool */
576 struct i40e_hw_port_stats stats_offset;
577 struct i40e_hw_port_stats stats;
580 struct rte_eth_dev_data *dev_data; /* Pointer to the device data */
581 struct ether_addr dev_addr; /* PF device mac address */
582 uint64_t flags; /* PF feature flags */
583 /* All kinds of queue pair setting for different VSIs */
584 struct i40e_pf_vf *vfs;
586 /* Each of below queue pairs should be power of 2 since it's the
587 precondition after TC configuration applied */
588 uint16_t lan_nb_qp_max;
589 uint16_t lan_nb_qps; /* The number of queue pairs of LAN */
590 uint16_t lan_qp_offset;
591 uint16_t vmdq_nb_qp_max;
592 uint16_t vmdq_nb_qps; /* The number of queue pairs of VMDq */
593 uint16_t vmdq_qp_offset;
594 uint16_t vf_nb_qp_max;
595 uint16_t vf_nb_qps; /* The number of queue pairs of VF */
596 uint16_t vf_qp_offset;
597 uint16_t fdir_nb_qps; /* The number of queue pairs of Flow Director */
598 uint16_t fdir_qp_offset;
600 uint16_t hash_lut_size; /* The size of hash lookup table */
601 /* input set bits for each pctype */
602 uint64_t hash_input_set[I40E_FILTER_PCTYPE_MAX];
603 /* store VXLAN UDP ports */
604 uint16_t vxlan_ports[I40E_MAX_PF_UDP_OFFLOAD_PORTS];
605 uint16_t vxlan_bitmap; /* Vxlan bit mask */
607 /* VMDQ related info */
608 uint16_t max_nb_vmdq_vsi; /* Max number of VMDQ VSIs supported */
609 uint16_t nb_cfg_vmdq_vsi; /* number of VMDQ VSIs configured */
610 struct i40e_vmdq_info *vmdq;
612 struct i40e_fdir_info fdir; /* flow director info */
613 struct i40e_ethertype_rule ethertype; /* Ethertype filter rule */
614 struct i40e_tunnel_rule tunnel; /* Tunnel filter rule */
615 struct i40e_fc_conf fc_conf; /* Flow control conf */
616 struct i40e_mirror_rule_list mirror_list;
617 uint16_t nb_mirror_rule; /* The number of mirror rules */
618 bool floating_veb; /* The flag to use the floating VEB */
619 /* The floating enable flag for the specific VF */
620 bool floating_veb_list[I40E_MAX_VF];
621 struct i40e_flow_list flow_list;
625 PFMSG_LINK_CHANGE = 0x1,
626 PFMSG_RESET_IMPENDING = 0x2,
627 PFMSG_DRIVER_CLOSE = 0x4,
630 struct i40e_vsi_vlan_pvid_info {
631 uint16_t on; /* Enable or disable pvid */
633 uint16_t pvid; /* Valid in case 'on' is set to set pvid */
635 /* Valid in case 'on' is cleared. 'tagged' will reject tagged packets,
636 * while 'untagged' will reject untagged packets.
644 struct i40e_vf_rx_queues {
645 uint64_t rx_dma_addr;
646 uint32_t rx_ring_len;
650 struct i40e_vf_tx_queues {
651 uint64_t tx_dma_addr;
652 uint32_t tx_ring_len;
656 * Structure to store private data specific for VF instance.
659 struct i40e_adapter *adapter; /* The adapter this VF associate to */
660 struct rte_eth_dev_data *dev_data; /* Pointer to the device data */
661 uint16_t num_queue_pairs;
662 uint16_t max_pkt_len; /* Maximum packet length */
663 bool promisc_unicast_enabled;
664 bool promisc_multicast_enabled;
666 uint32_t version_major; /* Major version number */
667 uint32_t version_minor; /* Minor version number */
668 uint16_t promisc_flags; /* Promiscuous setting */
669 uint32_t vlan[I40E_VFTA_SIZE]; /* VLAN bit map */
674 enum i40e_aq_link_speed link_speed;
676 volatile uint32_t pend_cmd; /* pending command not finished yet */
677 int32_t cmd_retval; /* return value of the cmd response from PF */
678 u16 pend_msg; /* flags indicates events from pf not handled yet */
679 uint8_t *aq_resp; /* buffer to store the adminq response from PF */
682 struct i40e_virtchnl_vf_resource *vf_res; /* All VSIs */
683 struct i40e_virtchnl_vsi_resource *vsi_res; /* LAN VSI */
689 * Structure to store private data for each PF/VF instance.
691 struct i40e_adapter {
692 /* Common for both PF and VF */
694 struct rte_eth_dev *eth_dev;
696 /* Specific for PF or VF */
703 bool rx_bulk_alloc_allowed;
705 bool tx_simple_allowed;
709 struct rte_timecounter systime_tc;
710 struct rte_timecounter rx_tstamp_tc;
711 struct rte_timecounter tx_tstamp_tc;
714 extern const struct rte_flow_ops i40e_flow_ops;
716 union i40e_filter_t {
717 struct rte_eth_ethertype_filter ethertype_filter;
718 struct rte_eth_fdir_filter fdir_filter;
719 struct rte_eth_tunnel_filter_conf tunnel_filter;
722 typedef int (*parse_filter_t)(struct rte_eth_dev *dev,
723 const struct rte_flow_attr *attr,
724 const struct rte_flow_item pattern[],
725 const struct rte_flow_action actions[],
726 struct rte_flow_error *error,
727 union i40e_filter_t *filter);
728 struct i40e_valid_pattern {
729 enum rte_flow_item_type *items;
730 parse_filter_t parse_filter;
733 int i40e_dev_switch_queues(struct i40e_pf *pf, bool on);
734 int i40e_vsi_release(struct i40e_vsi *vsi);
735 struct i40e_vsi *i40e_vsi_setup(struct i40e_pf *pf,
736 enum i40e_vsi_type type,
737 struct i40e_vsi *uplink_vsi,
738 uint16_t user_param);
739 int i40e_switch_rx_queue(struct i40e_hw *hw, uint16_t q_idx, bool on);
740 int i40e_switch_tx_queue(struct i40e_hw *hw, uint16_t q_idx, bool on);
741 int i40e_vsi_add_vlan(struct i40e_vsi *vsi, uint16_t vlan);
742 int i40e_vsi_delete_vlan(struct i40e_vsi *vsi, uint16_t vlan);
743 int i40e_vsi_add_mac(struct i40e_vsi *vsi, struct i40e_mac_filter_info *filter);
744 int i40e_vsi_delete_mac(struct i40e_vsi *vsi, struct ether_addr *addr);
745 void i40e_update_vsi_stats(struct i40e_vsi *vsi);
746 void i40e_pf_disable_irq0(struct i40e_hw *hw);
747 void i40e_pf_enable_irq0(struct i40e_hw *hw);
748 int i40e_dev_link_update(struct rte_eth_dev *dev,
749 __rte_unused int wait_to_complete);
750 void i40e_vsi_queues_bind_intr(struct i40e_vsi *vsi);
751 void i40e_vsi_queues_unbind_intr(struct i40e_vsi *vsi);
752 int i40e_vsi_vlan_pvid_set(struct i40e_vsi *vsi,
753 struct i40e_vsi_vlan_pvid_info *info);
754 int i40e_vsi_config_vlan_stripping(struct i40e_vsi *vsi, bool on);
755 int i40e_vsi_config_vlan_filter(struct i40e_vsi *vsi, bool on);
756 uint64_t i40e_config_hena(uint64_t flags, enum i40e_mac_type type);
757 uint64_t i40e_parse_hena(uint64_t flags);
758 enum i40e_status_code i40e_fdir_setup_tx_resources(struct i40e_pf *pf);
759 enum i40e_status_code i40e_fdir_setup_rx_resources(struct i40e_pf *pf);
760 int i40e_fdir_setup(struct i40e_pf *pf);
761 const struct rte_memzone *i40e_memzone_reserve(const char *name,
764 int i40e_fdir_configure(struct rte_eth_dev *dev);
765 void i40e_fdir_teardown(struct i40e_pf *pf);
766 enum i40e_filter_pctype i40e_flowtype_to_pctype(uint16_t flow_type);
767 uint16_t i40e_pctype_to_flowtype(enum i40e_filter_pctype pctype);
768 int i40e_fdir_ctrl_func(struct rte_eth_dev *dev,
769 enum rte_filter_op filter_op,
771 int i40e_select_filter_input_set(struct i40e_hw *hw,
772 struct rte_eth_input_set_conf *conf,
773 enum rte_filter_type filter);
774 void i40e_fdir_filter_restore(struct i40e_pf *pf);
775 int i40e_hash_filter_inset_select(struct i40e_hw *hw,
776 struct rte_eth_input_set_conf *conf);
777 int i40e_fdir_filter_inset_select(struct i40e_pf *pf,
778 struct rte_eth_input_set_conf *conf);
779 int i40e_pf_host_send_msg_to_vf(struct i40e_pf_vf *vf, uint32_t opcode,
780 uint32_t retval, uint8_t *msg,
782 void i40e_rxq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
783 struct rte_eth_rxq_info *qinfo);
784 void i40e_txq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
785 struct rte_eth_txq_info *qinfo);
786 struct i40e_ethertype_filter *
787 i40e_sw_ethertype_filter_lookup(struct i40e_ethertype_rule *ethertype_rule,
788 const struct i40e_ethertype_filter_input *input);
789 int i40e_sw_ethertype_filter_del(struct i40e_pf *pf,
790 struct i40e_ethertype_filter_input *input);
791 int i40e_sw_fdir_filter_del(struct i40e_pf *pf,
792 struct rte_eth_fdir_input *input);
793 struct i40e_tunnel_filter *
794 i40e_sw_tunnel_filter_lookup(struct i40e_tunnel_rule *tunnel_rule,
795 const struct i40e_tunnel_filter_input *input);
796 int i40e_sw_tunnel_filter_del(struct i40e_pf *pf,
797 struct i40e_tunnel_filter_input *input);
798 uint64_t i40e_get_default_input_set(uint16_t pctype);
799 int i40e_ethertype_filter_set(struct i40e_pf *pf,
800 struct rte_eth_ethertype_filter *filter,
802 int i40e_add_del_fdir_filter(struct rte_eth_dev *dev,
803 const struct rte_eth_fdir_filter *filter,
805 int i40e_dev_tunnel_filter_set(struct i40e_pf *pf,
806 struct rte_eth_tunnel_filter_conf *tunnel_filter,
808 int i40e_fdir_flush(struct rte_eth_dev *dev);
810 #define I40E_DEV_TO_PCI(eth_dev) \
811 RTE_DEV_TO_PCI((eth_dev)->device)
813 /* I40E_DEV_PRIVATE_TO */
814 #define I40E_DEV_PRIVATE_TO_PF(adapter) \
815 (&((struct i40e_adapter *)adapter)->pf)
816 #define I40E_DEV_PRIVATE_TO_HW(adapter) \
817 (&((struct i40e_adapter *)adapter)->hw)
818 #define I40E_DEV_PRIVATE_TO_ADAPTER(adapter) \
819 ((struct i40e_adapter *)adapter)
821 /* I40EVF_DEV_PRIVATE_TO */
822 #define I40EVF_DEV_PRIVATE_TO_VF(adapter) \
823 (&((struct i40e_adapter *)adapter)->vf)
825 static inline struct i40e_vsi *
826 i40e_get_vsi_from_adapter(struct i40e_adapter *adapter)
833 hw = I40E_DEV_PRIVATE_TO_HW(adapter);
834 if (hw->mac.type == I40E_MAC_VF || hw->mac.type == I40E_MAC_X722_VF) {
835 struct i40e_vf *vf = I40EVF_DEV_PRIVATE_TO_VF(adapter);
838 struct i40e_pf *pf = I40E_DEV_PRIVATE_TO_PF(adapter);
842 #define I40E_DEV_PRIVATE_TO_MAIN_VSI(adapter) \
843 i40e_get_vsi_from_adapter((struct i40e_adapter *)adapter)
846 #define I40E_VSI_TO_HW(vsi) \
847 (&(((struct i40e_vsi *)vsi)->adapter->hw))
848 #define I40E_VSI_TO_PF(vsi) \
849 (&(((struct i40e_vsi *)vsi)->adapter->pf))
850 #define I40E_VSI_TO_VF(vsi) \
851 (&(((struct i40e_vsi *)vsi)->adapter->vf))
852 #define I40E_VSI_TO_DEV_DATA(vsi) \
853 (((struct i40e_vsi *)vsi)->adapter->pf.dev_data)
854 #define I40E_VSI_TO_ETH_DEV(vsi) \
855 (((struct i40e_vsi *)vsi)->adapter->eth_dev)
858 #define I40E_PF_TO_HW(pf) \
859 (&(((struct i40e_pf *)pf)->adapter->hw))
860 #define I40E_PF_TO_ADAPTER(pf) \
861 ((struct i40e_adapter *)pf->adapter)
864 #define I40E_VF_TO_HW(vf) \
865 (&(((struct i40e_vf *)vf)->adapter->hw))
868 i40e_init_adminq_parameter(struct i40e_hw *hw)
870 hw->aq.num_arq_entries = I40E_AQ_LEN;
871 hw->aq.num_asq_entries = I40E_AQ_LEN;
872 hw->aq.arq_buf_size = I40E_AQ_BUF_SZ;
873 hw->aq.asq_buf_size = I40E_AQ_BUF_SZ;
877 i40e_align_floor(int n)
881 return 1 << (sizeof(n) * CHAR_BIT - 1 - __builtin_clz(n));
884 static inline uint16_t
885 i40e_calc_itr_interval(int16_t interval)
887 if (interval < 0 || interval > I40E_QUEUE_ITR_INTERVAL_MAX)
888 interval = I40E_QUEUE_ITR_INTERVAL_DEFAULT;
890 /* Convert to hardware count, as writing each 1 represents 2 us */
894 #define I40E_VALID_FLOW(flow_type) \
895 ((flow_type) == RTE_ETH_FLOW_FRAG_IPV4 || \
896 (flow_type) == RTE_ETH_FLOW_NONFRAG_IPV4_TCP || \
897 (flow_type) == RTE_ETH_FLOW_NONFRAG_IPV4_UDP || \
898 (flow_type) == RTE_ETH_FLOW_NONFRAG_IPV4_SCTP || \
899 (flow_type) == RTE_ETH_FLOW_NONFRAG_IPV4_OTHER || \
900 (flow_type) == RTE_ETH_FLOW_FRAG_IPV6 || \
901 (flow_type) == RTE_ETH_FLOW_NONFRAG_IPV6_TCP || \
902 (flow_type) == RTE_ETH_FLOW_NONFRAG_IPV6_UDP || \
903 (flow_type) == RTE_ETH_FLOW_NONFRAG_IPV6_SCTP || \
904 (flow_type) == RTE_ETH_FLOW_NONFRAG_IPV6_OTHER || \
905 (flow_type) == RTE_ETH_FLOW_L2_PAYLOAD)
907 #define I40E_VALID_PCTYPE_X722(pctype) \
908 ((pctype) == I40E_FILTER_PCTYPE_FRAG_IPV4 || \
909 (pctype) == I40E_FILTER_PCTYPE_NONF_IPV4_TCP || \
910 (pctype) == I40E_FILTER_PCTYPE_NONF_IPV4_TCP_SYN_NO_ACK || \
911 (pctype) == I40E_FILTER_PCTYPE_NONF_IPV4_UDP || \
912 (pctype) == I40E_FILTER_PCTYPE_NONF_UNICAST_IPV4_UDP || \
913 (pctype) == I40E_FILTER_PCTYPE_NONF_MULTICAST_IPV4_UDP || \
914 (pctype) == I40E_FILTER_PCTYPE_NONF_IPV4_SCTP || \
915 (pctype) == I40E_FILTER_PCTYPE_NONF_IPV4_OTHER || \
916 (pctype) == I40E_FILTER_PCTYPE_FRAG_IPV6 || \
917 (pctype) == I40E_FILTER_PCTYPE_NONF_IPV6_UDP || \
918 (pctype) == I40E_FILTER_PCTYPE_NONF_UNICAST_IPV6_UDP || \
919 (pctype) == I40E_FILTER_PCTYPE_NONF_MULTICAST_IPV6_UDP || \
920 (pctype) == I40E_FILTER_PCTYPE_NONF_IPV6_TCP || \
921 (pctype) == I40E_FILTER_PCTYPE_NONF_IPV6_TCP_SYN_NO_ACK || \
922 (pctype) == I40E_FILTER_PCTYPE_NONF_IPV6_SCTP || \
923 (pctype) == I40E_FILTER_PCTYPE_NONF_IPV6_OTHER || \
924 (pctype) == I40E_FILTER_PCTYPE_L2_PAYLOAD)
926 #define I40E_VALID_PCTYPE(pctype) \
927 ((pctype) == I40E_FILTER_PCTYPE_FRAG_IPV4 || \
928 (pctype) == I40E_FILTER_PCTYPE_NONF_IPV4_TCP || \
929 (pctype) == I40E_FILTER_PCTYPE_NONF_IPV4_UDP || \
930 (pctype) == I40E_FILTER_PCTYPE_NONF_IPV4_SCTP || \
931 (pctype) == I40E_FILTER_PCTYPE_NONF_IPV4_OTHER || \
932 (pctype) == I40E_FILTER_PCTYPE_FRAG_IPV6 || \
933 (pctype) == I40E_FILTER_PCTYPE_NONF_IPV6_UDP || \
934 (pctype) == I40E_FILTER_PCTYPE_NONF_IPV6_TCP || \
935 (pctype) == I40E_FILTER_PCTYPE_NONF_IPV6_SCTP || \
936 (pctype) == I40E_FILTER_PCTYPE_NONF_IPV6_OTHER || \
937 (pctype) == I40E_FILTER_PCTYPE_L2_PAYLOAD)
939 #define I40E_PHY_TYPE_SUPPORT_40G(phy_type) \
940 (((phy_type) & I40E_CAP_PHY_TYPE_40GBASE_KR4) || \
941 ((phy_type) & I40E_CAP_PHY_TYPE_40GBASE_CR4_CU) || \
942 ((phy_type) & I40E_CAP_PHY_TYPE_40GBASE_AOC) || \
943 ((phy_type) & I40E_CAP_PHY_TYPE_40GBASE_CR4) || \
944 ((phy_type) & I40E_CAP_PHY_TYPE_40GBASE_SR4) || \
945 ((phy_type) & I40E_CAP_PHY_TYPE_40GBASE_LR4))
947 #define I40E_PHY_TYPE_SUPPORT_25G(phy_type) \
948 (((phy_type) & I40E_CAP_PHY_TYPE_25GBASE_KR) || \
949 ((phy_type) & I40E_CAP_PHY_TYPE_25GBASE_CR) || \
950 ((phy_type) & I40E_CAP_PHY_TYPE_25GBASE_SR) || \
951 ((phy_type) & I40E_CAP_PHY_TYPE_25GBASE_LR))
953 #endif /* _I40E_ETHDEV_H_ */