1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2017 Intel Corporation
11 * RTE Ethernet Device API
13 * The Ethernet Device API is composed of two parts:
15 * - The application-oriented Ethernet API that includes functions to setup
16 * an Ethernet device (configure it, setup its RX and TX queues and start it),
17 * to get its MAC address, the speed and the status of its physical link,
18 * to receive and to transmit packets, and so on.
20 * - The driver-oriented Ethernet API that exports functions allowing
21 * an Ethernet Poll Mode Driver (PMD) to allocate an Ethernet device instance,
22 * create memzone for HW rings and process registered callbacks, and so on.
23 * PMDs should include rte_ethdev_driver.h instead of this header.
25 * By default, all the functions of the Ethernet Device API exported by a PMD
26 * are lock-free functions which assume to not be invoked in parallel on
27 * different logical cores to work on the same target object. For instance,
28 * the receive function of a PMD cannot be invoked in parallel on two logical
29 * cores to poll the same RX queue [of the same port]. Of course, this function
30 * can be invoked in parallel by different logical cores on different RX queues.
31 * It is the responsibility of the upper level application to enforce this rule.
33 * If needed, parallel accesses by multiple logical cores to shared queues
34 * shall be explicitly protected by dedicated inline lock-aware functions
35 * built on top of their corresponding lock-free functions of the PMD API.
37 * In all functions of the Ethernet API, the Ethernet device is
38 * designated by an integer >= 0 named the device port identifier.
40 * At the Ethernet driver level, Ethernet devices are represented by a generic
41 * data structure of type *rte_eth_dev*.
43 * Ethernet devices are dynamically registered during the PCI probing phase
44 * performed at EAL initialization time.
45 * When an Ethernet device is being probed, an *rte_eth_dev* structure and
46 * a new port identifier are allocated for that device. Then, the eth_dev_init()
47 * function supplied by the Ethernet driver matching the probed PCI
48 * device is invoked to properly initialize the device.
50 * The role of the device init function consists of resetting the hardware,
51 * checking access to Non-volatile Memory (NVM), reading the MAC address
54 * If the device init operation is successful, the correspondence between
55 * the port identifier assigned to the new device and its associated
56 * *rte_eth_dev* structure is effectively registered.
57 * Otherwise, both the *rte_eth_dev* structure and the port identifier are
60 * The functions exported by the application Ethernet API to setup a device
61 * designated by its port identifier must be invoked in the following order:
62 * - rte_eth_dev_configure()
63 * - rte_eth_tx_queue_setup()
64 * - rte_eth_rx_queue_setup()
65 * - rte_eth_dev_start()
67 * Then, the network application can invoke, in any order, the functions
68 * exported by the Ethernet API to get the MAC address of a given device, to
69 * get the speed and the status of a device physical link, to receive/transmit
70 * [burst of] packets, and so on.
72 * If the application wants to change the configuration (i.e. call
73 * rte_eth_dev_configure(), rte_eth_tx_queue_setup(), or
74 * rte_eth_rx_queue_setup()), it must call rte_eth_dev_stop() first to stop the
75 * device and then do the reconfiguration before calling rte_eth_dev_start()
76 * again. The transmit and receive functions should not be invoked when the
79 * Please note that some configuration is not stored between calls to
80 * rte_eth_dev_stop()/rte_eth_dev_start(). The following configuration will
83 * - flow control settings
84 * - receive mode configuration (promiscuous mode, hardware checksum mode,
85 * RSS/VMDQ settings etc.)
86 * - VLAN filtering configuration
87 * - MAC addresses supplied to MAC address array
88 * - flow director filtering mode (but not filtering rules)
89 * - NIC queue statistics mappings
91 * Any other configuration will not be stored and will need to be re-entered
92 * before a call to rte_eth_dev_start().
94 * Finally, a network application can close an Ethernet device by invoking the
95 * rte_eth_dev_close() function.
97 * Each function of the application Ethernet API invokes a specific function
98 * of the PMD that controls the target device designated by its port
100 * For this purpose, all device-specific functions of an Ethernet driver are
101 * supplied through a set of pointers contained in a generic structure of type
103 * The address of the *eth_dev_ops* structure is stored in the *rte_eth_dev*
104 * structure by the device init function of the Ethernet driver, which is
105 * invoked during the PCI probing phase, as explained earlier.
107 * In other words, each function of the Ethernet API simply retrieves the
108 * *rte_eth_dev* structure associated with the device port identifier and
109 * performs an indirect invocation of the corresponding driver function
110 * supplied in the *eth_dev_ops* structure of the *rte_eth_dev* structure.
112 * For performance reasons, the address of the burst-oriented RX and TX
113 * functions of the Ethernet driver are not contained in the *eth_dev_ops*
114 * structure. Instead, they are directly stored at the beginning of the
115 * *rte_eth_dev* structure to avoid an extra indirect memory access during
118 * RTE ethernet device drivers do not use interrupts for transmitting or
119 * receiving. Instead, Ethernet drivers export Poll-Mode receive and transmit
120 * functions to applications.
121 * Both receive and transmit functions are packet-burst oriented to minimize
122 * their cost per packet through the following optimizations:
124 * - Sharing among multiple packets the incompressible cost of the
125 * invocation of receive/transmit functions.
127 * - Enabling receive/transmit functions to take advantage of burst-oriented
128 * hardware features (L1 cache, prefetch instructions, NIC head/tail
129 * registers) to minimize the number of CPU cycles per packet, for instance,
130 * by avoiding useless read memory accesses to ring descriptors, or by
131 * systematically using arrays of pointers that exactly fit L1 cache line
132 * boundaries and sizes.
134 * The burst-oriented receive function does not provide any error notification,
135 * to avoid the corresponding overhead. As a hint, the upper-level application
136 * might check the status of the device link once being systematically returned
137 * a 0 value by the receive function of the driver for a given number of tries.
146 /* Use this macro to check if LRO API is supported */
147 #define RTE_ETHDEV_HAS_LRO_SUPPORT
149 #include <rte_compat.h>
151 #include <rte_interrupts.h>
153 #include <rte_devargs.h>
154 #include <rte_errno.h>
155 #include <rte_common.h>
156 #include <rte_config.h>
158 #include "rte_ether.h"
159 #include "rte_eth_ctrl.h"
160 #include "rte_dev_info.h"
162 extern int rte_eth_dev_logtype;
164 #define RTE_ETHDEV_LOG(level, ...) \
165 rte_log(RTE_LOG_ ## level, rte_eth_dev_logtype, "" __VA_ARGS__)
170 * A structure used to retrieve statistics for an Ethernet port.
171 * Not all statistics fields in struct rte_eth_stats are supported
172 * by any type of network interface card (NIC). If any statistics
173 * field is not supported, its value is 0.
175 struct rte_eth_stats {
176 uint64_t ipackets; /**< Total number of successfully received packets. */
177 uint64_t opackets; /**< Total number of successfully transmitted packets.*/
178 uint64_t ibytes; /**< Total number of successfully received bytes. */
179 uint64_t obytes; /**< Total number of successfully transmitted bytes. */
181 /**< Total of RX packets dropped by the HW,
182 * because there are no available buffer (i.e. RX queues are full).
184 uint64_t ierrors; /**< Total number of erroneous received packets. */
185 uint64_t oerrors; /**< Total number of failed transmitted packets. */
186 uint64_t rx_nombuf; /**< Total number of RX mbuf allocation failures. */
187 uint64_t q_ipackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
188 /**< Total number of queue RX packets. */
189 uint64_t q_opackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
190 /**< Total number of queue TX packets. */
191 uint64_t q_ibytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
192 /**< Total number of successfully received queue bytes. */
193 uint64_t q_obytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
194 /**< Total number of successfully transmitted queue bytes. */
195 uint64_t q_errors[RTE_ETHDEV_QUEUE_STAT_CNTRS];
196 /**< Total number of queue packets received that are dropped. */
200 * Device supported speeds bitmap flags
202 #define ETH_LINK_SPEED_AUTONEG (0 << 0) /**< Autonegotiate (all speeds) */
203 #define ETH_LINK_SPEED_FIXED (1 << 0) /**< Disable autoneg (fixed speed) */
204 #define ETH_LINK_SPEED_10M_HD (1 << 1) /**< 10 Mbps half-duplex */
205 #define ETH_LINK_SPEED_10M (1 << 2) /**< 10 Mbps full-duplex */
206 #define ETH_LINK_SPEED_100M_HD (1 << 3) /**< 100 Mbps half-duplex */
207 #define ETH_LINK_SPEED_100M (1 << 4) /**< 100 Mbps full-duplex */
208 #define ETH_LINK_SPEED_1G (1 << 5) /**< 1 Gbps */
209 #define ETH_LINK_SPEED_2_5G (1 << 6) /**< 2.5 Gbps */
210 #define ETH_LINK_SPEED_5G (1 << 7) /**< 5 Gbps */
211 #define ETH_LINK_SPEED_10G (1 << 8) /**< 10 Gbps */
212 #define ETH_LINK_SPEED_20G (1 << 9) /**< 20 Gbps */
213 #define ETH_LINK_SPEED_25G (1 << 10) /**< 25 Gbps */
214 #define ETH_LINK_SPEED_40G (1 << 11) /**< 40 Gbps */
215 #define ETH_LINK_SPEED_50G (1 << 12) /**< 50 Gbps */
216 #define ETH_LINK_SPEED_56G (1 << 13) /**< 56 Gbps */
217 #define ETH_LINK_SPEED_100G (1 << 14) /**< 100 Gbps */
220 * Ethernet numeric link speeds in Mbps
222 #define ETH_SPEED_NUM_NONE 0 /**< Not defined */
223 #define ETH_SPEED_NUM_10M 10 /**< 10 Mbps */
224 #define ETH_SPEED_NUM_100M 100 /**< 100 Mbps */
225 #define ETH_SPEED_NUM_1G 1000 /**< 1 Gbps */
226 #define ETH_SPEED_NUM_2_5G 2500 /**< 2.5 Gbps */
227 #define ETH_SPEED_NUM_5G 5000 /**< 5 Gbps */
228 #define ETH_SPEED_NUM_10G 10000 /**< 10 Gbps */
229 #define ETH_SPEED_NUM_20G 20000 /**< 20 Gbps */
230 #define ETH_SPEED_NUM_25G 25000 /**< 25 Gbps */
231 #define ETH_SPEED_NUM_40G 40000 /**< 40 Gbps */
232 #define ETH_SPEED_NUM_50G 50000 /**< 50 Gbps */
233 #define ETH_SPEED_NUM_56G 56000 /**< 56 Gbps */
234 #define ETH_SPEED_NUM_100G 100000 /**< 100 Gbps */
237 * A structure used to retrieve link-level information of an Ethernet port.
240 struct rte_eth_link {
241 uint32_t link_speed; /**< ETH_SPEED_NUM_ */
242 uint16_t link_duplex : 1; /**< ETH_LINK_[HALF/FULL]_DUPLEX */
243 uint16_t link_autoneg : 1; /**< ETH_LINK_[AUTONEG/FIXED] */
244 uint16_t link_status : 1; /**< ETH_LINK_[DOWN/UP] */
245 } __attribute__((aligned(8))); /**< aligned for atomic64 read/write */
247 /* Utility constants */
248 #define ETH_LINK_HALF_DUPLEX 0 /**< Half-duplex connection (see link_duplex). */
249 #define ETH_LINK_FULL_DUPLEX 1 /**< Full-duplex connection (see link_duplex). */
250 #define ETH_LINK_DOWN 0 /**< Link is down (see link_status). */
251 #define ETH_LINK_UP 1 /**< Link is up (see link_status). */
252 #define ETH_LINK_FIXED 0 /**< No autonegotiation (see link_autoneg). */
253 #define ETH_LINK_AUTONEG 1 /**< Autonegotiated (see link_autoneg). */
256 * A structure used to configure the ring threshold registers of an RX/TX
257 * queue for an Ethernet port.
259 struct rte_eth_thresh {
260 uint8_t pthresh; /**< Ring prefetch threshold. */
261 uint8_t hthresh; /**< Ring host threshold. */
262 uint8_t wthresh; /**< Ring writeback threshold. */
266 * Simple flags are used for rte_eth_conf.rxmode.mq_mode.
268 #define ETH_MQ_RX_RSS_FLAG 0x1
269 #define ETH_MQ_RX_DCB_FLAG 0x2
270 #define ETH_MQ_RX_VMDQ_FLAG 0x4
273 * A set of values to identify what method is to be used to route
274 * packets to multiple queues.
276 enum rte_eth_rx_mq_mode {
277 /** None of DCB,RSS or VMDQ mode */
280 /** For RX side, only RSS is on */
281 ETH_MQ_RX_RSS = ETH_MQ_RX_RSS_FLAG,
282 /** For RX side,only DCB is on. */
283 ETH_MQ_RX_DCB = ETH_MQ_RX_DCB_FLAG,
284 /** Both DCB and RSS enable */
285 ETH_MQ_RX_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG,
287 /** Only VMDQ, no RSS nor DCB */
288 ETH_MQ_RX_VMDQ_ONLY = ETH_MQ_RX_VMDQ_FLAG,
289 /** RSS mode with VMDQ */
290 ETH_MQ_RX_VMDQ_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_VMDQ_FLAG,
291 /** Use VMDQ+DCB to route traffic to queues */
292 ETH_MQ_RX_VMDQ_DCB = ETH_MQ_RX_VMDQ_FLAG | ETH_MQ_RX_DCB_FLAG,
293 /** Enable both VMDQ and DCB in VMDq */
294 ETH_MQ_RX_VMDQ_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG |
299 * for rx mq mode backward compatible
301 #define ETH_RSS ETH_MQ_RX_RSS
302 #define VMDQ_DCB ETH_MQ_RX_VMDQ_DCB
303 #define ETH_DCB_RX ETH_MQ_RX_DCB
306 * A set of values to identify what method is to be used to transmit
307 * packets using multi-TCs.
309 enum rte_eth_tx_mq_mode {
310 ETH_MQ_TX_NONE = 0, /**< It is in neither DCB nor VT mode. */
311 ETH_MQ_TX_DCB, /**< For TX side,only DCB is on. */
312 ETH_MQ_TX_VMDQ_DCB, /**< For TX side,both DCB and VT is on. */
313 ETH_MQ_TX_VMDQ_ONLY, /**< Only VT on, no DCB */
317 * for tx mq mode backward compatible
319 #define ETH_DCB_NONE ETH_MQ_TX_NONE
320 #define ETH_VMDQ_DCB_TX ETH_MQ_TX_VMDQ_DCB
321 #define ETH_DCB_TX ETH_MQ_TX_DCB
324 * A structure used to configure the RX features of an Ethernet port.
326 struct rte_eth_rxmode {
327 /** The multi-queue packet distribution mode to be used, e.g. RSS. */
328 enum rte_eth_rx_mq_mode mq_mode;
329 uint32_t max_rx_pkt_len; /**< Only used if jumbo_frame enabled. */
330 uint16_t split_hdr_size; /**< hdr buf size (header_split enabled).*/
332 * Per-port Rx offloads to be set using DEV_RX_OFFLOAD_* flags.
333 * Only offloads set on rx_offload_capa field on rte_eth_dev_info
334 * structure are allowed to be set.
339 * Below bitfield API is obsolete. Application should
340 * enable per-port offloads using the offload field
343 uint16_t header_split : 1, /**< Header Split enable. */
344 hw_ip_checksum : 1, /**< IP/UDP/TCP checksum offload enable. */
345 hw_vlan_filter : 1, /**< VLAN filter enable. */
346 hw_vlan_strip : 1, /**< VLAN strip enable. */
347 hw_vlan_extend : 1, /**< Extended VLAN enable. */
348 jumbo_frame : 1, /**< Jumbo Frame Receipt enable. */
349 hw_strip_crc : 1, /**< Enable CRC stripping by hardware. */
350 enable_scatter : 1, /**< Enable scatter packets rx handler */
351 enable_lro : 1, /**< Enable LRO */
352 hw_timestamp : 1, /**< Enable HW timestamp */
353 security : 1, /**< Enable rte_security offloads */
355 * When set the offload bitfield should be ignored.
356 * Instead per-port Rx offloads should be set on offloads
358 * Per-queue offloads shuold be set on rte_eth_rxq_conf
360 * This bit is temporary till rxmode bitfield offloads API will
363 ignore_offload_bitfield : 1;
367 * VLAN types to indicate if it is for single VLAN, inner VLAN or outer VLAN.
368 * Note that single VLAN is treated the same as inner VLAN.
371 ETH_VLAN_TYPE_UNKNOWN = 0,
372 ETH_VLAN_TYPE_INNER, /**< Inner VLAN. */
373 ETH_VLAN_TYPE_OUTER, /**< Single VLAN, or outer VLAN. */
378 * A structure used to describe a vlan filter.
379 * If the bit corresponding to a VID is set, such VID is on.
381 struct rte_vlan_filter_conf {
386 * A structure used to configure the Receive Side Scaling (RSS) feature
387 * of an Ethernet port.
388 * If not NULL, the *rss_key* pointer of the *rss_conf* structure points
389 * to an array holding the RSS key to use for hashing specific header
390 * fields of received packets. The length of this array should be indicated
391 * by *rss_key_len* below. Otherwise, a default random hash key is used by
394 * The *rss_key_len* field of the *rss_conf* structure indicates the length
395 * in bytes of the array pointed by *rss_key*. To be compatible, this length
396 * will be checked in i40e only. Others assume 40 bytes to be used as before.
398 * The *rss_hf* field of the *rss_conf* structure indicates the different
399 * types of IPv4/IPv6 packets to which the RSS hashing must be applied.
400 * Supplying an *rss_hf* equal to zero disables the RSS feature.
402 struct rte_eth_rss_conf {
403 uint8_t *rss_key; /**< If not NULL, 40-byte hash key. */
404 uint8_t rss_key_len; /**< hash key length in bytes. */
405 uint64_t rss_hf; /**< Hash functions to apply - see below. */
409 * The RSS offload types are defined based on flow types which are defined
410 * in rte_eth_ctrl.h. Different NIC hardwares may support different RSS offload
411 * types. The supported flow types or RSS offload types can be queried by
412 * rte_eth_dev_info_get().
414 #define ETH_RSS_IPV4 (1ULL << RTE_ETH_FLOW_IPV4)
415 #define ETH_RSS_FRAG_IPV4 (1ULL << RTE_ETH_FLOW_FRAG_IPV4)
416 #define ETH_RSS_NONFRAG_IPV4_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_TCP)
417 #define ETH_RSS_NONFRAG_IPV4_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_UDP)
418 #define ETH_RSS_NONFRAG_IPV4_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_SCTP)
419 #define ETH_RSS_NONFRAG_IPV4_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_OTHER)
420 #define ETH_RSS_IPV6 (1ULL << RTE_ETH_FLOW_IPV6)
421 #define ETH_RSS_FRAG_IPV6 (1ULL << RTE_ETH_FLOW_FRAG_IPV6)
422 #define ETH_RSS_NONFRAG_IPV6_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_TCP)
423 #define ETH_RSS_NONFRAG_IPV6_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_UDP)
424 #define ETH_RSS_NONFRAG_IPV6_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_SCTP)
425 #define ETH_RSS_NONFRAG_IPV6_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_OTHER)
426 #define ETH_RSS_L2_PAYLOAD (1ULL << RTE_ETH_FLOW_L2_PAYLOAD)
427 #define ETH_RSS_IPV6_EX (1ULL << RTE_ETH_FLOW_IPV6_EX)
428 #define ETH_RSS_IPV6_TCP_EX (1ULL << RTE_ETH_FLOW_IPV6_TCP_EX)
429 #define ETH_RSS_IPV6_UDP_EX (1ULL << RTE_ETH_FLOW_IPV6_UDP_EX)
430 #define ETH_RSS_PORT (1ULL << RTE_ETH_FLOW_PORT)
431 #define ETH_RSS_VXLAN (1ULL << RTE_ETH_FLOW_VXLAN)
432 #define ETH_RSS_GENEVE (1ULL << RTE_ETH_FLOW_GENEVE)
433 #define ETH_RSS_NVGRE (1ULL << RTE_ETH_FLOW_NVGRE)
435 #define ETH_RSS_IP ( \
437 ETH_RSS_FRAG_IPV4 | \
438 ETH_RSS_NONFRAG_IPV4_OTHER | \
440 ETH_RSS_FRAG_IPV6 | \
441 ETH_RSS_NONFRAG_IPV6_OTHER | \
444 #define ETH_RSS_UDP ( \
445 ETH_RSS_NONFRAG_IPV4_UDP | \
446 ETH_RSS_NONFRAG_IPV6_UDP | \
449 #define ETH_RSS_TCP ( \
450 ETH_RSS_NONFRAG_IPV4_TCP | \
451 ETH_RSS_NONFRAG_IPV6_TCP | \
454 #define ETH_RSS_SCTP ( \
455 ETH_RSS_NONFRAG_IPV4_SCTP | \
456 ETH_RSS_NONFRAG_IPV6_SCTP)
458 #define ETH_RSS_TUNNEL ( \
463 /**< Mask of valid RSS hash protocols */
464 #define ETH_RSS_PROTO_MASK ( \
466 ETH_RSS_FRAG_IPV4 | \
467 ETH_RSS_NONFRAG_IPV4_TCP | \
468 ETH_RSS_NONFRAG_IPV4_UDP | \
469 ETH_RSS_NONFRAG_IPV4_SCTP | \
470 ETH_RSS_NONFRAG_IPV4_OTHER | \
472 ETH_RSS_FRAG_IPV6 | \
473 ETH_RSS_NONFRAG_IPV6_TCP | \
474 ETH_RSS_NONFRAG_IPV6_UDP | \
475 ETH_RSS_NONFRAG_IPV6_SCTP | \
476 ETH_RSS_NONFRAG_IPV6_OTHER | \
477 ETH_RSS_L2_PAYLOAD | \
479 ETH_RSS_IPV6_TCP_EX | \
480 ETH_RSS_IPV6_UDP_EX | \
487 * Definitions used for redirection table entry size.
488 * Some RSS RETA sizes may not be supported by some drivers, check the
489 * documentation or the description of relevant functions for more details.
491 #define ETH_RSS_RETA_SIZE_64 64
492 #define ETH_RSS_RETA_SIZE_128 128
493 #define ETH_RSS_RETA_SIZE_256 256
494 #define ETH_RSS_RETA_SIZE_512 512
495 #define RTE_RETA_GROUP_SIZE 64
497 /* Definitions used for VMDQ and DCB functionality */
498 #define ETH_VMDQ_MAX_VLAN_FILTERS 64 /**< Maximum nb. of VMDQ vlan filters. */
499 #define ETH_DCB_NUM_USER_PRIORITIES 8 /**< Maximum nb. of DCB priorities. */
500 #define ETH_VMDQ_DCB_NUM_QUEUES 128 /**< Maximum nb. of VMDQ DCB queues. */
501 #define ETH_DCB_NUM_QUEUES 128 /**< Maximum nb. of DCB queues. */
503 /* DCB capability defines */
504 #define ETH_DCB_PG_SUPPORT 0x00000001 /**< Priority Group(ETS) support. */
505 #define ETH_DCB_PFC_SUPPORT 0x00000002 /**< Priority Flow Control support. */
507 /* Definitions used for VLAN Offload functionality */
508 #define ETH_VLAN_STRIP_OFFLOAD 0x0001 /**< VLAN Strip On/Off */
509 #define ETH_VLAN_FILTER_OFFLOAD 0x0002 /**< VLAN Filter On/Off */
510 #define ETH_VLAN_EXTEND_OFFLOAD 0x0004 /**< VLAN Extend On/Off */
512 /* Definitions used for mask VLAN setting */
513 #define ETH_VLAN_STRIP_MASK 0x0001 /**< VLAN Strip setting mask */
514 #define ETH_VLAN_FILTER_MASK 0x0002 /**< VLAN Filter setting mask*/
515 #define ETH_VLAN_EXTEND_MASK 0x0004 /**< VLAN Extend setting mask*/
516 #define ETH_VLAN_ID_MAX 0x0FFF /**< VLAN ID is in lower 12 bits*/
518 /* Definitions used for receive MAC address */
519 #define ETH_NUM_RECEIVE_MAC_ADDR 128 /**< Maximum nb. of receive mac addr. */
521 /* Definitions used for unicast hash */
522 #define ETH_VMDQ_NUM_UC_HASH_ARRAY 128 /**< Maximum nb. of UC hash array. */
524 /* Definitions used for VMDQ pool rx mode setting */
525 #define ETH_VMDQ_ACCEPT_UNTAG 0x0001 /**< accept untagged packets. */
526 #define ETH_VMDQ_ACCEPT_HASH_MC 0x0002 /**< accept packets in multicast table . */
527 #define ETH_VMDQ_ACCEPT_HASH_UC 0x0004 /**< accept packets in unicast table. */
528 #define ETH_VMDQ_ACCEPT_BROADCAST 0x0008 /**< accept broadcast packets. */
529 #define ETH_VMDQ_ACCEPT_MULTICAST 0x0010 /**< multicast promiscuous. */
531 /** Maximum nb. of vlan per mirror rule */
532 #define ETH_MIRROR_MAX_VLANS 64
534 #define ETH_MIRROR_VIRTUAL_POOL_UP 0x01 /**< Virtual Pool uplink Mirroring. */
535 #define ETH_MIRROR_UPLINK_PORT 0x02 /**< Uplink Port Mirroring. */
536 #define ETH_MIRROR_DOWNLINK_PORT 0x04 /**< Downlink Port Mirroring. */
537 #define ETH_MIRROR_VLAN 0x08 /**< VLAN Mirroring. */
538 #define ETH_MIRROR_VIRTUAL_POOL_DOWN 0x10 /**< Virtual Pool downlink Mirroring. */
541 * A structure used to configure VLAN traffic mirror of an Ethernet port.
543 struct rte_eth_vlan_mirror {
544 uint64_t vlan_mask; /**< mask for valid VLAN ID. */
545 /** VLAN ID list for vlan mirroring. */
546 uint16_t vlan_id[ETH_MIRROR_MAX_VLANS];
550 * A structure used to configure traffic mirror of an Ethernet port.
552 struct rte_eth_mirror_conf {
553 uint8_t rule_type; /**< Mirroring rule type */
554 uint8_t dst_pool; /**< Destination pool for this mirror rule. */
555 uint64_t pool_mask; /**< Bitmap of pool for pool mirroring */
556 /** VLAN ID setting for VLAN mirroring. */
557 struct rte_eth_vlan_mirror vlan;
561 * A structure used to configure 64 entries of Redirection Table of the
562 * Receive Side Scaling (RSS) feature of an Ethernet port. To configure
563 * more than 64 entries supported by hardware, an array of this structure
566 struct rte_eth_rss_reta_entry64 {
568 /**< Mask bits indicate which entries need to be updated/queried. */
569 uint16_t reta[RTE_RETA_GROUP_SIZE];
570 /**< Group of 64 redirection table entries. */
574 * This enum indicates the possible number of traffic classes
575 * in DCB configurations
577 enum rte_eth_nb_tcs {
578 ETH_4_TCS = 4, /**< 4 TCs with DCB. */
579 ETH_8_TCS = 8 /**< 8 TCs with DCB. */
583 * This enum indicates the possible number of queue pools
584 * in VMDQ configurations.
586 enum rte_eth_nb_pools {
587 ETH_8_POOLS = 8, /**< 8 VMDq pools. */
588 ETH_16_POOLS = 16, /**< 16 VMDq pools. */
589 ETH_32_POOLS = 32, /**< 32 VMDq pools. */
590 ETH_64_POOLS = 64 /**< 64 VMDq pools. */
593 /* This structure may be extended in future. */
594 struct rte_eth_dcb_rx_conf {
595 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs */
596 /** Traffic class each UP mapped to. */
597 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
600 struct rte_eth_vmdq_dcb_tx_conf {
601 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools. */
602 /** Traffic class each UP mapped to. */
603 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
606 struct rte_eth_dcb_tx_conf {
607 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs. */
608 /** Traffic class each UP mapped to. */
609 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
612 struct rte_eth_vmdq_tx_conf {
613 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq mode, 64 pools. */
617 * A structure used to configure the VMDQ+DCB feature
618 * of an Ethernet port.
620 * Using this feature, packets are routed to a pool of queues, based
621 * on the vlan id in the vlan tag, and then to a specific queue within
622 * that pool, using the user priority vlan tag field.
624 * A default pool may be used, if desired, to route all traffic which
625 * does not match the vlan filter rules.
627 struct rte_eth_vmdq_dcb_conf {
628 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools */
629 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
630 uint8_t default_pool; /**< The default pool, if applicable */
631 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
633 uint16_t vlan_id; /**< The vlan id of the received frame */
634 uint64_t pools; /**< Bitmask of pools for packet rx */
635 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
636 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
637 /**< Selects a queue in a pool */
641 * A structure used to configure the VMDQ feature of an Ethernet port when
642 * not combined with the DCB feature.
644 * Using this feature, packets are routed to a pool of queues. By default,
645 * the pool selection is based on the MAC address, the vlan id in the
646 * vlan tag as specified in the pool_map array.
647 * Passing the ETH_VMDQ_ACCEPT_UNTAG in the rx_mode field allows pool
648 * selection using only the MAC address. MAC address to pool mapping is done
649 * using the rte_eth_dev_mac_addr_add function, with the pool parameter
650 * corresponding to the pool id.
652 * Queue selection within the selected pool will be done using RSS when
653 * it is enabled or revert to the first queue of the pool if not.
655 * A default pool may be used, if desired, to route all traffic which
656 * does not match the vlan filter rules or any pool MAC address.
658 struct rte_eth_vmdq_rx_conf {
659 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq only mode, 8 or 64 pools */
660 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
661 uint8_t default_pool; /**< The default pool, if applicable */
662 uint8_t enable_loop_back; /**< Enable VT loop back */
663 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
664 uint32_t rx_mode; /**< Flags from ETH_VMDQ_ACCEPT_* */
666 uint16_t vlan_id; /**< The vlan id of the received frame */
667 uint64_t pools; /**< Bitmask of pools for packet rx */
668 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
672 * A structure used to configure the TX features of an Ethernet port.
674 struct rte_eth_txmode {
675 enum rte_eth_tx_mq_mode mq_mode; /**< TX multi-queues mode. */
677 * Per-port Tx offloads to be set using DEV_TX_OFFLOAD_* flags.
678 * Only offloads set on tx_offload_capa field on rte_eth_dev_info
679 * structure are allowed to be set.
683 /* For i40e specifically */
686 uint8_t hw_vlan_reject_tagged : 1,
687 /**< If set, reject sending out tagged pkts */
688 hw_vlan_reject_untagged : 1,
689 /**< If set, reject sending out untagged pkts */
690 hw_vlan_insert_pvid : 1;
691 /**< If set, enable port based VLAN insertion */
695 * A structure used to configure an RX ring of an Ethernet port.
697 struct rte_eth_rxconf {
698 struct rte_eth_thresh rx_thresh; /**< RX ring threshold registers. */
699 uint16_t rx_free_thresh; /**< Drives the freeing of RX descriptors. */
700 uint8_t rx_drop_en; /**< Drop packets if no descriptors are available. */
701 uint8_t rx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
703 * Per-queue Rx offloads to be set using DEV_RX_OFFLOAD_* flags.
704 * Only offloads set on rx_queue_offload_capa or rx_offload_capa
705 * fields on rte_eth_dev_info structure are allowed to be set.
710 #define ETH_TXQ_FLAGS_NOMULTSEGS 0x0001 /**< nb_segs=1 for all mbufs */
711 #define ETH_TXQ_FLAGS_NOREFCOUNT 0x0002 /**< refcnt can be ignored */
712 #define ETH_TXQ_FLAGS_NOMULTMEMP 0x0004 /**< all bufs come from same mempool */
713 #define ETH_TXQ_FLAGS_NOVLANOFFL 0x0100 /**< disable VLAN offload */
714 #define ETH_TXQ_FLAGS_NOXSUMSCTP 0x0200 /**< disable SCTP checksum offload */
715 #define ETH_TXQ_FLAGS_NOXSUMUDP 0x0400 /**< disable UDP checksum offload */
716 #define ETH_TXQ_FLAGS_NOXSUMTCP 0x0800 /**< disable TCP checksum offload */
717 #define ETH_TXQ_FLAGS_NOOFFLOADS \
718 (ETH_TXQ_FLAGS_NOVLANOFFL | ETH_TXQ_FLAGS_NOXSUMSCTP | \
719 ETH_TXQ_FLAGS_NOXSUMUDP | ETH_TXQ_FLAGS_NOXSUMTCP)
720 #define ETH_TXQ_FLAGS_NOXSUMS \
721 (ETH_TXQ_FLAGS_NOXSUMSCTP | ETH_TXQ_FLAGS_NOXSUMUDP | \
722 ETH_TXQ_FLAGS_NOXSUMTCP)
724 * When set the txq_flags should be ignored,
725 * instead per-queue Tx offloads will be set on offloads field
726 * located on rte_eth_txq_conf struct.
727 * This flag is temporary till the rte_eth_txq_conf.txq_flags
728 * API will be deprecated.
730 #define ETH_TXQ_FLAGS_IGNORE 0x8000
733 * A structure used to configure a TX ring of an Ethernet port.
735 struct rte_eth_txconf {
736 struct rte_eth_thresh tx_thresh; /**< TX ring threshold registers. */
737 uint16_t tx_rs_thresh; /**< Drives the setting of RS bit on TXDs. */
738 uint16_t tx_free_thresh; /**< Start freeing TX buffers if there are
739 less free descriptors than this value. */
741 uint32_t txq_flags; /**< Set flags for the Tx queue */
742 uint8_t tx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
744 * Per-queue Tx offloads to be set using DEV_TX_OFFLOAD_* flags.
745 * Only offloads set on tx_queue_offload_capa or tx_offload_capa
746 * fields on rte_eth_dev_info structure are allowed to be set.
752 * A structure contains information about HW descriptor ring limitations.
754 struct rte_eth_desc_lim {
755 uint16_t nb_max; /**< Max allowed number of descriptors. */
756 uint16_t nb_min; /**< Min allowed number of descriptors. */
757 uint16_t nb_align; /**< Number of descriptors should be aligned to. */
760 * Max allowed number of segments per whole packet.
762 * - For TSO packet this is the total number of data descriptors allowed
765 * @see nb_mtu_seg_max
770 * Max number of segments per one MTU.
772 * - For non-TSO packet, this is the maximum allowed number of segments
773 * in a single transmit packet.
775 * - For TSO packet each segment within the TSO may span up to this
780 uint16_t nb_mtu_seg_max;
784 * This enum indicates the flow control mode
786 enum rte_eth_fc_mode {
787 RTE_FC_NONE = 0, /**< Disable flow control. */
788 RTE_FC_RX_PAUSE, /**< RX pause frame, enable flowctrl on TX side. */
789 RTE_FC_TX_PAUSE, /**< TX pause frame, enable flowctrl on RX side. */
790 RTE_FC_FULL /**< Enable flow control on both side. */
794 * A structure used to configure Ethernet flow control parameter.
795 * These parameters will be configured into the register of the NIC.
796 * Please refer to the corresponding data sheet for proper value.
798 struct rte_eth_fc_conf {
799 uint32_t high_water; /**< High threshold value to trigger XOFF */
800 uint32_t low_water; /**< Low threshold value to trigger XON */
801 uint16_t pause_time; /**< Pause quota in the Pause frame */
802 uint16_t send_xon; /**< Is XON frame need be sent */
803 enum rte_eth_fc_mode mode; /**< Link flow control mode */
804 uint8_t mac_ctrl_frame_fwd; /**< Forward MAC control frames */
805 uint8_t autoneg; /**< Use Pause autoneg */
809 * A structure used to configure Ethernet priority flow control parameter.
810 * These parameters will be configured into the register of the NIC.
811 * Please refer to the corresponding data sheet for proper value.
813 struct rte_eth_pfc_conf {
814 struct rte_eth_fc_conf fc; /**< General flow control parameter. */
815 uint8_t priority; /**< VLAN User Priority. */
819 * Memory space that can be configured to store Flow Director filters
820 * in the board memory.
822 enum rte_fdir_pballoc_type {
823 RTE_FDIR_PBALLOC_64K = 0, /**< 64k. */
824 RTE_FDIR_PBALLOC_128K, /**< 128k. */
825 RTE_FDIR_PBALLOC_256K, /**< 256k. */
829 * Select report mode of FDIR hash information in RX descriptors.
831 enum rte_fdir_status_mode {
832 RTE_FDIR_NO_REPORT_STATUS = 0, /**< Never report FDIR hash. */
833 RTE_FDIR_REPORT_STATUS, /**< Only report FDIR hash for matching pkts. */
834 RTE_FDIR_REPORT_STATUS_ALWAYS, /**< Always report FDIR hash. */
838 * A structure used to configure the Flow Director (FDIR) feature
839 * of an Ethernet port.
841 * If mode is RTE_FDIR_DISABLE, the pballoc value is ignored.
843 struct rte_fdir_conf {
844 enum rte_fdir_mode mode; /**< Flow Director mode. */
845 enum rte_fdir_pballoc_type pballoc; /**< Space for FDIR filters. */
846 enum rte_fdir_status_mode status; /**< How to report FDIR hash. */
847 /** RX queue of packets matching a "drop" filter in perfect mode. */
849 struct rte_eth_fdir_masks mask;
850 struct rte_eth_fdir_flex_conf flex_conf;
851 /**< Flex payload configuration. */
855 * UDP tunneling configuration.
856 * Used to config the UDP port for a type of tunnel.
857 * NICs need the UDP port to identify the tunnel type.
858 * Normally a type of tunnel has a default UDP port, this structure can be used
859 * in case if the users want to change or support more UDP port.
861 struct rte_eth_udp_tunnel {
862 uint16_t udp_port; /**< UDP port used for the tunnel. */
863 uint8_t prot_type; /**< Tunnel type. Defined in rte_eth_tunnel_type. */
867 * A structure used to enable/disable specific device interrupts.
869 struct rte_intr_conf {
870 /** enable/disable lsc interrupt. 0 (default) - disable, 1 enable */
872 /** enable/disable rxq interrupt. 0 (default) - disable, 1 enable */
874 /** enable/disable rmv interrupt. 0 (default) - disable, 1 enable */
879 * A structure used to configure an Ethernet port.
880 * Depending upon the RX multi-queue mode, extra advanced
881 * configuration settings may be needed.
883 struct rte_eth_conf {
884 uint32_t link_speeds; /**< bitmap of ETH_LINK_SPEED_XXX of speeds to be
885 used. ETH_LINK_SPEED_FIXED disables link
886 autonegotiation, and a unique speed shall be
887 set. Otherwise, the bitmap defines the set of
888 speeds to be advertised. If the special value
889 ETH_LINK_SPEED_AUTONEG (0) is used, all speeds
890 supported are advertised. */
891 struct rte_eth_rxmode rxmode; /**< Port RX configuration. */
892 struct rte_eth_txmode txmode; /**< Port TX configuration. */
893 uint32_t lpbk_mode; /**< Loopback operation mode. By default the value
894 is 0, meaning the loopback mode is disabled.
895 Read the datasheet of given ethernet controller
896 for details. The possible values of this field
897 are defined in implementation of each driver. */
899 struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
900 struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
901 /**< Port vmdq+dcb configuration. */
902 struct rte_eth_dcb_rx_conf dcb_rx_conf;
903 /**< Port dcb RX configuration. */
904 struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
905 /**< Port vmdq RX configuration. */
906 } rx_adv_conf; /**< Port RX filtering configuration. */
908 struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
909 /**< Port vmdq+dcb TX configuration. */
910 struct rte_eth_dcb_tx_conf dcb_tx_conf;
911 /**< Port dcb TX configuration. */
912 struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
913 /**< Port vmdq TX configuration. */
914 } tx_adv_conf; /**< Port TX DCB configuration (union). */
915 /** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
916 is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
917 uint32_t dcb_capability_en;
918 struct rte_fdir_conf fdir_conf; /**< FDIR configuration. */
919 struct rte_intr_conf intr_conf; /**< Interrupt mode configuration. */
923 * A structure used to retrieve the contextual information of
924 * an Ethernet device, such as the controlling driver of the device,
925 * its PCI context, etc...
929 * RX offload capabilities of a device.
931 #define DEV_RX_OFFLOAD_VLAN_STRIP 0x00000001
932 #define DEV_RX_OFFLOAD_IPV4_CKSUM 0x00000002
933 #define DEV_RX_OFFLOAD_UDP_CKSUM 0x00000004
934 #define DEV_RX_OFFLOAD_TCP_CKSUM 0x00000008
935 #define DEV_RX_OFFLOAD_TCP_LRO 0x00000010
936 #define DEV_RX_OFFLOAD_QINQ_STRIP 0x00000020
937 #define DEV_RX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000040
938 #define DEV_RX_OFFLOAD_MACSEC_STRIP 0x00000080
939 #define DEV_RX_OFFLOAD_HEADER_SPLIT 0x00000100
940 #define DEV_RX_OFFLOAD_VLAN_FILTER 0x00000200
941 #define DEV_RX_OFFLOAD_VLAN_EXTEND 0x00000400
942 #define DEV_RX_OFFLOAD_JUMBO_FRAME 0x00000800
943 #define DEV_RX_OFFLOAD_CRC_STRIP 0x00001000
944 #define DEV_RX_OFFLOAD_SCATTER 0x00002000
945 #define DEV_RX_OFFLOAD_TIMESTAMP 0x00004000
946 #define DEV_RX_OFFLOAD_SECURITY 0x00008000
949 * Invalid to set both DEV_RX_OFFLOAD_CRC_STRIP and DEV_RX_OFFLOAD_KEEP_CRC
950 * No DEV_RX_OFFLOAD_CRC_STRIP flag means keep CRC
952 #define DEV_RX_OFFLOAD_KEEP_CRC 0x00010000
953 #define DEV_RX_OFFLOAD_CHECKSUM (DEV_RX_OFFLOAD_IPV4_CKSUM | \
954 DEV_RX_OFFLOAD_UDP_CKSUM | \
955 DEV_RX_OFFLOAD_TCP_CKSUM)
956 #define DEV_RX_OFFLOAD_VLAN (DEV_RX_OFFLOAD_VLAN_STRIP | \
957 DEV_RX_OFFLOAD_VLAN_FILTER | \
958 DEV_RX_OFFLOAD_VLAN_EXTEND)
961 * If new Rx offload capabilities are defined, they also must be
962 * mentioned in rte_rx_offload_names in rte_ethdev.c file.
966 * TX offload capabilities of a device.
968 #define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001
969 #define DEV_TX_OFFLOAD_IPV4_CKSUM 0x00000002
970 #define DEV_TX_OFFLOAD_UDP_CKSUM 0x00000004
971 #define DEV_TX_OFFLOAD_TCP_CKSUM 0x00000008
972 #define DEV_TX_OFFLOAD_SCTP_CKSUM 0x00000010
973 #define DEV_TX_OFFLOAD_TCP_TSO 0x00000020
974 #define DEV_TX_OFFLOAD_UDP_TSO 0x00000040
975 #define DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000080 /**< Used for tunneling packet. */
976 #define DEV_TX_OFFLOAD_QINQ_INSERT 0x00000100
977 #define DEV_TX_OFFLOAD_VXLAN_TNL_TSO 0x00000200 /**< Used for tunneling packet. */
978 #define DEV_TX_OFFLOAD_GRE_TNL_TSO 0x00000400 /**< Used for tunneling packet. */
979 #define DEV_TX_OFFLOAD_IPIP_TNL_TSO 0x00000800 /**< Used for tunneling packet. */
980 #define DEV_TX_OFFLOAD_GENEVE_TNL_TSO 0x00001000 /**< Used for tunneling packet. */
981 #define DEV_TX_OFFLOAD_MACSEC_INSERT 0x00002000
982 #define DEV_TX_OFFLOAD_MT_LOCKFREE 0x00004000
983 /**< Multiple threads can invoke rte_eth_tx_burst() concurrently on the same
984 * tx queue without SW lock.
986 #define DEV_TX_OFFLOAD_MULTI_SEGS 0x00008000
987 /**< Device supports multi segment send. */
988 #define DEV_TX_OFFLOAD_MBUF_FAST_FREE 0x00010000
989 /**< Device supports optimization for fast release of mbufs.
990 * When set application must guarantee that per-queue all mbufs comes from
991 * the same mempool and has refcnt = 1.
993 #define DEV_TX_OFFLOAD_SECURITY 0x00020000
995 * Device supports generic UDP tunneled packet TSO.
996 * Application must set PKT_TX_TUNNEL_UDP and other mbuf fields required
999 #define DEV_TX_OFFLOAD_UDP_TNL_TSO 0x00040000
1001 * Device supports generic IP tunneled packet TSO.
1002 * Application must set PKT_TX_TUNNEL_IP and other mbuf fields required
1005 #define DEV_TX_OFFLOAD_IP_TNL_TSO 0x00080000
1007 #define RTE_ETH_DEV_CAPA_RUNTIME_RX_QUEUE_SETUP 0x00000001
1008 /**< Device supports Rx queue setup after device started*/
1009 #define RTE_ETH_DEV_CAPA_RUNTIME_TX_QUEUE_SETUP 0x00000002
1010 /**< Device supports Tx queue setup after device started*/
1013 * If new Tx offload capabilities are defined, they also must be
1014 * mentioned in rte_tx_offload_names in rte_ethdev.c file.
1017 struct rte_pci_device;
1020 * Fallback default preferred Rx/Tx port parameters.
1021 * These are used if an application requests default parameters
1022 * but the PMD does not provide preferred values.
1024 #define RTE_ETH_DEV_FALLBACK_RX_RINGSIZE 512
1025 #define RTE_ETH_DEV_FALLBACK_TX_RINGSIZE 512
1026 #define RTE_ETH_DEV_FALLBACK_RX_NBQUEUES 1
1027 #define RTE_ETH_DEV_FALLBACK_TX_NBQUEUES 1
1030 * Preferred Rx/Tx port parameters.
1031 * There are separate instances of this structure for transmission
1032 * and reception respectively.
1034 struct rte_eth_dev_portconf {
1035 uint16_t burst_size; /**< Device-preferred burst size */
1036 uint16_t ring_size; /**< Device-preferred size of queue rings */
1037 uint16_t nb_queues; /**< Device-preferred number of queues */
1041 * Default values for switch domain id when ethdev does not support switch
1042 * domain definitions.
1044 #define RTE_ETH_DEV_SWITCH_DOMAIN_ID_INVALID (0)
1047 * Ethernet device associated switch information
1049 struct rte_eth_switch_info {
1050 const char *name; /**< switch name */
1051 uint16_t domain_id; /**< switch domain id */
1054 * mapping to the devices physical switch port as enumerated from the
1055 * perspective of the embedded interconnect/switch. For SR-IOV enabled
1056 * device this may correspond to the VF_ID of each virtual function,
1057 * but each driver should explicitly define the mapping of switch
1058 * port identifier to that physical interconnect/switch
1063 * Ethernet device information
1065 struct rte_eth_dev_info {
1066 struct rte_device *device; /** Generic device information */
1067 const char *driver_name; /**< Device Driver name. */
1068 unsigned int if_index; /**< Index to bound host interface, or 0 if none.
1069 Use if_indextoname() to translate into an interface name. */
1070 const uint32_t *dev_flags; /**< Device flags */
1071 uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
1072 uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
1073 uint16_t max_rx_queues; /**< Maximum number of RX queues. */
1074 uint16_t max_tx_queues; /**< Maximum number of TX queues. */
1075 uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
1076 uint32_t max_hash_mac_addrs;
1077 /** Maximum number of hash MAC addresses for MTA and UTA. */
1078 uint16_t max_vfs; /**< Maximum number of VFs. */
1079 uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
1080 uint64_t rx_offload_capa;
1081 /**< All RX offload capabilities including all per-queue ones */
1082 uint64_t tx_offload_capa;
1083 /**< All TX offload capabilities including all per-queue ones */
1084 uint64_t rx_queue_offload_capa;
1085 /**< Device per-queue RX offload capabilities. */
1086 uint64_t tx_queue_offload_capa;
1087 /**< Device per-queue TX offload capabilities. */
1089 /**< Device redirection table size, the total number of entries. */
1090 uint8_t hash_key_size; /**< Hash key size in bytes */
1091 /** Bit mask of RSS offloads, the bit offset also means flow type */
1092 uint64_t flow_type_rss_offloads;
1093 struct rte_eth_rxconf default_rxconf; /**< Default RX configuration */
1094 struct rte_eth_txconf default_txconf; /**< Default TX configuration */
1095 uint16_t vmdq_queue_base; /**< First queue ID for VMDQ pools. */
1096 uint16_t vmdq_queue_num; /**< Queue number for VMDQ pools. */
1097 uint16_t vmdq_pool_base; /**< First ID of VMDQ pools. */
1098 struct rte_eth_desc_lim rx_desc_lim; /**< RX descriptors limits */
1099 struct rte_eth_desc_lim tx_desc_lim; /**< TX descriptors limits */
1100 uint32_t speed_capa; /**< Supported speeds bitmap (ETH_LINK_SPEED_). */
1101 /** Configured number of rx/tx queues */
1102 uint16_t nb_rx_queues; /**< Number of RX queues. */
1103 uint16_t nb_tx_queues; /**< Number of TX queues. */
1104 /** Rx parameter recommendations */
1105 struct rte_eth_dev_portconf default_rxportconf;
1106 /** Tx parameter recommendations */
1107 struct rte_eth_dev_portconf default_txportconf;
1108 /** Generic device capabilities (RTE_ETH_DEV_CAPA_). */
1111 * Switching information for ports on a device with a
1112 * embedded managed interconnect/switch.
1114 struct rte_eth_switch_info switch_info;
1118 * Ethernet device RX queue information structure.
1119 * Used to retieve information about configured queue.
1121 struct rte_eth_rxq_info {
1122 struct rte_mempool *mp; /**< mempool used by that queue. */
1123 struct rte_eth_rxconf conf; /**< queue config parameters. */
1124 uint8_t scattered_rx; /**< scattered packets RX supported. */
1125 uint16_t nb_desc; /**< configured number of RXDs. */
1126 } __rte_cache_min_aligned;
1129 * Ethernet device TX queue information structure.
1130 * Used to retrieve information about configured queue.
1132 struct rte_eth_txq_info {
1133 struct rte_eth_txconf conf; /**< queue config parameters. */
1134 uint16_t nb_desc; /**< configured number of TXDs. */
1135 } __rte_cache_min_aligned;
1137 /** Maximum name length for extended statistics counters */
1138 #define RTE_ETH_XSTATS_NAME_SIZE 64
1141 * An Ethernet device extended statistic structure
1143 * This structure is used by rte_eth_xstats_get() to provide
1144 * statistics that are not provided in the generic *rte_eth_stats*
1146 * It maps a name id, corresponding to an index in the array returned
1147 * by rte_eth_xstats_get_names(), to a statistic value.
1149 struct rte_eth_xstat {
1150 uint64_t id; /**< The index in xstats name array. */
1151 uint64_t value; /**< The statistic counter value. */
1155 * A name element for extended statistics.
1157 * An array of this structure is returned by rte_eth_xstats_get_names().
1158 * It lists the names of extended statistics for a PMD. The *rte_eth_xstat*
1159 * structure references these names by their array index.
1161 struct rte_eth_xstat_name {
1162 char name[RTE_ETH_XSTATS_NAME_SIZE]; /**< The statistic name. */
1165 #define ETH_DCB_NUM_TCS 8
1166 #define ETH_MAX_VMDQ_POOL 64
1169 * A structure used to get the information of queue and
1170 * TC mapping on both TX and RX paths.
1172 struct rte_eth_dcb_tc_queue_mapping {
1173 /** rx queues assigned to tc per Pool */
1177 } tc_rxq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
1178 /** rx queues assigned to tc per Pool */
1182 } tc_txq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
1186 * A structure used to get the information of DCB.
1187 * It includes TC UP mapping and queue TC mapping.
1189 struct rte_eth_dcb_info {
1190 uint8_t nb_tcs; /**< number of TCs */
1191 uint8_t prio_tc[ETH_DCB_NUM_USER_PRIORITIES]; /**< Priority to tc */
1192 uint8_t tc_bws[ETH_DCB_NUM_TCS]; /**< TX BW percentage for each TC */
1193 /** rx queues assigned to tc */
1194 struct rte_eth_dcb_tc_queue_mapping tc_queue;
1198 * RX/TX queue states
1200 #define RTE_ETH_QUEUE_STATE_STOPPED 0
1201 #define RTE_ETH_QUEUE_STATE_STARTED 1
1203 #define RTE_ETH_ALL RTE_MAX_ETHPORTS
1205 /* Macros to check for valid port */
1206 #define RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, retval) do { \
1207 if (!rte_eth_dev_is_valid_port(port_id)) { \
1208 RTE_ETHDEV_LOG(ERR, "Invalid port_id=%u\n", port_id); \
1213 #define RTE_ETH_VALID_PORTID_OR_RET(port_id) do { \
1214 if (!rte_eth_dev_is_valid_port(port_id)) { \
1215 RTE_ETHDEV_LOG(ERR, "Invalid port_id=%u\n", port_id); \
1221 * l2 tunnel configuration.
1224 /**< l2 tunnel enable mask */
1225 #define ETH_L2_TUNNEL_ENABLE_MASK 0x00000001
1226 /**< l2 tunnel insertion mask */
1227 #define ETH_L2_TUNNEL_INSERTION_MASK 0x00000002
1228 /**< l2 tunnel stripping mask */
1229 #define ETH_L2_TUNNEL_STRIPPING_MASK 0x00000004
1230 /**< l2 tunnel forwarding mask */
1231 #define ETH_L2_TUNNEL_FORWARDING_MASK 0x00000008
1234 * Function type used for RX packet processing packet callbacks.
1236 * The callback function is called on RX with a burst of packets that have
1237 * been received on the given port and queue.
1240 * The Ethernet port on which RX is being performed.
1242 * The queue on the Ethernet port which is being used to receive the packets.
1244 * The burst of packets that have just been received.
1246 * The number of packets in the burst pointed to by "pkts".
1248 * The max number of packets that can be stored in the "pkts" array.
1250 * The arbitrary user parameter passed in by the application when the callback
1251 * was originally configured.
1253 * The number of packets returned to the user.
1255 typedef uint16_t (*rte_rx_callback_fn)(uint16_t port_id, uint16_t queue,
1256 struct rte_mbuf *pkts[], uint16_t nb_pkts, uint16_t max_pkts,
1260 * Function type used for TX packet processing packet callbacks.
1262 * The callback function is called on TX with a burst of packets immediately
1263 * before the packets are put onto the hardware queue for transmission.
1266 * The Ethernet port on which TX is being performed.
1268 * The queue on the Ethernet port which is being used to transmit the packets.
1270 * The burst of packets that are about to be transmitted.
1272 * The number of packets in the burst pointed to by "pkts".
1274 * The arbitrary user parameter passed in by the application when the callback
1275 * was originally configured.
1277 * The number of packets to be written to the NIC.
1279 typedef uint16_t (*rte_tx_callback_fn)(uint16_t port_id, uint16_t queue,
1280 struct rte_mbuf *pkts[], uint16_t nb_pkts, void *user_param);
1283 * Possible states of an ethdev port.
1285 enum rte_eth_dev_state {
1286 /** Device is unused before being probed. */
1287 RTE_ETH_DEV_UNUSED = 0,
1288 /** Device is attached when allocated in probing. */
1289 RTE_ETH_DEV_ATTACHED,
1290 /** The deferred state is useless and replaced by ownership. */
1291 RTE_ETH_DEV_DEFERRED,
1292 /** Device is in removed state when plug-out is detected. */
1293 RTE_ETH_DEV_REMOVED,
1296 struct rte_eth_dev_sriov {
1297 uint8_t active; /**< SRIOV is active with 16, 32 or 64 pools */
1298 uint8_t nb_q_per_pool; /**< rx queue number per pool */
1299 uint16_t def_vmdq_idx; /**< Default pool num used for PF */
1300 uint16_t def_pool_q_idx; /**< Default pool queue start reg index */
1302 #define RTE_ETH_DEV_SRIOV(dev) ((dev)->data->sriov)
1304 #define RTE_ETH_NAME_MAX_LEN RTE_DEV_NAME_MAX_LEN
1306 #define RTE_ETH_DEV_NO_OWNER 0
1308 #define RTE_ETH_MAX_OWNER_NAME_LEN 64
1310 struct rte_eth_dev_owner {
1311 uint64_t id; /**< The owner unique identifier. */
1312 char name[RTE_ETH_MAX_OWNER_NAME_LEN]; /**< The owner name. */
1315 /** Device supports link state interrupt */
1316 #define RTE_ETH_DEV_INTR_LSC 0x0002
1317 /** Device is a bonded slave */
1318 #define RTE_ETH_DEV_BONDED_SLAVE 0x0004
1319 /** Device supports device removal interrupt */
1320 #define RTE_ETH_DEV_INTR_RMV 0x0008
1321 /** Device is port representor */
1322 #define RTE_ETH_DEV_REPRESENTOR 0x0010
1325 * Iterates over valid ethdev ports owned by a specific owner.
1328 * The id of the next possible valid owned port.
1330 * The owner identifier.
1331 * RTE_ETH_DEV_NO_OWNER means iterate over all valid ownerless ports.
1333 * Next valid port id owned by owner_id, RTE_MAX_ETHPORTS if there is none.
1335 uint64_t rte_eth_find_next_owned_by(uint16_t port_id,
1336 const uint64_t owner_id);
1339 * Macro to iterate over all enabled ethdev ports owned by a specific owner.
1341 #define RTE_ETH_FOREACH_DEV_OWNED_BY(p, o) \
1342 for (p = rte_eth_find_next_owned_by(0, o); \
1343 (unsigned int)p < (unsigned int)RTE_MAX_ETHPORTS; \
1344 p = rte_eth_find_next_owned_by(p + 1, o))
1347 * Iterates over valid ethdev ports.
1350 * The id of the next possible valid port.
1352 * Next valid port id, RTE_MAX_ETHPORTS if there is none.
1354 uint16_t rte_eth_find_next(uint16_t port_id);
1357 * Macro to iterate over all enabled and ownerless ethdev ports.
1359 #define RTE_ETH_FOREACH_DEV(p) \
1360 RTE_ETH_FOREACH_DEV_OWNED_BY(p, RTE_ETH_DEV_NO_OWNER)
1365 * @b EXPERIMENTAL: this API may change without prior notice.
1367 * Get a new unique owner identifier.
1368 * An owner identifier is used to owns Ethernet devices by only one DPDK entity
1369 * to avoid multiple management of device by different entities.
1372 * Owner identifier pointer.
1374 * Negative errno value on error, 0 on success.
1376 int __rte_experimental rte_eth_dev_owner_new(uint64_t *owner_id);
1380 * @b EXPERIMENTAL: this API may change without prior notice.
1382 * Set an Ethernet device owner.
1385 * The identifier of the port to own.
1387 * The owner pointer.
1389 * Negative errno value on error, 0 on success.
1391 int __rte_experimental rte_eth_dev_owner_set(const uint16_t port_id,
1392 const struct rte_eth_dev_owner *owner);
1396 * @b EXPERIMENTAL: this API may change without prior notice.
1398 * Unset Ethernet device owner to make the device ownerless.
1401 * The identifier of port to make ownerless.
1403 * The owner identifier.
1405 * 0 on success, negative errno value on error.
1407 int __rte_experimental rte_eth_dev_owner_unset(const uint16_t port_id,
1408 const uint64_t owner_id);
1412 * @b EXPERIMENTAL: this API may change without prior notice.
1414 * Remove owner from all Ethernet devices owned by a specific owner.
1417 * The owner identifier.
1419 void __rte_experimental rte_eth_dev_owner_delete(const uint64_t owner_id);
1423 * @b EXPERIMENTAL: this API may change without prior notice.
1425 * Get the owner of an Ethernet device.
1428 * The port identifier.
1430 * The owner structure pointer to fill.
1432 * 0 on success, negative errno value on error..
1434 int __rte_experimental rte_eth_dev_owner_get(const uint16_t port_id,
1435 struct rte_eth_dev_owner *owner);
1438 * Get the total number of Ethernet devices that have been successfully
1439 * initialized by the matching Ethernet driver during the PCI probing phase
1440 * and that are available for applications to use. These devices must be
1441 * accessed by using the ``RTE_ETH_FOREACH_DEV()`` macro to deal with
1442 * non-contiguous ranges of devices.
1443 * These non-contiguous ranges can be created by calls to hotplug functions or
1447 * - The total number of usable Ethernet devices.
1450 uint16_t rte_eth_dev_count(void);
1453 * Get the number of ports which are usable for the application.
1455 * These devices must be iterated by using the macro
1456 * ``RTE_ETH_FOREACH_DEV`` or ``RTE_ETH_FOREACH_DEV_OWNED_BY``
1457 * to deal with non-contiguous ranges of devices.
1460 * The count of available Ethernet devices.
1462 uint16_t rte_eth_dev_count_avail(void);
1465 * Get the total number of ports which are allocated.
1467 * Some devices may not be available for the application.
1470 * The total count of Ethernet devices.
1472 uint16_t __rte_experimental rte_eth_dev_count_total(void);
1475 * Attach a new Ethernet device specified by arguments.
1478 * A pointer to a strings array describing the new device
1479 * to be attached. The strings should be a pci address like
1480 * '0000:01:00.0' or virtual device name like 'net_pcap0'.
1482 * A pointer to a port identifier actually attached.
1484 * 0 on success and port_id is filled, negative on error
1486 int rte_eth_dev_attach(const char *devargs, uint16_t *port_id);
1489 * Detach a Ethernet device specified by port identifier.
1490 * This function must be called when the device is in the
1494 * The port identifier of the device to detach.
1496 * A pointer to a buffer that will be filled with the device name.
1497 * This buffer must be at least RTE_DEV_NAME_MAX_LEN long.
1499 * 0 on success and devname is filled, negative on error
1501 int rte_eth_dev_detach(uint16_t port_id, char *devname);
1504 * Convert a numerical speed in Mbps to a bitmap flag that can be used in
1505 * the bitmap link_speeds of the struct rte_eth_conf
1508 * Numerical speed value in Mbps
1510 * ETH_LINK_[HALF/FULL]_DUPLEX (only for 10/100M speeds)
1512 * 0 if the speed cannot be mapped
1514 uint32_t rte_eth_speed_bitflag(uint32_t speed, int duplex);
1518 * @b EXPERIMENTAL: this API may change without prior notice
1520 * Get DEV_RX_OFFLOAD_* flag name.
1525 * Offload name or 'UNKNOWN' if the flag cannot be recognised.
1527 const char * __rte_experimental rte_eth_dev_rx_offload_name(uint64_t offload);
1531 * @b EXPERIMENTAL: this API may change without prior notice
1533 * Get DEV_TX_OFFLOAD_* flag name.
1538 * Offload name or 'UNKNOWN' if the flag cannot be recognised.
1540 const char * __rte_experimental rte_eth_dev_tx_offload_name(uint64_t offload);
1543 * Configure an Ethernet device.
1544 * This function must be invoked first before any other function in the
1545 * Ethernet API. This function can also be re-invoked when a device is in the
1549 * The port identifier of the Ethernet device to configure.
1550 * @param nb_rx_queue
1551 * The number of receive queues to set up for the Ethernet device.
1552 * @param nb_tx_queue
1553 * The number of transmit queues to set up for the Ethernet device.
1555 * The pointer to the configuration data to be used for the Ethernet device.
1556 * The *rte_eth_conf* structure includes:
1557 * - the hardware offload features to activate, with dedicated fields for
1558 * each statically configurable offload hardware feature provided by
1559 * Ethernet devices, such as IP checksum or VLAN tag stripping for
1561 * The Rx offload bitfield API is obsolete and will be deprecated.
1562 * Applications should set the ignore_bitfield_offloads bit on *rxmode*
1563 * structure and use offloads field to set per-port offloads instead.
1564 * - Any offloading set in eth_conf->[rt]xmode.offloads must be within
1565 * the [rt]x_offload_capa returned from rte_eth_dev_infos_get().
1566 * Any type of device supported offloading set in the input argument
1567 * eth_conf->[rt]xmode.offloads to rte_eth_dev_configure() is enabled
1568 * on all queues and it can't be disabled in rte_eth_[rt]x_queue_setup().
1569 * - the Receive Side Scaling (RSS) configuration when using multiple RX
1572 * Embedding all configuration information in a single data structure
1573 * is the more flexible method that allows the addition of new features
1574 * without changing the syntax of the API.
1576 * - 0: Success, device configured.
1577 * - <0: Error code returned by the driver configuration function.
1579 int rte_eth_dev_configure(uint16_t port_id, uint16_t nb_rx_queue,
1580 uint16_t nb_tx_queue, const struct rte_eth_conf *eth_conf);
1584 * @b EXPERIMENTAL: this API may change without prior notice.
1586 * Check if an Ethernet device was physically removed.
1589 * The port identifier of the Ethernet device.
1591 * 1 when the Ethernet device is removed, otherwise 0.
1593 int __rte_experimental
1594 rte_eth_dev_is_removed(uint16_t port_id);
1597 * Allocate and set up a receive queue for an Ethernet device.
1599 * The function allocates a contiguous block of memory for *nb_rx_desc*
1600 * receive descriptors from a memory zone associated with *socket_id*
1601 * and initializes each receive descriptor with a network buffer allocated
1602 * from the memory pool *mb_pool*.
1605 * The port identifier of the Ethernet device.
1606 * @param rx_queue_id
1607 * The index of the receive queue to set up.
1608 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1609 * to rte_eth_dev_configure().
1611 * The number of receive descriptors to allocate for the receive ring.
1613 * The *socket_id* argument is the socket identifier in case of NUMA.
1614 * The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1615 * the DMA memory allocated for the receive descriptors of the ring.
1617 * The pointer to the configuration data to be used for the receive queue.
1618 * NULL value is allowed, in which case default RX configuration
1620 * The *rx_conf* structure contains an *rx_thresh* structure with the values
1621 * of the Prefetch, Host, and Write-Back threshold registers of the receive
1623 * In addition it contains the hardware offloads features to activate using
1624 * the DEV_RX_OFFLOAD_* flags.
1625 * If an offloading set in rx_conf->offloads
1626 * hasn't been set in the input argument eth_conf->rxmode.offloads
1627 * to rte_eth_dev_configure(), it is a new added offloading, it must be
1628 * per-queue type and it is enabled for the queue.
1629 * No need to repeat any bit in rx_conf->offloads which has already been
1630 * enabled in rte_eth_dev_configure() at port level. An offloading enabled
1631 * at port level can't be disabled at queue level.
1633 * The pointer to the memory pool from which to allocate *rte_mbuf* network
1634 * memory buffers to populate each descriptor of the receive ring.
1636 * - 0: Success, receive queue correctly set up.
1637 * - -EIO: if device is removed.
1638 * - -EINVAL: The size of network buffers which can be allocated from the
1639 * memory pool does not fit the various buffer sizes allowed by the
1640 * device controller.
1641 * - -ENOMEM: Unable to allocate the receive ring descriptors or to
1642 * allocate network memory buffers from the memory pool when
1643 * initializing receive descriptors.
1645 int rte_eth_rx_queue_setup(uint16_t port_id, uint16_t rx_queue_id,
1646 uint16_t nb_rx_desc, unsigned int socket_id,
1647 const struct rte_eth_rxconf *rx_conf,
1648 struct rte_mempool *mb_pool);
1651 * Allocate and set up a transmit queue for an Ethernet device.
1654 * The port identifier of the Ethernet device.
1655 * @param tx_queue_id
1656 * The index of the transmit queue to set up.
1657 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1658 * to rte_eth_dev_configure().
1660 * The number of transmit descriptors to allocate for the transmit ring.
1662 * The *socket_id* argument is the socket identifier in case of NUMA.
1663 * Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1664 * the DMA memory allocated for the transmit descriptors of the ring.
1666 * The pointer to the configuration data to be used for the transmit queue.
1667 * NULL value is allowed, in which case default TX configuration
1669 * The *tx_conf* structure contains the following data:
1670 * - The *tx_thresh* structure with the values of the Prefetch, Host, and
1671 * Write-Back threshold registers of the transmit ring.
1672 * When setting Write-Back threshold to the value greater then zero,
1673 * *tx_rs_thresh* value should be explicitly set to one.
1674 * - The *tx_free_thresh* value indicates the [minimum] number of network
1675 * buffers that must be pending in the transmit ring to trigger their
1676 * [implicit] freeing by the driver transmit function.
1677 * - The *tx_rs_thresh* value indicates the [minimum] number of transmit
1678 * descriptors that must be pending in the transmit ring before setting the
1679 * RS bit on a descriptor by the driver transmit function.
1680 * The *tx_rs_thresh* value should be less or equal then
1681 * *tx_free_thresh* value, and both of them should be less then
1683 * - The *txq_flags* member contains flags to pass to the TX queue setup
1684 * function to configure the behavior of the TX queue. This should be set
1685 * to 0 if no special configuration is required.
1686 * This API is obsolete and will be deprecated. Applications
1687 * should set it to ETH_TXQ_FLAGS_IGNORE and use
1688 * the offloads field below.
1689 * - The *offloads* member contains Tx offloads to be enabled.
1690 * If an offloading set in tx_conf->offloads
1691 * hasn't been set in the input argument eth_conf->txmode.offloads
1692 * to rte_eth_dev_configure(), it is a new added offloading, it must be
1693 * per-queue type and it is enabled for the queue.
1694 * No need to repeat any bit in tx_conf->offloads which has already been
1695 * enabled in rte_eth_dev_configure() at port level. An offloading enabled
1696 * at port level can't be disabled at queue level.
1698 * Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces
1699 * the transmit function to use default values.
1701 * - 0: Success, the transmit queue is correctly set up.
1702 * - -ENOMEM: Unable to allocate the transmit ring descriptors.
1704 int rte_eth_tx_queue_setup(uint16_t port_id, uint16_t tx_queue_id,
1705 uint16_t nb_tx_desc, unsigned int socket_id,
1706 const struct rte_eth_txconf *tx_conf);
1709 * Return the NUMA socket to which an Ethernet device is connected
1712 * The port identifier of the Ethernet device
1714 * The NUMA socket id to which the Ethernet device is connected or
1715 * a default of zero if the socket could not be determined.
1716 * -1 is returned is the port_id value is out of range.
1718 int rte_eth_dev_socket_id(uint16_t port_id);
1721 * Check if port_id of device is attached
1724 * The port identifier of the Ethernet device
1726 * - 0 if port is out of range or not attached
1727 * - 1 if device is attached
1729 int rte_eth_dev_is_valid_port(uint16_t port_id);
1732 * Start specified RX queue of a port. It is used when rx_deferred_start
1733 * flag of the specified queue is true.
1736 * The port identifier of the Ethernet device
1737 * @param rx_queue_id
1738 * The index of the rx queue to update the ring.
1739 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1740 * to rte_eth_dev_configure().
1742 * - 0: Success, the receive queue is started.
1743 * - -EINVAL: The port_id or the queue_id out of range.
1744 * - -EIO: if device is removed.
1745 * - -ENOTSUP: The function not supported in PMD driver.
1747 int rte_eth_dev_rx_queue_start(uint16_t port_id, uint16_t rx_queue_id);
1750 * Stop specified RX queue of a port
1753 * The port identifier of the Ethernet device
1754 * @param rx_queue_id
1755 * The index of the rx queue to update the ring.
1756 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1757 * to rte_eth_dev_configure().
1759 * - 0: Success, the receive queue is stopped.
1760 * - -EINVAL: The port_id or the queue_id out of range.
1761 * - -EIO: if device is removed.
1762 * - -ENOTSUP: The function not supported in PMD driver.
1764 int rte_eth_dev_rx_queue_stop(uint16_t port_id, uint16_t rx_queue_id);
1767 * Start TX for specified queue of a port. It is used when tx_deferred_start
1768 * flag of the specified queue is true.
1771 * The port identifier of the Ethernet device
1772 * @param tx_queue_id
1773 * The index of the tx queue to update the ring.
1774 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1775 * to rte_eth_dev_configure().
1777 * - 0: Success, the transmit queue is started.
1778 * - -EINVAL: The port_id or the queue_id out of range.
1779 * - -EIO: if device is removed.
1780 * - -ENOTSUP: The function not supported in PMD driver.
1782 int rte_eth_dev_tx_queue_start(uint16_t port_id, uint16_t tx_queue_id);
1785 * Stop specified TX queue of a port
1788 * The port identifier of the Ethernet device
1789 * @param tx_queue_id
1790 * The index of the tx queue to update the ring.
1791 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1792 * to rte_eth_dev_configure().
1794 * - 0: Success, the transmit queue is stopped.
1795 * - -EINVAL: The port_id or the queue_id out of range.
1796 * - -EIO: if device is removed.
1797 * - -ENOTSUP: The function not supported in PMD driver.
1799 int rte_eth_dev_tx_queue_stop(uint16_t port_id, uint16_t tx_queue_id);
1802 * Start an Ethernet device.
1804 * The device start step is the last one and consists of setting the configured
1805 * offload features and in starting the transmit and the receive units of the
1807 * On success, all basic functions exported by the Ethernet API (link status,
1808 * receive/transmit, and so on) can be invoked.
1811 * The port identifier of the Ethernet device.
1813 * - 0: Success, Ethernet device started.
1814 * - <0: Error code of the driver device start function.
1816 int rte_eth_dev_start(uint16_t port_id);
1819 * Stop an Ethernet device. The device can be restarted with a call to
1820 * rte_eth_dev_start()
1823 * The port identifier of the Ethernet device.
1825 void rte_eth_dev_stop(uint16_t port_id);
1828 * Link up an Ethernet device.
1830 * Set device link up will re-enable the device rx/tx
1831 * functionality after it is previously set device linked down.
1834 * The port identifier of the Ethernet device.
1836 * - 0: Success, Ethernet device linked up.
1837 * - <0: Error code of the driver device link up function.
1839 int rte_eth_dev_set_link_up(uint16_t port_id);
1842 * Link down an Ethernet device.
1843 * The device rx/tx functionality will be disabled if success,
1844 * and it can be re-enabled with a call to
1845 * rte_eth_dev_set_link_up()
1848 * The port identifier of the Ethernet device.
1850 int rte_eth_dev_set_link_down(uint16_t port_id);
1853 * Close a stopped Ethernet device. The device cannot be restarted!
1854 * The function frees all resources except for needed by the
1855 * closed state. To free these resources, call rte_eth_dev_detach().
1858 * The port identifier of the Ethernet device.
1860 void rte_eth_dev_close(uint16_t port_id);
1863 * Reset a Ethernet device and keep its port id.
1865 * When a port has to be reset passively, the DPDK application can invoke
1866 * this function. For example when a PF is reset, all its VFs should also
1867 * be reset. Normally a DPDK application can invoke this function when
1868 * RTE_ETH_EVENT_INTR_RESET event is detected, but can also use it to start
1869 * a port reset in other circumstances.
1871 * When this function is called, it first stops the port and then calls the
1872 * PMD specific dev_uninit( ) and dev_init( ) to return the port to initial
1873 * state, in which no Tx and Rx queues are setup, as if the port has been
1874 * reset and not started. The port keeps the port id it had before the
1877 * After calling rte_eth_dev_reset( ), the application should use
1878 * rte_eth_dev_configure( ), rte_eth_rx_queue_setup( ),
1879 * rte_eth_tx_queue_setup( ), and rte_eth_dev_start( )
1880 * to reconfigure the device as appropriate.
1882 * Note: To avoid unexpected behavior, the application should stop calling
1883 * Tx and Rx functions before calling rte_eth_dev_reset( ). For thread
1884 * safety, all these controlling functions should be called from the same
1888 * The port identifier of the Ethernet device.
1891 * - (0) if successful.
1892 * - (-EINVAL) if port identifier is invalid.
1893 * - (-ENOTSUP) if hardware doesn't support this function.
1894 * - (-EPERM) if not ran from the primary process.
1895 * - (-EIO) if re-initialisation failed or device is removed.
1896 * - (-ENOMEM) if the reset failed due to OOM.
1897 * - (-EAGAIN) if the reset temporarily failed and should be retried later.
1899 int rte_eth_dev_reset(uint16_t port_id);
1902 * Enable receipt in promiscuous mode for an Ethernet device.
1905 * The port identifier of the Ethernet device.
1907 void rte_eth_promiscuous_enable(uint16_t port_id);
1910 * Disable receipt in promiscuous mode for an Ethernet device.
1913 * The port identifier of the Ethernet device.
1915 void rte_eth_promiscuous_disable(uint16_t port_id);
1918 * Return the value of promiscuous mode for an Ethernet device.
1921 * The port identifier of the Ethernet device.
1923 * - (1) if promiscuous is enabled
1924 * - (0) if promiscuous is disabled.
1927 int rte_eth_promiscuous_get(uint16_t port_id);
1930 * Enable the receipt of any multicast frame by an Ethernet device.
1933 * The port identifier of the Ethernet device.
1935 void rte_eth_allmulticast_enable(uint16_t port_id);
1938 * Disable the receipt of all multicast frames by an Ethernet device.
1941 * The port identifier of the Ethernet device.
1943 void rte_eth_allmulticast_disable(uint16_t port_id);
1946 * Return the value of allmulticast mode for an Ethernet device.
1949 * The port identifier of the Ethernet device.
1951 * - (1) if allmulticast is enabled
1952 * - (0) if allmulticast is disabled.
1955 int rte_eth_allmulticast_get(uint16_t port_id);
1958 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
1959 * or FULL-DUPLEX) of the physical link of an Ethernet device. It might need
1960 * to wait up to 9 seconds in it.
1963 * The port identifier of the Ethernet device.
1965 * A pointer to an *rte_eth_link* structure to be filled with
1966 * the status, the speed and the mode of the Ethernet device link.
1968 void rte_eth_link_get(uint16_t port_id, struct rte_eth_link *link);
1971 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
1972 * or FULL-DUPLEX) of the physical link of an Ethernet device. It is a no-wait
1973 * version of rte_eth_link_get().
1976 * The port identifier of the Ethernet device.
1978 * A pointer to an *rte_eth_link* structure to be filled with
1979 * the status, the speed and the mode of the Ethernet device link.
1981 void rte_eth_link_get_nowait(uint16_t port_id, struct rte_eth_link *link);
1984 * Retrieve the general I/O statistics of an Ethernet device.
1987 * The port identifier of the Ethernet device.
1989 * A pointer to a structure of type *rte_eth_stats* to be filled with
1990 * the values of device counters for the following set of statistics:
1991 * - *ipackets* with the total of successfully received packets.
1992 * - *opackets* with the total of successfully transmitted packets.
1993 * - *ibytes* with the total of successfully received bytes.
1994 * - *obytes* with the total of successfully transmitted bytes.
1995 * - *ierrors* with the total of erroneous received packets.
1996 * - *oerrors* with the total of failed transmitted packets.
1998 * Zero if successful. Non-zero otherwise.
2000 int rte_eth_stats_get(uint16_t port_id, struct rte_eth_stats *stats);
2003 * Reset the general I/O statistics of an Ethernet device.
2006 * The port identifier of the Ethernet device.
2008 * - (0) if device notified to reset stats.
2009 * - (-ENOTSUP) if hardware doesn't support.
2010 * - (-ENODEV) if *port_id* invalid.
2012 int rte_eth_stats_reset(uint16_t port_id);
2015 * Retrieve names of extended statistics of an Ethernet device.
2017 * There is an assumption that 'xstat_names' and 'xstats' arrays are matched
2019 * xstats_names[i].name => xstats[i].value
2021 * And the array index is same with id field of 'struct rte_eth_xstat':
2024 * This assumption makes key-value pair matching less flexible but simpler.
2027 * The port identifier of the Ethernet device.
2028 * @param xstats_names
2029 * An rte_eth_xstat_name array of at least *size* elements to
2030 * be filled. If set to NULL, the function returns the required number
2033 * The size of the xstats_names array (number of elements).
2035 * - A positive value lower or equal to size: success. The return value
2036 * is the number of entries filled in the stats table.
2037 * - A positive value higher than size: error, the given statistics table
2038 * is too small. The return value corresponds to the size that should
2039 * be given to succeed. The entries in the table are not valid and
2040 * shall not be used by the caller.
2041 * - A negative value on error (invalid port id).
2043 int rte_eth_xstats_get_names(uint16_t port_id,
2044 struct rte_eth_xstat_name *xstats_names,
2048 * Retrieve extended statistics of an Ethernet device.
2050 * There is an assumption that 'xstat_names' and 'xstats' arrays are matched
2052 * xstats_names[i].name => xstats[i].value
2054 * And the array index is same with id field of 'struct rte_eth_xstat':
2057 * This assumption makes key-value pair matching less flexible but simpler.
2060 * The port identifier of the Ethernet device.
2062 * A pointer to a table of structure of type *rte_eth_xstat*
2063 * to be filled with device statistics ids and values.
2064 * This parameter can be set to NULL if n is 0.
2066 * The size of the xstats array (number of elements).
2068 * - A positive value lower or equal to n: success. The return value
2069 * is the number of entries filled in the stats table.
2070 * - A positive value higher than n: error, the given statistics table
2071 * is too small. The return value corresponds to the size that should
2072 * be given to succeed. The entries in the table are not valid and
2073 * shall not be used by the caller.
2074 * - A negative value on error (invalid port id).
2076 int rte_eth_xstats_get(uint16_t port_id, struct rte_eth_xstat *xstats,
2080 * Retrieve names of extended statistics of an Ethernet device.
2083 * The port identifier of the Ethernet device.
2084 * @param xstats_names
2085 * An rte_eth_xstat_name array of at least *size* elements to
2086 * be filled. If set to NULL, the function returns the required number
2089 * IDs array given by app to retrieve specific statistics
2091 * The size of the xstats_names array (number of elements).
2093 * - A positive value lower or equal to size: success. The return value
2094 * is the number of entries filled in the stats table.
2095 * - A positive value higher than size: error, the given statistics table
2096 * is too small. The return value corresponds to the size that should
2097 * be given to succeed. The entries in the table are not valid and
2098 * shall not be used by the caller.
2099 * - A negative value on error (invalid port id).
2102 rte_eth_xstats_get_names_by_id(uint16_t port_id,
2103 struct rte_eth_xstat_name *xstats_names, unsigned int size,
2107 * Retrieve extended statistics of an Ethernet device.
2110 * The port identifier of the Ethernet device.
2112 * A pointer to an ids array passed by application. This tells which
2113 * statistics values function should retrieve. This parameter
2114 * can be set to NULL if size is 0. In this case function will retrieve
2115 * all avalible statistics.
2117 * A pointer to a table to be filled with device statistics values.
2119 * The size of the ids array (number of elements).
2121 * - A positive value lower or equal to size: success. The return value
2122 * is the number of entries filled in the stats table.
2123 * - A positive value higher than size: error, the given statistics table
2124 * is too small. The return value corresponds to the size that should
2125 * be given to succeed. The entries in the table are not valid and
2126 * shall not be used by the caller.
2127 * - A negative value on error (invalid port id).
2129 int rte_eth_xstats_get_by_id(uint16_t port_id, const uint64_t *ids,
2130 uint64_t *values, unsigned int size);
2133 * Gets the ID of a statistic from its name.
2135 * This function searches for the statistics using string compares, and
2136 * as such should not be used on the fast-path. For fast-path retrieval of
2137 * specific statistics, store the ID as provided in *id* from this function,
2138 * and pass the ID to rte_eth_xstats_get()
2140 * @param port_id The port to look up statistics from
2141 * @param xstat_name The name of the statistic to return
2142 * @param[out] id A pointer to an app-supplied uint64_t which should be
2143 * set to the ID of the stat if the stat exists.
2146 * -ENODEV for invalid port_id,
2147 * -EIO if device is removed,
2148 * -EINVAL if the xstat_name doesn't exist in port_id
2150 int rte_eth_xstats_get_id_by_name(uint16_t port_id, const char *xstat_name,
2154 * Reset extended statistics of an Ethernet device.
2157 * The port identifier of the Ethernet device.
2159 void rte_eth_xstats_reset(uint16_t port_id);
2162 * Set a mapping for the specified transmit queue to the specified per-queue
2163 * statistics counter.
2166 * The port identifier of the Ethernet device.
2167 * @param tx_queue_id
2168 * The index of the transmit queue for which a queue stats mapping is required.
2169 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2170 * to rte_eth_dev_configure().
2172 * The per-queue packet statistics functionality number that the transmit
2173 * queue is to be assigned.
2174 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2176 * Zero if successful. Non-zero otherwise.
2178 int rte_eth_dev_set_tx_queue_stats_mapping(uint16_t port_id,
2179 uint16_t tx_queue_id, uint8_t stat_idx);
2182 * Set a mapping for the specified receive queue to the specified per-queue
2183 * statistics counter.
2186 * The port identifier of the Ethernet device.
2187 * @param rx_queue_id
2188 * The index of the receive queue for which a queue stats mapping is required.
2189 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2190 * to rte_eth_dev_configure().
2192 * The per-queue packet statistics functionality number that the receive
2193 * queue is to be assigned.
2194 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2196 * Zero if successful. Non-zero otherwise.
2198 int rte_eth_dev_set_rx_queue_stats_mapping(uint16_t port_id,
2199 uint16_t rx_queue_id,
2203 * Retrieve the Ethernet address of an Ethernet device.
2206 * The port identifier of the Ethernet device.
2208 * A pointer to a structure of type *ether_addr* to be filled with
2209 * the Ethernet address of the Ethernet device.
2211 void rte_eth_macaddr_get(uint16_t port_id, struct ether_addr *mac_addr);
2214 * Retrieve the contextual information of an Ethernet device.
2217 * The port identifier of the Ethernet device.
2219 * A pointer to a structure of type *rte_eth_dev_info* to be filled with
2220 * the contextual information of the Ethernet device.
2222 void rte_eth_dev_info_get(uint16_t port_id, struct rte_eth_dev_info *dev_info);
2225 * Retrieve the firmware version of a device.
2228 * The port identifier of the device.
2230 * A pointer to a string array storing the firmware version of a device,
2231 * the string includes terminating null. This pointer is allocated by caller.
2233 * The size of the string array pointed by fw_version, which should be
2234 * large enough to store firmware version of the device.
2236 * - (0) if successful.
2237 * - (-ENOTSUP) if operation is not supported.
2238 * - (-ENODEV) if *port_id* invalid.
2239 * - (-EIO) if device is removed.
2240 * - (>0) if *fw_size* is not enough to store firmware version, return
2241 * the size of the non truncated string.
2243 int rte_eth_dev_fw_version_get(uint16_t port_id,
2244 char *fw_version, size_t fw_size);
2247 * Retrieve the supported packet types of an Ethernet device.
2249 * When a packet type is announced as supported, it *must* be recognized by
2250 * the PMD. For instance, if RTE_PTYPE_L2_ETHER, RTE_PTYPE_L2_ETHER_VLAN
2251 * and RTE_PTYPE_L3_IPV4 are announced, the PMD must return the following
2252 * packet types for these packets:
2253 * - Ether/IPv4 -> RTE_PTYPE_L2_ETHER | RTE_PTYPE_L3_IPV4
2254 * - Ether/Vlan/IPv4 -> RTE_PTYPE_L2_ETHER_VLAN | RTE_PTYPE_L3_IPV4
2255 * - Ether/[anything else] -> RTE_PTYPE_L2_ETHER
2256 * - Ether/Vlan/[anything else] -> RTE_PTYPE_L2_ETHER_VLAN
2258 * When a packet is received by a PMD, the most precise type must be
2259 * returned among the ones supported. However a PMD is allowed to set
2260 * packet type that is not in the supported list, at the condition that it
2261 * is more precise. Therefore, a PMD announcing no supported packet types
2262 * can still set a matching packet type in a received packet.
2265 * Better to invoke this API after the device is already started or rx burst
2266 * function is decided, to obtain correct supported ptypes.
2268 * if a given PMD does not report what ptypes it supports, then the supported
2269 * ptype count is reported as 0.
2271 * The port identifier of the Ethernet device.
2273 * A hint of what kind of packet type which the caller is interested in.
2275 * An array pointer to store adequate packet types, allocated by caller.
2277 * Size of the array pointed by param ptypes.
2279 * - (>=0) Number of supported ptypes. If the number of types exceeds num,
2280 * only num entries will be filled into the ptypes array, but the full
2281 * count of supported ptypes will be returned.
2282 * - (-ENODEV) if *port_id* invalid.
2284 int rte_eth_dev_get_supported_ptypes(uint16_t port_id, uint32_t ptype_mask,
2285 uint32_t *ptypes, int num);
2288 * Retrieve the MTU of an Ethernet device.
2291 * The port identifier of the Ethernet device.
2293 * A pointer to a uint16_t where the retrieved MTU is to be stored.
2295 * - (0) if successful.
2296 * - (-ENODEV) if *port_id* invalid.
2298 int rte_eth_dev_get_mtu(uint16_t port_id, uint16_t *mtu);
2301 * Change the MTU of an Ethernet device.
2304 * The port identifier of the Ethernet device.
2306 * A uint16_t for the MTU to be applied.
2308 * - (0) if successful.
2309 * - (-ENOTSUP) if operation is not supported.
2310 * - (-ENODEV) if *port_id* invalid.
2311 * - (-EIO) if device is removed.
2312 * - (-EINVAL) if *mtu* invalid.
2313 * - (-EBUSY) if operation is not allowed when the port is running
2315 int rte_eth_dev_set_mtu(uint16_t port_id, uint16_t mtu);
2318 * Enable/Disable hardware filtering by an Ethernet device of received
2319 * VLAN packets tagged with a given VLAN Tag Identifier.
2322 * The port identifier of the Ethernet device.
2324 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
2326 * If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*.
2327 * Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*.
2329 * - (0) if successful.
2330 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2331 * - (-ENODEV) if *port_id* invalid.
2332 * - (-EIO) if device is removed.
2333 * - (-ENOSYS) if VLAN filtering on *port_id* disabled.
2334 * - (-EINVAL) if *vlan_id* > 4095.
2336 int rte_eth_dev_vlan_filter(uint16_t port_id, uint16_t vlan_id, int on);
2339 * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
2340 * 82599/X540/X550 can support VLAN stripping at the rx queue level
2343 * The port identifier of the Ethernet device.
2344 * @param rx_queue_id
2345 * The index of the receive queue for which a queue stats mapping is required.
2346 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2347 * to rte_eth_dev_configure().
2349 * If 1, Enable VLAN Stripping of the receive queue of the Ethernet port.
2350 * If 0, Disable VLAN Stripping of the receive queue of the Ethernet port.
2352 * - (0) if successful.
2353 * - (-ENOSUP) if hardware-assisted VLAN stripping not configured.
2354 * - (-ENODEV) if *port_id* invalid.
2355 * - (-EINVAL) if *rx_queue_id* invalid.
2357 int rte_eth_dev_set_vlan_strip_on_queue(uint16_t port_id, uint16_t rx_queue_id,
2361 * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
2362 * the VLAN Header. This is a register setup available on some Intel NIC, not
2363 * but all, please check the data sheet for availability.
2366 * The port identifier of the Ethernet device.
2370 * The Tag Protocol ID
2372 * - (0) if successful.
2373 * - (-ENOSUP) if hardware-assisted VLAN TPID setup is not supported.
2374 * - (-ENODEV) if *port_id* invalid.
2375 * - (-EIO) if device is removed.
2377 int rte_eth_dev_set_vlan_ether_type(uint16_t port_id,
2378 enum rte_vlan_type vlan_type,
2382 * Set VLAN offload configuration on an Ethernet device
2383 * Enable/Disable Extended VLAN by an Ethernet device, This is a register setup
2384 * available on some Intel NIC, not but all, please check the data sheet for
2386 * Enable/Disable VLAN Strip can be done on rx queue for certain NIC, but here
2387 * the configuration is applied on the port level.
2390 * The port identifier of the Ethernet device.
2391 * @param offload_mask
2392 * The VLAN Offload bit mask can be mixed use with "OR"
2393 * ETH_VLAN_STRIP_OFFLOAD
2394 * ETH_VLAN_FILTER_OFFLOAD
2395 * ETH_VLAN_EXTEND_OFFLOAD
2397 * - (0) if successful.
2398 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2399 * - (-ENODEV) if *port_id* invalid.
2400 * - (-EIO) if device is removed.
2402 int rte_eth_dev_set_vlan_offload(uint16_t port_id, int offload_mask);
2405 * Read VLAN Offload configuration from an Ethernet device
2408 * The port identifier of the Ethernet device.
2410 * - (>0) if successful. Bit mask to indicate
2411 * ETH_VLAN_STRIP_OFFLOAD
2412 * ETH_VLAN_FILTER_OFFLOAD
2413 * ETH_VLAN_EXTEND_OFFLOAD
2414 * - (-ENODEV) if *port_id* invalid.
2416 int rte_eth_dev_get_vlan_offload(uint16_t port_id);
2419 * Set port based TX VLAN insertion on or off.
2422 * The port identifier of the Ethernet device.
2424 * Port based TX VLAN identifier together with user priority.
2426 * Turn on or off the port based TX VLAN insertion.
2429 * - (0) if successful.
2430 * - negative if failed.
2432 int rte_eth_dev_set_vlan_pvid(uint16_t port_id, uint16_t pvid, int on);
2434 typedef void (*buffer_tx_error_fn)(struct rte_mbuf **unsent, uint16_t count,
2438 * Structure used to buffer packets for future TX
2439 * Used by APIs rte_eth_tx_buffer and rte_eth_tx_buffer_flush
2441 struct rte_eth_dev_tx_buffer {
2442 buffer_tx_error_fn error_callback;
2443 void *error_userdata;
2444 uint16_t size; /**< Size of buffer for buffered tx */
2445 uint16_t length; /**< Number of packets in the array */
2446 struct rte_mbuf *pkts[];
2447 /**< Pending packets to be sent on explicit flush or when full */
2451 * Calculate the size of the tx buffer.
2454 * Number of stored packets.
2456 #define RTE_ETH_TX_BUFFER_SIZE(sz) \
2457 (sizeof(struct rte_eth_dev_tx_buffer) + (sz) * sizeof(struct rte_mbuf *))
2460 * Initialize default values for buffered transmitting
2463 * Tx buffer to be initialized.
2470 rte_eth_tx_buffer_init(struct rte_eth_dev_tx_buffer *buffer, uint16_t size);
2473 * Configure a callback for buffered packets which cannot be sent
2475 * Register a specific callback to be called when an attempt is made to send
2476 * all packets buffered on an ethernet port, but not all packets can
2477 * successfully be sent. The callback registered here will be called only
2478 * from calls to rte_eth_tx_buffer() and rte_eth_tx_buffer_flush() APIs.
2479 * The default callback configured for each queue by default just frees the
2480 * packets back to the calling mempool. If additional behaviour is required,
2481 * for example, to count dropped packets, or to retry transmission of packets
2482 * which cannot be sent, this function should be used to register a suitable
2483 * callback function to implement the desired behaviour.
2484 * The example callback "rte_eth_count_unsent_packet_callback()" is also
2485 * provided as reference.
2488 * The port identifier of the Ethernet device.
2490 * The function to be used as the callback.
2492 * Arbitrary parameter to be passed to the callback function
2494 * 0 on success, or -1 on error with rte_errno set appropriately
2497 rte_eth_tx_buffer_set_err_callback(struct rte_eth_dev_tx_buffer *buffer,
2498 buffer_tx_error_fn callback, void *userdata);
2501 * Callback function for silently dropping unsent buffered packets.
2503 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
2504 * adjust the default behavior when buffered packets cannot be sent. This
2505 * function drops any unsent packets silently and is used by tx buffered
2506 * operations as default behavior.
2508 * NOTE: this function should not be called directly, instead it should be used
2509 * as a callback for packet buffering.
2511 * NOTE: when configuring this function as a callback with
2512 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
2513 * should point to an uint64_t value.
2516 * The previously buffered packets which could not be sent
2518 * The number of unsent packets in the pkts array
2523 rte_eth_tx_buffer_drop_callback(struct rte_mbuf **pkts, uint16_t unsent,
2527 * Callback function for tracking unsent buffered packets.
2529 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
2530 * adjust the default behavior when buffered packets cannot be sent. This
2531 * function drops any unsent packets, but also updates a user-supplied counter
2532 * to track the overall number of packets dropped. The counter should be an
2533 * uint64_t variable.
2535 * NOTE: this function should not be called directly, instead it should be used
2536 * as a callback for packet buffering.
2538 * NOTE: when configuring this function as a callback with
2539 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
2540 * should point to an uint64_t value.
2543 * The previously buffered packets which could not be sent
2545 * The number of unsent packets in the pkts array
2547 * Pointer to an uint64_t value, which will be incremented by unsent
2550 rte_eth_tx_buffer_count_callback(struct rte_mbuf **pkts, uint16_t unsent,
2554 * Request the driver to free mbufs currently cached by the driver. The
2555 * driver will only free the mbuf if it is no longer in use. It is the
2556 * application's responsibity to ensure rte_eth_tx_buffer_flush(..) is
2560 * The port identifier of the Ethernet device.
2562 * The index of the transmit queue through which output packets must be
2564 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2565 * to rte_eth_dev_configure().
2567 * Maximum number of packets to free. Use 0 to indicate all possible packets
2568 * should be freed. Note that a packet may be using multiple mbufs.
2571 * -ENODEV: Invalid interface
2572 * -EIO: device is removed
2573 * -ENOTSUP: Driver does not support function
2575 * 0-n: Number of packets freed. More packets may still remain in ring that
2579 rte_eth_tx_done_cleanup(uint16_t port_id, uint16_t queue_id, uint32_t free_cnt);
2582 * Subtypes for IPsec offload event(@ref RTE_ETH_EVENT_IPSEC) raised by
2585 enum rte_eth_event_ipsec_subtype {
2586 RTE_ETH_EVENT_IPSEC_UNKNOWN = 0,
2587 /**< Unknown event type */
2588 RTE_ETH_EVENT_IPSEC_ESN_OVERFLOW,
2589 /**< Sequence number overflow */
2590 RTE_ETH_EVENT_IPSEC_SA_TIME_EXPIRY,
2591 /**< Soft time expiry of SA */
2592 RTE_ETH_EVENT_IPSEC_SA_BYTE_EXPIRY,
2593 /**< Soft byte expiry of SA */
2594 RTE_ETH_EVENT_IPSEC_MAX
2595 /**< Max value of this enum */
2599 * Descriptor for @ref RTE_ETH_EVENT_IPSEC event. Used by eth dev to send extra
2600 * information of the IPsec offload event.
2602 struct rte_eth_event_ipsec_desc {
2603 enum rte_eth_event_ipsec_subtype subtype;
2604 /**< Type of RTE_ETH_EVENT_IPSEC_* event */
2606 /**< Event specific metadata
2608 * For the following events, *userdata* registered
2609 * with the *rte_security_session* would be returned
2612 * - @ref RTE_ETH_EVENT_IPSEC_ESN_OVERFLOW
2613 * - @ref RTE_ETH_EVENT_IPSEC_SA_TIME_EXPIRY
2614 * - @ref RTE_ETH_EVENT_IPSEC_SA_BYTE_EXPIRY
2616 * @see struct rte_security_session_conf
2622 * The eth device event type for interrupt, and maybe others in the future.
2624 enum rte_eth_event_type {
2625 RTE_ETH_EVENT_UNKNOWN, /**< unknown event type */
2626 RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
2627 RTE_ETH_EVENT_QUEUE_STATE,
2628 /**< queue state event (enabled/disabled) */
2629 RTE_ETH_EVENT_INTR_RESET,
2630 /**< reset interrupt event, sent to VF on PF reset */
2631 RTE_ETH_EVENT_VF_MBOX, /**< message from the VF received by PF */
2632 RTE_ETH_EVENT_MACSEC, /**< MACsec offload related event */
2633 RTE_ETH_EVENT_INTR_RMV, /**< device removal event */
2634 RTE_ETH_EVENT_NEW, /**< port is probed */
2635 RTE_ETH_EVENT_DESTROY, /**< port is released */
2636 RTE_ETH_EVENT_IPSEC, /**< IPsec offload related event */
2637 RTE_ETH_EVENT_MAX /**< max value of this enum */
2640 typedef int (*rte_eth_dev_cb_fn)(uint16_t port_id,
2641 enum rte_eth_event_type event, void *cb_arg, void *ret_param);
2642 /**< user application callback to be registered for interrupts */
2645 * Register a callback function for port event.
2649 * RTE_ETH_ALL means register the event for all port ids.
2653 * User supplied callback function to be called.
2655 * Pointer to the parameters for the registered callback.
2658 * - On success, zero.
2659 * - On failure, a negative value.
2661 int rte_eth_dev_callback_register(uint16_t port_id,
2662 enum rte_eth_event_type event,
2663 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
2666 * Unregister a callback function for port event.
2670 * RTE_ETH_ALL means unregister the event for all port ids.
2674 * User supplied callback function to be called.
2676 * Pointer to the parameters for the registered callback. -1 means to
2677 * remove all for the same callback address and same event.
2680 * - On success, zero.
2681 * - On failure, a negative value.
2683 int rte_eth_dev_callback_unregister(uint16_t port_id,
2684 enum rte_eth_event_type event,
2685 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
2688 * When there is no rx packet coming in Rx Queue for a long time, we can
2689 * sleep lcore related to RX Queue for power saving, and enable rx interrupt
2690 * to be triggered when Rx packet arrives.
2692 * The rte_eth_dev_rx_intr_enable() function enables rx queue
2693 * interrupt on specific rx queue of a port.
2696 * The port identifier of the Ethernet device.
2698 * The index of the receive queue from which to retrieve input packets.
2699 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2700 * to rte_eth_dev_configure().
2702 * - (0) if successful.
2703 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
2705 * - (-ENODEV) if *port_id* invalid.
2706 * - (-EIO) if device is removed.
2708 int rte_eth_dev_rx_intr_enable(uint16_t port_id, uint16_t queue_id);
2711 * When lcore wakes up from rx interrupt indicating packet coming, disable rx
2712 * interrupt and returns to polling mode.
2714 * The rte_eth_dev_rx_intr_disable() function disables rx queue
2715 * interrupt on specific rx queue of a port.
2718 * The port identifier of the Ethernet device.
2720 * The index of the receive queue from which to retrieve input packets.
2721 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2722 * to rte_eth_dev_configure().
2724 * - (0) if successful.
2725 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
2727 * - (-ENODEV) if *port_id* invalid.
2728 * - (-EIO) if device is removed.
2730 int rte_eth_dev_rx_intr_disable(uint16_t port_id, uint16_t queue_id);
2733 * RX Interrupt control per port.
2736 * The port identifier of the Ethernet device.
2738 * Epoll instance fd which the intr vector associated to.
2739 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
2741 * The operation be performed for the vector.
2742 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
2746 * - On success, zero.
2747 * - On failure, a negative value.
2749 int rte_eth_dev_rx_intr_ctl(uint16_t port_id, int epfd, int op, void *data);
2752 * RX Interrupt control per queue.
2755 * The port identifier of the Ethernet device.
2757 * The index of the receive queue from which to retrieve input packets.
2758 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2759 * to rte_eth_dev_configure().
2761 * Epoll instance fd which the intr vector associated to.
2762 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
2764 * The operation be performed for the vector.
2765 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
2769 * - On success, zero.
2770 * - On failure, a negative value.
2772 int rte_eth_dev_rx_intr_ctl_q(uint16_t port_id, uint16_t queue_id,
2773 int epfd, int op, void *data);
2776 * Turn on the LED on the Ethernet device.
2777 * This function turns on the LED on the Ethernet device.
2780 * The port identifier of the Ethernet device.
2782 * - (0) if successful.
2783 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
2785 * - (-ENODEV) if *port_id* invalid.
2786 * - (-EIO) if device is removed.
2788 int rte_eth_led_on(uint16_t port_id);
2791 * Turn off the LED on the Ethernet device.
2792 * This function turns off the LED on the Ethernet device.
2795 * The port identifier of the Ethernet device.
2797 * - (0) if successful.
2798 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
2800 * - (-ENODEV) if *port_id* invalid.
2801 * - (-EIO) if device is removed.
2803 int rte_eth_led_off(uint16_t port_id);
2806 * Get current status of the Ethernet link flow control for Ethernet device
2809 * The port identifier of the Ethernet device.
2811 * The pointer to the structure where to store the flow control parameters.
2813 * - (0) if successful.
2814 * - (-ENOTSUP) if hardware doesn't support flow control.
2815 * - (-ENODEV) if *port_id* invalid.
2816 * - (-EIO) if device is removed.
2818 int rte_eth_dev_flow_ctrl_get(uint16_t port_id,
2819 struct rte_eth_fc_conf *fc_conf);
2822 * Configure the Ethernet link flow control for Ethernet device
2825 * The port identifier of the Ethernet device.
2827 * The pointer to the structure of the flow control parameters.
2829 * - (0) if successful.
2830 * - (-ENOTSUP) if hardware doesn't support flow control mode.
2831 * - (-ENODEV) if *port_id* invalid.
2832 * - (-EINVAL) if bad parameter
2833 * - (-EIO) if flow control setup failure or device is removed.
2835 int rte_eth_dev_flow_ctrl_set(uint16_t port_id,
2836 struct rte_eth_fc_conf *fc_conf);
2839 * Configure the Ethernet priority flow control under DCB environment
2840 * for Ethernet device.
2843 * The port identifier of the Ethernet device.
2845 * The pointer to the structure of the priority flow control parameters.
2847 * - (0) if successful.
2848 * - (-ENOTSUP) if hardware doesn't support priority flow control mode.
2849 * - (-ENODEV) if *port_id* invalid.
2850 * - (-EINVAL) if bad parameter
2851 * - (-EIO) if flow control setup failure or device is removed.
2853 int rte_eth_dev_priority_flow_ctrl_set(uint16_t port_id,
2854 struct rte_eth_pfc_conf *pfc_conf);
2857 * Add a MAC address to an internal array of addresses used to enable whitelist
2858 * filtering to accept packets only if the destination MAC address matches.
2861 * The port identifier of the Ethernet device.
2863 * The MAC address to add.
2865 * VMDq pool index to associate address with (if VMDq is enabled). If VMDq is
2866 * not enabled, this should be set to 0.
2868 * - (0) if successfully added or *mac_addr* was already added.
2869 * - (-ENOTSUP) if hardware doesn't support this feature.
2870 * - (-ENODEV) if *port* is invalid.
2871 * - (-EIO) if device is removed.
2872 * - (-ENOSPC) if no more MAC addresses can be added.
2873 * - (-EINVAL) if MAC address is invalid.
2875 int rte_eth_dev_mac_addr_add(uint16_t port_id, struct ether_addr *mac_addr,
2879 * Remove a MAC address from the internal array of addresses.
2882 * The port identifier of the Ethernet device.
2884 * MAC address to remove.
2886 * - (0) if successful, or *mac_addr* didn't exist.
2887 * - (-ENOTSUP) if hardware doesn't support.
2888 * - (-ENODEV) if *port* invalid.
2889 * - (-EADDRINUSE) if attempting to remove the default MAC address
2891 int rte_eth_dev_mac_addr_remove(uint16_t port_id, struct ether_addr *mac_addr);
2894 * Set the default MAC address.
2897 * The port identifier of the Ethernet device.
2899 * New default MAC address.
2901 * - (0) if successful, or *mac_addr* didn't exist.
2902 * - (-ENOTSUP) if hardware doesn't support.
2903 * - (-ENODEV) if *port* invalid.
2904 * - (-EINVAL) if MAC address is invalid.
2906 int rte_eth_dev_default_mac_addr_set(uint16_t port_id,
2907 struct ether_addr *mac_addr);
2910 * Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
2913 * The port identifier of the Ethernet device.
2917 * Redirection table size. The table size can be queried by
2918 * rte_eth_dev_info_get().
2920 * - (0) if successful.
2921 * - (-ENOTSUP) if hardware doesn't support.
2922 * - (-EINVAL) if bad parameter.
2923 * - (-EIO) if device is removed.
2925 int rte_eth_dev_rss_reta_update(uint16_t port_id,
2926 struct rte_eth_rss_reta_entry64 *reta_conf,
2927 uint16_t reta_size);
2930 * Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
2933 * The port identifier of the Ethernet device.
2937 * Redirection table size. The table size can be queried by
2938 * rte_eth_dev_info_get().
2940 * - (0) if successful.
2941 * - (-ENOTSUP) if hardware doesn't support.
2942 * - (-EINVAL) if bad parameter.
2943 * - (-EIO) if device is removed.
2945 int rte_eth_dev_rss_reta_query(uint16_t port_id,
2946 struct rte_eth_rss_reta_entry64 *reta_conf,
2947 uint16_t reta_size);
2950 * Updates unicast hash table for receiving packet with the given destination
2951 * MAC address, and the packet is routed to all VFs for which the RX mode is
2952 * accept packets that match the unicast hash table.
2955 * The port identifier of the Ethernet device.
2957 * Unicast MAC address.
2959 * 1 - Set an unicast hash bit for receiving packets with the MAC address.
2960 * 0 - Clear an unicast hash bit.
2962 * - (0) if successful.
2963 * - (-ENOTSUP) if hardware doesn't support.
2964 * - (-ENODEV) if *port_id* invalid.
2965 * - (-EIO) if device is removed.
2966 * - (-EINVAL) if bad parameter.
2968 int rte_eth_dev_uc_hash_table_set(uint16_t port_id, struct ether_addr *addr,
2972 * Updates all unicast hash bitmaps for receiving packet with any Unicast
2973 * Ethernet MAC addresses,the packet is routed to all VFs for which the RX
2974 * mode is accept packets that match the unicast hash table.
2977 * The port identifier of the Ethernet device.
2979 * 1 - Set all unicast hash bitmaps for receiving all the Ethernet
2981 * 0 - Clear all unicast hash bitmaps
2983 * - (0) if successful.
2984 * - (-ENOTSUP) if hardware doesn't support.
2985 * - (-ENODEV) if *port_id* invalid.
2986 * - (-EIO) if device is removed.
2987 * - (-EINVAL) if bad parameter.
2989 int rte_eth_dev_uc_all_hash_table_set(uint16_t port_id, uint8_t on);
2992 * Set a traffic mirroring rule on an Ethernet device
2995 * The port identifier of the Ethernet device.
2996 * @param mirror_conf
2997 * The pointer to the traffic mirroring structure describing the mirroring rule.
2998 * The *rte_eth_vm_mirror_conf* structure includes the type of mirroring rule,
2999 * destination pool and the value of rule if enable vlan or pool mirroring.
3002 * The index of traffic mirroring rule, we support four separated rules.
3004 * 1 - Enable a mirroring rule.
3005 * 0 - Disable a mirroring rule.
3007 * - (0) if successful.
3008 * - (-ENOTSUP) if hardware doesn't support this feature.
3009 * - (-ENODEV) if *port_id* invalid.
3010 * - (-EIO) if device is removed.
3011 * - (-EINVAL) if the mr_conf information is not correct.
3013 int rte_eth_mirror_rule_set(uint16_t port_id,
3014 struct rte_eth_mirror_conf *mirror_conf,
3019 * Reset a traffic mirroring rule on an Ethernet device.
3022 * The port identifier of the Ethernet device.
3024 * The index of traffic mirroring rule, we support four separated rules.
3026 * - (0) if successful.
3027 * - (-ENOTSUP) if hardware doesn't support this feature.
3028 * - (-ENODEV) if *port_id* invalid.
3029 * - (-EIO) if device is removed.
3030 * - (-EINVAL) if bad parameter.
3032 int rte_eth_mirror_rule_reset(uint16_t port_id,
3036 * Set the rate limitation for a queue on an Ethernet device.
3039 * The port identifier of the Ethernet device.
3043 * The tx rate in Mbps. Allocated from the total port link speed.
3045 * - (0) if successful.
3046 * - (-ENOTSUP) if hardware doesn't support this feature.
3047 * - (-ENODEV) if *port_id* invalid.
3048 * - (-EIO) if device is removed.
3049 * - (-EINVAL) if bad parameter.
3051 int rte_eth_set_queue_rate_limit(uint16_t port_id, uint16_t queue_idx,
3055 * Configuration of Receive Side Scaling hash computation of Ethernet device.
3058 * The port identifier of the Ethernet device.
3060 * The new configuration to use for RSS hash computation on the port.
3062 * - (0) if successful.
3063 * - (-ENODEV) if port identifier is invalid.
3064 * - (-EIO) if device is removed.
3065 * - (-ENOTSUP) if hardware doesn't support.
3066 * - (-EINVAL) if bad parameter.
3068 int rte_eth_dev_rss_hash_update(uint16_t port_id,
3069 struct rte_eth_rss_conf *rss_conf);
3072 * Retrieve current configuration of Receive Side Scaling hash computation
3073 * of Ethernet device.
3076 * The port identifier of the Ethernet device.
3078 * Where to store the current RSS hash configuration of the Ethernet device.
3080 * - (0) if successful.
3081 * - (-ENODEV) if port identifier is invalid.
3082 * - (-EIO) if device is removed.
3083 * - (-ENOTSUP) if hardware doesn't support RSS.
3086 rte_eth_dev_rss_hash_conf_get(uint16_t port_id,
3087 struct rte_eth_rss_conf *rss_conf);
3090 * Add UDP tunneling port for a specific type of tunnel.
3091 * The packets with this UDP port will be identified as this type of tunnel.
3092 * Before enabling any offloading function for a tunnel, users can call this API
3093 * to change or add more UDP port for the tunnel. So the offloading function
3094 * can take effect on the packets with the specific UDP port.
3097 * The port identifier of the Ethernet device.
3099 * UDP tunneling configuration.
3102 * - (0) if successful.
3103 * - (-ENODEV) if port identifier is invalid.
3104 * - (-EIO) if device is removed.
3105 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3108 rte_eth_dev_udp_tunnel_port_add(uint16_t port_id,
3109 struct rte_eth_udp_tunnel *tunnel_udp);
3112 * Delete UDP tunneling port a specific type of tunnel.
3113 * The packets with this UDP port will not be identified as this type of tunnel
3115 * Before enabling any offloading function for a tunnel, users can call this API
3116 * to delete a UDP port for the tunnel. So the offloading function will not take
3117 * effect on the packets with the specific UDP port.
3120 * The port identifier of the Ethernet device.
3122 * UDP tunneling configuration.
3125 * - (0) if successful.
3126 * - (-ENODEV) if port identifier is invalid.
3127 * - (-EIO) if device is removed.
3128 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3131 rte_eth_dev_udp_tunnel_port_delete(uint16_t port_id,
3132 struct rte_eth_udp_tunnel *tunnel_udp);
3135 * Check whether the filter type is supported on an Ethernet device.
3136 * All the supported filter types are defined in 'rte_eth_ctrl.h'.
3139 * The port identifier of the Ethernet device.
3140 * @param filter_type
3143 * - (0) if successful.
3144 * - (-ENOTSUP) if hardware doesn't support this filter type.
3145 * - (-ENODEV) if *port_id* invalid.
3146 * - (-EIO) if device is removed.
3148 int rte_eth_dev_filter_supported(uint16_t port_id,
3149 enum rte_filter_type filter_type);
3152 * Take operations to assigned filter type on an Ethernet device.
3153 * All the supported operations and filter types are defined in 'rte_eth_ctrl.h'.
3156 * The port identifier of the Ethernet device.
3157 * @param filter_type
3160 * Type of operation.
3162 * A pointer to arguments defined specifically for the operation.
3164 * - (0) if successful.
3165 * - (-ENOTSUP) if hardware doesn't support.
3166 * - (-ENODEV) if *port_id* invalid.
3167 * - (-EIO) if device is removed.
3168 * - others depends on the specific operations implementation.
3170 int rte_eth_dev_filter_ctrl(uint16_t port_id, enum rte_filter_type filter_type,
3171 enum rte_filter_op filter_op, void *arg);
3174 * Get DCB information on an Ethernet device.
3177 * The port identifier of the Ethernet device.
3181 * - (0) if successful.
3182 * - (-ENODEV) if port identifier is invalid.
3183 * - (-EIO) if device is removed.
3184 * - (-ENOTSUP) if hardware doesn't support.
3186 int rte_eth_dev_get_dcb_info(uint16_t port_id,
3187 struct rte_eth_dcb_info *dcb_info);
3189 struct rte_eth_rxtx_callback;
3192 * Add a callback to be called on packet RX on a given port and queue.
3194 * This API configures a function to be called for each burst of
3195 * packets received on a given NIC port queue. The return value is a pointer
3196 * that can be used to later remove the callback using
3197 * rte_eth_remove_rx_callback().
3199 * Multiple functions are called in the order that they are added.
3202 * The port identifier of the Ethernet device.
3204 * The queue on the Ethernet device on which the callback is to be added.
3206 * The callback function
3208 * A generic pointer parameter which will be passed to each invocation of the
3209 * callback function on this port and queue.
3213 * On success, a pointer value which can later be used to remove the callback.
3215 const struct rte_eth_rxtx_callback *
3216 rte_eth_add_rx_callback(uint16_t port_id, uint16_t queue_id,
3217 rte_rx_callback_fn fn, void *user_param);
3220 * Add a callback that must be called first on packet RX on a given port
3223 * This API configures a first function to be called for each burst of
3224 * packets received on a given NIC port queue. The return value is a pointer
3225 * that can be used to later remove the callback using
3226 * rte_eth_remove_rx_callback().
3228 * Multiple functions are called in the order that they are added.
3231 * The port identifier of the Ethernet device.
3233 * The queue on the Ethernet device on which the callback is to be added.
3235 * The callback function
3237 * A generic pointer parameter which will be passed to each invocation of the
3238 * callback function on this port and queue.
3242 * On success, a pointer value which can later be used to remove the callback.
3244 const struct rte_eth_rxtx_callback *
3245 rte_eth_add_first_rx_callback(uint16_t port_id, uint16_t queue_id,
3246 rte_rx_callback_fn fn, void *user_param);
3249 * Add a callback to be called on packet TX on a given port and queue.
3251 * This API configures a function to be called for each burst of
3252 * packets sent on a given NIC port queue. The return value is a pointer
3253 * that can be used to later remove the callback using
3254 * rte_eth_remove_tx_callback().
3256 * Multiple functions are called in the order that they are added.
3259 * The port identifier of the Ethernet device.
3261 * The queue on the Ethernet device on which the callback is to be added.
3263 * The callback function
3265 * A generic pointer parameter which will be passed to each invocation of the
3266 * callback function on this port and queue.
3270 * On success, a pointer value which can later be used to remove the callback.
3272 const struct rte_eth_rxtx_callback *
3273 rte_eth_add_tx_callback(uint16_t port_id, uint16_t queue_id,
3274 rte_tx_callback_fn fn, void *user_param);
3277 * Remove an RX packet callback from a given port and queue.
3279 * This function is used to removed callbacks that were added to a NIC port
3280 * queue using rte_eth_add_rx_callback().
3282 * Note: the callback is removed from the callback list but it isn't freed
3283 * since the it may still be in use. The memory for the callback can be
3284 * subsequently freed back by the application by calling rte_free():
3286 * - Immediately - if the port is stopped, or the user knows that no
3287 * callbacks are in flight e.g. if called from the thread doing RX/TX
3290 * - After a short delay - where the delay is sufficient to allow any
3291 * in-flight callbacks to complete.
3294 * The port identifier of the Ethernet device.
3296 * The queue on the Ethernet device from which the callback is to be removed.
3298 * User supplied callback created via rte_eth_add_rx_callback().
3301 * - 0: Success. Callback was removed.
3302 * - -ENOTSUP: Callback support is not available.
3303 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
3304 * is NULL or not found for the port/queue.
3306 int rte_eth_remove_rx_callback(uint16_t port_id, uint16_t queue_id,
3307 const struct rte_eth_rxtx_callback *user_cb);
3310 * Remove a TX packet callback from a given port and queue.
3312 * This function is used to removed callbacks that were added to a NIC port
3313 * queue using rte_eth_add_tx_callback().
3315 * Note: the callback is removed from the callback list but it isn't freed
3316 * since the it may still be in use. The memory for the callback can be
3317 * subsequently freed back by the application by calling rte_free():
3319 * - Immediately - if the port is stopped, or the user knows that no
3320 * callbacks are in flight e.g. if called from the thread doing RX/TX
3323 * - After a short delay - where the delay is sufficient to allow any
3324 * in-flight callbacks to complete.
3327 * The port identifier of the Ethernet device.
3329 * The queue on the Ethernet device from which the callback is to be removed.
3331 * User supplied callback created via rte_eth_add_tx_callback().
3334 * - 0: Success. Callback was removed.
3335 * - -ENOTSUP: Callback support is not available.
3336 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
3337 * is NULL or not found for the port/queue.
3339 int rte_eth_remove_tx_callback(uint16_t port_id, uint16_t queue_id,
3340 const struct rte_eth_rxtx_callback *user_cb);
3343 * Retrieve information about given port's RX queue.
3346 * The port identifier of the Ethernet device.
3348 * The RX queue on the Ethernet device for which information
3349 * will be retrieved.
3351 * A pointer to a structure of type *rte_eth_rxq_info_info* to be filled with
3352 * the information of the Ethernet device.
3356 * - -ENOTSUP: routine is not supported by the device PMD.
3357 * - -EINVAL: The port_id or the queue_id is out of range.
3359 int rte_eth_rx_queue_info_get(uint16_t port_id, uint16_t queue_id,
3360 struct rte_eth_rxq_info *qinfo);
3363 * Retrieve information about given port's TX queue.
3366 * The port identifier of the Ethernet device.
3368 * The TX queue on the Ethernet device for which information
3369 * will be retrieved.
3371 * A pointer to a structure of type *rte_eth_txq_info_info* to be filled with
3372 * the information of the Ethernet device.
3376 * - -ENOTSUP: routine is not supported by the device PMD.
3377 * - -EINVAL: The port_id or the queue_id is out of range.
3379 int rte_eth_tx_queue_info_get(uint16_t port_id, uint16_t queue_id,
3380 struct rte_eth_txq_info *qinfo);
3383 * Retrieve device registers and register attributes (number of registers and
3387 * The port identifier of the Ethernet device.
3389 * Pointer to rte_dev_reg_info structure to fill in. If info->data is
3390 * NULL the function fills in the width and length fields. If non-NULL
3391 * the registers are put into the buffer pointed at by the data field.
3393 * - (0) if successful.
3394 * - (-ENOTSUP) if hardware doesn't support.
3395 * - (-ENODEV) if *port_id* invalid.
3396 * - (-EIO) if device is removed.
3397 * - others depends on the specific operations implementation.
3399 int rte_eth_dev_get_reg_info(uint16_t port_id, struct rte_dev_reg_info *info);
3402 * Retrieve size of device EEPROM
3405 * The port identifier of the Ethernet device.
3407 * - (>=0) EEPROM size if successful.
3408 * - (-ENOTSUP) if hardware doesn't support.
3409 * - (-ENODEV) if *port_id* invalid.
3410 * - (-EIO) if device is removed.
3411 * - others depends on the specific operations implementation.
3413 int rte_eth_dev_get_eeprom_length(uint16_t port_id);
3416 * Retrieve EEPROM and EEPROM attribute
3419 * The port identifier of the Ethernet device.
3421 * The template includes buffer for return EEPROM data and
3422 * EEPROM attributes to be filled.
3424 * - (0) if successful.
3425 * - (-ENOTSUP) if hardware doesn't support.
3426 * - (-ENODEV) if *port_id* invalid.
3427 * - (-EIO) if device is removed.
3428 * - others depends on the specific operations implementation.
3430 int rte_eth_dev_get_eeprom(uint16_t port_id, struct rte_dev_eeprom_info *info);
3433 * Program EEPROM with provided data
3436 * The port identifier of the Ethernet device.
3438 * The template includes EEPROM data for programming and
3439 * EEPROM attributes to be filled
3441 * - (0) if successful.
3442 * - (-ENOTSUP) if hardware doesn't support.
3443 * - (-ENODEV) if *port_id* invalid.
3444 * - (-EIO) if device is removed.
3445 * - others depends on the specific operations implementation.
3447 int rte_eth_dev_set_eeprom(uint16_t port_id, struct rte_dev_eeprom_info *info);
3451 * @b EXPERIMENTAL: this API may change without prior notice.
3453 * Retrieve the type and size of plugin module EEPROM
3456 * The port identifier of the Ethernet device.
3458 * The type and size of plugin module EEPROM.
3460 * - (0) if successful.
3461 * - (-ENOTSUP) if hardware doesn't support.
3462 * - (-ENODEV) if *port_id* invalid.
3463 * - (-EIO) if device is removed.
3464 * - others depends on the specific operations implementation.
3466 int __rte_experimental
3467 rte_eth_dev_get_module_info(uint16_t port_id,
3468 struct rte_eth_dev_module_info *modinfo);
3472 * @b EXPERIMENTAL: this API may change without prior notice.
3474 * Retrieve the data of plugin module EEPROM
3477 * The port identifier of the Ethernet device.
3479 * The template includes the plugin module EEPROM attributes, and the
3480 * buffer for return plugin module EEPROM data.
3482 * - (0) if successful.
3483 * - (-ENOTSUP) if hardware doesn't support.
3484 * - (-ENODEV) if *port_id* invalid.
3485 * - (-EIO) if device is removed.
3486 * - others depends on the specific operations implementation.
3488 int __rte_experimental
3489 rte_eth_dev_get_module_eeprom(uint16_t port_id,
3490 struct rte_dev_eeprom_info *info);
3493 * Set the list of multicast addresses to filter on an Ethernet device.
3496 * The port identifier of the Ethernet device.
3497 * @param mc_addr_set
3498 * The array of multicast addresses to set. Equal to NULL when the function
3499 * is invoked to flush the set of filtered addresses.
3501 * The number of multicast addresses in the *mc_addr_set* array. Equal to 0
3502 * when the function is invoked to flush the set of filtered addresses.
3504 * - (0) if successful.
3505 * - (-ENODEV) if *port_id* invalid.
3506 * - (-EIO) if device is removed.
3507 * - (-ENOTSUP) if PMD of *port_id* doesn't support multicast filtering.
3508 * - (-ENOSPC) if *port_id* has not enough multicast filtering resources.
3510 int rte_eth_dev_set_mc_addr_list(uint16_t port_id,
3511 struct ether_addr *mc_addr_set,
3512 uint32_t nb_mc_addr);
3515 * Enable IEEE1588/802.1AS timestamping for an Ethernet device.
3518 * The port identifier of the Ethernet device.
3522 * - -ENODEV: The port ID is invalid.
3523 * - -EIO: if device is removed.
3524 * - -ENOTSUP: The function is not supported by the Ethernet driver.
3526 int rte_eth_timesync_enable(uint16_t port_id);
3529 * Disable IEEE1588/802.1AS timestamping for an Ethernet device.
3532 * The port identifier of the Ethernet device.
3536 * - -ENODEV: The port ID is invalid.
3537 * - -EIO: if device is removed.
3538 * - -ENOTSUP: The function is not supported by the Ethernet driver.
3540 int rte_eth_timesync_disable(uint16_t port_id);
3543 * Read an IEEE1588/802.1AS RX timestamp from an Ethernet device.
3546 * The port identifier of the Ethernet device.
3548 * Pointer to the timestamp struct.
3550 * Device specific flags. Used to pass the RX timesync register index to
3551 * i40e. Unused in igb/ixgbe, pass 0 instead.
3555 * - -EINVAL: No timestamp is available.
3556 * - -ENODEV: The port ID is invalid.
3557 * - -EIO: if device is removed.
3558 * - -ENOTSUP: The function is not supported by the Ethernet driver.
3560 int rte_eth_timesync_read_rx_timestamp(uint16_t port_id,
3561 struct timespec *timestamp, uint32_t flags);
3564 * Read an IEEE1588/802.1AS TX timestamp from an Ethernet device.
3567 * The port identifier of the Ethernet device.
3569 * Pointer to the timestamp struct.
3573 * - -EINVAL: No timestamp is available.
3574 * - -ENODEV: The port ID is invalid.
3575 * - -EIO: if device is removed.
3576 * - -ENOTSUP: The function is not supported by the Ethernet driver.
3578 int rte_eth_timesync_read_tx_timestamp(uint16_t port_id,
3579 struct timespec *timestamp);
3582 * Adjust the timesync clock on an Ethernet device.
3584 * This is usually used in conjunction with other Ethdev timesync functions to
3585 * synchronize the device time using the IEEE1588/802.1AS protocol.
3588 * The port identifier of the Ethernet device.
3590 * The adjustment in nanoseconds.
3594 * - -ENODEV: The port ID is invalid.
3595 * - -EIO: if device is removed.
3596 * - -ENOTSUP: The function is not supported by the Ethernet driver.
3598 int rte_eth_timesync_adjust_time(uint16_t port_id, int64_t delta);
3601 * Read the time from the timesync clock on an Ethernet device.
3603 * This is usually used in conjunction with other Ethdev timesync functions to
3604 * synchronize the device time using the IEEE1588/802.1AS protocol.
3607 * The port identifier of the Ethernet device.
3609 * Pointer to the timespec struct that holds the time.
3614 int rte_eth_timesync_read_time(uint16_t port_id, struct timespec *time);
3617 * Set the time of the timesync clock on an Ethernet device.
3619 * This is usually used in conjunction with other Ethdev timesync functions to
3620 * synchronize the device time using the IEEE1588/802.1AS protocol.
3623 * The port identifier of the Ethernet device.
3625 * Pointer to the timespec struct that holds the time.
3629 * - -EINVAL: No timestamp is available.
3630 * - -ENODEV: The port ID is invalid.
3631 * - -EIO: if device is removed.
3632 * - -ENOTSUP: The function is not supported by the Ethernet driver.
3634 int rte_eth_timesync_write_time(uint16_t port_id, const struct timespec *time);
3637 * Config l2 tunnel ether type of an Ethernet device for filtering specific
3638 * tunnel packets by ether type.
3641 * The port identifier of the Ethernet device.
3643 * l2 tunnel configuration.
3646 * - (0) if successful.
3647 * - (-ENODEV) if port identifier is invalid.
3648 * - (-EIO) if device is removed.
3649 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3652 rte_eth_dev_l2_tunnel_eth_type_conf(uint16_t port_id,
3653 struct rte_eth_l2_tunnel_conf *l2_tunnel);
3656 * Enable/disable l2 tunnel offload functions. Include,
3657 * 1, The ability of parsing a type of l2 tunnel of an Ethernet device.
3658 * Filtering, forwarding and offloading this type of tunnel packets depend on
3660 * 2, Stripping the l2 tunnel tag.
3661 * 3, Insertion of the l2 tunnel tag.
3662 * 4, Forwarding the packets based on the l2 tunnel tag.
3665 * The port identifier of the Ethernet device.
3667 * l2 tunnel parameters.
3669 * Indicate the offload function.
3671 * Enable or disable this function.
3674 * - (0) if successful.
3675 * - (-ENODEV) if port identifier is invalid.
3676 * - (-EIO) if device is removed.
3677 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3680 rte_eth_dev_l2_tunnel_offload_set(uint16_t port_id,
3681 struct rte_eth_l2_tunnel_conf *l2_tunnel,
3686 * Get the port id from pci address or device name
3688 * - PCIe, 0000:2:00.0
3693 * pci address or name of the device
3695 * pointer to port identifier of the device
3697 * - (0) if successful and port_id is filled.
3698 * - (-ENODEV or -EINVAL) on failure.
3701 rte_eth_dev_get_port_by_name(const char *name, uint16_t *port_id);
3704 * Get the device name from port id
3706 * - PCIe Bus:Domain:Function, 0000:02:00.0
3707 * - SoC device name, fsl-gmac0
3708 * - vdev dpdk name, net_[pcap0|null0|tun0|tap0]
3711 * Port identifier of the device.
3713 * Buffer of size RTE_ETH_NAME_MAX_LEN to store the name.
3715 * - (0) if successful.
3716 * - (-EINVAL) on failure.
3719 rte_eth_dev_get_name_by_port(uint16_t port_id, char *name);
3722 * Check that numbers of Rx and Tx descriptors satisfy descriptors limits from
3723 * the ethernet device information, otherwise adjust them to boundaries.
3726 * The port identifier of the Ethernet device.
3728 * A pointer to a uint16_t where the number of receive
3729 * descriptors stored.
3731 * A pointer to a uint16_t where the number of transmit
3732 * descriptors stored.
3734 * - (0) if successful.
3735 * - (-ENOTSUP, -ENODEV or -EINVAL) on failure.
3737 int rte_eth_dev_adjust_nb_rx_tx_desc(uint16_t port_id,
3738 uint16_t *nb_rx_desc,
3739 uint16_t *nb_tx_desc);
3742 * Test if a port supports specific mempool ops.
3745 * Port identifier of the Ethernet device.
3747 * The name of the pool operations to test.
3749 * - 0: best mempool ops choice for this port.
3750 * - 1: mempool ops are supported for this port.
3751 * - -ENOTSUP: mempool ops not supported for this port.
3752 * - -ENODEV: Invalid port Identifier.
3753 * - -EINVAL: Pool param is null.
3756 rte_eth_dev_pool_ops_supported(uint16_t port_id, const char *pool);
3759 * Get the security context for the Ethernet device.
3762 * Port identifier of the Ethernet device
3765 * - pointer to security context on success.
3768 rte_eth_dev_get_sec_ctx(uint16_t port_id);
3771 #include <rte_ethdev_core.h>
3775 * Retrieve a burst of input packets from a receive queue of an Ethernet
3776 * device. The retrieved packets are stored in *rte_mbuf* structures whose
3777 * pointers are supplied in the *rx_pkts* array.
3779 * The rte_eth_rx_burst() function loops, parsing the RX ring of the
3780 * receive queue, up to *nb_pkts* packets, and for each completed RX
3781 * descriptor in the ring, it performs the following operations:
3783 * - Initialize the *rte_mbuf* data structure associated with the
3784 * RX descriptor according to the information provided by the NIC into
3785 * that RX descriptor.
3787 * - Store the *rte_mbuf* data structure into the next entry of the
3790 * - Replenish the RX descriptor with a new *rte_mbuf* buffer
3791 * allocated from the memory pool associated with the receive queue at
3792 * initialization time.
3794 * When retrieving an input packet that was scattered by the controller
3795 * into multiple receive descriptors, the rte_eth_rx_burst() function
3796 * appends the associated *rte_mbuf* buffers to the first buffer of the
3799 * The rte_eth_rx_burst() function returns the number of packets
3800 * actually retrieved, which is the number of *rte_mbuf* data structures
3801 * effectively supplied into the *rx_pkts* array.
3802 * A return value equal to *nb_pkts* indicates that the RX queue contained
3803 * at least *rx_pkts* packets, and this is likely to signify that other
3804 * received packets remain in the input queue. Applications implementing
3805 * a "retrieve as much received packets as possible" policy can check this
3806 * specific case and keep invoking the rte_eth_rx_burst() function until
3807 * a value less than *nb_pkts* is returned.
3809 * This receive method has the following advantages:
3811 * - It allows a run-to-completion network stack engine to retrieve and
3812 * to immediately process received packets in a fast burst-oriented
3813 * approach, avoiding the overhead of unnecessary intermediate packet
3814 * queue/dequeue operations.
3816 * - Conversely, it also allows an asynchronous-oriented processing
3817 * method to retrieve bursts of received packets and to immediately
3818 * queue them for further parallel processing by another logical core,
3819 * for instance. However, instead of having received packets being
3820 * individually queued by the driver, this approach allows the caller
3821 * of the rte_eth_rx_burst() function to queue a burst of retrieved
3822 * packets at a time and therefore dramatically reduce the cost of
3823 * enqueue/dequeue operations per packet.
3825 * - It allows the rte_eth_rx_burst() function of the driver to take
3826 * advantage of burst-oriented hardware features (CPU cache,
3827 * prefetch instructions, and so on) to minimize the number of CPU
3828 * cycles per packet.
3830 * To summarize, the proposed receive API enables many
3831 * burst-oriented optimizations in both synchronous and asynchronous
3832 * packet processing environments with no overhead in both cases.
3834 * The rte_eth_rx_burst() function does not provide any error
3835 * notification to avoid the corresponding overhead. As a hint, the
3836 * upper-level application might check the status of the device link once
3837 * being systematically returned a 0 value for a given number of tries.
3840 * The port identifier of the Ethernet device.
3842 * The index of the receive queue from which to retrieve input packets.
3843 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3844 * to rte_eth_dev_configure().
3846 * The address of an array of pointers to *rte_mbuf* structures that
3847 * must be large enough to store *nb_pkts* pointers in it.
3849 * The maximum number of packets to retrieve.
3851 * The number of packets actually retrieved, which is the number
3852 * of pointers to *rte_mbuf* structures effectively supplied to the
3855 static inline uint16_t
3856 rte_eth_rx_burst(uint16_t port_id, uint16_t queue_id,
3857 struct rte_mbuf **rx_pkts, const uint16_t nb_pkts)
3859 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
3862 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3863 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
3864 RTE_FUNC_PTR_OR_ERR_RET(*dev->rx_pkt_burst, 0);
3866 if (queue_id >= dev->data->nb_rx_queues) {
3867 RTE_ETHDEV_LOG(ERR, "Invalid RX queue_id=%u\n", queue_id);
3871 nb_rx = (*dev->rx_pkt_burst)(dev->data->rx_queues[queue_id],
3874 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
3875 if (unlikely(dev->post_rx_burst_cbs[queue_id] != NULL)) {
3876 struct rte_eth_rxtx_callback *cb =
3877 dev->post_rx_burst_cbs[queue_id];
3880 nb_rx = cb->fn.rx(port_id, queue_id, rx_pkts, nb_rx,
3881 nb_pkts, cb->param);
3883 } while (cb != NULL);
3891 * Get the number of used descriptors of a rx queue
3894 * The port identifier of the Ethernet device.
3896 * The queue id on the specific port.
3898 * The number of used descriptors in the specific queue, or:
3899 * (-EINVAL) if *port_id* or *queue_id* is invalid
3900 * (-ENOTSUP) if the device does not support this function
3903 rte_eth_rx_queue_count(uint16_t port_id, uint16_t queue_id)
3905 struct rte_eth_dev *dev;
3907 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -EINVAL);
3908 dev = &rte_eth_devices[port_id];
3909 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_queue_count, -ENOTSUP);
3910 if (queue_id >= dev->data->nb_rx_queues)
3913 return (int)(*dev->dev_ops->rx_queue_count)(dev, queue_id);
3917 * Check if the DD bit of the specific RX descriptor in the queue has been set
3920 * The port identifier of the Ethernet device.
3922 * The queue id on the specific port.
3924 * The offset of the descriptor ID from tail.
3926 * - (1) if the specific DD bit is set.
3927 * - (0) if the specific DD bit is not set.
3928 * - (-ENODEV) if *port_id* invalid.
3929 * - (-ENOTSUP) if the device does not support this function
3932 rte_eth_rx_descriptor_done(uint16_t port_id, uint16_t queue_id, uint16_t offset)
3934 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
3935 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
3936 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_descriptor_done, -ENOTSUP);
3937 return (*dev->dev_ops->rx_descriptor_done)( \
3938 dev->data->rx_queues[queue_id], offset);
3941 #define RTE_ETH_RX_DESC_AVAIL 0 /**< Desc available for hw. */
3942 #define RTE_ETH_RX_DESC_DONE 1 /**< Desc done, filled by hw. */
3943 #define RTE_ETH_RX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */
3946 * Check the status of a Rx descriptor in the queue
3948 * It should be called in a similar context than the Rx function:
3949 * - on a dataplane core
3950 * - not concurrently on the same queue
3952 * Since it's a dataplane function, no check is performed on port_id and
3953 * queue_id. The caller must therefore ensure that the port is enabled
3954 * and the queue is configured and running.
3956 * Note: accessing to a random descriptor in the ring may trigger cache
3957 * misses and have a performance impact.
3960 * A valid port identifier of the Ethernet device which.
3962 * A valid Rx queue identifier on this port.
3964 * The offset of the descriptor starting from tail (0 is the next
3965 * packet to be received by the driver).
3968 * - (RTE_ETH_RX_DESC_AVAIL): Descriptor is available for the hardware to
3970 * - (RTE_ETH_RX_DESC_DONE): Descriptor is done, it is filled by hw, but
3971 * not yet processed by the driver (i.e. in the receive queue).
3972 * - (RTE_ETH_RX_DESC_UNAVAIL): Descriptor is unavailable, either hold by
3973 * the driver and not yet returned to hw, or reserved by the hw.
3974 * - (-EINVAL) bad descriptor offset.
3975 * - (-ENOTSUP) if the device does not support this function.
3976 * - (-ENODEV) bad port or queue (only if compiled with debug).
3979 rte_eth_rx_descriptor_status(uint16_t port_id, uint16_t queue_id,
3982 struct rte_eth_dev *dev;
3985 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3986 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
3988 dev = &rte_eth_devices[port_id];
3989 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3990 if (queue_id >= dev->data->nb_rx_queues)
3993 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_descriptor_status, -ENOTSUP);
3994 rxq = dev->data->rx_queues[queue_id];
3996 return (*dev->dev_ops->rx_descriptor_status)(rxq, offset);
3999 #define RTE_ETH_TX_DESC_FULL 0 /**< Desc filled for hw, waiting xmit. */
4000 #define RTE_ETH_TX_DESC_DONE 1 /**< Desc done, packet is transmitted. */
4001 #define RTE_ETH_TX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */
4004 * Check the status of a Tx descriptor in the queue.
4006 * It should be called in a similar context than the Tx function:
4007 * - on a dataplane core
4008 * - not concurrently on the same queue
4010 * Since it's a dataplane function, no check is performed on port_id and
4011 * queue_id. The caller must therefore ensure that the port is enabled
4012 * and the queue is configured and running.
4014 * Note: accessing to a random descriptor in the ring may trigger cache
4015 * misses and have a performance impact.
4018 * A valid port identifier of the Ethernet device which.
4020 * A valid Tx queue identifier on this port.
4022 * The offset of the descriptor starting from tail (0 is the place where
4023 * the next packet will be send).
4026 * - (RTE_ETH_TX_DESC_FULL) Descriptor is being processed by the hw, i.e.
4027 * in the transmit queue.
4028 * - (RTE_ETH_TX_DESC_DONE) Hardware is done with this descriptor, it can
4029 * be reused by the driver.
4030 * - (RTE_ETH_TX_DESC_UNAVAIL): Descriptor is unavailable, reserved by the
4031 * driver or the hardware.
4032 * - (-EINVAL) bad descriptor offset.
4033 * - (-ENOTSUP) if the device does not support this function.
4034 * - (-ENODEV) bad port or queue (only if compiled with debug).
4036 static inline int rte_eth_tx_descriptor_status(uint16_t port_id,
4037 uint16_t queue_id, uint16_t offset)
4039 struct rte_eth_dev *dev;
4042 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4043 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
4045 dev = &rte_eth_devices[port_id];
4046 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4047 if (queue_id >= dev->data->nb_tx_queues)
4050 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->tx_descriptor_status, -ENOTSUP);
4051 txq = dev->data->tx_queues[queue_id];
4053 return (*dev->dev_ops->tx_descriptor_status)(txq, offset);
4057 * Send a burst of output packets on a transmit queue of an Ethernet device.
4059 * The rte_eth_tx_burst() function is invoked to transmit output packets
4060 * on the output queue *queue_id* of the Ethernet device designated by its
4062 * The *nb_pkts* parameter is the number of packets to send which are
4063 * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
4064 * allocated from a pool created with rte_pktmbuf_pool_create().
4065 * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
4066 * up to the number of transmit descriptors available in the TX ring of the
4068 * For each packet to send, the rte_eth_tx_burst() function performs
4069 * the following operations:
4071 * - Pick up the next available descriptor in the transmit ring.
4073 * - Free the network buffer previously sent with that descriptor, if any.
4075 * - Initialize the transmit descriptor with the information provided
4076 * in the *rte_mbuf data structure.
4078 * In the case of a segmented packet composed of a list of *rte_mbuf* buffers,
4079 * the rte_eth_tx_burst() function uses several transmit descriptors
4082 * The rte_eth_tx_burst() function returns the number of packets it
4083 * actually sent. A return value equal to *nb_pkts* means that all packets
4084 * have been sent, and this is likely to signify that other output packets
4085 * could be immediately transmitted again. Applications that implement a
4086 * "send as many packets to transmit as possible" policy can check this
4087 * specific case and keep invoking the rte_eth_tx_burst() function until
4088 * a value less than *nb_pkts* is returned.
4090 * It is the responsibility of the rte_eth_tx_burst() function to
4091 * transparently free the memory buffers of packets previously sent.
4092 * This feature is driven by the *tx_free_thresh* value supplied to the
4093 * rte_eth_dev_configure() function at device configuration time.
4094 * When the number of free TX descriptors drops below this threshold, the
4095 * rte_eth_tx_burst() function must [attempt to] free the *rte_mbuf* buffers
4096 * of those packets whose transmission was effectively completed.
4098 * If the PMD is DEV_TX_OFFLOAD_MT_LOCKFREE capable, multiple threads can
4099 * invoke this function concurrently on the same tx queue without SW lock.
4100 * @see rte_eth_dev_info_get, struct rte_eth_txconf::txq_flags
4102 * @see rte_eth_tx_prepare to perform some prior checks or adjustments
4106 * The port identifier of the Ethernet device.
4108 * The index of the transmit queue through which output packets must be
4110 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
4111 * to rte_eth_dev_configure().
4113 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
4114 * which contain the output packets.
4116 * The maximum number of packets to transmit.
4118 * The number of output packets actually stored in transmit descriptors of
4119 * the transmit ring. The return value can be less than the value of the
4120 * *tx_pkts* parameter when the transmit ring is full or has been filled up.
4122 static inline uint16_t
4123 rte_eth_tx_burst(uint16_t port_id, uint16_t queue_id,
4124 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
4126 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
4128 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4129 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
4130 RTE_FUNC_PTR_OR_ERR_RET(*dev->tx_pkt_burst, 0);
4132 if (queue_id >= dev->data->nb_tx_queues) {
4133 RTE_ETHDEV_LOG(ERR, "Invalid TX queue_id=%u\n", queue_id);
4138 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
4139 struct rte_eth_rxtx_callback *cb = dev->pre_tx_burst_cbs[queue_id];
4141 if (unlikely(cb != NULL)) {
4143 nb_pkts = cb->fn.tx(port_id, queue_id, tx_pkts, nb_pkts,
4146 } while (cb != NULL);
4150 return (*dev->tx_pkt_burst)(dev->data->tx_queues[queue_id], tx_pkts, nb_pkts);
4155 * @b EXPERIMENTAL: this API may change without prior notice
4157 * Process a burst of output packets on a transmit queue of an Ethernet device.
4159 * The rte_eth_tx_prepare() function is invoked to prepare output packets to be
4160 * transmitted on the output queue *queue_id* of the Ethernet device designated
4162 * The *nb_pkts* parameter is the number of packets to be prepared which are
4163 * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
4164 * allocated from a pool created with rte_pktmbuf_pool_create().
4165 * For each packet to send, the rte_eth_tx_prepare() function performs
4166 * the following operations:
4168 * - Check if packet meets devices requirements for tx offloads.
4170 * - Check limitations about number of segments.
4172 * - Check additional requirements when debug is enabled.
4174 * - Update and/or reset required checksums when tx offload is set for packet.
4176 * Since this function can modify packet data, provided mbufs must be safely
4177 * writable (e.g. modified data cannot be in shared segment).
4179 * The rte_eth_tx_prepare() function returns the number of packets ready to be
4180 * sent. A return value equal to *nb_pkts* means that all packets are valid and
4181 * ready to be sent, otherwise stops processing on the first invalid packet and
4182 * leaves the rest packets untouched.
4184 * When this functionality is not implemented in the driver, all packets are
4185 * are returned untouched.
4188 * The port identifier of the Ethernet device.
4189 * The value must be a valid port id.
4191 * The index of the transmit queue through which output packets must be
4193 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
4194 * to rte_eth_dev_configure().
4196 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
4197 * which contain the output packets.
4199 * The maximum number of packets to process.
4201 * The number of packets correct and ready to be sent. The return value can be
4202 * less than the value of the *tx_pkts* parameter when some packet doesn't
4203 * meet devices requirements with rte_errno set appropriately:
4204 * - -EINVAL: offload flags are not correctly set
4205 * - -ENOTSUP: the offload feature is not supported by the hardware
4209 #ifndef RTE_ETHDEV_TX_PREPARE_NOOP
4211 static inline uint16_t
4212 rte_eth_tx_prepare(uint16_t port_id, uint16_t queue_id,
4213 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
4215 struct rte_eth_dev *dev;
4217 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4218 if (!rte_eth_dev_is_valid_port(port_id)) {
4219 RTE_ETHDEV_LOG(ERR, "Invalid TX port_id=%u\n", port_id);
4220 rte_errno = -EINVAL;
4225 dev = &rte_eth_devices[port_id];
4227 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4228 if (queue_id >= dev->data->nb_tx_queues) {
4229 RTE_ETHDEV_LOG(ERR, "Invalid TX queue_id=%u\n", queue_id);
4230 rte_errno = -EINVAL;
4235 if (!dev->tx_pkt_prepare)
4238 return (*dev->tx_pkt_prepare)(dev->data->tx_queues[queue_id],
4245 * Native NOOP operation for compilation targets which doesn't require any
4246 * preparations steps, and functional NOOP may introduce unnecessary performance
4249 * Generally this is not a good idea to turn it on globally and didn't should
4250 * be used if behavior of tx_preparation can change.
4253 static inline uint16_t
4254 rte_eth_tx_prepare(__rte_unused uint16_t port_id,
4255 __rte_unused uint16_t queue_id,
4256 __rte_unused struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
4264 * Send any packets queued up for transmission on a port and HW queue
4266 * This causes an explicit flush of packets previously buffered via the
4267 * rte_eth_tx_buffer() function. It returns the number of packets successfully
4268 * sent to the NIC, and calls the error callback for any unsent packets. Unless
4269 * explicitly set up otherwise, the default callback simply frees the unsent
4270 * packets back to the owning mempool.
4273 * The port identifier of the Ethernet device.
4275 * The index of the transmit queue through which output packets must be
4277 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
4278 * to rte_eth_dev_configure().
4280 * Buffer of packets to be transmit.
4282 * The number of packets successfully sent to the Ethernet device. The error
4283 * callback is called for any packets which could not be sent.
4285 static inline uint16_t
4286 rte_eth_tx_buffer_flush(uint16_t port_id, uint16_t queue_id,
4287 struct rte_eth_dev_tx_buffer *buffer)
4290 uint16_t to_send = buffer->length;
4295 sent = rte_eth_tx_burst(port_id, queue_id, buffer->pkts, to_send);
4299 /* All packets sent, or to be dealt with by callback below */
4300 if (unlikely(sent != to_send))
4301 buffer->error_callback(&buffer->pkts[sent],
4302 (uint16_t)(to_send - sent),
4303 buffer->error_userdata);
4309 * Buffer a single packet for future transmission on a port and queue
4311 * This function takes a single mbuf/packet and buffers it for later
4312 * transmission on the particular port and queue specified. Once the buffer is
4313 * full of packets, an attempt will be made to transmit all the buffered
4314 * packets. In case of error, where not all packets can be transmitted, a
4315 * callback is called with the unsent packets as a parameter. If no callback
4316 * is explicitly set up, the unsent packets are just freed back to the owning
4317 * mempool. The function returns the number of packets actually sent i.e.
4318 * 0 if no buffer flush occurred, otherwise the number of packets successfully
4322 * The port identifier of the Ethernet device.
4324 * The index of the transmit queue through which output packets must be
4326 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
4327 * to rte_eth_dev_configure().
4329 * Buffer used to collect packets to be sent.
4331 * Pointer to the packet mbuf to be sent.
4333 * 0 = packet has been buffered for later transmission
4334 * N > 0 = packet has been buffered, and the buffer was subsequently flushed,
4335 * causing N packets to be sent, and the error callback to be called for
4338 static __rte_always_inline uint16_t
4339 rte_eth_tx_buffer(uint16_t port_id, uint16_t queue_id,
4340 struct rte_eth_dev_tx_buffer *buffer, struct rte_mbuf *tx_pkt)
4342 buffer->pkts[buffer->length++] = tx_pkt;
4343 if (buffer->length < buffer->size)
4346 return rte_eth_tx_buffer_flush(port_id, queue_id, buffer);
4353 #endif /* _RTE_ETHDEV_H_ */