4 * Copyright(c) 2010-2014 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 _RTE_ETHDEV_H_
35 #define _RTE_ETHDEV_H_
40 * RTE Ethernet Device API
42 * The Ethernet Device API is composed of two parts:
44 * - The application-oriented Ethernet API that includes functions to setup
45 * an Ethernet device (configure it, setup its RX and TX queues and start it),
46 * to get its MAC address, the speed and the status of its physical link,
47 * to receive and to transmit packets, and so on.
49 * - The driver-oriented Ethernet API that exports a function allowing
50 * an Ethernet Poll Mode Driver (PMD) to simultaneously register itself as
51 * an Ethernet device driver and as a PCI driver for a set of matching PCI
52 * [Ethernet] devices classes.
54 * By default, all the functions of the Ethernet Device API exported by a PMD
55 * are lock-free functions which assume to not be invoked in parallel on
56 * different logical cores to work on the same target object. For instance,
57 * the receive function of a PMD cannot be invoked in parallel on two logical
58 * cores to poll the same RX queue [of the same port]. Of course, this function
59 * can be invoked in parallel by different logical cores on different RX queues.
60 * It is the responsibility of the upper level application to enforce this rule.
62 * If needed, parallel accesses by multiple logical cores to shared queues
63 * shall be explicitly protected by dedicated inline lock-aware functions
64 * built on top of their corresponding lock-free functions of the PMD API.
66 * In all functions of the Ethernet API, the Ethernet device is
67 * designated by an integer >= 0 named the device port identifier.
69 * At the Ethernet driver level, Ethernet devices are represented by a generic
70 * data structure of type *rte_eth_dev*.
72 * Ethernet devices are dynamically registered during the PCI probing phase
73 * performed at EAL initialization time.
74 * When an Ethernet device is being probed, an *rte_eth_dev* structure and
75 * a new port identifier are allocated for that device. Then, the eth_dev_init()
76 * function supplied by the Ethernet driver matching the probed PCI
77 * device is invoked to properly initialize the device.
79 * The role of the device init function consists of resetting the hardware,
80 * checking access to Non-volatile Memory (NVM), reading the MAC address
83 * If the device init operation is successful, the correspondence between
84 * the port identifier assigned to the new device and its associated
85 * *rte_eth_dev* structure is effectively registered.
86 * Otherwise, both the *rte_eth_dev* structure and the port identifier are
89 * The functions exported by the application Ethernet API to setup a device
90 * designated by its port identifier must be invoked in the following order:
91 * - rte_eth_dev_configure()
92 * - rte_eth_tx_queue_setup()
93 * - rte_eth_rx_queue_setup()
94 * - rte_eth_dev_start()
96 * Then, the network application can invoke, in any order, the functions
97 * exported by the Ethernet API to get the MAC address of a given device, to
98 * get the speed and the status of a device physical link, to receive/transmit
99 * [burst of] packets, and so on.
101 * If the application wants to change the configuration (i.e. call
102 * rte_eth_dev_configure(), rte_eth_tx_queue_setup(), or
103 * rte_eth_rx_queue_setup()), it must call rte_eth_dev_stop() first to stop the
104 * device and then do the reconfiguration before calling rte_eth_dev_start()
105 * again. The tramsit and receive functions should not be invoked when the
108 * Please note that some configuration is not stored between calls to
109 * rte_eth_dev_stop()/rte_eth_dev_start(). The following configuration will
112 * - flow control settings
113 * - receive mode configuration (promiscuous mode, hardware checksum mode,
114 * RSS/VMDQ settings etc.)
115 * - VLAN filtering configuration
116 * - MAC addresses supplied to MAC address array
117 * - flow director filtering mode (but not filtering rules)
118 * - NIC queue statistics mappings
120 * Any other configuration will not be stored and will need to be re-entered
121 * after a call to rte_eth_dev_start().
123 * Finally, a network application can close an Ethernet device by invoking the
124 * rte_eth_dev_close() function.
126 * Each function of the application Ethernet API invokes a specific function
127 * of the PMD that controls the target device designated by its port
129 * For this purpose, all device-specific functions of an Ethernet driver are
130 * supplied through a set of pointers contained in a generic structure of type
132 * The address of the *eth_dev_ops* structure is stored in the *rte_eth_dev*
133 * structure by the device init function of the Ethernet driver, which is
134 * invoked during the PCI probing phase, as explained earlier.
136 * In other words, each function of the Ethernet API simply retrieves the
137 * *rte_eth_dev* structure associated with the device port identifier and
138 * performs an indirect invocation of the corresponding driver function
139 * supplied in the *eth_dev_ops* structure of the *rte_eth_dev* structure.
141 * For performance reasons, the address of the burst-oriented RX and TX
142 * functions of the Ethernet driver are not contained in the *eth_dev_ops*
143 * structure. Instead, they are directly stored at the beginning of the
144 * *rte_eth_dev* structure to avoid an extra indirect memory access during
147 * RTE ethernet device drivers do not use interrupts for transmitting or
148 * receiving. Instead, Ethernet drivers export Poll-Mode receive and transmit
149 * functions to applications.
150 * Both receive and transmit functions are packet-burst oriented to minimize
151 * their cost per packet through the following optimizations:
153 * - Sharing among multiple packets the incompressible cost of the
154 * invocation of receive/transmit functions.
156 * - Enabling receive/transmit functions to take advantage of burst-oriented
157 * hardware features (L1 cache, prefetch instructions, NIC head/tail
158 * registers) to minimize the number of CPU cycles per packet, for instance,
159 * by avoiding useless read memory accesses to ring descriptors, or by
160 * systematically using arrays of pointers that exactly fit L1 cache line
161 * boundaries and sizes.
163 * The burst-oriented receive function does not provide any error notification,
164 * to avoid the corresponding overhead. As a hint, the upper-level application
165 * might check the status of the device link once being systematically returned
166 * a 0 value by the receive function of the driver for a given number of tries.
176 #include <rte_interrupts.h>
178 #include <rte_mbuf.h>
179 #include "rte_ether.h"
182 * A structure used to retrieve statistics for an Ethernet port.
184 struct rte_eth_stats {
185 uint64_t ipackets; /**< Total number of successfully received packets. */
186 uint64_t opackets; /**< Total number of successfully transmitted packets.*/
187 uint64_t ibytes; /**< Total number of successfully received bytes. */
188 uint64_t obytes; /**< Total number of successfully transmitted bytes. */
189 uint64_t imissed; /**< Total of RX missed packets (e.g full FIFO). */
190 uint64_t ibadcrc; /**< Total of RX packets with CRC error. */
191 uint64_t ibadlen; /**< Total of RX packets with bad length. */
192 uint64_t ierrors; /**< Total number of erroneous received packets. */
193 uint64_t oerrors; /**< Total number of failed transmitted packets. */
194 uint64_t imcasts; /**< Total number of multicast received packets. */
195 uint64_t rx_nombuf; /**< Total number of RX mbuf allocation failures. */
196 uint64_t fdirmatch; /**< Total number of RX packets matching a filter. */
197 uint64_t fdirmiss; /**< Total number of RX packets not matching any filter. */
198 uint64_t tx_pause_xon; /**< Total nb. of XON pause frame sent. */
199 uint64_t rx_pause_xon; /**< Total nb. of XON pause frame received. */
200 uint64_t tx_pause_xoff; /**< Total nb. of XOFF pause frame sent. */
201 uint64_t rx_pause_xoff; /**< Total nb. of XOFF pause frame received. */
202 uint64_t q_ipackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
203 /**< Total number of queue RX packets. */
204 uint64_t q_opackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
205 /**< Total number of queue TX packets. */
206 uint64_t q_ibytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
207 /**< Total number of successfully received queue bytes. */
208 uint64_t q_obytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
209 /**< Total number of successfully transmitted queue bytes. */
210 uint64_t q_errors[RTE_ETHDEV_QUEUE_STAT_CNTRS];
211 /**< Total number of queue packets received that are dropped. */
213 /**< Total number of good packets received from loopback,VF Only */
215 /**< Total number of good packets transmitted to loopback,VF Only */
217 /**< Total number of good bytes received from loopback,VF Only */
219 /**< Total number of good bytes transmitted to loopback,VF Only */
223 * A structure used to retrieve link-level information of an Ethernet port.
225 struct rte_eth_link {
226 uint16_t link_speed; /**< ETH_LINK_SPEED_[10, 100, 1000, 10000] */
227 uint16_t link_duplex; /**< ETH_LINK_[HALF_DUPLEX, FULL_DUPLEX] */
228 uint8_t link_status : 1; /**< 1 -> link up, 0 -> link down */
229 }__attribute__((aligned(8))); /**< aligned for atomic64 read/write */
231 #define ETH_LINK_SPEED_AUTONEG 0 /**< Auto-negotiate link speed. */
232 #define ETH_LINK_SPEED_10 10 /**< 10 megabits/second. */
233 #define ETH_LINK_SPEED_100 100 /**< 100 megabits/second. */
234 #define ETH_LINK_SPEED_1000 1000 /**< 1 gigabits/second. */
235 #define ETH_LINK_SPEED_10000 10000 /**< 10 gigabits/second. */
236 #define ETH_LINK_SPEED_10G 10000 /**< alias of 10 gigabits/second. */
237 #define ETH_LINK_SPEED_20G 20000 /**< 20 gigabits/second. */
238 #define ETH_LINK_SPEED_40G 40000 /**< 40 gigabits/second. */
240 #define ETH_LINK_AUTONEG_DUPLEX 0 /**< Auto-negotiate duplex. */
241 #define ETH_LINK_HALF_DUPLEX 1 /**< Half-duplex connection. */
242 #define ETH_LINK_FULL_DUPLEX 2 /**< Full-duplex connection. */
245 * A structure used to configure the ring threshold registers of an RX/TX
246 * queue for an Ethernet port.
248 struct rte_eth_thresh {
249 uint8_t pthresh; /**< Ring prefetch threshold. */
250 uint8_t hthresh; /**< Ring host threshold. */
251 uint8_t wthresh; /**< Ring writeback threshold. */
255 * A set of values to identify what method is to be used to route
256 * packets to multiple queues.
258 enum rte_eth_rx_mq_mode {
259 ETH_MQ_RX_NONE = 0, /**< None of DCB,RSS or VMDQ mode */
261 ETH_MQ_RX_RSS, /**< For RX side, only RSS is on */
262 ETH_MQ_RX_DCB, /**< For RX side,only DCB is on. */
263 ETH_MQ_RX_DCB_RSS, /**< Both DCB and RSS enable */
265 ETH_MQ_RX_VMDQ_ONLY, /**< Only VMDQ, no RSS nor DCB */
266 ETH_MQ_RX_VMDQ_RSS, /**< RSS mode with VMDQ */
267 ETH_MQ_RX_VMDQ_DCB, /**< Use VMDQ+DCB to route traffic to queues */
268 ETH_MQ_RX_VMDQ_DCB_RSS, /**< Enable both VMDQ and DCB in VMDq */
272 * for rx mq mode backward compatible
274 #define ETH_RSS ETH_MQ_RX_RSS
275 #define VMDQ_DCB ETH_MQ_RX_VMDQ_DCB
276 #define ETH_DCB_RX ETH_MQ_RX_DCB
279 * A set of values to identify what method is to be used to transmit
280 * packets using multi-TCs.
282 enum rte_eth_tx_mq_mode {
283 ETH_MQ_TX_NONE = 0, /**< It is in neither DCB nor VT mode. */
284 ETH_MQ_TX_DCB, /**< For TX side,only DCB is on. */
285 ETH_MQ_TX_VMDQ_DCB, /**< For TX side,both DCB and VT is on. */
286 ETH_MQ_TX_VMDQ_ONLY, /**< Only VT on, no DCB */
290 * for tx mq mode backward compatible
292 #define ETH_DCB_NONE ETH_MQ_TX_NONE
293 #define ETH_VMDQ_DCB_TX ETH_MQ_TX_VMDQ_DCB
294 #define ETH_DCB_TX ETH_MQ_TX_DCB
297 * A structure used to configure the RX features of an Ethernet port.
299 struct rte_eth_rxmode {
300 /** The multi-queue packet distribution mode to be used, e.g. RSS. */
301 enum rte_eth_rx_mq_mode mq_mode;
302 uint32_t max_rx_pkt_len; /**< Only used if jumbo_frame enabled. */
303 uint16_t split_hdr_size; /**< hdr buf size (header_split enabled).*/
304 uint8_t header_split : 1, /**< Header Split enable. */
305 hw_ip_checksum : 1, /**< IP/UDP/TCP checksum offload enable. */
306 hw_vlan_filter : 1, /**< VLAN filter enable. */
307 hw_vlan_strip : 1, /**< VLAN strip enable. */
308 hw_vlan_extend : 1, /**< Extended VLAN enable. */
309 jumbo_frame : 1, /**< Jumbo Frame Receipt enable. */
310 hw_strip_crc : 1, /**< Enable CRC stripping by hardware. */
311 enable_scatter : 1; /**< Enable scatter packets rx handler */
315 * A structure used to configure the Receive Side Scaling (RSS) feature
316 * of an Ethernet port.
317 * If not NULL, the *rss_key* pointer of the *rss_conf* structure points
318 * to an array holding the RSS key to use for hashing specific header
319 * fields of received packets. The length of this array should be indicated
320 * by *rss_key_len* below. Otherwise, a default random hash key is used by
323 * The *rss_key_len* field of the *rss_conf* structure indicates the length
324 * in bytes of the array pointed by *rss_key*. To be compatible, this length
325 * will be checked in i40e only. Others assume 40 bytes to be used as before.
327 * The *rss_hf* field of the *rss_conf* structure indicates the different
328 * types of IPv4/IPv6 packets to which the RSS hashing must be applied.
329 * Supplying an *rss_hf* equal to zero disables the RSS feature.
331 struct rte_eth_rss_conf {
332 uint8_t *rss_key; /**< If not NULL, 40-byte hash key. */
333 uint8_t rss_key_len; /**< hash key length in bytes. */
334 uint64_t rss_hf; /**< Hash functions to apply - see below. */
337 /* Supported RSS offloads */
339 #define ETH_RSS_IPV4_SHIFT 0
340 #define ETH_RSS_IPV4_TCP_SHIFT 1
341 #define ETH_RSS_IPV6_SHIFT 2
342 #define ETH_RSS_IPV6_EX_SHIFT 3
343 #define ETH_RSS_IPV6_TCP_SHIFT 4
344 #define ETH_RSS_IPV6_TCP_EX_SHIFT 5
345 #define ETH_RSS_IPV4_UDP_SHIFT 6
346 #define ETH_RSS_IPV6_UDP_SHIFT 7
347 #define ETH_RSS_IPV6_UDP_EX_SHIFT 8
349 #define ETH_RSS_NONF_IPV4_UDP_SHIFT 31
350 #define ETH_RSS_NONF_IPV4_TCP_SHIFT 33
351 #define ETH_RSS_NONF_IPV4_SCTP_SHIFT 34
352 #define ETH_RSS_NONF_IPV4_OTHER_SHIFT 35
353 #define ETH_RSS_FRAG_IPV4_SHIFT 36
354 #define ETH_RSS_NONF_IPV6_UDP_SHIFT 41
355 #define ETH_RSS_NONF_IPV6_TCP_SHIFT 43
356 #define ETH_RSS_NONF_IPV6_SCTP_SHIFT 44
357 #define ETH_RSS_NONF_IPV6_OTHER_SHIFT 45
358 #define ETH_RSS_FRAG_IPV6_SHIFT 46
359 #define ETH_RSS_FCOE_OX_SHIFT 48
360 #define ETH_RSS_FCOE_RX_SHIFT 49
361 #define ETH_RSS_FCOE_OTHER_SHIFT 50
362 #define ETH_RSS_L2_PAYLOAD_SHIFT 63
365 #define ETH_RSS_IPV4 (1 << ETH_RSS_IPV4_SHIFT)
366 #define ETH_RSS_IPV4_TCP (1 << ETH_RSS_IPV4_TCP_SHIFT)
367 #define ETH_RSS_IPV6 (1 << ETH_RSS_IPV6_SHIFT)
368 #define ETH_RSS_IPV6_EX (1 << ETH_RSS_IPV6_EX_SHIFT)
369 #define ETH_RSS_IPV6_TCP (1 << ETH_RSS_IPV6_TCP_SHIFT)
370 #define ETH_RSS_IPV6_TCP_EX (1 << ETH_RSS_IPV6_TCP_EX_SHIFT)
371 #define ETH_RSS_IPV4_UDP (1 << ETH_RSS_IPV4_UDP_SHIFT)
372 #define ETH_RSS_IPV6_UDP (1 << ETH_RSS_IPV6_UDP_SHIFT)
373 #define ETH_RSS_IPV6_UDP_EX (1 << ETH_RSS_IPV6_UDP_EX_SHIFT)
375 #define ETH_RSS_NONF_IPV4_UDP (1ULL << ETH_RSS_NONF_IPV4_UDP_SHIFT)
376 #define ETH_RSS_NONF_IPV4_TCP (1ULL << ETH_RSS_NONF_IPV4_TCP_SHIFT)
377 #define ETH_RSS_NONF_IPV4_SCTP (1ULL << ETH_RSS_NONF_IPV4_SCTP_SHIFT)
378 #define ETH_RSS_NONF_IPV4_OTHER (1ULL << ETH_RSS_NONF_IPV4_OTHER_SHIFT)
379 #define ETH_RSS_FRAG_IPV4 (1ULL << ETH_RSS_FRAG_IPV4_SHIFT)
380 #define ETH_RSS_NONF_IPV6_UDP (1ULL << ETH_RSS_NONF_IPV6_UDP_SHIFT)
381 #define ETH_RSS_NONF_IPV6_TCP (1ULL << ETH_RSS_NONF_IPV6_TCP_SHIFT)
382 #define ETH_RSS_NONF_IPV6_SCTP (1ULL << ETH_RSS_NONF_IPV6_SCTP_SHIFT)
383 #define ETH_RSS_NONF_IPV6_OTHER (1ULL << ETH_RSS_NONF_IPV6_OTHER_SHIFT)
384 #define ETH_RSS_FRAG_IPV6 (1ULL << ETH_RSS_FRAG_IPV6_SHIFT)
385 /* FCOE relevant should not be used */
386 #define ETH_RSS_FCOE_OX (1ULL << ETH_RSS_FCOE_OX_SHIFT)
387 #define ETH_RSS_FCOE_RX (1ULL << ETH_RSS_FCOE_RX_SHIFT)
388 #define ETH_RSS_FCOE_OTHER (1ULL << ETH_RSS_FCOE_OTHER_SHIFT)
389 #define ETH_RSS_L2_PAYLOAD (1ULL << ETH_RSS_L2_PAYLOAD_SHIFT)
391 #define ETH_RSS_IP ( \
394 ETH_RSS_NONF_IPV4_OTHER | \
395 ETH_RSS_FRAG_IPV4 | \
396 ETH_RSS_NONF_IPV6_OTHER | \
398 #define ETH_RSS_UDP ( \
403 ETH_RSS_IPV6_UDP_EX | \
404 ETH_RSS_NONF_IPV4_UDP | \
405 ETH_RSS_NONF_IPV6_UDP)
406 /**< Mask of valid RSS hash protocols */
407 #define ETH_RSS_PROTO_MASK ( \
413 ETH_RSS_IPV6_TCP_EX | \
416 ETH_RSS_IPV6_UDP_EX | \
417 ETH_RSS_NONF_IPV4_UDP | \
418 ETH_RSS_NONF_IPV4_TCP | \
419 ETH_RSS_NONF_IPV4_SCTP | \
420 ETH_RSS_NONF_IPV4_OTHER | \
421 ETH_RSS_FRAG_IPV4 | \
422 ETH_RSS_NONF_IPV6_UDP | \
423 ETH_RSS_NONF_IPV6_TCP | \
424 ETH_RSS_NONF_IPV6_SCTP | \
425 ETH_RSS_NONF_IPV6_OTHER | \
426 ETH_RSS_FRAG_IPV6 | \
429 /* Definitions used for redirection table entry size */
430 #define ETH_RSS_RETA_NUM_ENTRIES 128
431 #define ETH_RSS_RETA_MAX_QUEUE 16
433 /* Definitions used for VMDQ and DCB functionality */
434 #define ETH_VMDQ_MAX_VLAN_FILTERS 64 /**< Maximum nb. of VMDQ vlan filters. */
435 #define ETH_DCB_NUM_USER_PRIORITIES 8 /**< Maximum nb. of DCB priorities. */
436 #define ETH_VMDQ_DCB_NUM_QUEUES 128 /**< Maximum nb. of VMDQ DCB queues. */
437 #define ETH_DCB_NUM_QUEUES 128 /**< Maximum nb. of DCB queues. */
439 /* DCB capability defines */
440 #define ETH_DCB_PG_SUPPORT 0x00000001 /**< Priority Group(ETS) support. */
441 #define ETH_DCB_PFC_SUPPORT 0x00000002 /**< Priority Flow Control support. */
443 /* Definitions used for VLAN Offload functionality */
444 #define ETH_VLAN_STRIP_OFFLOAD 0x0001 /**< VLAN Strip On/Off */
445 #define ETH_VLAN_FILTER_OFFLOAD 0x0002 /**< VLAN Filter On/Off */
446 #define ETH_VLAN_EXTEND_OFFLOAD 0x0004 /**< VLAN Extend On/Off */
448 /* Definitions used for mask VLAN setting */
449 #define ETH_VLAN_STRIP_MASK 0x0001 /**< VLAN Strip setting mask */
450 #define ETH_VLAN_FILTER_MASK 0x0002 /**< VLAN Filter setting mask*/
451 #define ETH_VLAN_EXTEND_MASK 0x0004 /**< VLAN Extend setting mask*/
452 #define ETH_VLAN_ID_MAX 0x0FFF /**< VLAN ID is in lower 12 bits*/
454 /* Definitions used for receive MAC address */
455 #define ETH_NUM_RECEIVE_MAC_ADDR 128 /**< Maximum nb. of receive mac addr. */
457 /* Definitions used for unicast hash */
458 #define ETH_VMDQ_NUM_UC_HASH_ARRAY 128 /**< Maximum nb. of UC hash array. */
460 /* Definitions used for VMDQ pool rx mode setting */
461 #define ETH_VMDQ_ACCEPT_UNTAG 0x0001 /**< accept untagged packets. */
462 #define ETH_VMDQ_ACCEPT_HASH_MC 0x0002 /**< accept packets in multicast table . */
463 #define ETH_VMDQ_ACCEPT_HASH_UC 0x0004 /**< accept packets in unicast table. */
464 #define ETH_VMDQ_ACCEPT_BROADCAST 0x0008 /**< accept broadcast packets. */
465 #define ETH_VMDQ_ACCEPT_MULTICAST 0x0010 /**< multicast promiscuous. */
467 /* Definitions used for VMDQ mirror rules setting */
468 #define ETH_VMDQ_NUM_MIRROR_RULE 4 /**< Maximum nb. of mirror rules. . */
470 #define ETH_VMDQ_POOL_MIRROR 0x0001 /**< Virtual Pool Mirroring. */
471 #define ETH_VMDQ_UPLINK_MIRROR 0x0002 /**< Uplink Port Mirroring. */
472 #define ETH_VMDQ_DOWNLIN_MIRROR 0x0004 /**< Downlink Port Mirroring. */
473 #define ETH_VMDQ_VLAN_MIRROR 0x0008 /**< VLAN Mirroring. */
476 * A structure used to configure VLAN traffic mirror of an Ethernet port.
478 struct rte_eth_vlan_mirror {
479 uint64_t vlan_mask; /**< mask for valid VLAN ID. */
480 uint16_t vlan_id[ETH_VMDQ_MAX_VLAN_FILTERS];
481 /** VLAN ID list for vlan mirror. */
485 * A structure used to configure traffic mirror of an Ethernet port.
487 struct rte_eth_vmdq_mirror_conf {
488 uint8_t rule_type_mask; /**< Mirroring rule type mask we want to set */
489 uint8_t dst_pool; /**< Destination pool for this mirror rule. */
490 uint64_t pool_mask; /**< Bitmap of pool for pool mirroring */
491 struct rte_eth_vlan_mirror vlan; /**< VLAN ID setting for VLAN mirroring */
495 * A structure used to configure Redirection Table of the Receive Side
496 * Scaling (RSS) feature of an Ethernet port.
498 struct rte_eth_rss_reta {
499 /** First 64 mask bits indicate which entry(s) need to updated/queried. */
501 /** Second 64 mask bits indicate which entry(s) need to updated/queried. */
503 uint8_t reta[ETH_RSS_RETA_NUM_ENTRIES]; /**< 128 RETA entries*/
507 * This enum indicates the possible number of traffic classes
508 * in DCB configratioins
510 enum rte_eth_nb_tcs {
511 ETH_4_TCS = 4, /**< 4 TCs with DCB. */
512 ETH_8_TCS = 8 /**< 8 TCs with DCB. */
516 * This enum indicates the possible number of queue pools
517 * in VMDQ configurations.
519 enum rte_eth_nb_pools {
520 ETH_8_POOLS = 8, /**< 8 VMDq pools. */
521 ETH_16_POOLS = 16, /**< 16 VMDq pools. */
522 ETH_32_POOLS = 32, /**< 32 VMDq pools. */
523 ETH_64_POOLS = 64 /**< 64 VMDq pools. */
526 /* This structure may be extended in future. */
527 struct rte_eth_dcb_rx_conf {
528 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs */
529 uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
530 /**< Possible DCB queue,4 or 8. */
533 struct rte_eth_vmdq_dcb_tx_conf {
534 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools. */
535 uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
536 /**< Possible DCB queue,4 or 8. */
539 struct rte_eth_dcb_tx_conf {
540 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs. */
541 uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
542 /**< Possible DCB queue,4 or 8. */
545 struct rte_eth_vmdq_tx_conf {
546 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq mode, 64 pools. */
550 * A structure used to configure the VMDQ+DCB feature
551 * of an Ethernet port.
553 * Using this feature, packets are routed to a pool of queues, based
554 * on the vlan id in the vlan tag, and then to a specific queue within
555 * that pool, using the user priority vlan tag field.
557 * A default pool may be used, if desired, to route all traffic which
558 * does not match the vlan filter rules.
560 struct rte_eth_vmdq_dcb_conf {
561 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools */
562 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
563 uint8_t default_pool; /**< The default pool, if applicable */
564 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
566 uint16_t vlan_id; /**< The vlan id of the received frame */
567 uint64_t pools; /**< Bitmask of pools for packet rx */
568 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
569 uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
570 /**< Selects a queue in a pool */
573 struct rte_eth_vmdq_rx_conf {
574 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq only mode, 8 or 64 pools */
575 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
576 uint8_t default_pool; /**< The default pool, if applicable */
577 uint8_t enable_loop_back; /**< Enable VT loop back */
578 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
580 uint16_t vlan_id; /**< The vlan id of the received frame */
581 uint64_t pools; /**< Bitmask of pools for packet rx */
582 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
586 * A structure used to configure the TX features of an Ethernet port.
588 struct rte_eth_txmode {
589 enum rte_eth_tx_mq_mode mq_mode; /**< TX multi-queues mode. */
591 /* For i40e specifically */
593 uint8_t hw_vlan_reject_tagged : 1,
594 /**< If set, reject sending out tagged pkts */
595 hw_vlan_reject_untagged : 1,
596 /**< If set, reject sending out untagged pkts */
597 hw_vlan_insert_pvid : 1;
598 /**< If set, enable port based VLAN insertion */
602 * A structure used to configure an RX ring of an Ethernet port.
604 struct rte_eth_rxconf {
605 struct rte_eth_thresh rx_thresh; /**< RX ring threshold registers. */
606 uint16_t rx_free_thresh; /**< Drives the freeing of RX descriptors. */
607 uint8_t rx_drop_en; /**< Drop packets if no descriptors are available. */
608 uint8_t rx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
611 #define ETH_TXQ_FLAGS_NOMULTSEGS 0x0001 /**< nb_segs=1 for all mbufs */
612 #define ETH_TXQ_FLAGS_NOREFCOUNT 0x0002 /**< refcnt can be ignored */
613 #define ETH_TXQ_FLAGS_NOMULTMEMP 0x0004 /**< all bufs come from same mempool */
614 #define ETH_TXQ_FLAGS_NOVLANOFFL 0x0100 /**< disable VLAN offload */
615 #define ETH_TXQ_FLAGS_NOXSUMSCTP 0x0200 /**< disable SCTP checksum offload */
616 #define ETH_TXQ_FLAGS_NOXSUMUDP 0x0400 /**< disable UDP checksum offload */
617 #define ETH_TXQ_FLAGS_NOXSUMTCP 0x0800 /**< disable TCP checksum offload */
618 #define ETH_TXQ_FLAGS_NOOFFLOADS \
619 (ETH_TXQ_FLAGS_NOVLANOFFL | ETH_TXQ_FLAGS_NOXSUMSCTP | \
620 ETH_TXQ_FLAGS_NOXSUMUDP | ETH_TXQ_FLAGS_NOXSUMTCP)
622 * A structure used to configure a TX ring of an Ethernet port.
624 struct rte_eth_txconf {
625 struct rte_eth_thresh tx_thresh; /**< TX ring threshold registers. */
626 uint16_t tx_rs_thresh; /**< Drives the setting of RS bit on TXDs. */
627 uint16_t tx_free_thresh; /**< Drives the freeing of TX buffers. */
628 uint32_t txq_flags; /**< Set flags for the Tx queue */
629 uint8_t tx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
633 * This enum indicates the flow control mode
635 enum rte_eth_fc_mode {
636 RTE_FC_NONE = 0, /**< Disable flow control. */
637 RTE_FC_RX_PAUSE, /**< RX pause frame, enable flowctrl on TX side. */
638 RTE_FC_TX_PAUSE, /**< TX pause frame, enable flowctrl on RX side. */
639 RTE_FC_FULL /**< Enable flow control on both side. */
643 * A structure used to configure Ethernet flow control parameter.
644 * These parameters will be configured into the register of the NIC.
645 * Please refer to the corresponding data sheet for proper value.
647 struct rte_eth_fc_conf {
648 uint32_t high_water; /**< High threshold value to trigger XOFF */
649 uint32_t low_water; /**< Low threshold value to trigger XON */
650 uint16_t pause_time; /**< Pause quota in the Pause frame */
651 uint16_t send_xon; /**< Is XON frame need be sent */
652 enum rte_eth_fc_mode mode; /**< Link flow control mode */
653 uint8_t mac_ctrl_frame_fwd; /**< Forward MAC control frames */
654 uint8_t autoneg; /**< Use Pause autoneg */
658 * A structure used to configure Ethernet priority flow control parameter.
659 * These parameters will be configured into the register of the NIC.
660 * Please refer to the corresponding data sheet for proper value.
662 struct rte_eth_pfc_conf {
663 struct rte_eth_fc_conf fc; /**< General flow control parameter. */
664 uint8_t priority; /**< VLAN User Priority. */
668 * Flow Director setting modes: none (default), signature or perfect.
671 RTE_FDIR_MODE_NONE = 0, /**< Disable FDIR support. */
672 RTE_FDIR_MODE_SIGNATURE, /**< Enable FDIR signature filter mode. */
673 RTE_FDIR_MODE_PERFECT, /**< Enable FDIR perfect filter mode. */
677 * Memory space that can be configured to store Flow Director filters
678 * in the board memory.
680 enum rte_fdir_pballoc_type {
681 RTE_FDIR_PBALLOC_64K = 0, /**< 64k. */
682 RTE_FDIR_PBALLOC_128K, /**< 128k. */
683 RTE_FDIR_PBALLOC_256K, /**< 256k. */
687 * Select report mode of FDIR hash information in RX descriptors.
689 enum rte_fdir_status_mode {
690 RTE_FDIR_NO_REPORT_STATUS = 0, /**< Never report FDIR hash. */
691 RTE_FDIR_REPORT_STATUS, /**< Only report FDIR hash for matching pkts. */
692 RTE_FDIR_REPORT_STATUS_ALWAYS, /**< Always report FDIR hash. */
696 * A structure used to configure the Flow Director (FDIR) feature
697 * of an Ethernet port.
699 * If mode is RTE_FDIR_DISABLE, the pballoc value is ignored.
701 struct rte_fdir_conf {
702 enum rte_fdir_mode mode; /**< Flow Director mode. */
703 enum rte_fdir_pballoc_type pballoc; /**< Space for FDIR filters. */
704 enum rte_fdir_status_mode status; /**< How to report FDIR hash. */
705 /** Offset of flexbytes field in RX packets (in 16-bit word units). */
706 uint8_t flexbytes_offset;
707 /** RX queue of packets matching a "drop" filter in perfect mode. */
712 * Possible l4type of FDIR filters.
715 RTE_FDIR_L4TYPE_NONE = 0, /**< None. */
716 RTE_FDIR_L4TYPE_UDP, /**< UDP. */
717 RTE_FDIR_L4TYPE_TCP, /**< TCP. */
718 RTE_FDIR_L4TYPE_SCTP, /**< SCTP. */
722 * Select IPv4 or IPv6 FDIR filters.
725 RTE_FDIR_IPTYPE_IPV4 = 0, /**< IPv4. */
726 RTE_FDIR_IPTYPE_IPV6 , /**< IPv6. */
730 * A structure used to define a FDIR packet filter.
732 struct rte_fdir_filter {
733 uint16_t flex_bytes; /**< Flex bytes value to match. */
734 uint16_t vlan_id; /**< VLAN ID value to match, 0 otherwise. */
735 uint16_t port_src; /**< Source port to match, 0 otherwise. */
736 uint16_t port_dst; /**< Destination port to match, 0 otherwise. */
738 uint32_t ipv4_addr; /**< IPv4 source address to match. */
739 uint32_t ipv6_addr[4]; /**< IPv6 source address to match. */
740 } ip_src; /**< IPv4/IPv6 source address to match (union of above). */
742 uint32_t ipv4_addr; /**< IPv4 destination address to match. */
743 uint32_t ipv6_addr[4]; /**< IPv6 destination address to match */
744 } ip_dst; /**< IPv4/IPv6 destination address to match (union of above). */
745 enum rte_l4type l4type; /**< l4type to match: NONE/UDP/TCP/SCTP. */
746 enum rte_iptype iptype; /**< IP packet type to match: IPv4 or IPv6. */
750 * A structure used to configure FDIR masks that are used by the device
751 * to match the various fields of RX packet headers.
752 * @note The only_ip_flow field has the opposite meaning compared to other
755 struct rte_fdir_masks {
756 /** When set to 1, packet l4type is \b NOT relevant in filters, and
757 source and destination port masks must be set to zero. */
758 uint8_t only_ip_flow;
759 /** If set to 1, vlan_id is relevant in filters. */
761 /** If set to 1, vlan_prio is relevant in filters. */
763 /** If set to 1, flexbytes is relevant in filters. */
765 /** If set to 1, set the IPv6 masks. Otherwise set the IPv4 masks. */
766 uint8_t set_ipv6_mask;
767 /** When set to 1, comparison of destination IPv6 address with IP6AT
768 registers is meaningful. */
769 uint8_t comp_ipv6_dst;
770 /** Mask of Destination IPv4 Address. All bits set to 1 define the
771 relevant bits to use in the destination address of an IPv4 packet
772 when matching it against FDIR filters. */
773 uint32_t dst_ipv4_mask;
774 /** Mask of Source IPv4 Address. All bits set to 1 define
775 the relevant bits to use in the source address of an IPv4 packet
776 when matching it against FDIR filters. */
777 uint32_t src_ipv4_mask;
778 /** Mask of Source IPv6 Address. All bits set to 1 define the
779 relevant BYTES to use in the source address of an IPv6 packet
780 when matching it against FDIR filters. */
781 uint16_t dst_ipv6_mask;
782 /** Mask of Destination IPv6 Address. All bits set to 1 define the
783 relevant BYTES to use in the destination address of an IPv6 packet
784 when matching it against FDIR filters. */
785 uint16_t src_ipv6_mask;
786 /** Mask of Source Port. All bits set to 1 define the relevant
787 bits to use in the source port of an IP packets when matching it
788 against FDIR filters. */
789 uint16_t src_port_mask;
790 /** Mask of Destination Port. All bits set to 1 define the relevant
791 bits to use in the destination port of an IP packet when matching it
792 against FDIR filters. */
793 uint16_t dst_port_mask;
797 * A structure used to report the status of the flow director filters in use.
799 struct rte_eth_fdir {
800 /** Number of filters with collision indication. */
802 /** Number of free (non programmed) filters. */
804 /** The Lookup hash value of the added filter that updated the value
805 of the MAXLEN field */
807 /** Longest linked list of filters in the table. */
809 /** Number of added filters. */
811 /** Number of removed filters. */
813 /** Number of failed added filters (no more space in device). */
815 /** Number of failed removed filters. */
820 * A structure used to enable/disable specific device interrupts.
822 struct rte_intr_conf {
823 /** enable/disable lsc interrupt. 0 (default) - disable, 1 enable */
828 * A structure used to configure an Ethernet port.
829 * Depending upon the RX multi-queue mode, extra advanced
830 * configuration settings may be needed.
832 struct rte_eth_conf {
834 /**< ETH_LINK_SPEED_10[0|00|000], or 0 for autonegotation */
835 uint16_t link_duplex;
836 /**< ETH_LINK_[HALF_DUPLEX|FULL_DUPLEX], or 0 for autonegotation */
837 struct rte_eth_rxmode rxmode; /**< Port RX configuration. */
838 struct rte_eth_txmode txmode; /**< Port TX configuration. */
839 uint32_t lpbk_mode; /**< Loopback operation mode. By default the value
840 is 0, meaning the loopback mode is disabled.
841 Read the datasheet of given ethernet controller
842 for details. The possible values of this field
843 are defined in implementation of each driver. */
845 struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
846 struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
847 /**< Port vmdq+dcb configuration. */
848 struct rte_eth_dcb_rx_conf dcb_rx_conf;
849 /**< Port dcb RX configuration. */
850 struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
851 /**< Port vmdq RX configuration. */
852 } rx_adv_conf; /**< Port RX filtering configuration (union). */
854 struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
855 /**< Port vmdq+dcb TX configuration. */
856 struct rte_eth_dcb_tx_conf dcb_tx_conf;
857 /**< Port dcb TX configuration. */
858 struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
859 /**< Port vmdq TX configuration. */
860 } tx_adv_conf; /**< Port TX DCB configuration (union). */
861 /** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
862 is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
863 uint32_t dcb_capability_en;
864 struct rte_fdir_conf fdir_conf; /**< FDIR configuration. */
865 struct rte_intr_conf intr_conf; /**< Interrupt mode configuration. */
869 * A structure used to retrieve the contextual information of
870 * an Ethernet device, such as the controlling driver of the device,
871 * its PCI context, etc...
875 * RX offload capabilities of a device.
877 #define DEV_RX_OFFLOAD_VLAN_STRIP 0x00000001
878 #define DEV_RX_OFFLOAD_IPV4_CKSUM 0x00000002
879 #define DEV_RX_OFFLOAD_UDP_CKSUM 0x00000004
880 #define DEV_RX_OFFLOAD_TCP_CKSUM 0x00000008
881 #define DEV_RX_OFFLOAD_TCP_LRO 0x00000010
884 * TX offload capabilities of a device.
886 #define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001
887 #define DEV_TX_OFFLOAD_IPV4_CKSUM 0x00000002
888 #define DEV_TX_OFFLOAD_UDP_CKSUM 0x00000004
889 #define DEV_TX_OFFLOAD_TCP_CKSUM 0x00000008
890 #define DEV_TX_OFFLOAD_SCTP_CKSUM 0x00000010
891 #define DEV_TX_OFFLOAD_TCP_TSO 0x00000020
892 #define DEV_TX_OFFLOAD_UDP_TSO 0x00000040
894 struct rte_eth_dev_info {
895 struct rte_pci_device *pci_dev; /**< Device PCI information. */
896 const char *driver_name; /**< Device Driver name. */
897 unsigned int if_index; /**< Index to bound host interface, or 0 if none.
898 Use if_indextoname() to translate into an interface name. */
899 uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
900 uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
901 uint16_t max_rx_queues; /**< Maximum number of RX queues. */
902 uint16_t max_tx_queues; /**< Maximum number of TX queues. */
903 uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
904 uint32_t max_hash_mac_addrs;
905 /** Maximum number of hash MAC addresses for MTA and UTA. */
906 uint16_t max_vfs; /**< Maximum number of VFs. */
907 uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
908 uint32_t rx_offload_capa; /**< Device RX offload capabilities. */
909 uint32_t tx_offload_capa; /**< Device TX offload capabilities. */
910 struct rte_eth_rxconf default_rxconf; /**< Default RX configuration */
911 struct rte_eth_txconf default_txconf; /**< Default TX configuration */
914 /** Maximum name length for extended statistics counters */
915 #define RTE_ETH_XSTATS_NAME_SIZE 64
918 * An Ethernet device extended statistic structure
920 * This structure is used by ethdev->eth_xstats_get() to provide
921 * statistics that are not provided in the generic rte_eth_stats
924 struct rte_eth_xstats {
925 char name[RTE_ETH_XSTATS_NAME_SIZE];
931 struct rte_eth_dev_callback;
932 /** @internal Structure to keep track of registered callbacks */
933 TAILQ_HEAD(rte_eth_dev_cb_list, rte_eth_dev_callback);
935 #define TCP_UGR_FLAG 0x20
936 #define TCP_ACK_FLAG 0x10
937 #define TCP_PSH_FLAG 0x08
938 #define TCP_RST_FLAG 0x04
939 #define TCP_SYN_FLAG 0x02
940 #define TCP_FIN_FLAG 0x01
941 #define TCP_FLAG_ALL 0x3F
944 * A structure used to define an ethertype filter.
946 struct rte_ethertype_filter {
947 uint16_t ethertype; /**< little endian. */
948 uint8_t priority_en; /**< compare priority enable. */
953 * A structure used to define an syn filter.
955 struct rte_syn_filter {
956 uint8_t hig_pri; /**< 1 means higher pri than 2tuple, 5tupe,
957 and flex filter, 0 means lower pri. */
961 * A structure used to define a 2tuple filter.
963 struct rte_2tuple_filter {
964 uint16_t dst_port; /**< big endian. */
967 uint16_t priority; /**< used when more than one filter matches. */
968 uint8_t dst_port_mask:1, /**< if mask is 1b, means not compare. */
973 * A structure used to define a flex filter.
975 struct rte_flex_filter {
977 uint32_t dwords[32]; /**< flex bytes in big endian. */
978 uint8_t mask[16]; /**< if mask bit is 1b, do not compare
979 corresponding byte in dwords. */
984 * A structure used to define a 5tuple filter.
986 struct rte_5tuple_filter {
987 uint32_t dst_ip; /**< destination IP address in big endian. */
988 uint32_t src_ip; /**< source IP address in big endian. */
989 uint16_t dst_port; /**< destination port in big endian. */
990 uint16_t src_port; /**< source Port big endian. */
991 uint8_t protocol; /**< l4 protocol. */
992 uint8_t tcp_flags; /**< tcp flags. */
993 uint16_t priority; /**< seven evels (001b-111b), 111b is highest,
994 used when more than one filter matches. */
995 uint8_t dst_ip_mask:1, /**< if mask is 1b, do not compare dst ip. */
996 src_ip_mask:1, /**< if mask is 1b, do not compare src ip. */
997 dst_port_mask:1, /**< if mask is 1b, do not compare dst port. */
998 src_port_mask:1, /**< if mask is 1b, do not compare src port. */
999 protocol_mask:1; /**< if mask is 1b, do not compare protocol. */
1003 * Definitions of all functions exported by an Ethernet driver through the
1004 * the generic structure of type *eth_dev_ops* supplied in the *rte_eth_dev*
1005 * structure associated with an Ethernet device.
1008 typedef int (*eth_dev_configure_t)(struct rte_eth_dev *dev);
1009 /**< @internal Ethernet device configuration. */
1011 typedef int (*eth_dev_start_t)(struct rte_eth_dev *dev);
1012 /**< @internal Function used to start a configured Ethernet device. */
1014 typedef void (*eth_dev_stop_t)(struct rte_eth_dev *dev);
1015 /**< @internal Function used to stop a configured Ethernet device. */
1017 typedef int (*eth_dev_set_link_up_t)(struct rte_eth_dev *dev);
1018 /**< @internal Function used to link up a configured Ethernet device. */
1020 typedef int (*eth_dev_set_link_down_t)(struct rte_eth_dev *dev);
1021 /**< @internal Function used to link down a configured Ethernet device. */
1023 typedef void (*eth_dev_close_t)(struct rte_eth_dev *dev);
1024 /**< @internal Function used to close a configured Ethernet device. */
1026 typedef void (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev);
1027 /**< @internal Function used to enable the RX promiscuous mode of an Ethernet device. */
1029 typedef void (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev);
1030 /**< @internal Function used to disable the RX promiscuous mode of an Ethernet device. */
1032 typedef void (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
1033 /**< @internal Enable the receipt of all multicast packets by an Ethernet device. */
1035 typedef void (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
1036 /**< @internal Disable the receipt of all multicast packets by an Ethernet device. */
1038 typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
1039 int wait_to_complete);
1040 /**< @internal Get link speed, duplex mode and state (up/down) of an Ethernet device. */
1042 typedef void (*eth_stats_get_t)(struct rte_eth_dev *dev,
1043 struct rte_eth_stats *igb_stats);
1044 /**< @internal Get global I/O statistics of an Ethernet device. */
1046 typedef void (*eth_stats_reset_t)(struct rte_eth_dev *dev);
1047 /**< @internal Reset global I/O statistics of an Ethernet device to 0. */
1049 typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev,
1050 struct rte_eth_xstats *stats, unsigned n);
1051 /**< @internal Get extended stats of an Ethernet device. */
1053 typedef void (*eth_xstats_reset_t)(struct rte_eth_dev *dev);
1054 /**< @internal Reset extended stats of an Ethernet device. */
1056 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
1060 /**< @internal Set a queue statistics mapping for a tx/rx queue of an Ethernet device. */
1062 typedef void (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
1063 struct rte_eth_dev_info *dev_info);
1064 /**< @internal Get specific informations of an Ethernet device. */
1066 typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
1068 /**< @internal Start rx and tx of a queue of an Ethernet device. */
1070 typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
1072 /**< @internal Stop rx and tx of a queue of an Ethernet device. */
1074 typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
1075 uint16_t rx_queue_id,
1076 uint16_t nb_rx_desc,
1077 unsigned int socket_id,
1078 const struct rte_eth_rxconf *rx_conf,
1079 struct rte_mempool *mb_pool);
1080 /**< @internal Set up a receive queue of an Ethernet device. */
1082 typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
1083 uint16_t tx_queue_id,
1084 uint16_t nb_tx_desc,
1085 unsigned int socket_id,
1086 const struct rte_eth_txconf *tx_conf);
1087 /**< @internal Setup a transmit queue of an Ethernet device. */
1089 typedef void (*eth_queue_release_t)(void *queue);
1090 /**< @internal Release memory resources allocated by given RX/TX queue. */
1092 typedef uint32_t (*eth_rx_queue_count_t)(struct rte_eth_dev *dev,
1093 uint16_t rx_queue_id);
1094 /**< @Get number of available descriptors on a receive queue of an Ethernet device. */
1096 typedef int (*eth_rx_descriptor_done_t)(void *rxq, uint16_t offset);
1097 /**< @Check DD bit of specific RX descriptor */
1099 typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);
1100 /**< @internal Set MTU. */
1102 typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
1105 /**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */
1107 typedef void (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
1109 /**< @internal set the outer VLAN-TPID by an Ethernet device. */
1111 typedef void (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
1112 /**< @internal set VLAN offload function by an Ethernet device. */
1114 typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
1117 /**< @internal set port based TX VLAN insertion by an Ethernet device. */
1119 typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
1120 uint16_t rx_queue_id,
1122 /**< @internal VLAN stripping enable/disable by an queue of Ethernet device. */
1124 typedef uint16_t (*eth_rx_burst_t)(void *rxq,
1125 struct rte_mbuf **rx_pkts,
1127 /**< @internal Retrieve input packets from a receive queue of an Ethernet device. */
1129 typedef uint16_t (*eth_tx_burst_t)(void *txq,
1130 struct rte_mbuf **tx_pkts,
1132 /**< @internal Send output packets on a transmit queue of an Ethernet device. */
1134 typedef int (*fdir_add_signature_filter_t)(struct rte_eth_dev *dev,
1135 struct rte_fdir_filter *fdir_ftr,
1137 /**< @internal Setup a new signature filter rule on an Ethernet device */
1139 typedef int (*fdir_update_signature_filter_t)(struct rte_eth_dev *dev,
1140 struct rte_fdir_filter *fdir_ftr,
1142 /**< @internal Update a signature filter rule on an Ethernet device */
1144 typedef int (*fdir_remove_signature_filter_t)(struct rte_eth_dev *dev,
1145 struct rte_fdir_filter *fdir_ftr);
1146 /**< @internal Remove a signature filter rule on an Ethernet device */
1148 typedef void (*fdir_infos_get_t)(struct rte_eth_dev *dev,
1149 struct rte_eth_fdir *fdir);
1150 /**< @internal Get information about fdir status */
1152 typedef int (*fdir_add_perfect_filter_t)(struct rte_eth_dev *dev,
1153 struct rte_fdir_filter *fdir_ftr,
1154 uint16_t soft_id, uint8_t rx_queue,
1156 /**< @internal Setup a new perfect filter rule on an Ethernet device */
1158 typedef int (*fdir_update_perfect_filter_t)(struct rte_eth_dev *dev,
1159 struct rte_fdir_filter *fdir_ftr,
1160 uint16_t soft_id, uint8_t rx_queue,
1162 /**< @internal Update a perfect filter rule on an Ethernet device */
1164 typedef int (*fdir_remove_perfect_filter_t)(struct rte_eth_dev *dev,
1165 struct rte_fdir_filter *fdir_ftr,
1167 /**< @internal Remove a perfect filter rule on an Ethernet device */
1169 typedef int (*fdir_set_masks_t)(struct rte_eth_dev *dev,
1170 struct rte_fdir_masks *fdir_masks);
1171 /**< @internal Setup flow director masks on an Ethernet device */
1173 typedef int (*flow_ctrl_get_t)(struct rte_eth_dev *dev,
1174 struct rte_eth_fc_conf *fc_conf);
1175 /**< @internal Get current flow control parameter on an Ethernet device */
1177 typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
1178 struct rte_eth_fc_conf *fc_conf);
1179 /**< @internal Setup flow control parameter on an Ethernet device */
1181 typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
1182 struct rte_eth_pfc_conf *pfc_conf);
1183 /**< @internal Setup priority flow control parameter on an Ethernet device */
1185 typedef int (*reta_update_t)(struct rte_eth_dev *dev,
1186 struct rte_eth_rss_reta *reta_conf);
1187 /**< @internal Update RSS redirection table on an Ethernet device */
1189 typedef int (*reta_query_t)(struct rte_eth_dev *dev,
1190 struct rte_eth_rss_reta *reta_conf);
1191 /**< @internal Query RSS redirection table on an Ethernet device */
1193 typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
1194 struct rte_eth_rss_conf *rss_conf);
1195 /**< @internal Update RSS hash configuration of an Ethernet device */
1197 typedef int (*rss_hash_conf_get_t)(struct rte_eth_dev *dev,
1198 struct rte_eth_rss_conf *rss_conf);
1199 /**< @internal Get current RSS hash configuration of an Ethernet device */
1201 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
1202 /**< @internal Turn on SW controllable LED on an Ethernet device */
1204 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
1205 /**< @internal Turn off SW controllable LED on an Ethernet device */
1207 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
1208 /**< @internal Remove MAC address from receive address register */
1210 typedef void (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
1211 struct ether_addr *mac_addr,
1214 /**< @internal Set a MAC address into Receive Address Address Register */
1216 typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
1217 struct ether_addr *mac_addr,
1219 /**< @internal Set a Unicast Hash bitmap */
1221 typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
1223 /**< @internal Set all Unicast Hash bitmap */
1225 typedef int (*eth_set_vf_rx_mode_t)(struct rte_eth_dev *dev,
1229 /**< @internal Set a VF receive mode */
1231 typedef int (*eth_set_vf_rx_t)(struct rte_eth_dev *dev,
1234 /**< @internal Set a VF receive mode */
1236 typedef int (*eth_set_vf_tx_t)(struct rte_eth_dev *dev,
1239 /**< @internal Enable or disable a VF transmit */
1241 typedef int (*eth_set_vf_vlan_filter_t)(struct rte_eth_dev *dev,
1245 /**< @internal Set VF VLAN pool filter */
1247 typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
1250 /**< @internal Set queue TX rate */
1252 typedef int (*eth_set_vf_rate_limit_t)(struct rte_eth_dev *dev,
1256 /**< @internal Set VF TX rate */
1258 typedef int (*eth_mirror_rule_set_t)(struct rte_eth_dev *dev,
1259 struct rte_eth_vmdq_mirror_conf *mirror_conf,
1262 /**< @internal Add a traffic mirroring rule on an Ethernet device */
1264 typedef int (*eth_mirror_rule_reset_t)(struct rte_eth_dev *dev,
1266 /**< @internal Remove a traffic mirroring rule on an Ethernet device */
1268 #ifdef RTE_NIC_BYPASS
1271 RTE_BYPASS_MODE_NONE,
1272 RTE_BYPASS_MODE_NORMAL,
1273 RTE_BYPASS_MODE_BYPASS,
1274 RTE_BYPASS_MODE_ISOLATE,
1275 RTE_BYPASS_MODE_NUM,
1278 #define RTE_BYPASS_MODE_VALID(x) \
1279 ((x) > RTE_BYPASS_MODE_NONE && (x) < RTE_BYPASS_MODE_NUM)
1282 RTE_BYPASS_EVENT_NONE,
1283 RTE_BYPASS_EVENT_START,
1284 RTE_BYPASS_EVENT_OS_ON = RTE_BYPASS_EVENT_START,
1285 RTE_BYPASS_EVENT_POWER_ON,
1286 RTE_BYPASS_EVENT_OS_OFF,
1287 RTE_BYPASS_EVENT_POWER_OFF,
1288 RTE_BYPASS_EVENT_TIMEOUT,
1289 RTE_BYPASS_EVENT_NUM
1292 #define RTE_BYPASS_EVENT_VALID(x) \
1293 ((x) > RTE_BYPASS_EVENT_NONE && (x) < RTE_BYPASS_MODE_NUM)
1296 RTE_BYPASS_TMT_OFF, /* timeout disabled. */
1297 RTE_BYPASS_TMT_1_5_SEC, /* timeout for 1.5 seconds */
1298 RTE_BYPASS_TMT_2_SEC, /* timeout for 2 seconds */
1299 RTE_BYPASS_TMT_3_SEC, /* timeout for 3 seconds */
1300 RTE_BYPASS_TMT_4_SEC, /* timeout for 4 seconds */
1301 RTE_BYPASS_TMT_8_SEC, /* timeout for 8 seconds */
1302 RTE_BYPASS_TMT_16_SEC, /* timeout for 16 seconds */
1303 RTE_BYPASS_TMT_32_SEC, /* timeout for 32 seconds */
1307 #define RTE_BYPASS_TMT_VALID(x) \
1308 ((x) == RTE_BYPASS_TMT_OFF || \
1309 ((x) > RTE_BYPASS_TMT_OFF && (x) < RTE_BYPASS_TMT_NUM))
1311 typedef void (*bypass_init_t)(struct rte_eth_dev *dev);
1312 typedef int32_t (*bypass_state_set_t)(struct rte_eth_dev *dev, uint32_t *new_state);
1313 typedef int32_t (*bypass_state_show_t)(struct rte_eth_dev *dev, uint32_t *state);
1314 typedef int32_t (*bypass_event_set_t)(struct rte_eth_dev *dev, uint32_t state, uint32_t event);
1315 typedef int32_t (*bypass_event_show_t)(struct rte_eth_dev *dev, uint32_t event_shift, uint32_t *event);
1316 typedef int32_t (*bypass_wd_timeout_set_t)(struct rte_eth_dev *dev, uint32_t timeout);
1317 typedef int32_t (*bypass_wd_timeout_show_t)(struct rte_eth_dev *dev, uint32_t *wd_timeout);
1318 typedef int32_t (*bypass_ver_show_t)(struct rte_eth_dev *dev, uint32_t *ver);
1319 typedef int32_t (*bypass_wd_reset_t)(struct rte_eth_dev *dev);
1322 typedef int (*eth_add_syn_filter_t)(struct rte_eth_dev *dev,
1323 struct rte_syn_filter *filter, uint16_t rx_queue);
1324 /**< @internal add syn filter rule on an Ethernet device */
1326 typedef int (*eth_remove_syn_filter_t)(struct rte_eth_dev *dev);
1327 /**< @internal remove syn filter rule on an Ethernet device */
1329 typedef int (*eth_get_syn_filter_t)(struct rte_eth_dev *dev,
1330 struct rte_syn_filter *filter, uint16_t *rx_queue);
1331 /**< @internal Get syn filter rule on an Ethernet device */
1333 typedef int (*eth_add_ethertype_filter_t)(struct rte_eth_dev *dev,
1334 uint16_t index, struct rte_ethertype_filter *filter,
1336 /**< @internal Setup a new ethertype filter rule on an Ethernet device */
1338 typedef int (*eth_remove_ethertype_filter_t)(struct rte_eth_dev *dev,
1340 /**< @internal Remove an ethertype filter rule on an Ethernet device */
1342 typedef int (*eth_get_ethertype_filter_t)(struct rte_eth_dev *dev,
1343 uint16_t index, struct rte_ethertype_filter *filter,
1344 uint16_t *rx_queue);
1345 /**< @internal Get an ethertype filter rule on an Ethernet device */
1347 typedef int (*eth_add_2tuple_filter_t)(struct rte_eth_dev *dev,
1348 uint16_t index, struct rte_2tuple_filter *filter,
1350 /**< @internal Setup a new 2tuple filter rule on an Ethernet device */
1352 typedef int (*eth_remove_2tuple_filter_t)(struct rte_eth_dev *dev,
1354 /**< @internal Remove a 2tuple filter rule on an Ethernet device */
1356 typedef int (*eth_get_2tuple_filter_t)(struct rte_eth_dev *dev,
1357 uint16_t index, struct rte_2tuple_filter *filter,
1358 uint16_t *rx_queue);
1359 /**< @internal Get a 2tuple filter rule on an Ethernet device */
1361 typedef int (*eth_add_5tuple_filter_t)(struct rte_eth_dev *dev,
1362 uint16_t index, struct rte_5tuple_filter *filter,
1364 /**< @internal Setup a new 5tuple filter rule on an Ethernet device */
1366 typedef int (*eth_remove_5tuple_filter_t)(struct rte_eth_dev *dev,
1368 /**< @internal Remove a 5tuple filter rule on an Ethernet device */
1370 typedef int (*eth_get_5tuple_filter_t)(struct rte_eth_dev *dev,
1371 uint16_t index, struct rte_5tuple_filter *filter,
1372 uint16_t *rx_queue);
1373 /**< @internal Get a 5tuple filter rule on an Ethernet device */
1375 typedef int (*eth_add_flex_filter_t)(struct rte_eth_dev *dev,
1376 uint16_t index, struct rte_flex_filter *filter,
1378 /**< @internal Setup a new flex filter rule on an Ethernet device */
1380 typedef int (*eth_remove_flex_filter_t)(struct rte_eth_dev *dev,
1382 /**< @internal Remove a flex filter rule on an Ethernet device */
1384 typedef int (*eth_get_flex_filter_t)(struct rte_eth_dev *dev,
1385 uint16_t index, struct rte_flex_filter *filter,
1386 uint16_t *rx_queue);
1387 /**< @internal Get a flex filter rule on an Ethernet device */
1390 * @internal A structure containing the functions exported by an Ethernet driver.
1392 struct eth_dev_ops {
1393 eth_dev_configure_t dev_configure; /**< Configure device. */
1394 eth_dev_start_t dev_start; /**< Start device. */
1395 eth_dev_stop_t dev_stop; /**< Stop device. */
1396 eth_dev_set_link_up_t dev_set_link_up; /**< Device link up. */
1397 eth_dev_set_link_down_t dev_set_link_down; /**< Device link down. */
1398 eth_dev_close_t dev_close; /**< Close device. */
1399 eth_promiscuous_enable_t promiscuous_enable; /**< Promiscuous ON. */
1400 eth_promiscuous_disable_t promiscuous_disable;/**< Promiscuous OFF. */
1401 eth_allmulticast_enable_t allmulticast_enable;/**< RX multicast ON. */
1402 eth_allmulticast_disable_t allmulticast_disable;/**< RX multicast OF. */
1403 eth_link_update_t link_update; /**< Get device link state. */
1404 eth_stats_get_t stats_get; /**< Get generic device statistics. */
1405 eth_stats_reset_t stats_reset; /**< Reset generic device statistics. */
1406 eth_xstats_get_t xstats_get; /**< Get extended device statistics. */
1407 eth_xstats_reset_t xstats_reset; /**< Reset extended device statistics. */
1408 eth_queue_stats_mapping_set_t queue_stats_mapping_set;
1409 /**< Configure per queue stat counter mapping. */
1410 eth_dev_infos_get_t dev_infos_get; /**< Get device info. */
1411 mtu_set_t mtu_set; /**< Set MTU. */
1412 vlan_filter_set_t vlan_filter_set; /**< Filter VLAN Setup. */
1413 vlan_tpid_set_t vlan_tpid_set; /**< Outer VLAN TPID Setup. */
1414 vlan_strip_queue_set_t vlan_strip_queue_set; /**< VLAN Stripping on queue. */
1415 vlan_offload_set_t vlan_offload_set; /**< Set VLAN Offload. */
1416 vlan_pvid_set_t vlan_pvid_set; /**< Set port based TX VLAN insertion */
1417 eth_queue_start_t rx_queue_start;/**< Start RX for a queue.*/
1418 eth_queue_stop_t rx_queue_stop;/**< Stop RX for a queue.*/
1419 eth_queue_start_t tx_queue_start;/**< Start TX for a queue.*/
1420 eth_queue_stop_t tx_queue_stop;/**< Stop TX for a queue.*/
1421 eth_rx_queue_setup_t rx_queue_setup;/**< Set up device RX queue.*/
1422 eth_queue_release_t rx_queue_release;/**< Release RX queue.*/
1423 eth_rx_queue_count_t rx_queue_count; /**< Get Rx queue count. */
1424 eth_rx_descriptor_done_t rx_descriptor_done; /**< Check rxd DD bit */
1425 eth_tx_queue_setup_t tx_queue_setup;/**< Set up device TX queue.*/
1426 eth_queue_release_t tx_queue_release;/**< Release TX queue.*/
1427 eth_dev_led_on_t dev_led_on; /**< Turn on LED. */
1428 eth_dev_led_off_t dev_led_off; /**< Turn off LED. */
1429 flow_ctrl_get_t flow_ctrl_get; /**< Get flow control. */
1430 flow_ctrl_set_t flow_ctrl_set; /**< Setup flow control. */
1431 priority_flow_ctrl_set_t priority_flow_ctrl_set; /**< Setup priority flow control.*/
1432 eth_mac_addr_remove_t mac_addr_remove; /**< Remove MAC address */
1433 eth_mac_addr_add_t mac_addr_add; /**< Add a MAC address */
1434 eth_uc_hash_table_set_t uc_hash_table_set; /**< Set Unicast Table Array */
1435 eth_uc_all_hash_table_set_t uc_all_hash_table_set; /**< Set Unicast hash bitmap */
1436 eth_mirror_rule_set_t mirror_rule_set; /**< Add a traffic mirror rule.*/
1437 eth_mirror_rule_reset_t mirror_rule_reset; /**< reset a traffic mirror rule.*/
1438 eth_set_vf_rx_mode_t set_vf_rx_mode; /**< Set VF RX mode */
1439 eth_set_vf_rx_t set_vf_rx; /**< enable/disable a VF receive */
1440 eth_set_vf_tx_t set_vf_tx; /**< enable/disable a VF transmit */
1441 eth_set_vf_vlan_filter_t set_vf_vlan_filter; /**< Set VF VLAN filter */
1442 eth_set_queue_rate_limit_t set_queue_rate_limit; /**< Set queue rate limit */
1443 eth_set_vf_rate_limit_t set_vf_rate_limit; /**< Set VF rate limit */
1445 /** Add a signature filter. */
1446 fdir_add_signature_filter_t fdir_add_signature_filter;
1447 /** Update a signature filter. */
1448 fdir_update_signature_filter_t fdir_update_signature_filter;
1449 /** Remove a signature filter. */
1450 fdir_remove_signature_filter_t fdir_remove_signature_filter;
1451 /** Get information about FDIR status. */
1452 fdir_infos_get_t fdir_infos_get;
1453 /** Add a perfect filter. */
1454 fdir_add_perfect_filter_t fdir_add_perfect_filter;
1455 /** Update a perfect filter. */
1456 fdir_update_perfect_filter_t fdir_update_perfect_filter;
1457 /** Remove a perfect filter. */
1458 fdir_remove_perfect_filter_t fdir_remove_perfect_filter;
1459 /** Setup masks for FDIR filtering. */
1460 fdir_set_masks_t fdir_set_masks;
1461 /** Update redirection table. */
1462 reta_update_t reta_update;
1463 /** Query redirection table. */
1464 reta_query_t reta_query;
1465 /* bypass control */
1466 #ifdef RTE_NIC_BYPASS
1467 bypass_init_t bypass_init;
1468 bypass_state_set_t bypass_state_set;
1469 bypass_state_show_t bypass_state_show;
1470 bypass_event_set_t bypass_event_set;
1471 bypass_event_show_t bypass_event_show;
1472 bypass_wd_timeout_set_t bypass_wd_timeout_set;
1473 bypass_wd_timeout_show_t bypass_wd_timeout_show;
1474 bypass_ver_show_t bypass_ver_show;
1475 bypass_wd_reset_t bypass_wd_reset;
1478 /** Configure RSS hash protocols. */
1479 rss_hash_update_t rss_hash_update;
1480 /** Get current RSS hash configuration. */
1481 rss_hash_conf_get_t rss_hash_conf_get;
1482 eth_add_syn_filter_t add_syn_filter; /**< add syn filter. */
1483 eth_remove_syn_filter_t remove_syn_filter; /**< remove syn filter. */
1484 eth_get_syn_filter_t get_syn_filter; /**< get syn filter. */
1485 eth_add_ethertype_filter_t add_ethertype_filter; /**< add ethertype filter. */
1486 eth_remove_ethertype_filter_t remove_ethertype_filter; /**< remove ethertype filter. */
1487 eth_get_ethertype_filter_t get_ethertype_filter; /**< get ethertype filter. */
1488 eth_add_2tuple_filter_t add_2tuple_filter; /**< add 2tuple filter. */
1489 eth_remove_2tuple_filter_t remove_2tuple_filter; /**< remove 2tuple filter. */
1490 eth_get_2tuple_filter_t get_2tuple_filter; /**< get 2tuple filter. */
1491 eth_add_5tuple_filter_t add_5tuple_filter; /**< add 5tuple filter. */
1492 eth_remove_5tuple_filter_t remove_5tuple_filter; /**< remove 5tuple filter. */
1493 eth_get_5tuple_filter_t get_5tuple_filter; /**< get 5tuple filter. */
1494 eth_add_flex_filter_t add_flex_filter; /**< add flex filter. */
1495 eth_remove_flex_filter_t remove_flex_filter; /**< remove flex filter. */
1496 eth_get_flex_filter_t get_flex_filter; /**< get flex filter. */
1501 * The generic data structure associated with each ethernet device.
1503 * Pointers to burst-oriented packet receive and transmit functions are
1504 * located at the beginning of the structure, along with the pointer to
1505 * where all the data elements for the particular device are stored in shared
1506 * memory. This split allows the function pointer and driver data to be per-
1507 * process, while the actual configuration data for the device is shared.
1509 struct rte_eth_dev {
1510 eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
1511 eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
1512 struct rte_eth_dev_data *data; /**< Pointer to device data */
1513 const struct eth_driver *driver;/**< Driver for this device */
1514 struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
1515 struct rte_pci_device *pci_dev; /**< PCI info. supplied by probing */
1516 struct rte_eth_dev_cb_list callbacks; /**< User application callbacks */
1519 struct rte_eth_dev_sriov {
1520 uint8_t active; /**< SRIOV is active with 16, 32 or 64 pools */
1521 uint8_t nb_q_per_pool; /**< rx queue number per pool */
1522 uint16_t def_vmdq_idx; /**< Default pool num used for PF */
1523 uint16_t def_pool_q_idx; /**< Default pool queue start reg index */
1525 #define RTE_ETH_DEV_SRIOV(dev) ((dev)->data->sriov)
1527 #define RTE_ETH_NAME_MAX_LEN (32)
1531 * The data part, with no function pointers, associated with each ethernet device.
1533 * This structure is safe to place in shared memory to be common among different
1534 * processes in a multi-process configuration.
1536 struct rte_eth_dev_data {
1537 char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
1539 void **rx_queues; /**< Array of pointers to RX queues. */
1540 void **tx_queues; /**< Array of pointers to TX queues. */
1541 uint16_t nb_rx_queues; /**< Number of RX queues. */
1542 uint16_t nb_tx_queues; /**< Number of TX queues. */
1544 struct rte_eth_dev_sriov sriov; /**< SRIOV data */
1546 void *dev_private; /**< PMD-specific private data */
1548 struct rte_eth_link dev_link;
1549 /**< Link-level information & status */
1551 struct rte_eth_conf dev_conf; /**< Configuration applied to device. */
1552 uint16_t mtu; /**< Maximum Transmission Unit. */
1554 uint32_t min_rx_buf_size;
1555 /**< Common rx buffer size handled by all queues */
1557 uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
1558 struct ether_addr* mac_addrs;/**< Device Ethernet Link address. */
1559 uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
1560 /** bitmap array of associating Ethernet MAC addresses to pools */
1561 struct ether_addr* hash_mac_addrs;
1562 /** Device Ethernet MAC addresses of hash filtering. */
1563 uint8_t port_id; /**< Device [external] port identifier. */
1564 uint8_t promiscuous : 1, /**< RX promiscuous mode ON(1) / OFF(0). */
1565 scattered_rx : 1, /**< RX of scattered packets is ON(1) / OFF(0) */
1566 all_multicast : 1, /**< RX all multicast mode ON(1) / OFF(0). */
1567 dev_started : 1; /**< Device state: STARTED(1) / STOPPED(0). */
1572 * The pool of *rte_eth_dev* structures. The size of the pool
1573 * is configured at compile-time in the <rte_ethdev.c> file.
1575 extern struct rte_eth_dev rte_eth_devices[];
1578 * Get the total number of Ethernet devices that have been successfully
1579 * initialized by the [matching] Ethernet driver during the PCI probing phase.
1580 * All devices whose port identifier is in the range
1581 * [0, rte_eth_dev_count() - 1] can be operated on by network applications.
1584 * - The total number of usable Ethernet devices.
1586 extern uint8_t rte_eth_dev_count(void);
1589 * Function for internal use by dummy drivers primarily, e.g. ring-based
1591 * Allocates a new ethdev slot for an ethernet device and returns the pointer
1592 * to that slot for the driver to use.
1594 * @param name Unique identifier name for each Ethernet device
1596 * - Slot in the rte_dev_devices array for a new device;
1598 struct rte_eth_dev *rte_eth_dev_allocate(const char *name);
1603 * Initialization function of an Ethernet driver invoked for each matching
1604 * Ethernet PCI device detected during the PCI probing phase.
1607 * The pointer to the [matching] Ethernet driver structure supplied by
1608 * the PMD when it registered itself.
1610 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1611 * associated with the matching device and which have been [automatically]
1612 * allocated in the *rte_eth_devices* array.
1613 * The *eth_dev* structure is supplied to the driver initialization function
1614 * with the following fields already initialized:
1616 * - *pci_dev*: Holds the pointers to the *rte_pci_device* structure which
1617 * contains the generic PCI information of the matching device.
1619 * - *dev_private*: Holds a pointer to the device private data structure.
1621 * - *max_frame_size*: Contains the default Ethernet maximum frame length
1624 * - *port_id*: Contains the port index of the device (actually the index
1625 * of the *eth_dev* structure in the *rte_eth_devices* array).
1628 * - 0: Success, the device is properly initialized by the driver.
1629 * In particular, the driver MUST have set up the *dev_ops* pointer
1630 * of the *eth_dev* structure.
1631 * - <0: Error code of the device initialization failure.
1633 typedef int (*eth_dev_init_t)(struct eth_driver *eth_drv,
1634 struct rte_eth_dev *eth_dev);
1638 * The structure associated with a PMD Ethernet driver.
1640 * Each Ethernet driver acts as a PCI driver and is represented by a generic
1641 * *eth_driver* structure that holds:
1643 * - An *rte_pci_driver* structure (which must be the first field).
1645 * - The *eth_dev_init* function invoked for each matching PCI device.
1647 * - The size of the private data to allocate for each matching device.
1650 struct rte_pci_driver pci_drv; /**< The PMD is also a PCI driver. */
1651 eth_dev_init_t eth_dev_init; /**< Device init function. */
1652 unsigned int dev_private_size; /**< Size of device private data. */
1657 * A function invoked by the initialization function of an Ethernet driver
1658 * to simultaneously register itself as a PCI driver and as an Ethernet
1659 * Poll Mode Driver (PMD).
1662 * The pointer to the *eth_driver* structure associated with
1663 * the Ethernet driver.
1665 extern void rte_eth_driver_register(struct eth_driver *eth_drv);
1668 * Configure an Ethernet device.
1669 * This function must be invoked first before any other function in the
1670 * Ethernet API. This function can also be re-invoked when a device is in the
1674 * The port identifier of the Ethernet device to configure.
1675 * @param nb_rx_queue
1676 * The number of receive queues to set up for the Ethernet device.
1677 * @param nb_tx_queue
1678 * The number of transmit queues to set up for the Ethernet device.
1680 * The pointer to the configuration data to be used for the Ethernet device.
1681 * The *rte_eth_conf* structure includes:
1682 * - the hardware offload features to activate, with dedicated fields for
1683 * each statically configurable offload hardware feature provided by
1684 * Ethernet devices, such as IP checksum or VLAN tag stripping for
1686 * - the Receive Side Scaling (RSS) configuration when using multiple RX
1689 * Embedding all configuration information in a single data structure
1690 * is the more flexible method that allows the addition of new features
1691 * without changing the syntax of the API.
1693 * - 0: Success, device configured.
1694 * - <0: Error code returned by the driver configuration function.
1696 extern int rte_eth_dev_configure(uint8_t port_id,
1697 uint16_t nb_rx_queue,
1698 uint16_t nb_tx_queue,
1699 const struct rte_eth_conf *eth_conf);
1702 * Allocate and set up a receive queue for an Ethernet device.
1704 * The function allocates a contiguous block of memory for *nb_rx_desc*
1705 * receive descriptors from a memory zone associated with *socket_id*
1706 * and initializes each receive descriptor with a network buffer allocated
1707 * from the memory pool *mb_pool*.
1710 * The port identifier of the Ethernet device.
1711 * @param rx_queue_id
1712 * The index of the receive queue to set up.
1713 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1714 * to rte_eth_dev_configure().
1716 * The number of receive descriptors to allocate for the receive ring.
1718 * The *socket_id* argument is the socket identifier in case of NUMA.
1719 * The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1720 * the DMA memory allocated for the receive descriptors of the ring.
1722 * The pointer to the configuration data to be used for the receive queue.
1723 * NULL value is allowed, in which case default RX configuration
1725 * The *rx_conf* structure contains an *rx_thresh* structure with the values
1726 * of the Prefetch, Host, and Write-Back threshold registers of the receive
1729 * The pointer to the memory pool from which to allocate *rte_mbuf* network
1730 * memory buffers to populate each descriptor of the receive ring.
1732 * - 0: Success, receive queue correctly set up.
1733 * - -EINVAL: The size of network buffers which can be allocated from the
1734 * memory pool does not fit the various buffer sizes allowed by the
1735 * device controller.
1736 * - -ENOMEM: Unable to allocate the receive ring descriptors or to
1737 * allocate network memory buffers from the memory pool when
1738 * initializing receive descriptors.
1740 extern int rte_eth_rx_queue_setup(uint8_t port_id, uint16_t rx_queue_id,
1741 uint16_t nb_rx_desc, unsigned int socket_id,
1742 const struct rte_eth_rxconf *rx_conf,
1743 struct rte_mempool *mb_pool);
1746 * Allocate and set up a transmit queue for an Ethernet device.
1749 * The port identifier of the Ethernet device.
1750 * @param tx_queue_id
1751 * The index of the transmit queue to set up.
1752 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1753 * to rte_eth_dev_configure().
1755 * The number of transmit descriptors to allocate for the transmit ring.
1757 * The *socket_id* argument is the socket identifier in case of NUMA.
1758 * Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1759 * the DMA memory allocated for the transmit descriptors of the ring.
1761 * The pointer to the configuration data to be used for the transmit queue.
1762 * NULL value is allowed, in which case default RX configuration
1764 * The *tx_conf* structure contains the following data:
1765 * - The *tx_thresh* structure with the values of the Prefetch, Host, and
1766 * Write-Back threshold registers of the transmit ring.
1767 * When setting Write-Back threshold to the value greater then zero,
1768 * *tx_rs_thresh* value should be explicitly set to one.
1769 * - The *tx_free_thresh* value indicates the [minimum] number of network
1770 * buffers that must be pending in the transmit ring to trigger their
1771 * [implicit] freeing by the driver transmit function.
1772 * - The *tx_rs_thresh* value indicates the [minimum] number of transmit
1773 * descriptors that must be pending in the transmit ring before setting the
1774 * RS bit on a descriptor by the driver transmit function.
1775 * The *tx_rs_thresh* value should be less or equal then
1776 * *tx_free_thresh* value, and both of them should be less then
1778 * - The *txq_flags* member contains flags to pass to the TX queue setup
1779 * function to configure the behavior of the TX queue. This should be set
1780 * to 0 if no special configuration is required.
1782 * Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces
1783 * the transmit function to use default values.
1785 * - 0: Success, the transmit queue is correctly set up.
1786 * - -ENOMEM: Unable to allocate the transmit ring descriptors.
1788 extern int rte_eth_tx_queue_setup(uint8_t port_id, uint16_t tx_queue_id,
1789 uint16_t nb_tx_desc, unsigned int socket_id,
1790 const struct rte_eth_txconf *tx_conf);
1793 * Return the NUMA socket to which an Ethernet device is connected
1796 * The port identifier of the Ethernet device
1798 * The NUMA socket id to which the Ethernet device is connected or
1799 * a default of zero if the socket could not be determined.
1800 * -1 is returned is the port_id value is out of range.
1802 extern int rte_eth_dev_socket_id(uint8_t port_id);
1805 * Allocate mbuf from mempool, setup the DMA physical address
1806 * and then start RX for specified queue of a port. It is used
1807 * when rx_deferred_start flag of the specified queue is true.
1810 * The port identifier of the Ethernet device
1811 * @param rx_queue_id
1812 * The index of the rx queue to update the ring.
1813 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1814 * to rte_eth_dev_configure().
1816 * - 0: Success, the transmit queue is correctly set up.
1817 * - -EINVAL: The port_id or the queue_id out of range.
1818 * - -ENOTSUP: The function not supported in PMD driver.
1820 extern int rte_eth_dev_rx_queue_start(uint8_t port_id, uint16_t rx_queue_id);
1823 * Stop specified RX queue of a port
1826 * The port identifier of the Ethernet device
1827 * @param rx_queue_id
1828 * The index of the rx queue to update the ring.
1829 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1830 * to rte_eth_dev_configure().
1832 * - 0: Success, the transmit queue is correctly set up.
1833 * - -EINVAL: The port_id or the queue_id out of range.
1834 * - -ENOTSUP: The function not supported in PMD driver.
1836 extern int rte_eth_dev_rx_queue_stop(uint8_t port_id, uint16_t rx_queue_id);
1839 * Start TX for specified queue of a port. It is used when tx_deferred_start
1840 * flag of the specified queue is true.
1843 * The port identifier of the Ethernet device
1844 * @param tx_queue_id
1845 * The index of the tx queue to update the ring.
1846 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1847 * to rte_eth_dev_configure().
1849 * - 0: Success, the transmit queue is correctly set up.
1850 * - -EINVAL: The port_id or the queue_id out of range.
1851 * - -ENOTSUP: The function not supported in PMD driver.
1853 extern int rte_eth_dev_tx_queue_start(uint8_t port_id, uint16_t tx_queue_id);
1856 * Stop specified TX queue of a port
1859 * The port identifier of the Ethernet device
1860 * @param tx_queue_id
1861 * The index of the tx queue to update the ring.
1862 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1863 * to rte_eth_dev_configure().
1865 * - 0: Success, the transmit queue is correctly set up.
1866 * - -EINVAL: The port_id or the queue_id out of range.
1867 * - -ENOTSUP: The function not supported in PMD driver.
1869 extern int rte_eth_dev_tx_queue_stop(uint8_t port_id, uint16_t tx_queue_id);
1874 * Start an Ethernet device.
1876 * The device start step is the last one and consists of setting the configured
1877 * offload features and in starting the transmit and the receive units of the
1879 * On success, all basic functions exported by the Ethernet API (link status,
1880 * receive/transmit, and so on) can be invoked.
1883 * The port identifier of the Ethernet device.
1885 * - 0: Success, Ethernet device started.
1886 * - <0: Error code of the driver device start function.
1888 extern int rte_eth_dev_start(uint8_t port_id);
1891 * Stop an Ethernet device. The device can be restarted with a call to
1892 * rte_eth_dev_start()
1895 * The port identifier of the Ethernet device.
1897 extern void rte_eth_dev_stop(uint8_t port_id);
1901 * Link up an Ethernet device.
1903 * Set device link up will re-enable the device rx/tx
1904 * functionality after it is previously set device linked down.
1907 * The port identifier of the Ethernet device.
1909 * - 0: Success, Ethernet device linked up.
1910 * - <0: Error code of the driver device link up function.
1912 extern int rte_eth_dev_set_link_up(uint8_t port_id);
1915 * Link down an Ethernet device.
1916 * The device rx/tx functionality will be disabled if success,
1917 * and it can be re-enabled with a call to
1918 * rte_eth_dev_set_link_up()
1921 * The port identifier of the Ethernet device.
1923 extern int rte_eth_dev_set_link_down(uint8_t port_id);
1926 * Close an Ethernet device. The device cannot be restarted!
1929 * The port identifier of the Ethernet device.
1931 extern void rte_eth_dev_close(uint8_t port_id);
1934 * Enable receipt in promiscuous mode for an Ethernet device.
1937 * The port identifier of the Ethernet device.
1939 extern void rte_eth_promiscuous_enable(uint8_t port_id);
1942 * Disable receipt in promiscuous mode for an Ethernet device.
1945 * The port identifier of the Ethernet device.
1947 extern void rte_eth_promiscuous_disable(uint8_t port_id);
1950 * Return the value of promiscuous mode for an Ethernet device.
1953 * The port identifier of the Ethernet device.
1955 * - (1) if promiscuous is enabled
1956 * - (0) if promiscuous is disabled.
1959 extern int rte_eth_promiscuous_get(uint8_t port_id);
1962 * Enable the receipt of any multicast frame by an Ethernet device.
1965 * The port identifier of the Ethernet device.
1967 extern void rte_eth_allmulticast_enable(uint8_t port_id);
1970 * Disable the receipt of all multicast frames by an Ethernet device.
1973 * The port identifier of the Ethernet device.
1975 extern void rte_eth_allmulticast_disable(uint8_t port_id);
1978 * Return the value of allmulticast mode for an Ethernet device.
1981 * The port identifier of the Ethernet device.
1983 * - (1) if allmulticast is enabled
1984 * - (0) if allmulticast is disabled.
1987 extern int rte_eth_allmulticast_get(uint8_t port_id);
1990 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
1991 * or FULL-DUPLEX) of the physical link of an Ethernet device. It might need
1992 * to wait up to 9 seconds in it.
1995 * The port identifier of the Ethernet device.
1997 * A pointer to an *rte_eth_link* structure to be filled with
1998 * the status, the speed and the mode of the Ethernet device link.
2000 extern void rte_eth_link_get(uint8_t port_id, struct rte_eth_link *link);
2003 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2004 * or FULL-DUPLEX) of the physical link of an Ethernet device. It is a no-wait
2005 * version of rte_eth_link_get().
2008 * The port identifier of the Ethernet device.
2010 * A pointer to an *rte_eth_link* structure to be filled with
2011 * the status, the speed and the mode of the Ethernet device link.
2013 extern void rte_eth_link_get_nowait(uint8_t port_id,
2014 struct rte_eth_link *link);
2017 * Retrieve the general I/O statistics of an Ethernet device.
2020 * The port identifier of the Ethernet device.
2022 * A pointer to a structure of type *rte_eth_stats* to be filled with
2023 * the values of device counters for the following set of statistics:
2024 * - *ipackets* with the total of successfully received packets.
2025 * - *opackets* with the total of successfully transmitted packets.
2026 * - *ibytes* with the total of successfully received bytes.
2027 * - *obytes* with the total of successfully transmitted bytes.
2028 * - *ierrors* with the total of erroneous received packets.
2029 * - *oerrors* with the total of failed transmitted packets.
2031 extern void rte_eth_stats_get(uint8_t port_id, struct rte_eth_stats *stats);
2034 * Reset the general I/O statistics of an Ethernet device.
2037 * The port identifier of the Ethernet device.
2039 extern void rte_eth_stats_reset(uint8_t port_id);
2042 * Retrieve extended statistics of an Ethernet device.
2045 * The port identifier of the Ethernet device.
2047 * A pointer to a table of structure of type *rte_eth_xstats*
2048 * to be filled with device statistics names and values.
2049 * This parameter can be set to NULL if n is 0.
2051 * The size of the stats table, which should be large enough to store
2052 * all the statistics of the device.
2054 * - positive value lower or equal to n: success. The return value
2055 * is the number of entries filled in the stats table.
2056 * - positive value higher than n: error, the given statistics table
2057 * is too small. The return value corresponds to the size that should
2058 * be given to succeed. The entries in the table are not valid and
2059 * shall not be used by the caller.
2060 * - negative value on error (invalid port id)
2062 extern int rte_eth_xstats_get(uint8_t port_id,
2063 struct rte_eth_xstats *xstats, unsigned n);
2066 * Reset extended statistics of an Ethernet device.
2069 * The port identifier of the Ethernet device.
2071 extern void rte_eth_xstats_reset(uint8_t port_id);
2074 * Set a mapping for the specified transmit queue to the specified per-queue
2075 * statistics counter.
2078 * The port identifier of the Ethernet device.
2079 * @param tx_queue_id
2080 * The index of the transmit queue for which a queue stats mapping is required.
2081 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2082 * to rte_eth_dev_configure().
2084 * The per-queue packet statistics functionality number that the transmit
2085 * queue is to be assigned.
2086 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2088 * Zero if successful. Non-zero otherwise.
2090 extern int rte_eth_dev_set_tx_queue_stats_mapping(uint8_t port_id,
2091 uint16_t tx_queue_id,
2095 * Set a mapping for the specified receive queue to the specified per-queue
2096 * statistics counter.
2099 * The port identifier of the Ethernet device.
2100 * @param rx_queue_id
2101 * The index of the receive queue for which a queue stats mapping is required.
2102 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2103 * to rte_eth_dev_configure().
2105 * The per-queue packet statistics functionality number that the receive
2106 * queue is to be assigned.
2107 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2109 * Zero if successful. Non-zero otherwise.
2111 extern int rte_eth_dev_set_rx_queue_stats_mapping(uint8_t port_id,
2112 uint16_t rx_queue_id,
2116 * Retrieve the Ethernet address of an Ethernet device.
2119 * The port identifier of the Ethernet device.
2121 * A pointer to a structure of type *ether_addr* to be filled with
2122 * the Ethernet address of the Ethernet device.
2124 extern void rte_eth_macaddr_get(uint8_t port_id, struct ether_addr *mac_addr);
2127 * Retrieve the contextual information of an Ethernet device.
2130 * The port identifier of the Ethernet device.
2132 * A pointer to a structure of type *rte_eth_dev_info* to be filled with
2133 * the contextual information of the Ethernet device.
2135 extern void rte_eth_dev_info_get(uint8_t port_id,
2136 struct rte_eth_dev_info *dev_info);
2139 * Retrieve the MTU of an Ethernet device.
2142 * The port identifier of the Ethernet device.
2144 * A pointer to a uint16_t where the retrieved MTU is to be stored.
2146 * - (0) if successful.
2147 * - (-ENODEV) if *port_id* invalid.
2149 extern int rte_eth_dev_get_mtu(uint8_t port_id, uint16_t *mtu);
2152 * Change the MTU of an Ethernet device.
2155 * The port identifier of the Ethernet device.
2157 * A uint16_t for the MTU to be applied.
2159 * - (0) if successful.
2160 * - (-ENOTSUP) if operation is not supported.
2161 * - (-ENODEV) if *port_id* invalid.
2162 * - (-EINVAL) if *mtu* invalid.
2164 extern int rte_eth_dev_set_mtu(uint8_t port_id, uint16_t mtu);
2167 * Enable/Disable hardware filtering by an Ethernet device of received
2168 * VLAN packets tagged with a given VLAN Tag Identifier.
2171 * The port identifier of the Ethernet device.
2173 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
2175 * If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*.
2176 * Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*.
2178 * - (0) if successful.
2179 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2180 * - (-ENODEV) if *port_id* invalid.
2181 * - (-ENOSYS) if VLAN filtering on *port_id* disabled.
2182 * - (-EINVAL) if *vlan_id* > 4095.
2184 extern int rte_eth_dev_vlan_filter(uint8_t port_id, uint16_t vlan_id , int on);
2187 * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
2188 * 82599/X540/X550 can support VLAN stripping at the rx queue level
2191 * The port identifier of the Ethernet device.
2192 * @param rx_queue_id
2193 * The index of the receive queue for which a queue stats mapping is required.
2194 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2195 * to rte_eth_dev_configure().
2197 * If 1, Enable VLAN Stripping of the receive queue of the Ethernet port.
2198 * If 0, Disable VLAN Stripping of the receive queue of the Ethernet port.
2200 * - (0) if successful.
2201 * - (-ENOSUP) if hardware-assisted VLAN stripping not configured.
2202 * - (-ENODEV) if *port_id* invalid.
2203 * - (-EINVAL) if *rx_queue_id* invalid.
2205 extern int rte_eth_dev_set_vlan_strip_on_queue(uint8_t port_id,
2206 uint16_t rx_queue_id, int on);
2209 * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
2210 * the VLAN Header. This is a register setup available on some Intel NIC, not
2211 * but all, please check the data sheet for availability.
2214 * The port identifier of the Ethernet device.
2216 * The Tag Protocol ID
2218 * - (0) if successful.
2219 * - (-ENOSUP) if hardware-assisted VLAN TPID setup is not supported.
2220 * - (-ENODEV) if *port_id* invalid.
2222 extern int rte_eth_dev_set_vlan_ether_type(uint8_t port_id, uint16_t tag_type);
2225 * Set VLAN offload configuration on an Ethernet device
2226 * Enable/Disable Extended VLAN by an Ethernet device, This is a register setup
2227 * available on some Intel NIC, not but all, please check the data sheet for
2229 * Enable/Disable VLAN Strip can be done on rx queue for certain NIC, but here
2230 * the configuration is applied on the port level.
2233 * The port identifier of the Ethernet device.
2234 * @param offload_mask
2235 * The VLAN Offload bit mask can be mixed use with "OR"
2236 * ETH_VLAN_STRIP_OFFLOAD
2237 * ETH_VLAN_FILTER_OFFLOAD
2238 * ETH_VLAN_EXTEND_OFFLOAD
2240 * - (0) if successful.
2241 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2242 * - (-ENODEV) if *port_id* invalid.
2244 extern int rte_eth_dev_set_vlan_offload(uint8_t port_id, int offload_mask);
2247 * Read VLAN Offload configuration from an Ethernet device
2250 * The port identifier of the Ethernet device.
2252 * - (>0) if successful. Bit mask to indicate
2253 * ETH_VLAN_STRIP_OFFLOAD
2254 * ETH_VLAN_FILTER_OFFLOAD
2255 * ETH_VLAN_EXTEND_OFFLOAD
2256 * - (-ENODEV) if *port_id* invalid.
2258 extern int rte_eth_dev_get_vlan_offload(uint8_t port_id);
2261 * Set port based TX VLAN insersion on or off.
2264 * The port identifier of the Ethernet device.
2266 * Port based TX VLAN identifier togeth with user priority.
2268 * Turn on or off the port based TX VLAN insertion.
2271 * - (0) if successful.
2272 * - negative if failed.
2274 extern int rte_eth_dev_set_vlan_pvid(uint8_t port_id, uint16_t pvid, int on);
2278 * Retrieve a burst of input packets from a receive queue of an Ethernet
2279 * device. The retrieved packets are stored in *rte_mbuf* structures whose
2280 * pointers are supplied in the *rx_pkts* array.
2282 * The rte_eth_rx_burst() function loops, parsing the RX ring of the
2283 * receive queue, up to *nb_pkts* packets, and for each completed RX
2284 * descriptor in the ring, it performs the following operations:
2286 * - Initialize the *rte_mbuf* data structure associated with the
2287 * RX descriptor according to the information provided by the NIC into
2288 * that RX descriptor.
2290 * - Store the *rte_mbuf* data structure into the next entry of the
2293 * - Replenish the RX descriptor with a new *rte_mbuf* buffer
2294 * allocated from the memory pool associated with the receive queue at
2295 * initialization time.
2297 * When retrieving an input packet that was scattered by the controller
2298 * into multiple receive descriptors, the rte_eth_rx_burst() function
2299 * appends the associated *rte_mbuf* buffers to the first buffer of the
2302 * The rte_eth_rx_burst() function returns the number of packets
2303 * actually retrieved, which is the number of *rte_mbuf* data structures
2304 * effectively supplied into the *rx_pkts* array.
2305 * A return value equal to *nb_pkts* indicates that the RX queue contained
2306 * at least *rx_pkts* packets, and this is likely to signify that other
2307 * received packets remain in the input queue. Applications implementing
2308 * a "retrieve as much received packets as possible" policy can check this
2309 * specific case and keep invoking the rte_eth_rx_burst() function until
2310 * a value less than *nb_pkts* is returned.
2312 * This receive method has the following advantages:
2314 * - It allows a run-to-completion network stack engine to retrieve and
2315 * to immediately process received packets in a fast burst-oriented
2316 * approach, avoiding the overhead of unnecessary intermediate packet
2317 * queue/dequeue operations.
2319 * - Conversely, it also allows an asynchronous-oriented processing
2320 * method to retrieve bursts of received packets and to immediately
2321 * queue them for further parallel processing by another logical core,
2322 * for instance. However, instead of having received packets being
2323 * individually queued by the driver, this approach allows the invoker
2324 * of the rte_eth_rx_burst() function to queue a burst of retrieved
2325 * packets at a time and therefore dramatically reduce the cost of
2326 * enqueue/dequeue operations per packet.
2328 * - It allows the rte_eth_rx_burst() function of the driver to take
2329 * advantage of burst-oriented hardware features (CPU cache,
2330 * prefetch instructions, and so on) to minimize the number of CPU
2331 * cycles per packet.
2333 * To summarize, the proposed receive API enables many
2334 * burst-oriented optimizations in both synchronous and asynchronous
2335 * packet processing environments with no overhead in both cases.
2337 * The rte_eth_rx_burst() function does not provide any error
2338 * notification to avoid the corresponding overhead. As a hint, the
2339 * upper-level application might check the status of the device link once
2340 * being systematically returned a 0 value for a given number of tries.
2343 * The port identifier of the Ethernet device.
2345 * The index of the receive queue from which to retrieve input packets.
2346 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2347 * to rte_eth_dev_configure().
2349 * The address of an array of pointers to *rte_mbuf* structures that
2350 * must be large enough to store *nb_pkts* pointers in it.
2352 * The maximum number of packets to retrieve.
2354 * The number of packets actually retrieved, which is the number
2355 * of pointers to *rte_mbuf* structures effectively supplied to the
2358 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2359 extern uint16_t rte_eth_rx_burst(uint8_t port_id, uint16_t queue_id,
2360 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
2362 static inline uint16_t
2363 rte_eth_rx_burst(uint8_t port_id, uint16_t queue_id,
2364 struct rte_mbuf **rx_pkts, uint16_t nb_pkts)
2366 struct rte_eth_dev *dev;
2368 dev = &rte_eth_devices[port_id];
2369 return (*dev->rx_pkt_burst)(dev->data->rx_queues[queue_id], rx_pkts, nb_pkts);
2374 * Get the number of used descriptors in a specific queue
2377 * The port identifier of the Ethernet device.
2379 * The queue id on the specific port.
2381 * The number of used descriptors in the specific queue.
2383 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2384 extern uint32_t rte_eth_rx_queue_count(uint8_t port_id, uint16_t queue_id);
2386 static inline uint32_t
2387 rte_eth_rx_queue_count(uint8_t port_id, uint16_t queue_id)
2389 struct rte_eth_dev *dev;
2391 dev = &rte_eth_devices[port_id];
2392 return (*dev->dev_ops->rx_queue_count)(dev, queue_id);
2397 * Check if the DD bit of the specific RX descriptor in the queue has been set
2400 * The port identifier of the Ethernet device.
2402 * The queue id on the specific port.
2404 * The offset of the descriptor ID from tail.
2406 * - (1) if the specific DD bit is set.
2407 * - (0) if the specific DD bit is not set.
2408 * - (-ENODEV) if *port_id* invalid.
2410 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2411 extern int rte_eth_rx_descriptor_done(uint8_t port_id,
2416 rte_eth_rx_descriptor_done(uint8_t port_id, uint16_t queue_id, uint16_t offset)
2418 struct rte_eth_dev *dev;
2420 dev = &rte_eth_devices[port_id];
2421 return (*dev->dev_ops->rx_descriptor_done)( \
2422 dev->data->rx_queues[queue_id], offset);
2427 * Send a burst of output packets on a transmit queue of an Ethernet device.
2429 * The rte_eth_tx_burst() function is invoked to transmit output packets
2430 * on the output queue *queue_id* of the Ethernet device designated by its
2432 * The *nb_pkts* parameter is the number of packets to send which are
2433 * supplied in the *tx_pkts* array of *rte_mbuf* structures.
2434 * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
2435 * up to the number of transmit descriptors available in the TX ring of the
2437 * For each packet to send, the rte_eth_tx_burst() function performs
2438 * the following operations:
2440 * - Pick up the next available descriptor in the transmit ring.
2442 * - Free the network buffer previously sent with that descriptor, if any.
2444 * - Initialize the transmit descriptor with the information provided
2445 * in the *rte_mbuf data structure.
2447 * In the case of a segmented packet composed of a list of *rte_mbuf* buffers,
2448 * the rte_eth_tx_burst() function uses several transmit descriptors
2451 * The rte_eth_tx_burst() function returns the number of packets it
2452 * actually sent. A return value equal to *nb_pkts* means that all packets
2453 * have been sent, and this is likely to signify that other output packets
2454 * could be immediately transmitted again. Applications that implement a
2455 * "send as many packets to transmit as possible" policy can check this
2456 * specific case and keep invoking the rte_eth_tx_burst() function until
2457 * a value less than *nb_pkts* is returned.
2459 * It is the responsibility of the rte_eth_tx_burst() function to
2460 * transparently free the memory buffers of packets previously sent.
2461 * This feature is driven by the *tx_free_thresh* value supplied to the
2462 * rte_eth_dev_configure() function at device configuration time.
2463 * When the number of previously sent packets reached the "minimum transmit
2464 * packets to free" threshold, the rte_eth_tx_burst() function must
2465 * [attempt to] free the *rte_mbuf* buffers of those packets whose
2466 * transmission was effectively completed.
2469 * The port identifier of the Ethernet device.
2471 * The index of the transmit queue through which output packets must be
2473 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2474 * to rte_eth_dev_configure().
2476 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
2477 * which contain the output packets.
2479 * The maximum number of packets to transmit.
2481 * The number of output packets actually stored in transmit descriptors of
2482 * the transmit ring. The return value can be less than the value of the
2483 * *tx_pkts* parameter when the transmit ring is full or has been filled up.
2485 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2486 extern uint16_t rte_eth_tx_burst(uint8_t port_id, uint16_t queue_id,
2487 struct rte_mbuf **tx_pkts, uint16_t nb_pkts);
2489 static inline uint16_t
2490 rte_eth_tx_burst(uint8_t port_id, uint16_t queue_id,
2491 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
2493 struct rte_eth_dev *dev;
2495 dev = &rte_eth_devices[port_id];
2496 return (*dev->tx_pkt_burst)(dev->data->tx_queues[queue_id], tx_pkts, nb_pkts);
2501 * Setup a new signature filter rule on an Ethernet device
2504 * The port identifier of the Ethernet device.
2505 * @param fdir_filter
2506 * The pointer to the fdir filter structure describing the signature filter
2508 * The *rte_fdir_filter* structure includes the values of the different fields
2509 * to match: source and destination IP addresses, vlan id, flexbytes, source
2510 * and destination ports, and so on.
2512 * The index of the RX queue where to store RX packets matching the added
2513 * signature filter defined in fdir_filter.
2515 * - (0) if successful.
2516 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2517 * - (-ENODEV) if *port_id* invalid.
2518 * - (-ENOSYS) if the FDIR mode is not configured in signature mode
2520 * - (-EINVAL) if the fdir_filter information is not correct.
2522 int rte_eth_dev_fdir_add_signature_filter(uint8_t port_id,
2523 struct rte_fdir_filter *fdir_filter,
2527 * Update a signature filter rule on an Ethernet device.
2528 * If the rule doesn't exits, it is created.
2531 * The port identifier of the Ethernet device.
2533 * The pointer to the structure describing the signature filter rule.
2534 * The *rte_fdir_filter* structure includes the values of the different fields
2535 * to match: source and destination IP addresses, vlan id, flexbytes, source
2536 * and destination ports, and so on.
2538 * The index of the RX queue where to store RX packets matching the added
2539 * signature filter defined in fdir_ftr.
2541 * - (0) if successful.
2542 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2543 * - (-ENODEV) if *port_id* invalid.
2544 * - (-ENOSYS) if the flow director mode is not configured in signature mode
2546 * - (-EINVAL) if the fdir_filter information is not correct.
2548 int rte_eth_dev_fdir_update_signature_filter(uint8_t port_id,
2549 struct rte_fdir_filter *fdir_ftr,
2553 * Remove a signature filter rule on an Ethernet device.
2556 * The port identifier of the Ethernet device.
2558 * The pointer to the structure describing the signature filter rule.
2559 * The *rte_fdir_filter* structure includes the values of the different fields
2560 * to match: source and destination IP addresses, vlan id, flexbytes, source
2561 * and destination ports, and so on.
2563 * - (0) if successful.
2564 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2565 * - (-ENODEV) if *port_id* invalid.
2566 * - (-ENOSYS) if the flow director mode is not configured in signature mode
2568 * - (-EINVAL) if the fdir_filter information is not correct.
2570 int rte_eth_dev_fdir_remove_signature_filter(uint8_t port_id,
2571 struct rte_fdir_filter *fdir_ftr);
2574 * Retrieve the flow director information of an Ethernet device.
2577 * The port identifier of the Ethernet device.
2579 * A pointer to a structure of type *rte_eth_dev_fdir* to be filled with
2580 * the flow director information of the Ethernet device.
2582 * - (0) if successful.
2583 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2584 * - (-ENODEV) if *port_id* invalid.
2585 * - (-ENOSYS) if the flow director mode is not configured on *port_id*.
2587 int rte_eth_dev_fdir_get_infos(uint8_t port_id, struct rte_eth_fdir *fdir);
2590 * Add a new perfect filter rule on an Ethernet device.
2593 * The port identifier of the Ethernet device.
2594 * @param fdir_filter
2595 * The pointer to the structure describing the perfect filter rule.
2596 * The *rte_fdir_filter* structure includes the values of the different fields
2597 * to match: source and destination IP addresses, vlan id, flexbytes, source
2598 * and destination ports, and so on.
2599 * IPv6 are not supported.
2601 * The 16-bit value supplied in the field hash.fdir.id of mbuf for RX
2602 * packets matching the perfect filter.
2604 * The index of the RX queue where to store RX packets matching the added
2605 * perfect filter defined in fdir_filter.
2607 * If drop is set to 1, matching RX packets are stored into the RX drop
2608 * queue defined in the rte_fdir_conf.
2610 * - (0) if successful.
2611 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2612 * - (-ENODEV) if *port_id* invalid.
2613 * - (-ENOSYS) if the flow director mode is not configured in perfect mode
2615 * - (-EINVAL) if the fdir_filter information is not correct.
2617 int rte_eth_dev_fdir_add_perfect_filter(uint8_t port_id,
2618 struct rte_fdir_filter *fdir_filter,
2619 uint16_t soft_id, uint8_t rx_queue,
2623 * Update a perfect filter rule on an Ethernet device.
2624 * If the rule doesn't exits, it is created.
2627 * The port identifier of the Ethernet device.
2628 * @param fdir_filter
2629 * The pointer to the structure describing the perfect filter rule.
2630 * The *rte_fdir_filter* structure includes the values of the different fields
2631 * to match: source and destination IP addresses, vlan id, flexbytes, source
2632 * and destination ports, and so on.
2633 * IPv6 are not supported.
2635 * The 16-bit value supplied in the field hash.fdir.id of mbuf for RX
2636 * packets matching the perfect filter.
2638 * The index of the RX queue where to store RX packets matching the added
2639 * perfect filter defined in fdir_filter.
2641 * If drop is set to 1, matching RX packets are stored into the RX drop
2642 * queue defined in the rte_fdir_conf.
2644 * - (0) if successful.
2645 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2646 * - (-ENODEV) if *port_id* invalid.
2647 * - (-ENOSYS) if the flow director mode is not configured in perfect mode
2649 * - (-EINVAL) if the fdir_filter information is not correct.
2651 int rte_eth_dev_fdir_update_perfect_filter(uint8_t port_id,
2652 struct rte_fdir_filter *fdir_filter,
2653 uint16_t soft_id, uint8_t rx_queue,
2657 * Remove a perfect filter rule on an Ethernet device.
2660 * The port identifier of the Ethernet device.
2661 * @param fdir_filter
2662 * The pointer to the structure describing the perfect filter rule.
2663 * The *rte_fdir_filter* structure includes the values of the different fields
2664 * to match: source and destination IP addresses, vlan id, flexbytes, source
2665 * and destination ports, and so on.
2666 * IPv6 are not supported.
2668 * The soft_id value provided when adding/updating the removed filter.
2670 * - (0) if successful.
2671 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2672 * - (-ENODEV) if *port_id* invalid.
2673 * - (-ENOSYS) if the flow director mode is not configured in perfect mode
2675 * - (-EINVAL) if the fdir_filter information is not correct.
2677 int rte_eth_dev_fdir_remove_perfect_filter(uint8_t port_id,
2678 struct rte_fdir_filter *fdir_filter,
2681 * Configure globally the masks for flow director mode for an Ethernet device.
2682 * For example, the device can match packets with only the first 24 bits of
2683 * the IPv4 source address.
2685 * The following fields can be masked: IPv4 addresses and L4 port numbers.
2686 * The following fields can be either enabled or disabled completely for the
2687 * matching functionality: VLAN ID tag; VLAN Priority + CFI bit; Flexible 2-byte
2689 * IPv6 masks are not supported.
2691 * All filters must comply with the masks previously configured.
2692 * For example, with a mask equal to 255.255.255.0 for the source IPv4 address,
2693 * all IPv4 filters must be created with a source IPv4 address that fits the
2696 * This function flushes all filters that have been previously added in
2700 * The port identifier of the Ethernet device.
2702 * The pointer to the fdir mask structure describing relevant headers fields
2703 * and relevant bits to use when matching packets addresses and ports.
2704 * IPv6 masks are not supported.
2706 * - (0) if successful.
2707 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2708 * - (-ENODEV) if *port_id* invalid.
2709 * - (-ENOSYS) if the flow director mode is not configured in perfect
2710 * mode on *port_id*.
2711 * - (-EINVAL) if the fdir_filter information is not correct
2713 int rte_eth_dev_fdir_set_masks(uint8_t port_id,
2714 struct rte_fdir_masks *fdir_mask);
2717 * The eth device event type for interrupt, and maybe others in the future.
2719 enum rte_eth_event_type {
2720 RTE_ETH_EVENT_UNKNOWN, /**< unknown event type */
2721 RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
2722 RTE_ETH_EVENT_MAX /**< max value of this enum */
2725 typedef void (*rte_eth_dev_cb_fn)(uint8_t port_id, \
2726 enum rte_eth_event_type event, void *cb_arg);
2727 /**< user application callback to be registered for interrupts */
2732 * Register a callback function for specific port id.
2739 * User supplied callback function to be called.
2741 * Pointer to the parameters for the registered callback.
2744 * - On success, zero.
2745 * - On failure, a negative value.
2747 int rte_eth_dev_callback_register(uint8_t port_id,
2748 enum rte_eth_event_type event,
2749 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
2752 * Unregister a callback function for specific port id.
2759 * User supplied callback function to be called.
2761 * Pointer to the parameters for the registered callback. -1 means to
2762 * remove all for the same callback address and same event.
2765 * - On success, zero.
2766 * - On failure, a negative value.
2768 int rte_eth_dev_callback_unregister(uint8_t port_id,
2769 enum rte_eth_event_type event,
2770 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
2773 * @internal Executes all the user application registered callbacks for
2774 * the specific device. It is for DPDK internal user only. User
2775 * application should not call it directly.
2778 * Pointer to struct rte_eth_dev.
2780 * Eth device interrupt event type.
2785 void _rte_eth_dev_callback_process(struct rte_eth_dev *dev,
2786 enum rte_eth_event_type event);
2789 * Turn on the LED on the Ethernet device.
2790 * This function turns on the LED on the Ethernet device.
2793 * The port identifier of the Ethernet device.
2795 * - (0) if successful.
2796 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
2798 * - (-ENODEV) if *port_id* invalid.
2800 int rte_eth_led_on(uint8_t port_id);
2803 * Turn off the LED on the Ethernet device.
2804 * This function turns off the LED on the Ethernet device.
2807 * The port identifier of the Ethernet device.
2809 * - (0) if successful.
2810 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
2812 * - (-ENODEV) if *port_id* invalid.
2814 int rte_eth_led_off(uint8_t port_id);
2817 * Get current status of the Ethernet link flow control for Ethernet device
2820 * The port identifier of the Ethernet device.
2822 * The pointer to the structure where to store the flow control parameters.
2824 * - (0) if successful.
2825 * - (-ENOTSUP) if hardware doesn't support flow control.
2826 * - (-ENODEV) if *port_id* invalid.
2828 int rte_eth_dev_flow_ctrl_get(uint8_t port_id,
2829 struct rte_eth_fc_conf *fc_conf);
2832 * Configure the Ethernet link flow control for Ethernet device
2835 * The port identifier of the Ethernet device.
2837 * The pointer to the structure of the flow control parameters.
2839 * - (0) if successful.
2840 * - (-ENOTSUP) if hardware doesn't support flow control mode.
2841 * - (-ENODEV) if *port_id* invalid.
2842 * - (-EINVAL) if bad parameter
2843 * - (-EIO) if flow control setup failure
2845 int rte_eth_dev_flow_ctrl_set(uint8_t port_id,
2846 struct rte_eth_fc_conf *fc_conf);
2849 * Configure the Ethernet priority flow control under DCB environment
2850 * for Ethernet device.
2853 * The port identifier of the Ethernet device.
2855 * The pointer to the structure of the priority flow control parameters.
2857 * - (0) if successful.
2858 * - (-ENOTSUP) if hardware doesn't support priority flow control mode.
2859 * - (-ENODEV) if *port_id* invalid.
2860 * - (-EINVAL) if bad parameter
2861 * - (-EIO) if flow control setup failure
2863 int rte_eth_dev_priority_flow_ctrl_set(uint8_t port_id,
2864 struct rte_eth_pfc_conf *pfc_conf);
2867 * Add a MAC address to an internal array of addresses used to enable whitelist
2868 * filtering to accept packets only if the destination MAC address matches.
2871 * The port identifier of the Ethernet device.
2873 * The MAC address to add.
2875 * VMDq pool index to associate address with (if VMDq is enabled). If VMDq is
2876 * not enabled, this should be set to 0.
2878 * - (0) if successfully added or *mac_addr" was already added.
2879 * - (-ENOTSUP) if hardware doesn't support this feature.
2880 * - (-ENODEV) if *port* is invalid.
2881 * - (-ENOSPC) if no more MAC addresses can be added.
2882 * - (-EINVAL) if MAC address is invalid.
2884 int rte_eth_dev_mac_addr_add(uint8_t port, struct ether_addr *mac_addr,
2888 * Remove a MAC address from the internal array of addresses.
2891 * The port identifier of the Ethernet device.
2893 * MAC address to remove.
2895 * - (0) if successful, or *mac_addr* didn't exist.
2896 * - (-ENOTSUP) if hardware doesn't support.
2897 * - (-ENODEV) if *port* invalid.
2898 * - (-EADDRINUSE) if attempting to remove the default MAC address
2900 int rte_eth_dev_mac_addr_remove(uint8_t port, struct ether_addr *mac_addr);
2903 * Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
2906 * The port identifier of the Ethernet device.
2910 * - (0) if successful.
2911 * - (-ENOTSUP) if hardware doesn't support.
2912 * - (-EINVAL) if bad parameter.
2914 int rte_eth_dev_rss_reta_update(uint8_t port,
2915 struct rte_eth_rss_reta *reta_conf);
2918 * Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
2921 * The port identifier of the Ethernet device.
2925 * - (0) if successful.
2926 * - (-ENOTSUP) if hardware doesn't support.
2927 * - (-EINVAL) if bad parameter.
2929 int rte_eth_dev_rss_reta_query(uint8_t port,
2930 struct rte_eth_rss_reta *reta_conf);
2933 * Updates unicast hash table for receiving packet with the given destination
2934 * MAC address, and the packet is routed to all VFs for which the RX mode is
2935 * accept packets that match the unicast hash table.
2938 * The port identifier of the Ethernet device.
2940 * Unicast MAC address.
2942 * 1 - Set an unicast hash bit for receiving packets with the MAC address.
2943 * 0 - Clear an unicast hash bit.
2945 * - (0) if successful.
2946 * - (-ENOTSUP) if hardware doesn't support.
2947 * - (-ENODEV) if *port_id* invalid.
2948 * - (-EINVAL) if bad parameter.
2950 int rte_eth_dev_uc_hash_table_set(uint8_t port,struct ether_addr *addr,
2954 * Updates all unicast hash bitmaps for receiving packet with any Unicast
2955 * Ethernet MAC addresses,the packet is routed to all VFs for which the RX
2956 * mode is accept packets that match the unicast hash table.
2959 * The port identifier of the Ethernet device.
2961 * 1 - Set all unicast hash bitmaps for receiving all the Ethernet
2963 * 0 - Clear all unicast hash bitmaps
2965 * - (0) if successful.
2966 * - (-ENOTSUP) if hardware doesn't support.
2967 * - (-ENODEV) if *port_id* invalid.
2968 * - (-EINVAL) if bad parameter.
2970 int rte_eth_dev_uc_all_hash_table_set(uint8_t port,uint8_t on);
2973 * Set RX L2 Filtering mode of a VF of an Ethernet device.
2976 * The port identifier of the Ethernet device.
2980 * The RX mode mask, which is one or more of accepting Untagged Packets,
2981 * packets that match the PFUTA table, Broadcast and Multicast Promiscuous.
2982 * ETH_VMDQ_ACCEPT_UNTAG,ETH_VMDQ_ACCEPT_HASH_UC,
2983 * ETH_VMDQ_ACCEPT_BROADCAST and ETH_VMDQ_ACCEPT_MULTICAST will be used
2986 * 1 - Enable a VF RX mode.
2987 * 0 - Disable a VF RX mode.
2989 * - (0) if successful.
2990 * - (-ENOTSUP) if hardware doesn't support.
2991 * - (-ENOTSUP) if hardware doesn't support.
2992 * - (-EINVAL) if bad parameter.
2994 int rte_eth_dev_set_vf_rxmode(uint8_t port, uint16_t vf, uint16_t rx_mode,
2998 * Enable or disable a VF traffic transmit of the Ethernet device.
3001 * The port identifier of the Ethernet device.
3005 * 1 - Enable a VF traffic transmit.
3006 * 0 - Disable a VF traffic transmit.
3008 * - (0) if successful.
3009 * - (-ENODEV) if *port_id* invalid.
3010 * - (-ENOTSUP) if hardware doesn't support.
3011 * - (-EINVAL) if bad parameter.
3014 rte_eth_dev_set_vf_tx(uint8_t port,uint16_t vf, uint8_t on);
3017 * Enable or disable a VF traffic receive of an Ethernet device.
3020 * The port identifier of the Ethernet device.
3024 * 1 - Enable a VF traffic receive.
3025 * 0 - Disable a VF traffic receive.
3027 * - (0) if successful.
3028 * - (-ENOTSUP) if hardware doesn't support.
3029 * - (-ENODEV) if *port_id* invalid.
3030 * - (-EINVAL) if bad parameter.
3033 rte_eth_dev_set_vf_rx(uint8_t port,uint16_t vf, uint8_t on);
3036 * Enable/Disable hardware VF VLAN filtering by an Ethernet device of
3037 * received VLAN packets tagged with a given VLAN Tag Identifier.
3040 * The port identifier of the Ethernet device.
3042 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
3044 * Bitmap listing which VFs participate in the VLAN filtering.
3046 * 1 - Enable VFs VLAN filtering.
3047 * 0 - Disable VFs VLAN filtering.
3049 * - (0) if successful.
3050 * - (-ENOTSUP) if hardware doesn't support.
3051 * - (-ENODEV) if *port_id* invalid.
3052 * - (-EINVAL) if bad parameter.
3055 rte_eth_dev_set_vf_vlan_filter(uint8_t port, uint16_t vlan_id,
3060 * Set a traffic mirroring rule on an Ethernet device
3063 * The port identifier of the Ethernet device.
3064 * @param mirror_conf
3065 * The pointer to the traffic mirroring structure describing the mirroring rule.
3066 * The *rte_eth_vm_mirror_conf* structure includes the type of mirroring rule,
3067 * destination pool and the value of rule if enable vlan or pool mirroring.
3070 * The index of traffic mirroring rule, we support four separated rules.
3072 * 1 - Enable a mirroring rule.
3073 * 0 - Disable a mirroring rule.
3075 * - (0) if successful.
3076 * - (-ENOTSUP) if hardware doesn't support this feature.
3077 * - (-ENODEV) if *port_id* invalid.
3078 * - (-EINVAL) if the mr_conf information is not correct.
3080 int rte_eth_mirror_rule_set(uint8_t port_id,
3081 struct rte_eth_vmdq_mirror_conf *mirror_conf,
3086 * Reset a traffic mirroring rule on an Ethernet device.
3089 * The port identifier of the Ethernet device.
3091 * The index of traffic mirroring rule, we support four separated rules.
3093 * - (0) if successful.
3094 * - (-ENOTSUP) if hardware doesn't support this feature.
3095 * - (-ENODEV) if *port_id* invalid.
3096 * - (-EINVAL) if bad parameter.
3098 int rte_eth_mirror_rule_reset(uint8_t port_id,
3102 * Set the rate limitation for a queue on an Ethernet device.
3105 * The port identifier of the Ethernet device.
3109 * The tx rate allocated from the total link speed for this queue.
3111 * - (0) if successful.
3112 * - (-ENOTSUP) if hardware doesn't support this feature.
3113 * - (-ENODEV) if *port_id* invalid.
3114 * - (-EINVAL) if bad parameter.
3116 int rte_eth_set_queue_rate_limit(uint8_t port_id, uint16_t queue_idx,
3120 * Set the rate limitation for a vf on an Ethernet device.
3123 * The port identifier of the Ethernet device.
3127 * The tx rate allocated from the total link speed for this VF id.
3129 * The queue mask which need to set the rate.
3131 * - (0) if successful.
3132 * - (-ENOTSUP) if hardware doesn't support this feature.
3133 * - (-ENODEV) if *port_id* invalid.
3134 * - (-EINVAL) if bad parameter.
3136 int rte_eth_set_vf_rate_limit(uint8_t port_id, uint16_t vf,
3137 uint16_t tx_rate, uint64_t q_msk);
3140 * Initialize bypass logic. This function needs to be called before
3141 * executing any other bypass API.
3144 * The port identifier of the Ethernet device.
3146 * - (0) if successful.
3147 * - (-ENOTSUP) if hardware doesn't support.
3148 * - (-EINVAL) if bad parameter.
3150 int rte_eth_dev_bypass_init(uint8_t port);
3153 * Return bypass state.
3156 * The port identifier of the Ethernet device.
3158 * The return bypass state.
3161 * - (3) Isolate mode
3163 * - (0) if successful.
3164 * - (-ENOTSUP) if hardware doesn't support.
3165 * - (-EINVAL) if bad parameter.
3167 int rte_eth_dev_bypass_state_show(uint8_t port, uint32_t *state);
3173 * The port identifier of the Ethernet device.
3175 * The current bypass state.
3178 * - (3) Isolate mode
3180 * - (0) if successful.
3181 * - (-ENOTSUP) if hardware doesn't support.
3182 * - (-EINVAL) if bad parameter.
3184 int rte_eth_dev_bypass_state_set(uint8_t port, uint32_t *new_state);
3187 * Return bypass state when given event occurs.
3190 * The port identifier of the Ethernet device.
3193 * - (1) Main power on (power button is pushed)
3194 * - (2) Auxiliary power on (power supply is being plugged)
3195 * - (3) Main power off (system shutdown and power supply is left plugged in)
3196 * - (4) Auxiliary power off (power supply is being unplugged)
3197 * - (5) Display or set the watchdog timer
3199 * The bypass state when given event occurred.
3202 * - (3) Isolate mode
3204 * - (0) if successful.
3205 * - (-ENOTSUP) if hardware doesn't support.
3206 * - (-EINVAL) if bad parameter.
3208 int rte_eth_dev_bypass_event_show(uint8_t port, uint32_t event, uint32_t *state);
3211 * Set bypass state when given event occurs.
3214 * The port identifier of the Ethernet device.
3217 * - (1) Main power on (power button is pushed)
3218 * - (2) Auxiliary power on (power supply is being plugged)
3219 * - (3) Main power off (system shutdown and power supply is left plugged in)
3220 * - (4) Auxiliary power off (power supply is being unplugged)
3221 * - (5) Display or set the watchdog timer
3223 * The assigned state when given event occurs.
3226 * - (3) Isolate mode
3228 * - (0) if successful.
3229 * - (-ENOTSUP) if hardware doesn't support.
3230 * - (-EINVAL) if bad parameter.
3232 int rte_eth_dev_bypass_event_store(uint8_t port, uint32_t event, uint32_t state);
3235 * Set bypass watchdog timeout count.
3238 * The port identifier of the Ethernet device.
3240 * The timeout to be set.
3241 * - (0) 0 seconds (timer is off)
3250 * - (0) if successful.
3251 * - (-ENOTSUP) if hardware doesn't support.
3252 * - (-EINVAL) if bad parameter.
3254 int rte_eth_dev_wd_timeout_store(uint8_t port, uint32_t timeout);
3257 * Get bypass firmware version.
3260 * The port identifier of the Ethernet device.
3262 * The firmware version
3264 * - (0) if successful.
3265 * - (-ENOTSUP) if hardware doesn't support.
3266 * - (-EINVAL) if bad parameter.
3268 int rte_eth_dev_bypass_ver_show(uint8_t port, uint32_t *ver);
3271 * Return bypass watchdog timeout in seconds
3274 * The port identifier of the Ethernet device.
3276 * The return watchdog timeout. "0" represents timer expired
3277 * - (0) 0 seconds (timer is off)
3286 * - (0) if successful.
3287 * - (-ENOTSUP) if hardware doesn't support.
3288 * - (-EINVAL) if bad parameter.
3290 int rte_eth_dev_bypass_wd_timeout_show(uint8_t port, uint32_t *wd_timeout);
3293 * Reset bypass watchdog timer
3296 * The port identifier of the Ethernet device.
3298 * - (0) if successful.
3299 * - (-ENOTSUP) if hardware doesn't support.
3300 * - (-EINVAL) if bad parameter.
3302 int rte_eth_dev_bypass_wd_reset(uint8_t port);
3305 * Configuration of Receive Side Scaling hash computation of Ethernet device.
3308 * The port identifier of the Ethernet device.
3310 * The new configuration to use for RSS hash computation on the port.
3312 * - (0) if successful.
3313 * - (-ENODEV) if port identifier is invalid.
3314 * - (-ENOTSUP) if hardware doesn't support.
3315 * - (-EINVAL) if bad parameter.
3317 int rte_eth_dev_rss_hash_update(uint8_t port_id,
3318 struct rte_eth_rss_conf *rss_conf);
3321 * Retrieve current configuration of Receive Side Scaling hash computation
3322 * of Ethernet device.
3325 * The port identifier of the Ethernet device.
3327 * Where to store the current RSS hash configuration of the Ethernet device.
3329 * - (0) if successful.
3330 * - (-ENODEV) if port identifier is invalid.
3331 * - (-ENOTSUP) if hardware doesn't support RSS.
3334 rte_eth_dev_rss_hash_conf_get(uint8_t port_id,
3335 struct rte_eth_rss_conf *rss_conf);
3341 * The port identifier of the Ethernet device.
3343 * The index of RX queue where to store RX packets matching the syn filter.
3345 * The pointer to the structure describing the syn filter rule.
3347 * - (0) if successful.
3348 * - (-ENOTSUP) if hardware doesn't support.
3349 * - (-EINVAL) if bad parameter.
3351 int rte_eth_dev_add_syn_filter(uint8_t port_id,
3352 struct rte_syn_filter *filter, uint16_t rx_queue);
3358 * The port identifier of the Ethernet device.
3360 * - (0) if successful.
3361 * - (-ENOTSUP) if hardware doesn't support.
3362 * - (-EINVAL) if bad parameter.
3364 int rte_eth_dev_remove_syn_filter(uint8_t port_id);
3370 * The port identifier of the Ethernet device.
3372 * The pointer to the structure describing the syn filter.
3374 * A pointer to get the queue index of syn filter.
3376 * - (0) if successful.
3377 * - (-ENOTSUP) if hardware doesn't support.
3378 * - (-EINVAL) if bad parameter.
3380 int rte_eth_dev_get_syn_filter(uint8_t port_id,
3381 struct rte_syn_filter *filter, uint16_t *rx_queue);
3384 * Add a new ethertype filter rule on an Ethernet device.
3387 * The port identifier of the Ethernet device.
3389 * The identifier of ethertype filter.
3391 * The pointer to the structure describing the ethertype filter rule.
3392 * The *rte_ethertype_filter* structure includes the values of the different
3393 * fields to match: ethertype and priority in vlan tag.
3394 * priority in vlan tag is not supported for E1000 dev.
3396 * The index of the RX queue where to store RX packets matching the added
3399 * - (0) if successful.
3400 * - (-ENOTSUP) if hardware doesn't support ethertype filter.
3401 * - (-ENODEV) if *port_id* invalid.
3402 * - (-EINVAL) if the filter information is not correct.
3404 int rte_eth_dev_add_ethertype_filter(uint8_t port_id, uint16_t index,
3405 struct rte_ethertype_filter *filter, uint16_t rx_queue);
3408 * remove an ethertype filter rule on an Ethernet device.
3411 * The port identifier of the Ethernet device.
3413 * The identifier of ethertype filter.
3415 * - (0) if successful.
3416 * - (-ENOTSUP) if hardware doesn't support ethertype filter.
3417 * - (-ENODEV) if *port_id* invalid.
3418 * - (-EINVAL) if the filter information is not correct.
3420 int rte_eth_dev_remove_ethertype_filter(uint8_t port_id,
3424 * Get an ethertype filter rule on an Ethernet device.
3427 * The port identifier of the Ethernet device.
3429 * The identifier of ethertype filter.
3431 * A pointer to a structure of type *rte_ethertype_filter* to be filled with
3432 * the information of the Ethertype filter.
3434 * A pointer to get the queue index.
3436 * - (0) if successful.
3437 * - (-ENOTSUP) if hardware doesn't support ethertype filter.
3438 * - (-ENODEV) if *port_id* invalid.
3439 * - (-EINVAL) if the filter information is not correct.
3440 * - (-ENOENT) if no enabled filter in this index.
3442 int rte_eth_dev_get_ethertype_filter(uint8_t port_id, uint16_t index,
3443 struct rte_ethertype_filter *filter, uint16_t *rx_queue);
3446 * Add a new 2tuple filter rule on an Ethernet device.
3449 * The port identifier of the Ethernet device.
3451 * The identifier of 2tuple filter.
3453 * The pointer to the structure describing the 2tuple filter rule.
3454 * The *rte_2tuple_filter* structure includes the values of the different
3455 * fields to match: protocol, dst_port and
3456 * tcp_flags if the protocol is tcp type.
3458 * The index of the RX queue where to store RX packets matching the added
3461 * - (0) if successful.
3462 * - (-ENOTSUP) if hardware doesn't support 2tuple filter.
3463 * - (-ENODEV) if *port_id* invalid.
3464 * - (-EINVAL) if the filter information is not correct.
3466 int rte_eth_dev_add_2tuple_filter(uint8_t port_id, uint16_t index,
3467 struct rte_2tuple_filter *filter, uint16_t rx_queue);
3470 * remove a 2tuple filter rule on an Ethernet device.
3473 * The port identifier of the Ethernet device.
3475 * The identifier of 2tuple filter.
3477 * - (0) if successful.
3478 * - (-ENOTSUP) if hardware doesn't support 2tuple filter.
3479 * - (-ENODEV) if *port_id* invalid.
3480 * - (-EINVAL) if the filter information is not correct.
3482 int rte_eth_dev_remove_2tuple_filter(uint8_t port_id, uint16_t index);
3485 * Get an 2tuple filter rule on an Ethernet device.
3488 * The port identifier of the Ethernet device.
3490 * The identifier of 2tuple filter.
3492 * A pointer to a structure of type *rte_2tuple_filter* to be filled with
3493 * the information of the 2tuple filter.
3495 * A pointer to get the queue index.
3497 * - (0) if successful.
3498 * - (-ENOTSUP) if hardware doesn't support 2tuple filter.
3499 * - (-ENODEV) if *port_id* invalid.
3500 * - (-EINVAL) if the filter information is not correct.
3501 * - (-ENOENT) if no enabled filter in this index.
3503 int rte_eth_dev_get_2tuple_filter(uint8_t port_id, uint16_t index,
3504 struct rte_2tuple_filter *filter, uint16_t *rx_queue);
3507 * Add a new 5tuple filter rule on an Ethernet device.
3510 * The port identifier of the Ethernet device.
3512 * The identifier of 5tuple filter.
3514 * The pointer to the structure describing the 5tuple filter rule.
3515 * The *rte_5tuple_filter* structure includes the values of the different
3516 * fields to match: dst src IP, dst src port, protocol and relative masks
3518 * The index of the RX queue where to store RX packets matching the added
3521 * - (0) if successful.
3522 * - (-ENOTSUP) if hardware doesn't support 5tuple filter.
3523 * - (-ENODEV) if *port_id* invalid.
3524 * - (-EINVAL) if the filter information is not correct.
3526 int rte_eth_dev_add_5tuple_filter(uint8_t port_id, uint16_t index,
3527 struct rte_5tuple_filter *filter, uint16_t rx_queue);
3530 * remove a 5tuple filter rule on an Ethernet device.
3533 * The port identifier of the Ethernet device.
3535 * The identifier of 5tuple filter.
3537 * - (0) if successful.
3538 * - (-ENOTSUP) if hardware doesn't support 5tuple filter.
3539 * - (-ENODEV) if *port_id* invalid.
3540 * - (-EINVAL) if the filter information is not correct.
3542 int rte_eth_dev_remove_5tuple_filter(uint8_t port_id, uint16_t index);
3545 * Get an 5tuple filter rule on an Ethernet device.
3548 * The port identifier of the Ethernet device.
3550 * The identifier of 5tuple filter.
3552 * A pointer to a structure of type *rte_5tuple_filter* to be filled with
3553 * the information of the 5tuple filter.
3555 * A pointer to get the queue index.
3557 * - (0) if successful.
3558 * - (-ENOTSUP) if hardware doesn't support 5tuple filter.
3559 * - (-ENODEV) if *port_id* invalid.
3560 * - (-EINVAL) if the filter information is not correct.
3562 int rte_eth_dev_get_5tuple_filter(uint8_t port_id, uint16_t index,
3563 struct rte_5tuple_filter *filter, uint16_t *rx_queue);
3566 * Add a new flex filter rule on an Ethernet device.
3569 * The port identifier of the Ethernet device.
3571 * The identifier of flex filter.
3573 * The pointer to the structure describing the flex filter rule.
3574 * The *rte_flex_filter* structure includes the values of the different fields
3575 * to match: the dwords (first len bytes of packet ) and relative masks.
3577 * The index of the RX queue where to store RX packets matching the added
3580 * - (0) if successful.
3581 * - (-ENOTSUP) if hardware doesn't support flex filter.
3582 * - (-ENODEV) if *port_id* invalid.
3583 * - (-EINVAL) if the filter information is not correct.
3584 * - (-ENOENT) if no enabled filter in this index.
3586 int rte_eth_dev_add_flex_filter(uint8_t port_id, uint16_t index,
3587 struct rte_flex_filter *filter, uint16_t rx_queue);
3590 * remove a flex filter rule on an Ethernet device.
3593 * The port identifier of the Ethernet device.
3595 * The identifier of flex filter.
3597 * - (0) if successful.
3598 * - (-ENOTSUP) if hardware doesn't support flex filter.
3599 * - (-ENODEV) if *port_id* invalid.
3600 * - (-EINVAL) if the filter information is not correct.
3602 int rte_eth_dev_remove_flex_filter(uint8_t port_id, uint16_t index);
3605 * Get an flex filter rule on an Ethernet device.
3608 * The port identifier of the Ethernet device.
3610 * The identifier of flex filter.
3612 * A pointer to a structure of type *rte_flex_filter* to be filled with
3613 * the information of the flex filter.
3615 * A pointer to get the queue index.
3617 * - (0) if successful.
3618 * - (-ENOTSUP) if hardware doesn't support flex filter.
3619 * - (-ENODEV) if *port_id* invalid.
3620 * - (-EINVAL) if the filter information is not correct.
3621 * - (-ENOENT) if no enabled filter in this index.
3623 int rte_eth_dev_get_flex_filter(uint8_t port_id, uint16_t index,
3624 struct rte_flex_filter *filter, uint16_t *rx_queue);
3630 #endif /* _RTE_ETHDEV_H_ */