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 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
84 * - flow control settings
85 * - receive mode configuration (promiscuous mode, all-multicast mode,
86 * hardware checksum mode, RSS/VMDQ settings etc.)
87 * - VLAN filtering configuration
88 * - default MAC address
89 * - MAC addresses supplied to MAC address array
90 * - flow director filtering mode (but not filtering rules)
91 * - NIC queue statistics mappings
93 * Any other configuration will not be stored and will need to be re-entered
94 * before a call to rte_eth_dev_start().
96 * Finally, a network application can close an Ethernet device by invoking the
97 * rte_eth_dev_close() function.
99 * Each function of the application Ethernet API invokes a specific function
100 * of the PMD that controls the target device designated by its port
102 * For this purpose, all device-specific functions of an Ethernet driver are
103 * supplied through a set of pointers contained in a generic structure of type
105 * The address of the *eth_dev_ops* structure is stored in the *rte_eth_dev*
106 * structure by the device init function of the Ethernet driver, which is
107 * invoked during the PCI probing phase, as explained earlier.
109 * In other words, each function of the Ethernet API simply retrieves the
110 * *rte_eth_dev* structure associated with the device port identifier and
111 * performs an indirect invocation of the corresponding driver function
112 * supplied in the *eth_dev_ops* structure of the *rte_eth_dev* structure.
114 * For performance reasons, the address of the burst-oriented RX and TX
115 * functions of the Ethernet driver are not contained in the *eth_dev_ops*
116 * structure. Instead, they are directly stored at the beginning of the
117 * *rte_eth_dev* structure to avoid an extra indirect memory access during
120 * RTE ethernet device drivers do not use interrupts for transmitting or
121 * receiving. Instead, Ethernet drivers export Poll-Mode receive and transmit
122 * functions to applications.
123 * Both receive and transmit functions are packet-burst oriented to minimize
124 * their cost per packet through the following optimizations:
126 * - Sharing among multiple packets the incompressible cost of the
127 * invocation of receive/transmit functions.
129 * - Enabling receive/transmit functions to take advantage of burst-oriented
130 * hardware features (L1 cache, prefetch instructions, NIC head/tail
131 * registers) to minimize the number of CPU cycles per packet, for instance,
132 * by avoiding useless read memory accesses to ring descriptors, or by
133 * systematically using arrays of pointers that exactly fit L1 cache line
134 * boundaries and sizes.
136 * The burst-oriented receive function does not provide any error notification,
137 * to avoid the corresponding overhead. As a hint, the upper-level application
138 * might check the status of the device link once being systematically returned
139 * a 0 value by the receive function of the driver for a given number of tries.
148 /* Use this macro to check if LRO API is supported */
149 #define RTE_ETHDEV_HAS_LRO_SUPPORT
151 /* Alias RTE_LIBRTE_ETHDEV_DEBUG for backward compatibility. */
152 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
153 #define RTE_ETHDEV_DEBUG_RX
154 #define RTE_ETHDEV_DEBUG_TX
157 #include <rte_compat.h>
159 #include <rte_interrupts.h>
161 #include <rte_devargs.h>
162 #include <rte_errno.h>
163 #include <rte_common.h>
164 #include <rte_config.h>
165 #include <rte_ether.h>
166 #include <rte_power_intrinsics.h>
168 #include "rte_ethdev_trace_fp.h"
169 #include "rte_dev_info.h"
171 extern int rte_eth_dev_logtype;
173 #define RTE_ETHDEV_LOG(level, ...) \
174 rte_log(RTE_LOG_ ## level, rte_eth_dev_logtype, "" __VA_ARGS__)
179 * Initializes a device iterator.
181 * This iterator allows accessing a list of devices matching some devargs.
184 * Device iterator handle initialized by the function.
185 * The fields bus_str and cls_str might be dynamically allocated,
186 * and could be freed by calling rte_eth_iterator_cleanup().
189 * Device description string.
192 * 0 on successful initialization, negative otherwise.
194 int rte_eth_iterator_init(struct rte_dev_iterator *iter, const char *devargs);
197 * Iterates on devices with devargs filter.
198 * The ownership is not checked.
200 * The next port id is returned, and the iterator is updated.
203 * Device iterator handle initialized by rte_eth_iterator_init().
204 * Some fields bus_str and cls_str might be freed when no more port is found,
205 * by calling rte_eth_iterator_cleanup().
208 * A port id if found, RTE_MAX_ETHPORTS otherwise.
210 uint16_t rte_eth_iterator_next(struct rte_dev_iterator *iter);
213 * Free some allocated fields of the iterator.
215 * This function is automatically called by rte_eth_iterator_next()
216 * on the last iteration (i.e. when no more matching port is found).
218 * It is safe to call this function twice; it will do nothing more.
221 * Device iterator handle initialized by rte_eth_iterator_init().
222 * The fields bus_str and cls_str are freed if needed.
224 void rte_eth_iterator_cleanup(struct rte_dev_iterator *iter);
227 * Macro to iterate over all ethdev ports matching some devargs.
229 * If a break is done before the end of the loop,
230 * the function rte_eth_iterator_cleanup() must be called.
233 * Iterated port id of type uint16_t.
235 * Device parameters input as string of type char*.
237 * Iterator handle of type struct rte_dev_iterator, used internally.
239 #define RTE_ETH_FOREACH_MATCHING_DEV(id, devargs, iter) \
240 for (rte_eth_iterator_init(iter, devargs), \
241 id = rte_eth_iterator_next(iter); \
242 id != RTE_MAX_ETHPORTS; \
243 id = rte_eth_iterator_next(iter))
246 * A structure used to retrieve statistics for an Ethernet port.
247 * Not all statistics fields in struct rte_eth_stats are supported
248 * by any type of network interface card (NIC). If any statistics
249 * field is not supported, its value is 0.
250 * All byte-related statistics do not include Ethernet FCS regardless
251 * of whether these bytes have been delivered to the application
252 * (see DEV_RX_OFFLOAD_KEEP_CRC).
254 struct rte_eth_stats {
255 uint64_t ipackets; /**< Total number of successfully received packets. */
256 uint64_t opackets; /**< Total number of successfully transmitted packets.*/
257 uint64_t ibytes; /**< Total number of successfully received bytes. */
258 uint64_t obytes; /**< Total number of successfully transmitted bytes. */
260 /**< Total of RX packets dropped by the HW,
261 * because there are no available buffer (i.e. RX queues are full).
263 uint64_t ierrors; /**< Total number of erroneous received packets. */
264 uint64_t oerrors; /**< Total number of failed transmitted packets. */
265 uint64_t rx_nombuf; /**< Total number of RX mbuf allocation failures. */
266 /* Queue stats are limited to max 256 queues */
267 uint64_t q_ipackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
268 /**< Total number of queue RX packets. */
269 uint64_t q_opackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
270 /**< Total number of queue TX packets. */
271 uint64_t q_ibytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
272 /**< Total number of successfully received queue bytes. */
273 uint64_t q_obytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
274 /**< Total number of successfully transmitted queue bytes. */
275 uint64_t q_errors[RTE_ETHDEV_QUEUE_STAT_CNTRS];
276 /**< Total number of queue packets received that are dropped. */
279 /**@{@name Link speed capabilities
280 * Device supported speeds bitmap flags
282 #define ETH_LINK_SPEED_AUTONEG (0 << 0) /**< Autonegotiate (all speeds) */
283 #define ETH_LINK_SPEED_FIXED (1 << 0) /**< Disable autoneg (fixed speed) */
284 #define ETH_LINK_SPEED_10M_HD (1 << 1) /**< 10 Mbps half-duplex */
285 #define ETH_LINK_SPEED_10M (1 << 2) /**< 10 Mbps full-duplex */
286 #define ETH_LINK_SPEED_100M_HD (1 << 3) /**< 100 Mbps half-duplex */
287 #define ETH_LINK_SPEED_100M (1 << 4) /**< 100 Mbps full-duplex */
288 #define ETH_LINK_SPEED_1G (1 << 5) /**< 1 Gbps */
289 #define ETH_LINK_SPEED_2_5G (1 << 6) /**< 2.5 Gbps */
290 #define ETH_LINK_SPEED_5G (1 << 7) /**< 5 Gbps */
291 #define ETH_LINK_SPEED_10G (1 << 8) /**< 10 Gbps */
292 #define ETH_LINK_SPEED_20G (1 << 9) /**< 20 Gbps */
293 #define ETH_LINK_SPEED_25G (1 << 10) /**< 25 Gbps */
294 #define ETH_LINK_SPEED_40G (1 << 11) /**< 40 Gbps */
295 #define ETH_LINK_SPEED_50G (1 << 12) /**< 50 Gbps */
296 #define ETH_LINK_SPEED_56G (1 << 13) /**< 56 Gbps */
297 #define ETH_LINK_SPEED_100G (1 << 14) /**< 100 Gbps */
298 #define ETH_LINK_SPEED_200G (1 << 15) /**< 200 Gbps */
301 /**@{@name Link speed
302 * Ethernet numeric link speeds in Mbps
304 #define ETH_SPEED_NUM_NONE 0 /**< Not defined */
305 #define ETH_SPEED_NUM_10M 10 /**< 10 Mbps */
306 #define ETH_SPEED_NUM_100M 100 /**< 100 Mbps */
307 #define ETH_SPEED_NUM_1G 1000 /**< 1 Gbps */
308 #define ETH_SPEED_NUM_2_5G 2500 /**< 2.5 Gbps */
309 #define ETH_SPEED_NUM_5G 5000 /**< 5 Gbps */
310 #define ETH_SPEED_NUM_10G 10000 /**< 10 Gbps */
311 #define ETH_SPEED_NUM_20G 20000 /**< 20 Gbps */
312 #define ETH_SPEED_NUM_25G 25000 /**< 25 Gbps */
313 #define ETH_SPEED_NUM_40G 40000 /**< 40 Gbps */
314 #define ETH_SPEED_NUM_50G 50000 /**< 50 Gbps */
315 #define ETH_SPEED_NUM_56G 56000 /**< 56 Gbps */
316 #define ETH_SPEED_NUM_100G 100000 /**< 100 Gbps */
317 #define ETH_SPEED_NUM_200G 200000 /**< 200 Gbps */
318 #define ETH_SPEED_NUM_UNKNOWN UINT32_MAX /**< Unknown */
322 * A structure used to retrieve link-level information of an Ethernet port.
325 struct rte_eth_link {
326 uint32_t link_speed; /**< ETH_SPEED_NUM_ */
327 uint16_t link_duplex : 1; /**< ETH_LINK_[HALF/FULL]_DUPLEX */
328 uint16_t link_autoneg : 1; /**< ETH_LINK_[AUTONEG/FIXED] */
329 uint16_t link_status : 1; /**< ETH_LINK_[DOWN/UP] */
330 } __rte_aligned(8); /**< aligned for atomic64 read/write */
332 /**@{@name Link negotiation
333 * Constants used in link management.
335 #define ETH_LINK_HALF_DUPLEX 0 /**< Half-duplex connection (see link_duplex). */
336 #define ETH_LINK_FULL_DUPLEX 1 /**< Full-duplex connection (see link_duplex). */
337 #define ETH_LINK_DOWN 0 /**< Link is down (see link_status). */
338 #define ETH_LINK_UP 1 /**< Link is up (see link_status). */
339 #define ETH_LINK_FIXED 0 /**< No autonegotiation (see link_autoneg). */
340 #define ETH_LINK_AUTONEG 1 /**< Autonegotiated (see link_autoneg). */
341 #define RTE_ETH_LINK_MAX_STR_LEN 40 /**< Max length of default link string. */
345 * A structure used to configure the ring threshold registers of an RX/TX
346 * queue for an Ethernet port.
348 struct rte_eth_thresh {
349 uint8_t pthresh; /**< Ring prefetch threshold. */
350 uint8_t hthresh; /**< Ring host threshold. */
351 uint8_t wthresh; /**< Ring writeback threshold. */
354 /**@{@name Multi-queue mode
355 * @see rte_eth_conf.rxmode.mq_mode.
357 #define ETH_MQ_RX_RSS_FLAG 0x1 /**< Enable RSS. @see rte_eth_rss_conf */
358 #define ETH_MQ_RX_DCB_FLAG 0x2 /**< Enable DCB. */
359 #define ETH_MQ_RX_VMDQ_FLAG 0x4 /**< Enable VMDq. */
363 * A set of values to identify what method is to be used to route
364 * packets to multiple queues.
366 enum rte_eth_rx_mq_mode {
367 /** None of DCB,RSS or VMDQ mode */
370 /** For RX side, only RSS is on */
371 ETH_MQ_RX_RSS = ETH_MQ_RX_RSS_FLAG,
372 /** For RX side,only DCB is on. */
373 ETH_MQ_RX_DCB = ETH_MQ_RX_DCB_FLAG,
374 /** Both DCB and RSS enable */
375 ETH_MQ_RX_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG,
377 /** Only VMDQ, no RSS nor DCB */
378 ETH_MQ_RX_VMDQ_ONLY = ETH_MQ_RX_VMDQ_FLAG,
379 /** RSS mode with VMDQ */
380 ETH_MQ_RX_VMDQ_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_VMDQ_FLAG,
381 /** Use VMDQ+DCB to route traffic to queues */
382 ETH_MQ_RX_VMDQ_DCB = ETH_MQ_RX_VMDQ_FLAG | ETH_MQ_RX_DCB_FLAG,
383 /** Enable both VMDQ and DCB in VMDq */
384 ETH_MQ_RX_VMDQ_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG |
389 * for rx mq mode backward compatible
391 #define ETH_RSS ETH_MQ_RX_RSS
392 #define VMDQ_DCB ETH_MQ_RX_VMDQ_DCB
393 #define ETH_DCB_RX ETH_MQ_RX_DCB
396 * A set of values to identify what method is to be used to transmit
397 * packets using multi-TCs.
399 enum rte_eth_tx_mq_mode {
400 ETH_MQ_TX_NONE = 0, /**< It is in neither DCB nor VT mode. */
401 ETH_MQ_TX_DCB, /**< For TX side,only DCB is on. */
402 ETH_MQ_TX_VMDQ_DCB, /**< For TX side,both DCB and VT is on. */
403 ETH_MQ_TX_VMDQ_ONLY, /**< Only VT on, no DCB */
407 * for tx mq mode backward compatible
409 #define ETH_DCB_NONE ETH_MQ_TX_NONE
410 #define ETH_VMDQ_DCB_TX ETH_MQ_TX_VMDQ_DCB
411 #define ETH_DCB_TX ETH_MQ_TX_DCB
414 * A structure used to configure the RX features of an Ethernet port.
416 struct rte_eth_rxmode {
417 /** The multi-queue packet distribution mode to be used, e.g. RSS. */
418 enum rte_eth_rx_mq_mode mq_mode;
419 uint32_t max_rx_pkt_len; /**< Only used if JUMBO_FRAME enabled. */
420 /** Maximum allowed size of LRO aggregated packet. */
421 uint32_t max_lro_pkt_size;
422 uint16_t split_hdr_size; /**< hdr buf size (header_split enabled).*/
424 * Per-port Rx offloads to be set using DEV_RX_OFFLOAD_* flags.
425 * Only offloads set on rx_offload_capa field on rte_eth_dev_info
426 * structure are allowed to be set.
430 uint64_t reserved_64s[2]; /**< Reserved for future fields */
431 void *reserved_ptrs[2]; /**< Reserved for future fields */
435 * VLAN types to indicate if it is for single VLAN, inner VLAN or outer VLAN.
436 * Note that single VLAN is treated the same as inner VLAN.
439 ETH_VLAN_TYPE_UNKNOWN = 0,
440 ETH_VLAN_TYPE_INNER, /**< Inner VLAN. */
441 ETH_VLAN_TYPE_OUTER, /**< Single VLAN, or outer VLAN. */
446 * A structure used to describe a vlan filter.
447 * If the bit corresponding to a VID is set, such VID is on.
449 struct rte_vlan_filter_conf {
454 * A structure used to configure the Receive Side Scaling (RSS) feature
455 * of an Ethernet port.
456 * If not NULL, the *rss_key* pointer of the *rss_conf* structure points
457 * to an array holding the RSS key to use for hashing specific header
458 * fields of received packets. The length of this array should be indicated
459 * by *rss_key_len* below. Otherwise, a default random hash key is used by
462 * The *rss_key_len* field of the *rss_conf* structure indicates the length
463 * in bytes of the array pointed by *rss_key*. To be compatible, this length
464 * will be checked in i40e only. Others assume 40 bytes to be used as before.
466 * The *rss_hf* field of the *rss_conf* structure indicates the different
467 * types of IPv4/IPv6 packets to which the RSS hashing must be applied.
468 * Supplying an *rss_hf* equal to zero disables the RSS feature.
470 struct rte_eth_rss_conf {
471 uint8_t *rss_key; /**< If not NULL, 40-byte hash key. */
472 uint8_t rss_key_len; /**< hash key length in bytes. */
473 uint64_t rss_hf; /**< Hash functions to apply - see below. */
477 * A packet can be identified by hardware as different flow types. Different
478 * NIC hardware may support different flow types.
479 * Basically, the NIC hardware identifies the flow type as deep protocol as
480 * possible, and exclusively. For example, if a packet is identified as
481 * 'RTE_ETH_FLOW_NONFRAG_IPV4_TCP', it will not be any of other flow types,
482 * though it is an actual IPV4 packet.
484 #define RTE_ETH_FLOW_UNKNOWN 0
485 #define RTE_ETH_FLOW_RAW 1
486 #define RTE_ETH_FLOW_IPV4 2
487 #define RTE_ETH_FLOW_FRAG_IPV4 3
488 #define RTE_ETH_FLOW_NONFRAG_IPV4_TCP 4
489 #define RTE_ETH_FLOW_NONFRAG_IPV4_UDP 5
490 #define RTE_ETH_FLOW_NONFRAG_IPV4_SCTP 6
491 #define RTE_ETH_FLOW_NONFRAG_IPV4_OTHER 7
492 #define RTE_ETH_FLOW_IPV6 8
493 #define RTE_ETH_FLOW_FRAG_IPV6 9
494 #define RTE_ETH_FLOW_NONFRAG_IPV6_TCP 10
495 #define RTE_ETH_FLOW_NONFRAG_IPV6_UDP 11
496 #define RTE_ETH_FLOW_NONFRAG_IPV6_SCTP 12
497 #define RTE_ETH_FLOW_NONFRAG_IPV6_OTHER 13
498 #define RTE_ETH_FLOW_L2_PAYLOAD 14
499 #define RTE_ETH_FLOW_IPV6_EX 15
500 #define RTE_ETH_FLOW_IPV6_TCP_EX 16
501 #define RTE_ETH_FLOW_IPV6_UDP_EX 17
502 #define RTE_ETH_FLOW_PORT 18
503 /**< Consider device port number as a flow differentiator */
504 #define RTE_ETH_FLOW_VXLAN 19 /**< VXLAN protocol based flow */
505 #define RTE_ETH_FLOW_GENEVE 20 /**< GENEVE protocol based flow */
506 #define RTE_ETH_FLOW_NVGRE 21 /**< NVGRE protocol based flow */
507 #define RTE_ETH_FLOW_VXLAN_GPE 22 /**< VXLAN-GPE protocol based flow */
508 #define RTE_ETH_FLOW_GTPU 23 /**< GTPU protocol based flow */
509 #define RTE_ETH_FLOW_MAX 24
512 * Below macros are defined for RSS offload types, they can be used to
513 * fill rte_eth_rss_conf.rss_hf or rte_flow_action_rss.types.
515 #define ETH_RSS_IPV4 (1ULL << 2)
516 #define ETH_RSS_FRAG_IPV4 (1ULL << 3)
517 #define ETH_RSS_NONFRAG_IPV4_TCP (1ULL << 4)
518 #define ETH_RSS_NONFRAG_IPV4_UDP (1ULL << 5)
519 #define ETH_RSS_NONFRAG_IPV4_SCTP (1ULL << 6)
520 #define ETH_RSS_NONFRAG_IPV4_OTHER (1ULL << 7)
521 #define ETH_RSS_IPV6 (1ULL << 8)
522 #define ETH_RSS_FRAG_IPV6 (1ULL << 9)
523 #define ETH_RSS_NONFRAG_IPV6_TCP (1ULL << 10)
524 #define ETH_RSS_NONFRAG_IPV6_UDP (1ULL << 11)
525 #define ETH_RSS_NONFRAG_IPV6_SCTP (1ULL << 12)
526 #define ETH_RSS_NONFRAG_IPV6_OTHER (1ULL << 13)
527 #define ETH_RSS_L2_PAYLOAD (1ULL << 14)
528 #define ETH_RSS_IPV6_EX (1ULL << 15)
529 #define ETH_RSS_IPV6_TCP_EX (1ULL << 16)
530 #define ETH_RSS_IPV6_UDP_EX (1ULL << 17)
531 #define ETH_RSS_PORT (1ULL << 18)
532 #define ETH_RSS_VXLAN (1ULL << 19)
533 #define ETH_RSS_GENEVE (1ULL << 20)
534 #define ETH_RSS_NVGRE (1ULL << 21)
535 #define ETH_RSS_GTPU (1ULL << 23)
536 #define ETH_RSS_ETH (1ULL << 24)
537 #define ETH_RSS_S_VLAN (1ULL << 25)
538 #define ETH_RSS_C_VLAN (1ULL << 26)
539 #define ETH_RSS_ESP (1ULL << 27)
540 #define ETH_RSS_AH (1ULL << 28)
541 #define ETH_RSS_L2TPV3 (1ULL << 29)
542 #define ETH_RSS_PFCP (1ULL << 30)
543 #define ETH_RSS_PPPOE (1ULL << 31)
544 #define ETH_RSS_ECPRI (1ULL << 32)
545 #define ETH_RSS_MPLS (1ULL << 33)
546 #define ETH_RSS_IPV4_CHKSUM (1ULL << 34)
549 * The ETH_RSS_L4_CHKSUM works on checksum field of any L4 header.
550 * It is similar to ETH_RSS_PORT that they don't specify the specific type of
551 * L4 header. This macro is defined to replace some specific L4 (TCP/UDP/SCTP)
552 * checksum type for constructing the use of RSS offload bits.
554 * Due to above reason, some old APIs (and configuration) don't support
555 * ETH_RSS_L4_CHKSUM. The rte_flow RSS API supports it.
557 * For the case that checksum is not used in an UDP header,
558 * it takes the reserved value 0 as input for the hash function.
560 #define ETH_RSS_L4_CHKSUM (1ULL << 35)
563 * We use the following macros to combine with above ETH_RSS_* for
564 * more specific input set selection. These bits are defined starting
565 * from the high end of the 64 bits.
566 * Note: If we use above ETH_RSS_* without SRC/DST_ONLY, it represents
567 * both SRC and DST are taken into account. If SRC_ONLY and DST_ONLY of
568 * the same level are used simultaneously, it is the same case as none of
571 #define ETH_RSS_L3_SRC_ONLY (1ULL << 63)
572 #define ETH_RSS_L3_DST_ONLY (1ULL << 62)
573 #define ETH_RSS_L4_SRC_ONLY (1ULL << 61)
574 #define ETH_RSS_L4_DST_ONLY (1ULL << 60)
575 #define ETH_RSS_L2_SRC_ONLY (1ULL << 59)
576 #define ETH_RSS_L2_DST_ONLY (1ULL << 58)
579 * Only select IPV6 address prefix as RSS input set according to
580 * https://tools.ietf.org/html/rfc6052
581 * Must be combined with ETH_RSS_IPV6, ETH_RSS_NONFRAG_IPV6_UDP,
582 * ETH_RSS_NONFRAG_IPV6_TCP, ETH_RSS_NONFRAG_IPV6_SCTP.
584 #define RTE_ETH_RSS_L3_PRE32 (1ULL << 57)
585 #define RTE_ETH_RSS_L3_PRE40 (1ULL << 56)
586 #define RTE_ETH_RSS_L3_PRE48 (1ULL << 55)
587 #define RTE_ETH_RSS_L3_PRE56 (1ULL << 54)
588 #define RTE_ETH_RSS_L3_PRE64 (1ULL << 53)
589 #define RTE_ETH_RSS_L3_PRE96 (1ULL << 52)
592 * Use the following macros to combine with the above layers
593 * to choose inner and outer layers or both for RSS computation.
594 * Bits 50 and 51 are reserved for this.
598 * level 0, requests the default behavior.
599 * Depending on the packet type, it can mean outermost, innermost,
600 * anything in between or even no RSS.
601 * It basically stands for the innermost encapsulation level RSS
602 * can be performed on according to PMD and device capabilities.
604 #define ETH_RSS_LEVEL_PMD_DEFAULT (0ULL << 50)
607 * level 1, requests RSS to be performed on the outermost packet
608 * encapsulation level.
610 #define ETH_RSS_LEVEL_OUTERMOST (1ULL << 50)
613 * level 2, requests RSS to be performed on the specified inner packet
614 * encapsulation level, from outermost to innermost (lower to higher values).
616 #define ETH_RSS_LEVEL_INNERMOST (2ULL << 50)
617 #define ETH_RSS_LEVEL_MASK (3ULL << 50)
619 #define ETH_RSS_LEVEL(rss_hf) ((rss_hf & ETH_RSS_LEVEL_MASK) >> 50)
622 * For input set change of hash filter, if SRC_ONLY and DST_ONLY of
623 * the same level are used simultaneously, it is the same case as
624 * none of them are added.
627 * RSS types with SRC/DST_ONLY.
631 static inline uint64_t
632 rte_eth_rss_hf_refine(uint64_t rss_hf)
634 if ((rss_hf & ETH_RSS_L3_SRC_ONLY) && (rss_hf & ETH_RSS_L3_DST_ONLY))
635 rss_hf &= ~(ETH_RSS_L3_SRC_ONLY | ETH_RSS_L3_DST_ONLY);
637 if ((rss_hf & ETH_RSS_L4_SRC_ONLY) && (rss_hf & ETH_RSS_L4_DST_ONLY))
638 rss_hf &= ~(ETH_RSS_L4_SRC_ONLY | ETH_RSS_L4_DST_ONLY);
643 #define ETH_RSS_IPV6_PRE32 ( \
645 RTE_ETH_RSS_L3_PRE32)
647 #define ETH_RSS_IPV6_PRE40 ( \
649 RTE_ETH_RSS_L3_PRE40)
651 #define ETH_RSS_IPV6_PRE48 ( \
653 RTE_ETH_RSS_L3_PRE48)
655 #define ETH_RSS_IPV6_PRE56 ( \
657 RTE_ETH_RSS_L3_PRE56)
659 #define ETH_RSS_IPV6_PRE64 ( \
661 RTE_ETH_RSS_L3_PRE64)
663 #define ETH_RSS_IPV6_PRE96 ( \
665 RTE_ETH_RSS_L3_PRE96)
667 #define ETH_RSS_IPV6_PRE32_UDP ( \
668 ETH_RSS_NONFRAG_IPV6_UDP | \
669 RTE_ETH_RSS_L3_PRE32)
671 #define ETH_RSS_IPV6_PRE40_UDP ( \
672 ETH_RSS_NONFRAG_IPV6_UDP | \
673 RTE_ETH_RSS_L3_PRE40)
675 #define ETH_RSS_IPV6_PRE48_UDP ( \
676 ETH_RSS_NONFRAG_IPV6_UDP | \
677 RTE_ETH_RSS_L3_PRE48)
679 #define ETH_RSS_IPV6_PRE56_UDP ( \
680 ETH_RSS_NONFRAG_IPV6_UDP | \
681 RTE_ETH_RSS_L3_PRE56)
683 #define ETH_RSS_IPV6_PRE64_UDP ( \
684 ETH_RSS_NONFRAG_IPV6_UDP | \
685 RTE_ETH_RSS_L3_PRE64)
687 #define ETH_RSS_IPV6_PRE96_UDP ( \
688 ETH_RSS_NONFRAG_IPV6_UDP | \
689 RTE_ETH_RSS_L3_PRE96)
691 #define ETH_RSS_IPV6_PRE32_TCP ( \
692 ETH_RSS_NONFRAG_IPV6_TCP | \
693 RTE_ETH_RSS_L3_PRE32)
695 #define ETH_RSS_IPV6_PRE40_TCP ( \
696 ETH_RSS_NONFRAG_IPV6_TCP | \
697 RTE_ETH_RSS_L3_PRE40)
699 #define ETH_RSS_IPV6_PRE48_TCP ( \
700 ETH_RSS_NONFRAG_IPV6_TCP | \
701 RTE_ETH_RSS_L3_PRE48)
703 #define ETH_RSS_IPV6_PRE56_TCP ( \
704 ETH_RSS_NONFRAG_IPV6_TCP | \
705 RTE_ETH_RSS_L3_PRE56)
707 #define ETH_RSS_IPV6_PRE64_TCP ( \
708 ETH_RSS_NONFRAG_IPV6_TCP | \
709 RTE_ETH_RSS_L3_PRE64)
711 #define ETH_RSS_IPV6_PRE96_TCP ( \
712 ETH_RSS_NONFRAG_IPV6_TCP | \
713 RTE_ETH_RSS_L3_PRE96)
715 #define ETH_RSS_IPV6_PRE32_SCTP ( \
716 ETH_RSS_NONFRAG_IPV6_SCTP | \
717 RTE_ETH_RSS_L3_PRE32)
719 #define ETH_RSS_IPV6_PRE40_SCTP ( \
720 ETH_RSS_NONFRAG_IPV6_SCTP | \
721 RTE_ETH_RSS_L3_PRE40)
723 #define ETH_RSS_IPV6_PRE48_SCTP ( \
724 ETH_RSS_NONFRAG_IPV6_SCTP | \
725 RTE_ETH_RSS_L3_PRE48)
727 #define ETH_RSS_IPV6_PRE56_SCTP ( \
728 ETH_RSS_NONFRAG_IPV6_SCTP | \
729 RTE_ETH_RSS_L3_PRE56)
731 #define ETH_RSS_IPV6_PRE64_SCTP ( \
732 ETH_RSS_NONFRAG_IPV6_SCTP | \
733 RTE_ETH_RSS_L3_PRE64)
735 #define ETH_RSS_IPV6_PRE96_SCTP ( \
736 ETH_RSS_NONFRAG_IPV6_SCTP | \
737 RTE_ETH_RSS_L3_PRE96)
739 #define ETH_RSS_IP ( \
741 ETH_RSS_FRAG_IPV4 | \
742 ETH_RSS_NONFRAG_IPV4_OTHER | \
744 ETH_RSS_FRAG_IPV6 | \
745 ETH_RSS_NONFRAG_IPV6_OTHER | \
748 #define ETH_RSS_UDP ( \
749 ETH_RSS_NONFRAG_IPV4_UDP | \
750 ETH_RSS_NONFRAG_IPV6_UDP | \
753 #define ETH_RSS_TCP ( \
754 ETH_RSS_NONFRAG_IPV4_TCP | \
755 ETH_RSS_NONFRAG_IPV6_TCP | \
758 #define ETH_RSS_SCTP ( \
759 ETH_RSS_NONFRAG_IPV4_SCTP | \
760 ETH_RSS_NONFRAG_IPV6_SCTP)
762 #define ETH_RSS_TUNNEL ( \
767 #define ETH_RSS_VLAN ( \
771 /**< Mask of valid RSS hash protocols */
772 #define ETH_RSS_PROTO_MASK ( \
774 ETH_RSS_FRAG_IPV4 | \
775 ETH_RSS_NONFRAG_IPV4_TCP | \
776 ETH_RSS_NONFRAG_IPV4_UDP | \
777 ETH_RSS_NONFRAG_IPV4_SCTP | \
778 ETH_RSS_NONFRAG_IPV4_OTHER | \
780 ETH_RSS_FRAG_IPV6 | \
781 ETH_RSS_NONFRAG_IPV6_TCP | \
782 ETH_RSS_NONFRAG_IPV6_UDP | \
783 ETH_RSS_NONFRAG_IPV6_SCTP | \
784 ETH_RSS_NONFRAG_IPV6_OTHER | \
785 ETH_RSS_L2_PAYLOAD | \
787 ETH_RSS_IPV6_TCP_EX | \
788 ETH_RSS_IPV6_UDP_EX | \
796 * Definitions used for redirection table entry size.
797 * Some RSS RETA sizes may not be supported by some drivers, check the
798 * documentation or the description of relevant functions for more details.
800 #define ETH_RSS_RETA_SIZE_64 64
801 #define ETH_RSS_RETA_SIZE_128 128
802 #define ETH_RSS_RETA_SIZE_256 256
803 #define ETH_RSS_RETA_SIZE_512 512
804 #define RTE_RETA_GROUP_SIZE 64
806 /**@{@name VMDq and DCB maximums */
807 #define ETH_VMDQ_MAX_VLAN_FILTERS 64 /**< Maximum nb. of VMDQ vlan filters. */
808 #define ETH_DCB_NUM_USER_PRIORITIES 8 /**< Maximum nb. of DCB priorities. */
809 #define ETH_VMDQ_DCB_NUM_QUEUES 128 /**< Maximum nb. of VMDQ DCB queues. */
810 #define ETH_DCB_NUM_QUEUES 128 /**< Maximum nb. of DCB queues. */
813 /**@{@name DCB capabilities */
814 #define ETH_DCB_PG_SUPPORT 0x00000001 /**< Priority Group(ETS) support. */
815 #define ETH_DCB_PFC_SUPPORT 0x00000002 /**< Priority Flow Control support. */
818 /**@{@name VLAN offload bits */
819 #define ETH_VLAN_STRIP_OFFLOAD 0x0001 /**< VLAN Strip On/Off */
820 #define ETH_VLAN_FILTER_OFFLOAD 0x0002 /**< VLAN Filter On/Off */
821 #define ETH_VLAN_EXTEND_OFFLOAD 0x0004 /**< VLAN Extend On/Off */
822 #define ETH_QINQ_STRIP_OFFLOAD 0x0008 /**< QINQ Strip On/Off */
824 #define ETH_VLAN_STRIP_MASK 0x0001 /**< VLAN Strip setting mask */
825 #define ETH_VLAN_FILTER_MASK 0x0002 /**< VLAN Filter setting mask*/
826 #define ETH_VLAN_EXTEND_MASK 0x0004 /**< VLAN Extend setting mask*/
827 #define ETH_QINQ_STRIP_MASK 0x0008 /**< QINQ Strip setting mask */
828 #define ETH_VLAN_ID_MAX 0x0FFF /**< VLAN ID is in lower 12 bits*/
831 /* Definitions used for receive MAC address */
832 #define ETH_NUM_RECEIVE_MAC_ADDR 128 /**< Maximum nb. of receive mac addr. */
834 /* Definitions used for unicast hash */
835 #define ETH_VMDQ_NUM_UC_HASH_ARRAY 128 /**< Maximum nb. of UC hash array. */
837 /**@{@name VMDq Rx mode
838 * @see rte_eth_vmdq_rx_conf.rx_mode
840 #define ETH_VMDQ_ACCEPT_UNTAG 0x0001 /**< accept untagged packets. */
841 #define ETH_VMDQ_ACCEPT_HASH_MC 0x0002 /**< accept packets in multicast table . */
842 #define ETH_VMDQ_ACCEPT_HASH_UC 0x0004 /**< accept packets in unicast table. */
843 #define ETH_VMDQ_ACCEPT_BROADCAST 0x0008 /**< accept broadcast packets. */
844 #define ETH_VMDQ_ACCEPT_MULTICAST 0x0010 /**< multicast promiscuous. */
848 * A structure used to configure 64 entries of Redirection Table of the
849 * Receive Side Scaling (RSS) feature of an Ethernet port. To configure
850 * more than 64 entries supported by hardware, an array of this structure
853 struct rte_eth_rss_reta_entry64 {
855 /**< Mask bits indicate which entries need to be updated/queried. */
856 uint16_t reta[RTE_RETA_GROUP_SIZE];
857 /**< Group of 64 redirection table entries. */
861 * This enum indicates the possible number of traffic classes
862 * in DCB configurations
864 enum rte_eth_nb_tcs {
865 ETH_4_TCS = 4, /**< 4 TCs with DCB. */
866 ETH_8_TCS = 8 /**< 8 TCs with DCB. */
870 * This enum indicates the possible number of queue pools
871 * in VMDQ configurations.
873 enum rte_eth_nb_pools {
874 ETH_8_POOLS = 8, /**< 8 VMDq pools. */
875 ETH_16_POOLS = 16, /**< 16 VMDq pools. */
876 ETH_32_POOLS = 32, /**< 32 VMDq pools. */
877 ETH_64_POOLS = 64 /**< 64 VMDq pools. */
880 /* This structure may be extended in future. */
881 struct rte_eth_dcb_rx_conf {
882 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs */
883 /** Traffic class each UP mapped to. */
884 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
887 struct rte_eth_vmdq_dcb_tx_conf {
888 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools. */
889 /** Traffic class each UP mapped to. */
890 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
893 struct rte_eth_dcb_tx_conf {
894 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs. */
895 /** Traffic class each UP mapped to. */
896 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
899 struct rte_eth_vmdq_tx_conf {
900 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq mode, 64 pools. */
904 * A structure used to configure the VMDQ+DCB feature
905 * of an Ethernet port.
907 * Using this feature, packets are routed to a pool of queues, based
908 * on the vlan id in the vlan tag, and then to a specific queue within
909 * that pool, using the user priority vlan tag field.
911 * A default pool may be used, if desired, to route all traffic which
912 * does not match the vlan filter rules.
914 struct rte_eth_vmdq_dcb_conf {
915 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools */
916 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
917 uint8_t default_pool; /**< The default pool, if applicable */
918 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
920 uint16_t vlan_id; /**< The vlan id of the received frame */
921 uint64_t pools; /**< Bitmask of pools for packet rx */
922 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
923 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
924 /**< Selects a queue in a pool */
928 * A structure used to configure the VMDQ feature of an Ethernet port when
929 * not combined with the DCB feature.
931 * Using this feature, packets are routed to a pool of queues. By default,
932 * the pool selection is based on the MAC address, the vlan id in the
933 * vlan tag as specified in the pool_map array.
934 * Passing the ETH_VMDQ_ACCEPT_UNTAG in the rx_mode field allows pool
935 * selection using only the MAC address. MAC address to pool mapping is done
936 * using the rte_eth_dev_mac_addr_add function, with the pool parameter
937 * corresponding to the pool id.
939 * Queue selection within the selected pool will be done using RSS when
940 * it is enabled or revert to the first queue of the pool if not.
942 * A default pool may be used, if desired, to route all traffic which
943 * does not match the vlan filter rules or any pool MAC address.
945 struct rte_eth_vmdq_rx_conf {
946 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq only mode, 8 or 64 pools */
947 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
948 uint8_t default_pool; /**< The default pool, if applicable */
949 uint8_t enable_loop_back; /**< Enable VT loop back */
950 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
951 uint32_t rx_mode; /**< Flags from ETH_VMDQ_ACCEPT_* */
953 uint16_t vlan_id; /**< The vlan id of the received frame */
954 uint64_t pools; /**< Bitmask of pools for packet rx */
955 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
959 * A structure used to configure the TX features of an Ethernet port.
961 struct rte_eth_txmode {
962 enum rte_eth_tx_mq_mode mq_mode; /**< TX multi-queues mode. */
964 * Per-port Tx offloads to be set using DEV_TX_OFFLOAD_* flags.
965 * Only offloads set on tx_offload_capa field on rte_eth_dev_info
966 * structure are allowed to be set.
972 uint8_t hw_vlan_reject_tagged : 1,
973 /**< If set, reject sending out tagged pkts */
974 hw_vlan_reject_untagged : 1,
975 /**< If set, reject sending out untagged pkts */
976 hw_vlan_insert_pvid : 1;
977 /**< If set, enable port based VLAN insertion */
979 uint64_t reserved_64s[2]; /**< Reserved for future fields */
980 void *reserved_ptrs[2]; /**< Reserved for future fields */
985 * @b EXPERIMENTAL: this structure may change without prior notice.
987 * A structure used to configure an Rx packet segment to split.
989 * If RTE_ETH_RX_OFFLOAD_BUFFER_SPLIT flag is set in offloads field,
990 * the PMD will split the received packets into multiple segments
991 * according to the specification in the description array:
993 * - The first network buffer will be allocated from the memory pool,
994 * specified in the first array element, the second buffer, from the
995 * pool in the second element, and so on.
997 * - The offsets from the segment description elements specify
998 * the data offset from the buffer beginning except the first mbuf.
999 * The first segment offset is added with RTE_PKTMBUF_HEADROOM.
1001 * - The lengths in the elements define the maximal data amount
1002 * being received to each segment. The receiving starts with filling
1003 * up the first mbuf data buffer up to specified length. If the
1004 * there are data remaining (packet is longer than buffer in the first
1005 * mbuf) the following data will be pushed to the next segment
1006 * up to its own length, and so on.
1008 * - If the length in the segment description element is zero
1009 * the actual buffer size will be deduced from the appropriate
1010 * memory pool properties.
1012 * - If there is not enough elements to describe the buffer for entire
1013 * packet of maximal length the following parameters will be used
1014 * for the all remaining segments:
1015 * - pool from the last valid element
1016 * - the buffer size from this pool
1019 struct rte_eth_rxseg_split {
1020 struct rte_mempool *mp; /**< Memory pool to allocate segment from. */
1021 uint16_t length; /**< Segment data length, configures split point. */
1022 uint16_t offset; /**< Data offset from beginning of mbuf data buffer. */
1023 uint32_t reserved; /**< Reserved field. */
1028 * @b EXPERIMENTAL: this structure may change without prior notice.
1030 * A common structure used to describe Rx packet segment properties.
1032 union rte_eth_rxseg {
1033 /* The settings for buffer split offload. */
1034 struct rte_eth_rxseg_split split;
1035 /* The other features settings should be added here. */
1039 * A structure used to configure an RX ring of an Ethernet port.
1041 struct rte_eth_rxconf {
1042 struct rte_eth_thresh rx_thresh; /**< RX ring threshold registers. */
1043 uint16_t rx_free_thresh; /**< Drives the freeing of RX descriptors. */
1044 uint8_t rx_drop_en; /**< Drop packets if no descriptors are available. */
1045 uint8_t rx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
1046 uint16_t rx_nseg; /**< Number of descriptions in rx_seg array. */
1048 * Per-queue Rx offloads to be set using DEV_RX_OFFLOAD_* flags.
1049 * Only offloads set on rx_queue_offload_capa or rx_offload_capa
1050 * fields on rte_eth_dev_info structure are allowed to be set.
1054 * Points to the array of segment descriptions for an entire packet.
1055 * Array elements are properties for consecutive Rx segments.
1057 * The supported capabilities of receiving segmentation is reported
1058 * in rte_eth_dev_info.rx_seg_capa field.
1060 union rte_eth_rxseg *rx_seg;
1062 uint64_t reserved_64s[2]; /**< Reserved for future fields */
1063 void *reserved_ptrs[2]; /**< Reserved for future fields */
1067 * A structure used to configure a TX ring of an Ethernet port.
1069 struct rte_eth_txconf {
1070 struct rte_eth_thresh tx_thresh; /**< TX ring threshold registers. */
1071 uint16_t tx_rs_thresh; /**< Drives the setting of RS bit on TXDs. */
1072 uint16_t tx_free_thresh; /**< Start freeing TX buffers if there are
1073 less free descriptors than this value. */
1075 uint8_t tx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
1077 * Per-queue Tx offloads to be set using DEV_TX_OFFLOAD_* flags.
1078 * Only offloads set on tx_queue_offload_capa or tx_offload_capa
1079 * fields on rte_eth_dev_info structure are allowed to be set.
1083 uint64_t reserved_64s[2]; /**< Reserved for future fields */
1084 void *reserved_ptrs[2]; /**< Reserved for future fields */
1089 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
1091 * A structure used to return the hairpin capabilities that are supported.
1093 struct rte_eth_hairpin_cap {
1094 /** The max number of hairpin queues (different bindings). */
1095 uint16_t max_nb_queues;
1096 /** Max number of Rx queues to be connected to one Tx queue. */
1097 uint16_t max_rx_2_tx;
1098 /** Max number of Tx queues to be connected to one Rx queue. */
1099 uint16_t max_tx_2_rx;
1100 uint16_t max_nb_desc; /**< The max num of descriptors. */
1103 #define RTE_ETH_MAX_HAIRPIN_PEERS 32
1107 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
1109 * A structure used to hold hairpin peer data.
1111 struct rte_eth_hairpin_peer {
1112 uint16_t port; /**< Peer port. */
1113 uint16_t queue; /**< Peer queue. */
1118 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
1120 * A structure used to configure hairpin binding.
1122 struct rte_eth_hairpin_conf {
1123 uint32_t peer_count:16; /**< The number of peers. */
1126 * Explicit Tx flow rule mode.
1127 * One hairpin pair of queues should have the same attribute.
1129 * - When set, the user should be responsible for inserting the hairpin
1130 * Tx part flows and removing them.
1131 * - When clear, the PMD will try to handle the Tx part of the flows,
1132 * e.g., by splitting one flow into two parts.
1134 uint32_t tx_explicit:1;
1137 * Manually bind hairpin queues.
1138 * One hairpin pair of queues should have the same attribute.
1140 * - When set, to enable hairpin, the user should call the hairpin bind
1141 * function after all the queues are set up properly and the ports are
1142 * started. Also, the hairpin unbind function should be called
1143 * accordingly before stopping a port that with hairpin configured.
1144 * - When clear, the PMD will try to enable the hairpin with the queues
1145 * configured automatically during port start.
1147 uint32_t manual_bind:1;
1148 uint32_t reserved:14; /**< Reserved bits. */
1149 struct rte_eth_hairpin_peer peers[RTE_ETH_MAX_HAIRPIN_PEERS];
1153 * A structure contains information about HW descriptor ring limitations.
1155 struct rte_eth_desc_lim {
1156 uint16_t nb_max; /**< Max allowed number of descriptors. */
1157 uint16_t nb_min; /**< Min allowed number of descriptors. */
1158 uint16_t nb_align; /**< Number of descriptors should be aligned to. */
1161 * Max allowed number of segments per whole packet.
1163 * - For TSO packet this is the total number of data descriptors allowed
1166 * @see nb_mtu_seg_max
1168 uint16_t nb_seg_max;
1171 * Max number of segments per one MTU.
1173 * - For non-TSO packet, this is the maximum allowed number of segments
1174 * in a single transmit packet.
1176 * - For TSO packet each segment within the TSO may span up to this
1181 uint16_t nb_mtu_seg_max;
1185 * This enum indicates the flow control mode
1187 enum rte_eth_fc_mode {
1188 RTE_FC_NONE = 0, /**< Disable flow control. */
1189 RTE_FC_RX_PAUSE, /**< RX pause frame, enable flowctrl on TX side. */
1190 RTE_FC_TX_PAUSE, /**< TX pause frame, enable flowctrl on RX side. */
1191 RTE_FC_FULL /**< Enable flow control on both side. */
1195 * A structure used to configure Ethernet flow control parameter.
1196 * These parameters will be configured into the register of the NIC.
1197 * Please refer to the corresponding data sheet for proper value.
1199 struct rte_eth_fc_conf {
1200 uint32_t high_water; /**< High threshold value to trigger XOFF */
1201 uint32_t low_water; /**< Low threshold value to trigger XON */
1202 uint16_t pause_time; /**< Pause quota in the Pause frame */
1203 uint16_t send_xon; /**< Is XON frame need be sent */
1204 enum rte_eth_fc_mode mode; /**< Link flow control mode */
1205 uint8_t mac_ctrl_frame_fwd; /**< Forward MAC control frames */
1206 uint8_t autoneg; /**< Use Pause autoneg */
1210 * A structure used to configure Ethernet priority flow control parameter.
1211 * These parameters will be configured into the register of the NIC.
1212 * Please refer to the corresponding data sheet for proper value.
1214 struct rte_eth_pfc_conf {
1215 struct rte_eth_fc_conf fc; /**< General flow control parameter. */
1216 uint8_t priority; /**< VLAN User Priority. */
1220 * Tunnel type for device-specific classifier configuration.
1221 * @see rte_eth_udp_tunnel
1223 enum rte_eth_tunnel_type {
1224 RTE_TUNNEL_TYPE_NONE = 0,
1225 RTE_TUNNEL_TYPE_VXLAN,
1226 RTE_TUNNEL_TYPE_GENEVE,
1227 RTE_TUNNEL_TYPE_TEREDO,
1228 RTE_TUNNEL_TYPE_NVGRE,
1229 RTE_TUNNEL_TYPE_IP_IN_GRE,
1230 RTE_L2_TUNNEL_TYPE_E_TAG,
1231 RTE_TUNNEL_TYPE_VXLAN_GPE,
1232 RTE_TUNNEL_TYPE_ECPRI,
1233 RTE_TUNNEL_TYPE_MAX,
1236 /* Deprecated API file for rte_eth_dev_filter_* functions */
1237 #include "rte_eth_ctrl.h"
1240 * Memory space that can be configured to store Flow Director filters
1241 * in the board memory.
1243 enum rte_fdir_pballoc_type {
1244 RTE_FDIR_PBALLOC_64K = 0, /**< 64k. */
1245 RTE_FDIR_PBALLOC_128K, /**< 128k. */
1246 RTE_FDIR_PBALLOC_256K, /**< 256k. */
1250 * Select report mode of FDIR hash information in RX descriptors.
1252 enum rte_fdir_status_mode {
1253 RTE_FDIR_NO_REPORT_STATUS = 0, /**< Never report FDIR hash. */
1254 RTE_FDIR_REPORT_STATUS, /**< Only report FDIR hash for matching pkts. */
1255 RTE_FDIR_REPORT_STATUS_ALWAYS, /**< Always report FDIR hash. */
1259 * A structure used to configure the Flow Director (FDIR) feature
1260 * of an Ethernet port.
1262 * If mode is RTE_FDIR_MODE_NONE, the pballoc value is ignored.
1264 struct rte_fdir_conf {
1265 enum rte_fdir_mode mode; /**< Flow Director mode. */
1266 enum rte_fdir_pballoc_type pballoc; /**< Space for FDIR filters. */
1267 enum rte_fdir_status_mode status; /**< How to report FDIR hash. */
1268 /** RX queue of packets matching a "drop" filter in perfect mode. */
1270 struct rte_eth_fdir_masks mask;
1271 struct rte_eth_fdir_flex_conf flex_conf;
1272 /**< Flex payload configuration. */
1276 * UDP tunneling configuration.
1278 * Used to configure the classifier of a device,
1279 * associating an UDP port with a type of tunnel.
1281 * Some NICs may need such configuration to properly parse a tunnel
1282 * with any standard or custom UDP port.
1284 struct rte_eth_udp_tunnel {
1285 uint16_t udp_port; /**< UDP port used for the tunnel. */
1286 uint8_t prot_type; /**< Tunnel type. @see rte_eth_tunnel_type */
1290 * A structure used to enable/disable specific device interrupts.
1292 struct rte_intr_conf {
1293 /** enable/disable lsc interrupt. 0 (default) - disable, 1 enable */
1295 /** enable/disable rxq interrupt. 0 (default) - disable, 1 enable */
1297 /** enable/disable rmv interrupt. 0 (default) - disable, 1 enable */
1302 * A structure used to configure an Ethernet port.
1303 * Depending upon the RX multi-queue mode, extra advanced
1304 * configuration settings may be needed.
1306 struct rte_eth_conf {
1307 uint32_t link_speeds; /**< bitmap of ETH_LINK_SPEED_XXX of speeds to be
1308 used. ETH_LINK_SPEED_FIXED disables link
1309 autonegotiation, and a unique speed shall be
1310 set. Otherwise, the bitmap defines the set of
1311 speeds to be advertised. If the special value
1312 ETH_LINK_SPEED_AUTONEG (0) is used, all speeds
1313 supported are advertised. */
1314 struct rte_eth_rxmode rxmode; /**< Port RX configuration. */
1315 struct rte_eth_txmode txmode; /**< Port TX configuration. */
1316 uint32_t lpbk_mode; /**< Loopback operation mode. By default the value
1317 is 0, meaning the loopback mode is disabled.
1318 Read the datasheet of given ethernet controller
1319 for details. The possible values of this field
1320 are defined in implementation of each driver. */
1322 struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
1323 struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
1324 /**< Port vmdq+dcb configuration. */
1325 struct rte_eth_dcb_rx_conf dcb_rx_conf;
1326 /**< Port dcb RX configuration. */
1327 struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
1328 /**< Port vmdq RX configuration. */
1329 } rx_adv_conf; /**< Port RX filtering configuration. */
1331 struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
1332 /**< Port vmdq+dcb TX configuration. */
1333 struct rte_eth_dcb_tx_conf dcb_tx_conf;
1334 /**< Port dcb TX configuration. */
1335 struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
1336 /**< Port vmdq TX configuration. */
1337 } tx_adv_conf; /**< Port TX DCB configuration (union). */
1338 /** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
1339 is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
1340 uint32_t dcb_capability_en;
1341 struct rte_fdir_conf fdir_conf; /**< FDIR configuration. DEPRECATED */
1342 struct rte_intr_conf intr_conf; /**< Interrupt mode configuration. */
1346 * RX offload capabilities of a device.
1348 #define DEV_RX_OFFLOAD_VLAN_STRIP 0x00000001
1349 #define DEV_RX_OFFLOAD_IPV4_CKSUM 0x00000002
1350 #define DEV_RX_OFFLOAD_UDP_CKSUM 0x00000004
1351 #define DEV_RX_OFFLOAD_TCP_CKSUM 0x00000008
1352 #define DEV_RX_OFFLOAD_TCP_LRO 0x00000010
1353 #define DEV_RX_OFFLOAD_QINQ_STRIP 0x00000020
1354 #define DEV_RX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000040
1355 #define DEV_RX_OFFLOAD_MACSEC_STRIP 0x00000080
1356 #define DEV_RX_OFFLOAD_HEADER_SPLIT 0x00000100
1357 #define DEV_RX_OFFLOAD_VLAN_FILTER 0x00000200
1358 #define DEV_RX_OFFLOAD_VLAN_EXTEND 0x00000400
1359 #define DEV_RX_OFFLOAD_JUMBO_FRAME 0x00000800
1360 #define DEV_RX_OFFLOAD_SCATTER 0x00002000
1362 * Timestamp is set by the driver in RTE_MBUF_DYNFIELD_TIMESTAMP_NAME
1363 * and RTE_MBUF_DYNFLAG_RX_TIMESTAMP_NAME is set in ol_flags.
1364 * The mbuf field and flag are registered when the offload is configured.
1366 #define DEV_RX_OFFLOAD_TIMESTAMP 0x00004000
1367 #define DEV_RX_OFFLOAD_SECURITY 0x00008000
1368 #define DEV_RX_OFFLOAD_KEEP_CRC 0x00010000
1369 #define DEV_RX_OFFLOAD_SCTP_CKSUM 0x00020000
1370 #define DEV_RX_OFFLOAD_OUTER_UDP_CKSUM 0x00040000
1371 #define DEV_RX_OFFLOAD_RSS_HASH 0x00080000
1372 #define RTE_ETH_RX_OFFLOAD_BUFFER_SPLIT 0x00100000
1374 #define DEV_RX_OFFLOAD_CHECKSUM (DEV_RX_OFFLOAD_IPV4_CKSUM | \
1375 DEV_RX_OFFLOAD_UDP_CKSUM | \
1376 DEV_RX_OFFLOAD_TCP_CKSUM)
1377 #define DEV_RX_OFFLOAD_VLAN (DEV_RX_OFFLOAD_VLAN_STRIP | \
1378 DEV_RX_OFFLOAD_VLAN_FILTER | \
1379 DEV_RX_OFFLOAD_VLAN_EXTEND | \
1380 DEV_RX_OFFLOAD_QINQ_STRIP)
1383 * If new Rx offload capabilities are defined, they also must be
1384 * mentioned in rte_rx_offload_names in rte_ethdev.c file.
1388 * TX offload capabilities of a device.
1390 #define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001
1391 #define DEV_TX_OFFLOAD_IPV4_CKSUM 0x00000002
1392 #define DEV_TX_OFFLOAD_UDP_CKSUM 0x00000004
1393 #define DEV_TX_OFFLOAD_TCP_CKSUM 0x00000008
1394 #define DEV_TX_OFFLOAD_SCTP_CKSUM 0x00000010
1395 #define DEV_TX_OFFLOAD_TCP_TSO 0x00000020
1396 #define DEV_TX_OFFLOAD_UDP_TSO 0x00000040
1397 #define DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000080 /**< Used for tunneling packet. */
1398 #define DEV_TX_OFFLOAD_QINQ_INSERT 0x00000100
1399 #define DEV_TX_OFFLOAD_VXLAN_TNL_TSO 0x00000200 /**< Used for tunneling packet. */
1400 #define DEV_TX_OFFLOAD_GRE_TNL_TSO 0x00000400 /**< Used for tunneling packet. */
1401 #define DEV_TX_OFFLOAD_IPIP_TNL_TSO 0x00000800 /**< Used for tunneling packet. */
1402 #define DEV_TX_OFFLOAD_GENEVE_TNL_TSO 0x00001000 /**< Used for tunneling packet. */
1403 #define DEV_TX_OFFLOAD_MACSEC_INSERT 0x00002000
1404 #define DEV_TX_OFFLOAD_MT_LOCKFREE 0x00004000
1405 /**< Multiple threads can invoke rte_eth_tx_burst() concurrently on the same
1406 * tx queue without SW lock.
1408 #define DEV_TX_OFFLOAD_MULTI_SEGS 0x00008000
1409 /**< Device supports multi segment send. */
1410 #define DEV_TX_OFFLOAD_MBUF_FAST_FREE 0x00010000
1411 /**< Device supports optimization for fast release of mbufs.
1412 * When set application must guarantee that per-queue all mbufs comes from
1413 * the same mempool and has refcnt = 1.
1415 #define DEV_TX_OFFLOAD_SECURITY 0x00020000
1417 * Device supports generic UDP tunneled packet TSO.
1418 * Application must set PKT_TX_TUNNEL_UDP and other mbuf fields required
1421 #define DEV_TX_OFFLOAD_UDP_TNL_TSO 0x00040000
1423 * Device supports generic IP tunneled packet TSO.
1424 * Application must set PKT_TX_TUNNEL_IP and other mbuf fields required
1427 #define DEV_TX_OFFLOAD_IP_TNL_TSO 0x00080000
1428 /** Device supports outer UDP checksum */
1429 #define DEV_TX_OFFLOAD_OUTER_UDP_CKSUM 0x00100000
1431 * Device sends on time read from RTE_MBUF_DYNFIELD_TIMESTAMP_NAME
1432 * if RTE_MBUF_DYNFLAG_TX_TIMESTAMP_NAME is set in ol_flags.
1433 * The mbuf field and flag are registered when the offload is configured.
1435 #define DEV_TX_OFFLOAD_SEND_ON_TIMESTAMP 0x00200000
1437 * If new Tx offload capabilities are defined, they also must be
1438 * mentioned in rte_tx_offload_names in rte_ethdev.c file.
1441 /**@{@name Device capabilities
1442 * Non-offload capabilities reported in rte_eth_dev_info.dev_capa.
1444 /** Device supports Rx queue setup after device started. */
1445 #define RTE_ETH_DEV_CAPA_RUNTIME_RX_QUEUE_SETUP 0x00000001
1446 /** Device supports Tx queue setup after device started. */
1447 #define RTE_ETH_DEV_CAPA_RUNTIME_TX_QUEUE_SETUP 0x00000002
1451 * Fallback default preferred Rx/Tx port parameters.
1452 * These are used if an application requests default parameters
1453 * but the PMD does not provide preferred values.
1455 #define RTE_ETH_DEV_FALLBACK_RX_RINGSIZE 512
1456 #define RTE_ETH_DEV_FALLBACK_TX_RINGSIZE 512
1457 #define RTE_ETH_DEV_FALLBACK_RX_NBQUEUES 1
1458 #define RTE_ETH_DEV_FALLBACK_TX_NBQUEUES 1
1461 * Preferred Rx/Tx port parameters.
1462 * There are separate instances of this structure for transmission
1463 * and reception respectively.
1465 struct rte_eth_dev_portconf {
1466 uint16_t burst_size; /**< Device-preferred burst size */
1467 uint16_t ring_size; /**< Device-preferred size of queue rings */
1468 uint16_t nb_queues; /**< Device-preferred number of queues */
1472 * Default values for switch domain id when ethdev does not support switch
1473 * domain definitions.
1475 #define RTE_ETH_DEV_SWITCH_DOMAIN_ID_INVALID (UINT16_MAX)
1478 * Ethernet device associated switch information
1480 struct rte_eth_switch_info {
1481 const char *name; /**< switch name */
1482 uint16_t domain_id; /**< switch domain id */
1485 * mapping to the devices physical switch port as enumerated from the
1486 * perspective of the embedded interconnect/switch. For SR-IOV enabled
1487 * device this may correspond to the VF_ID of each virtual function,
1488 * but each driver should explicitly define the mapping of switch
1489 * port identifier to that physical interconnect/switch
1495 * @b EXPERIMENTAL: this structure may change without prior notice.
1497 * Ethernet device Rx buffer segmentation capabilities.
1499 struct rte_eth_rxseg_capa {
1501 uint32_t multi_pools:1; /**< Supports receiving to multiple pools.*/
1502 uint32_t offset_allowed:1; /**< Supports buffer offsets. */
1503 uint32_t offset_align_log2:4; /**< Required offset alignment. */
1504 uint16_t max_nseg; /**< Maximum amount of segments to split. */
1505 uint16_t reserved; /**< Reserved field. */
1509 * Ethernet device information
1513 * Ethernet device representor port type.
1515 enum rte_eth_representor_type {
1516 RTE_ETH_REPRESENTOR_NONE, /**< not a representor. */
1517 RTE_ETH_REPRESENTOR_VF, /**< representor of Virtual Function. */
1518 RTE_ETH_REPRESENTOR_SF, /**< representor of Sub Function. */
1519 RTE_ETH_REPRESENTOR_PF, /**< representor of Physical Function. */
1523 * A structure used to retrieve the contextual information of
1524 * an Ethernet device, such as the controlling driver of the
1527 struct rte_eth_dev_info {
1528 struct rte_device *device; /** Generic device information */
1529 const char *driver_name; /**< Device Driver name. */
1530 unsigned int if_index; /**< Index to bound host interface, or 0 if none.
1531 Use if_indextoname() to translate into an interface name. */
1532 uint16_t min_mtu; /**< Minimum MTU allowed */
1533 uint16_t max_mtu; /**< Maximum MTU allowed */
1534 const uint32_t *dev_flags; /**< Device flags */
1535 uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
1536 uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
1537 /** Maximum configurable size of LRO aggregated packet. */
1538 uint32_t max_lro_pkt_size;
1539 uint16_t max_rx_queues; /**< Maximum number of RX queues. */
1540 uint16_t max_tx_queues; /**< Maximum number of TX queues. */
1541 uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
1542 uint32_t max_hash_mac_addrs;
1543 /** Maximum number of hash MAC addresses for MTA and UTA. */
1544 uint16_t max_vfs; /**< Maximum number of VFs. */
1545 uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
1546 struct rte_eth_rxseg_capa rx_seg_capa; /**< Segmentation capability.*/
1547 uint64_t rx_offload_capa;
1548 /**< All RX offload capabilities including all per-queue ones */
1549 uint64_t tx_offload_capa;
1550 /**< All TX offload capabilities including all per-queue ones */
1551 uint64_t rx_queue_offload_capa;
1552 /**< Device per-queue RX offload capabilities. */
1553 uint64_t tx_queue_offload_capa;
1554 /**< Device per-queue TX offload capabilities. */
1556 /**< Device redirection table size, the total number of entries. */
1557 uint8_t hash_key_size; /**< Hash key size in bytes */
1558 /** Bit mask of RSS offloads, the bit offset also means flow type */
1559 uint64_t flow_type_rss_offloads;
1560 struct rte_eth_rxconf default_rxconf; /**< Default RX configuration */
1561 struct rte_eth_txconf default_txconf; /**< Default TX configuration */
1562 uint16_t vmdq_queue_base; /**< First queue ID for VMDQ pools. */
1563 uint16_t vmdq_queue_num; /**< Queue number for VMDQ pools. */
1564 uint16_t vmdq_pool_base; /**< First ID of VMDQ pools. */
1565 struct rte_eth_desc_lim rx_desc_lim; /**< RX descriptors limits */
1566 struct rte_eth_desc_lim tx_desc_lim; /**< TX descriptors limits */
1567 uint32_t speed_capa; /**< Supported speeds bitmap (ETH_LINK_SPEED_). */
1568 /** Configured number of rx/tx queues */
1569 uint16_t nb_rx_queues; /**< Number of RX queues. */
1570 uint16_t nb_tx_queues; /**< Number of TX queues. */
1571 /** Rx parameter recommendations */
1572 struct rte_eth_dev_portconf default_rxportconf;
1573 /** Tx parameter recommendations */
1574 struct rte_eth_dev_portconf default_txportconf;
1575 /** Generic device capabilities (RTE_ETH_DEV_CAPA_). */
1578 * Switching information for ports on a device with a
1579 * embedded managed interconnect/switch.
1581 struct rte_eth_switch_info switch_info;
1583 uint64_t reserved_64s[2]; /**< Reserved for future fields */
1584 void *reserved_ptrs[2]; /**< Reserved for future fields */
1587 /**@{@name Rx/Tx queue states */
1588 #define RTE_ETH_QUEUE_STATE_STOPPED 0 /**< Queue stopped. */
1589 #define RTE_ETH_QUEUE_STATE_STARTED 1 /**< Queue started. */
1590 #define RTE_ETH_QUEUE_STATE_HAIRPIN 2 /**< Queue used for hairpin. */
1594 * Ethernet device RX queue information structure.
1595 * Used to retrieve information about configured queue.
1597 struct rte_eth_rxq_info {
1598 struct rte_mempool *mp; /**< mempool used by that queue. */
1599 struct rte_eth_rxconf conf; /**< queue config parameters. */
1600 uint8_t scattered_rx; /**< scattered packets RX supported. */
1601 uint8_t queue_state; /**< one of RTE_ETH_QUEUE_STATE_*. */
1602 uint16_t nb_desc; /**< configured number of RXDs. */
1603 uint16_t rx_buf_size; /**< hardware receive buffer size. */
1604 } __rte_cache_min_aligned;
1607 * Ethernet device TX queue information structure.
1608 * Used to retrieve information about configured queue.
1610 struct rte_eth_txq_info {
1611 struct rte_eth_txconf conf; /**< queue config parameters. */
1612 uint16_t nb_desc; /**< configured number of TXDs. */
1613 uint8_t queue_state; /**< one of RTE_ETH_QUEUE_STATE_*. */
1614 } __rte_cache_min_aligned;
1616 /* Generic Burst mode flag definition, values can be ORed. */
1619 * If the queues have different burst mode description, this bit will be set
1620 * by PMD, then the application can iterate to retrieve burst description for
1623 #define RTE_ETH_BURST_FLAG_PER_QUEUE (1ULL << 0)
1626 * Ethernet device RX/TX queue packet burst mode information structure.
1627 * Used to retrieve information about packet burst mode setting.
1629 struct rte_eth_burst_mode {
1630 uint64_t flags; /**< The ORed values of RTE_ETH_BURST_FLAG_xxx */
1632 #define RTE_ETH_BURST_MODE_INFO_SIZE 1024 /**< Maximum size for information */
1633 char info[RTE_ETH_BURST_MODE_INFO_SIZE]; /**< burst mode information */
1636 /** Maximum name length for extended statistics counters */
1637 #define RTE_ETH_XSTATS_NAME_SIZE 64
1640 * An Ethernet device extended statistic structure
1642 * This structure is used by rte_eth_xstats_get() to provide
1643 * statistics that are not provided in the generic *rte_eth_stats*
1645 * It maps a name id, corresponding to an index in the array returned
1646 * by rte_eth_xstats_get_names(), to a statistic value.
1648 struct rte_eth_xstat {
1649 uint64_t id; /**< The index in xstats name array. */
1650 uint64_t value; /**< The statistic counter value. */
1654 * A name element for extended statistics.
1656 * An array of this structure is returned by rte_eth_xstats_get_names().
1657 * It lists the names of extended statistics for a PMD. The *rte_eth_xstat*
1658 * structure references these names by their array index.
1660 * The xstats should follow a common naming scheme.
1661 * Some names are standardized in rte_stats_strings.
1663 * - rx_missed_errors
1665 * - tx_size_128_to_255_packets
1667 struct rte_eth_xstat_name {
1668 char name[RTE_ETH_XSTATS_NAME_SIZE]; /**< The statistic name. */
1671 #define ETH_DCB_NUM_TCS 8
1672 #define ETH_MAX_VMDQ_POOL 64
1675 * A structure used to get the information of queue and
1676 * TC mapping on both TX and RX paths.
1678 struct rte_eth_dcb_tc_queue_mapping {
1679 /** rx queues assigned to tc per Pool */
1683 } tc_rxq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
1684 /** rx queues assigned to tc per Pool */
1688 } tc_txq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
1692 * A structure used to get the information of DCB.
1693 * It includes TC UP mapping and queue TC mapping.
1695 struct rte_eth_dcb_info {
1696 uint8_t nb_tcs; /**< number of TCs */
1697 uint8_t prio_tc[ETH_DCB_NUM_USER_PRIORITIES]; /**< Priority to tc */
1698 uint8_t tc_bws[ETH_DCB_NUM_TCS]; /**< TX BW percentage for each TC */
1699 /** rx queues assigned to tc */
1700 struct rte_eth_dcb_tc_queue_mapping tc_queue;
1704 * This enum indicates the possible Forward Error Correction (FEC) modes
1705 * of an ethdev port.
1707 enum rte_eth_fec_mode {
1708 RTE_ETH_FEC_NOFEC = 0, /**< FEC is off */
1709 RTE_ETH_FEC_AUTO, /**< FEC autonegotiation modes */
1710 RTE_ETH_FEC_BASER, /**< FEC using common algorithm */
1711 RTE_ETH_FEC_RS, /**< FEC using RS algorithm */
1714 /* Translate from FEC mode to FEC capa */
1715 #define RTE_ETH_FEC_MODE_TO_CAPA(x) (1U << (x))
1717 /* This macro indicates FEC capa mask */
1718 #define RTE_ETH_FEC_MODE_CAPA_MASK(x) (1U << (RTE_ETH_FEC_ ## x))
1720 /* A structure used to get capabilities per link speed */
1721 struct rte_eth_fec_capa {
1722 uint32_t speed; /**< Link speed (see ETH_SPEED_NUM_*) */
1723 uint32_t capa; /**< FEC capabilities bitmask */
1726 #define RTE_ETH_ALL RTE_MAX_ETHPORTS
1728 /* Macros to check for valid port */
1729 #define RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, retval) do { \
1730 if (!rte_eth_dev_is_valid_port(port_id)) { \
1731 RTE_ETHDEV_LOG(ERR, "Invalid port_id=%u\n", port_id); \
1736 #define RTE_ETH_VALID_PORTID_OR_RET(port_id) do { \
1737 if (!rte_eth_dev_is_valid_port(port_id)) { \
1738 RTE_ETHDEV_LOG(ERR, "Invalid port_id=%u\n", port_id); \
1743 /**@{@name L2 tunnel configuration */
1744 /**< l2 tunnel enable mask */
1745 #define ETH_L2_TUNNEL_ENABLE_MASK 0x00000001
1746 /**< l2 tunnel insertion mask */
1747 #define ETH_L2_TUNNEL_INSERTION_MASK 0x00000002
1748 /**< l2 tunnel stripping mask */
1749 #define ETH_L2_TUNNEL_STRIPPING_MASK 0x00000004
1750 /**< l2 tunnel forwarding mask */
1751 #define ETH_L2_TUNNEL_FORWARDING_MASK 0x00000008
1755 * Function type used for RX packet processing packet callbacks.
1757 * The callback function is called on RX with a burst of packets that have
1758 * been received on the given port and queue.
1761 * The Ethernet port on which RX is being performed.
1763 * The queue on the Ethernet port which is being used to receive the packets.
1765 * The burst of packets that have just been received.
1767 * The number of packets in the burst pointed to by "pkts".
1769 * The max number of packets that can be stored in the "pkts" array.
1771 * The arbitrary user parameter passed in by the application when the callback
1772 * was originally configured.
1774 * The number of packets returned to the user.
1776 typedef uint16_t (*rte_rx_callback_fn)(uint16_t port_id, uint16_t queue,
1777 struct rte_mbuf *pkts[], uint16_t nb_pkts, uint16_t max_pkts,
1781 * Function type used for TX packet processing packet callbacks.
1783 * The callback function is called on TX with a burst of packets immediately
1784 * before the packets are put onto the hardware queue for transmission.
1787 * The Ethernet port on which TX is being performed.
1789 * The queue on the Ethernet port which is being used to transmit the packets.
1791 * The burst of packets that are about to be transmitted.
1793 * The number of packets in the burst pointed to by "pkts".
1795 * The arbitrary user parameter passed in by the application when the callback
1796 * was originally configured.
1798 * The number of packets to be written to the NIC.
1800 typedef uint16_t (*rte_tx_callback_fn)(uint16_t port_id, uint16_t queue,
1801 struct rte_mbuf *pkts[], uint16_t nb_pkts, void *user_param);
1804 * Possible states of an ethdev port.
1806 enum rte_eth_dev_state {
1807 /** Device is unused before being probed. */
1808 RTE_ETH_DEV_UNUSED = 0,
1809 /** Device is attached when allocated in probing. */
1810 RTE_ETH_DEV_ATTACHED,
1811 /** Device is in removed state when plug-out is detected. */
1812 RTE_ETH_DEV_REMOVED,
1815 struct rte_eth_dev_sriov {
1816 uint8_t active; /**< SRIOV is active with 16, 32 or 64 pools */
1817 uint8_t nb_q_per_pool; /**< rx queue number per pool */
1818 uint16_t def_vmdq_idx; /**< Default pool num used for PF */
1819 uint16_t def_pool_q_idx; /**< Default pool queue start reg index */
1821 #define RTE_ETH_DEV_SRIOV(dev) ((dev)->data->sriov)
1823 #define RTE_ETH_NAME_MAX_LEN RTE_DEV_NAME_MAX_LEN
1825 #define RTE_ETH_DEV_NO_OWNER 0
1827 #define RTE_ETH_MAX_OWNER_NAME_LEN 64
1829 struct rte_eth_dev_owner {
1830 uint64_t id; /**< The owner unique identifier. */
1831 char name[RTE_ETH_MAX_OWNER_NAME_LEN]; /**< The owner name. */
1834 /**@{@name Device flags
1835 * Flags internally saved in rte_eth_dev_data.dev_flags
1836 * and reported in rte_eth_dev_info.dev_flags.
1838 /** PMD supports thread-safe flow operations */
1839 #define RTE_ETH_DEV_FLOW_OPS_THREAD_SAFE 0x0001
1840 /** Device supports link state interrupt */
1841 #define RTE_ETH_DEV_INTR_LSC 0x0002
1842 /** Device is a bonded slave */
1843 #define RTE_ETH_DEV_BONDED_SLAVE 0x0004
1844 /** Device supports device removal interrupt */
1845 #define RTE_ETH_DEV_INTR_RMV 0x0008
1846 /** Device is port representor */
1847 #define RTE_ETH_DEV_REPRESENTOR 0x0010
1848 /** Device does not support MAC change after started */
1849 #define RTE_ETH_DEV_NOLIVE_MAC_ADDR 0x0020
1851 * Queue xstats filled automatically by ethdev layer.
1852 * PMDs filling the queue xstats themselves should not set this flag
1854 #define RTE_ETH_DEV_AUTOFILL_QUEUE_XSTATS 0x0040
1858 * Iterates over valid ethdev ports owned by a specific owner.
1861 * The id of the next possible valid owned port.
1863 * The owner identifier.
1864 * RTE_ETH_DEV_NO_OWNER means iterate over all valid ownerless ports.
1866 * Next valid port id owned by owner_id, RTE_MAX_ETHPORTS if there is none.
1868 uint64_t rte_eth_find_next_owned_by(uint16_t port_id,
1869 const uint64_t owner_id);
1872 * Macro to iterate over all enabled ethdev ports owned by a specific owner.
1874 #define RTE_ETH_FOREACH_DEV_OWNED_BY(p, o) \
1875 for (p = rte_eth_find_next_owned_by(0, o); \
1876 (unsigned int)p < (unsigned int)RTE_MAX_ETHPORTS; \
1877 p = rte_eth_find_next_owned_by(p + 1, o))
1880 * Iterates over valid ethdev ports.
1883 * The id of the next possible valid port.
1885 * Next valid port id, RTE_MAX_ETHPORTS if there is none.
1887 uint16_t rte_eth_find_next(uint16_t port_id);
1890 * Macro to iterate over all enabled and ownerless ethdev ports.
1892 #define RTE_ETH_FOREACH_DEV(p) \
1893 RTE_ETH_FOREACH_DEV_OWNED_BY(p, RTE_ETH_DEV_NO_OWNER)
1896 * Iterates over ethdev ports of a specified device.
1898 * @param port_id_start
1899 * The id of the next possible valid port.
1901 * The generic device behind the ports to iterate.
1903 * Next port id of the device, possibly port_id_start,
1904 * RTE_MAX_ETHPORTS if there is none.
1907 rte_eth_find_next_of(uint16_t port_id_start,
1908 const struct rte_device *parent);
1911 * Macro to iterate over all ethdev ports of a specified device.
1914 * The id of the matching port being iterated.
1916 * The rte_device pointer matching the iterated ports.
1918 #define RTE_ETH_FOREACH_DEV_OF(port_id, parent) \
1919 for (port_id = rte_eth_find_next_of(0, parent); \
1920 port_id < RTE_MAX_ETHPORTS; \
1921 port_id = rte_eth_find_next_of(port_id + 1, parent))
1924 * Iterates over sibling ethdev ports (i.e. sharing the same rte_device).
1926 * @param port_id_start
1927 * The id of the next possible valid sibling port.
1928 * @param ref_port_id
1929 * The id of a reference port to compare rte_device with.
1931 * Next sibling port id, possibly port_id_start or ref_port_id itself,
1932 * RTE_MAX_ETHPORTS if there is none.
1935 rte_eth_find_next_sibling(uint16_t port_id_start, uint16_t ref_port_id);
1938 * Macro to iterate over all ethdev ports sharing the same rte_device
1939 * as the specified port.
1940 * Note: the specified reference port is part of the loop iterations.
1943 * The id of the matching port being iterated.
1944 * @param ref_port_id
1945 * The id of the port being compared.
1947 #define RTE_ETH_FOREACH_DEV_SIBLING(port_id, ref_port_id) \
1948 for (port_id = rte_eth_find_next_sibling(0, ref_port_id); \
1949 port_id < RTE_MAX_ETHPORTS; \
1950 port_id = rte_eth_find_next_sibling(port_id + 1, ref_port_id))
1954 * @b EXPERIMENTAL: this API may change without prior notice.
1956 * Get a new unique owner identifier.
1957 * An owner identifier is used to owns Ethernet devices by only one DPDK entity
1958 * to avoid multiple management of device by different entities.
1961 * Owner identifier pointer.
1963 * Negative errno value on error, 0 on success.
1966 int rte_eth_dev_owner_new(uint64_t *owner_id);
1970 * @b EXPERIMENTAL: this API may change without prior notice.
1972 * Set an Ethernet device owner.
1975 * The identifier of the port to own.
1977 * The owner pointer.
1979 * Negative errno value on error, 0 on success.
1982 int rte_eth_dev_owner_set(const uint16_t port_id,
1983 const struct rte_eth_dev_owner *owner);
1987 * @b EXPERIMENTAL: this API may change without prior notice.
1989 * Unset Ethernet device owner to make the device ownerless.
1992 * The identifier of port to make ownerless.
1994 * The owner identifier.
1996 * 0 on success, negative errno value on error.
1999 int rte_eth_dev_owner_unset(const uint16_t port_id,
2000 const uint64_t owner_id);
2004 * @b EXPERIMENTAL: this API may change without prior notice.
2006 * Remove owner from all Ethernet devices owned by a specific owner.
2009 * The owner identifier.
2011 * 0 on success, negative errno value on error.
2014 int rte_eth_dev_owner_delete(const uint64_t owner_id);
2018 * @b EXPERIMENTAL: this API may change without prior notice.
2020 * Get the owner of an Ethernet device.
2023 * The port identifier.
2025 * The owner structure pointer to fill.
2027 * 0 on success, negative errno value on error..
2030 int rte_eth_dev_owner_get(const uint16_t port_id,
2031 struct rte_eth_dev_owner *owner);
2034 * Get the number of ports which are usable for the application.
2036 * These devices must be iterated by using the macro
2037 * ``RTE_ETH_FOREACH_DEV`` or ``RTE_ETH_FOREACH_DEV_OWNED_BY``
2038 * to deal with non-contiguous ranges of devices.
2041 * The count of available Ethernet devices.
2043 uint16_t rte_eth_dev_count_avail(void);
2046 * Get the total number of ports which are allocated.
2048 * Some devices may not be available for the application.
2051 * The total count of Ethernet devices.
2053 uint16_t rte_eth_dev_count_total(void);
2056 * Convert a numerical speed in Mbps to a bitmap flag that can be used in
2057 * the bitmap link_speeds of the struct rte_eth_conf
2060 * Numerical speed value in Mbps
2062 * ETH_LINK_[HALF/FULL]_DUPLEX (only for 10/100M speeds)
2064 * 0 if the speed cannot be mapped
2066 uint32_t rte_eth_speed_bitflag(uint32_t speed, int duplex);
2069 * Get DEV_RX_OFFLOAD_* flag name.
2074 * Offload name or 'UNKNOWN' if the flag cannot be recognised.
2076 const char *rte_eth_dev_rx_offload_name(uint64_t offload);
2079 * Get DEV_TX_OFFLOAD_* flag name.
2084 * Offload name or 'UNKNOWN' if the flag cannot be recognised.
2086 const char *rte_eth_dev_tx_offload_name(uint64_t offload);
2089 * Configure an Ethernet device.
2090 * This function must be invoked first before any other function in the
2091 * Ethernet API. This function can also be re-invoked when a device is in the
2095 * The port identifier of the Ethernet device to configure.
2096 * @param nb_rx_queue
2097 * The number of receive queues to set up for the Ethernet device.
2098 * @param nb_tx_queue
2099 * The number of transmit queues to set up for the Ethernet device.
2101 * The pointer to the configuration data to be used for the Ethernet device.
2102 * The *rte_eth_conf* structure includes:
2103 * - the hardware offload features to activate, with dedicated fields for
2104 * each statically configurable offload hardware feature provided by
2105 * Ethernet devices, such as IP checksum or VLAN tag stripping for
2107 * The Rx offload bitfield API is obsolete and will be deprecated.
2108 * Applications should set the ignore_bitfield_offloads bit on *rxmode*
2109 * structure and use offloads field to set per-port offloads instead.
2110 * - Any offloading set in eth_conf->[rt]xmode.offloads must be within
2111 * the [rt]x_offload_capa returned from rte_eth_dev_info_get().
2112 * Any type of device supported offloading set in the input argument
2113 * eth_conf->[rt]xmode.offloads to rte_eth_dev_configure() is enabled
2114 * on all queues and it can't be disabled in rte_eth_[rt]x_queue_setup()
2115 * - the Receive Side Scaling (RSS) configuration when using multiple RX
2116 * queues per port. Any RSS hash function set in eth_conf->rss_conf.rss_hf
2117 * must be within the flow_type_rss_offloads provided by drivers via
2118 * rte_eth_dev_info_get() API.
2120 * Embedding all configuration information in a single data structure
2121 * is the more flexible method that allows the addition of new features
2122 * without changing the syntax of the API.
2124 * - 0: Success, device configured.
2125 * - <0: Error code returned by the driver configuration function.
2127 int rte_eth_dev_configure(uint16_t port_id, uint16_t nb_rx_queue,
2128 uint16_t nb_tx_queue, const struct rte_eth_conf *eth_conf);
2132 * @b EXPERIMENTAL: this API may change without prior notice.
2134 * Check if an Ethernet device was physically removed.
2137 * The port identifier of the Ethernet device.
2139 * 1 when the Ethernet device is removed, otherwise 0.
2143 rte_eth_dev_is_removed(uint16_t port_id);
2146 * Allocate and set up a receive queue for an Ethernet device.
2148 * The function allocates a contiguous block of memory for *nb_rx_desc*
2149 * receive descriptors from a memory zone associated with *socket_id*
2150 * and initializes each receive descriptor with a network buffer allocated
2151 * from the memory pool *mb_pool*.
2154 * The port identifier of the Ethernet device.
2155 * @param rx_queue_id
2156 * The index of the receive queue to set up.
2157 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2158 * to rte_eth_dev_configure().
2160 * The number of receive descriptors to allocate for the receive ring.
2162 * The *socket_id* argument is the socket identifier in case of NUMA.
2163 * The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
2164 * the DMA memory allocated for the receive descriptors of the ring.
2166 * The pointer to the configuration data to be used for the receive queue.
2167 * NULL value is allowed, in which case default RX configuration
2169 * The *rx_conf* structure contains an *rx_thresh* structure with the values
2170 * of the Prefetch, Host, and Write-Back threshold registers of the receive
2172 * In addition it contains the hardware offloads features to activate using
2173 * the DEV_RX_OFFLOAD_* flags.
2174 * If an offloading set in rx_conf->offloads
2175 * hasn't been set in the input argument eth_conf->rxmode.offloads
2176 * to rte_eth_dev_configure(), it is a new added offloading, it must be
2177 * per-queue type and it is enabled for the queue.
2178 * No need to repeat any bit in rx_conf->offloads which has already been
2179 * enabled in rte_eth_dev_configure() at port level. An offloading enabled
2180 * at port level can't be disabled at queue level.
2181 * The configuration structure also contains the pointer to the array
2182 * of the receiving buffer segment descriptions, see rx_seg and rx_nseg
2183 * fields, this extended configuration might be used by split offloads like
2184 * RTE_ETH_RX_OFFLOAD_BUFFER_SPLIT. If mb_pool is not NULL,
2185 * the extended configuration fields must be set to NULL and zero.
2187 * The pointer to the memory pool from which to allocate *rte_mbuf* network
2188 * memory buffers to populate each descriptor of the receive ring. There are
2189 * two options to provide Rx buffer configuration:
2191 * mb_pool is not NULL, rx_conf.rx_nseg is 0.
2192 * - multiple segments description:
2193 * mb_pool is NULL, rx_conf.rx_seg is not NULL, rx_conf.rx_nseg is not 0.
2194 * Taken only if flag RTE_ETH_RX_OFFLOAD_BUFFER_SPLIT is set in offloads.
2197 * - 0: Success, receive queue correctly set up.
2198 * - -EIO: if device is removed.
2199 * - -ENODEV: if *port_id* is invalid.
2200 * - -EINVAL: The memory pool pointer is null or the size of network buffers
2201 * which can be allocated from this memory pool does not fit the various
2202 * buffer sizes allowed by the device controller.
2203 * - -ENOMEM: Unable to allocate the receive ring descriptors or to
2204 * allocate network memory buffers from the memory pool when
2205 * initializing receive descriptors.
2207 int rte_eth_rx_queue_setup(uint16_t port_id, uint16_t rx_queue_id,
2208 uint16_t nb_rx_desc, unsigned int socket_id,
2209 const struct rte_eth_rxconf *rx_conf,
2210 struct rte_mempool *mb_pool);
2214 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
2216 * Allocate and set up a hairpin receive queue for an Ethernet device.
2218 * The function set up the selected queue to be used in hairpin.
2221 * The port identifier of the Ethernet device.
2222 * @param rx_queue_id
2223 * The index of the receive queue to set up.
2224 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2225 * to rte_eth_dev_configure().
2227 * The number of receive descriptors to allocate for the receive ring.
2228 * 0 means the PMD will use default value.
2230 * The pointer to the hairpin configuration.
2233 * - (0) if successful.
2234 * - (-ENODEV) if *port_id* is invalid.
2235 * - (-ENOTSUP) if hardware doesn't support.
2236 * - (-EINVAL) if bad parameter.
2237 * - (-ENOMEM) if unable to allocate the resources.
2240 int rte_eth_rx_hairpin_queue_setup
2241 (uint16_t port_id, uint16_t rx_queue_id, uint16_t nb_rx_desc,
2242 const struct rte_eth_hairpin_conf *conf);
2245 * Allocate and set up a transmit queue for an Ethernet device.
2248 * The port identifier of the Ethernet device.
2249 * @param tx_queue_id
2250 * The index of the transmit queue to set up.
2251 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2252 * to rte_eth_dev_configure().
2254 * The number of transmit descriptors to allocate for the transmit ring.
2256 * The *socket_id* argument is the socket identifier in case of NUMA.
2257 * Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
2258 * the DMA memory allocated for the transmit descriptors of the ring.
2260 * The pointer to the configuration data to be used for the transmit queue.
2261 * NULL value is allowed, in which case default TX configuration
2263 * The *tx_conf* structure contains the following data:
2264 * - The *tx_thresh* structure with the values of the Prefetch, Host, and
2265 * Write-Back threshold registers of the transmit ring.
2266 * When setting Write-Back threshold to the value greater then zero,
2267 * *tx_rs_thresh* value should be explicitly set to one.
2268 * - The *tx_free_thresh* value indicates the [minimum] number of network
2269 * buffers that must be pending in the transmit ring to trigger their
2270 * [implicit] freeing by the driver transmit function.
2271 * - The *tx_rs_thresh* value indicates the [minimum] number of transmit
2272 * descriptors that must be pending in the transmit ring before setting the
2273 * RS bit on a descriptor by the driver transmit function.
2274 * The *tx_rs_thresh* value should be less or equal then
2275 * *tx_free_thresh* value, and both of them should be less then
2277 * - The *offloads* member contains Tx offloads to be enabled.
2278 * If an offloading set in tx_conf->offloads
2279 * hasn't been set in the input argument eth_conf->txmode.offloads
2280 * to rte_eth_dev_configure(), it is a new added offloading, it must be
2281 * per-queue type and it is enabled for the queue.
2282 * No need to repeat any bit in tx_conf->offloads which has already been
2283 * enabled in rte_eth_dev_configure() at port level. An offloading enabled
2284 * at port level can't be disabled at queue level.
2286 * Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces
2287 * the transmit function to use default values.
2289 * - 0: Success, the transmit queue is correctly set up.
2290 * - -ENOMEM: Unable to allocate the transmit ring descriptors.
2292 int rte_eth_tx_queue_setup(uint16_t port_id, uint16_t tx_queue_id,
2293 uint16_t nb_tx_desc, unsigned int socket_id,
2294 const struct rte_eth_txconf *tx_conf);
2298 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
2300 * Allocate and set up a transmit hairpin queue for an Ethernet device.
2303 * The port identifier of the Ethernet device.
2304 * @param tx_queue_id
2305 * The index of the transmit queue to set up.
2306 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2307 * to rte_eth_dev_configure().
2309 * The number of transmit descriptors to allocate for the transmit ring.
2310 * 0 to set default PMD value.
2312 * The hairpin configuration.
2315 * - (0) if successful.
2316 * - (-ENODEV) if *port_id* is invalid.
2317 * - (-ENOTSUP) if hardware doesn't support.
2318 * - (-EINVAL) if bad parameter.
2319 * - (-ENOMEM) if unable to allocate the resources.
2322 int rte_eth_tx_hairpin_queue_setup
2323 (uint16_t port_id, uint16_t tx_queue_id, uint16_t nb_tx_desc,
2324 const struct rte_eth_hairpin_conf *conf);
2328 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
2330 * Get all the hairpin peer Rx / Tx ports of the current port.
2331 * The caller should ensure that the array is large enough to save the ports
2335 * The port identifier of the Ethernet device.
2337 * Pointer to the array to store the peer ports list.
2339 * Length of the array to store the port identifiers.
2341 * Current port to peer port direction
2342 * positive - current used as Tx to get all peer Rx ports.
2343 * zero - current used as Rx to get all peer Tx ports.
2346 * - (0 or positive) actual peer ports number.
2347 * - (-EINVAL) if bad parameter.
2348 * - (-ENODEV) if *port_id* invalid
2349 * - (-ENOTSUP) if hardware doesn't support.
2350 * - Others detailed errors from PMD drivers.
2353 int rte_eth_hairpin_get_peer_ports(uint16_t port_id, uint16_t *peer_ports,
2354 size_t len, uint32_t direction);
2358 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
2360 * Bind all hairpin Tx queues of one port to the Rx queues of the peer port.
2361 * It is only allowed to call this function after all hairpin queues are
2362 * configured properly and the devices are in started state.
2365 * The identifier of the Tx port.
2367 * The identifier of peer Rx port.
2368 * RTE_MAX_ETHPORTS is allowed for the traversal of all devices.
2369 * Rx port ID could have the same value as Tx port ID.
2372 * - (0) if successful.
2373 * - (-ENODEV) if Tx port ID is invalid.
2374 * - (-EBUSY) if device is not in started state.
2375 * - (-ENOTSUP) if hardware doesn't support.
2376 * - Others detailed errors from PMD drivers.
2379 int rte_eth_hairpin_bind(uint16_t tx_port, uint16_t rx_port);
2383 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
2385 * Unbind all hairpin Tx queues of one port from the Rx queues of the peer port.
2386 * This should be called before closing the Tx or Rx devices, if the bind
2387 * function is called before.
2388 * After unbinding the hairpin ports pair, it is allowed to bind them again.
2389 * Changing queues configuration should be after stopping the device(s).
2392 * The identifier of the Tx port.
2394 * The identifier of peer Rx port.
2395 * RTE_MAX_ETHPORTS is allowed for traversal of all devices.
2396 * Rx port ID could have the same value as Tx port ID.
2399 * - (0) if successful.
2400 * - (-ENODEV) if Tx port ID is invalid.
2401 * - (-EBUSY) if device is in stopped state.
2402 * - (-ENOTSUP) if hardware doesn't support.
2403 * - Others detailed errors from PMD drivers.
2406 int rte_eth_hairpin_unbind(uint16_t tx_port, uint16_t rx_port);
2409 * Return the NUMA socket to which an Ethernet device is connected
2412 * The port identifier of the Ethernet device
2414 * The NUMA socket id to which the Ethernet device is connected or
2415 * a default of zero if the socket could not be determined.
2416 * -1 is returned is the port_id value is out of range.
2418 int rte_eth_dev_socket_id(uint16_t port_id);
2421 * Check if port_id of device is attached
2424 * The port identifier of the Ethernet device
2426 * - 0 if port is out of range or not attached
2427 * - 1 if device is attached
2429 int rte_eth_dev_is_valid_port(uint16_t port_id);
2432 * Start specified RX queue of a port. It is used when rx_deferred_start
2433 * flag of the specified queue is true.
2436 * The port identifier of the Ethernet device
2437 * @param rx_queue_id
2438 * The index of the rx queue to update the ring.
2439 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2440 * to rte_eth_dev_configure().
2442 * - 0: Success, the receive queue is started.
2443 * - -ENODEV: if *port_id* is invalid.
2444 * - -EINVAL: The queue_id out of range or belong to hairpin.
2445 * - -EIO: if device is removed.
2446 * - -ENOTSUP: The function not supported in PMD driver.
2448 int rte_eth_dev_rx_queue_start(uint16_t port_id, uint16_t rx_queue_id);
2451 * Stop specified RX queue of a port
2454 * The port identifier of the Ethernet device
2455 * @param rx_queue_id
2456 * The index of the rx queue to update the ring.
2457 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2458 * to rte_eth_dev_configure().
2460 * - 0: Success, the receive queue is stopped.
2461 * - -ENODEV: if *port_id* is invalid.
2462 * - -EINVAL: The queue_id out of range or belong to hairpin.
2463 * - -EIO: if device is removed.
2464 * - -ENOTSUP: The function not supported in PMD driver.
2466 int rte_eth_dev_rx_queue_stop(uint16_t port_id, uint16_t rx_queue_id);
2469 * Start TX for specified queue of a port. It is used when tx_deferred_start
2470 * flag of the specified queue is true.
2473 * The port identifier of the Ethernet device
2474 * @param tx_queue_id
2475 * The index of the tx queue to update the ring.
2476 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2477 * to rte_eth_dev_configure().
2479 * - 0: Success, the transmit queue is started.
2480 * - -ENODEV: if *port_id* is invalid.
2481 * - -EINVAL: The queue_id out of range or belong to hairpin.
2482 * - -EIO: if device is removed.
2483 * - -ENOTSUP: The function not supported in PMD driver.
2485 int rte_eth_dev_tx_queue_start(uint16_t port_id, uint16_t tx_queue_id);
2488 * Stop specified TX queue of a port
2491 * The port identifier of the Ethernet device
2492 * @param tx_queue_id
2493 * The index of the tx queue to update the ring.
2494 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2495 * to rte_eth_dev_configure().
2497 * - 0: Success, the transmit queue is stopped.
2498 * - -ENODEV: if *port_id* is invalid.
2499 * - -EINVAL: The queue_id out of range or belong to hairpin.
2500 * - -EIO: if device is removed.
2501 * - -ENOTSUP: The function not supported in PMD driver.
2503 int rte_eth_dev_tx_queue_stop(uint16_t port_id, uint16_t tx_queue_id);
2506 * Start an Ethernet device.
2508 * The device start step is the last one and consists of setting the configured
2509 * offload features and in starting the transmit and the receive units of the
2512 * Device RTE_ETH_DEV_NOLIVE_MAC_ADDR flag causes MAC address to be set before
2513 * PMD port start callback function is invoked.
2515 * On success, all basic functions exported by the Ethernet API (link status,
2516 * receive/transmit, and so on) can be invoked.
2519 * The port identifier of the Ethernet device.
2521 * - 0: Success, Ethernet device started.
2522 * - <0: Error code of the driver device start function.
2524 int rte_eth_dev_start(uint16_t port_id);
2527 * Stop an Ethernet device. The device can be restarted with a call to
2528 * rte_eth_dev_start()
2531 * The port identifier of the Ethernet device.
2533 * - 0: Success, Ethernet device stopped.
2534 * - <0: Error code of the driver device stop function.
2536 int rte_eth_dev_stop(uint16_t port_id);
2539 * Link up an Ethernet device.
2541 * Set device link up will re-enable the device rx/tx
2542 * functionality after it is previously set device linked down.
2545 * The port identifier of the Ethernet device.
2547 * - 0: Success, Ethernet device linked up.
2548 * - <0: Error code of the driver device link up function.
2550 int rte_eth_dev_set_link_up(uint16_t port_id);
2553 * Link down an Ethernet device.
2554 * The device rx/tx functionality will be disabled if success,
2555 * and it can be re-enabled with a call to
2556 * rte_eth_dev_set_link_up()
2559 * The port identifier of the Ethernet device.
2561 int rte_eth_dev_set_link_down(uint16_t port_id);
2564 * Close a stopped Ethernet device. The device cannot be restarted!
2565 * The function frees all port resources.
2568 * The port identifier of the Ethernet device.
2570 * - Zero if the port is closed successfully.
2571 * - Negative if something went wrong.
2573 int rte_eth_dev_close(uint16_t port_id);
2576 * Reset a Ethernet device and keep its port id.
2578 * When a port has to be reset passively, the DPDK application can invoke
2579 * this function. For example when a PF is reset, all its VFs should also
2580 * be reset. Normally a DPDK application can invoke this function when
2581 * RTE_ETH_EVENT_INTR_RESET event is detected, but can also use it to start
2582 * a port reset in other circumstances.
2584 * When this function is called, it first stops the port and then calls the
2585 * PMD specific dev_uninit( ) and dev_init( ) to return the port to initial
2586 * state, in which no Tx and Rx queues are setup, as if the port has been
2587 * reset and not started. The port keeps the port id it had before the
2590 * After calling rte_eth_dev_reset( ), the application should use
2591 * rte_eth_dev_configure( ), rte_eth_rx_queue_setup( ),
2592 * rte_eth_tx_queue_setup( ), and rte_eth_dev_start( )
2593 * to reconfigure the device as appropriate.
2595 * Note: To avoid unexpected behavior, the application should stop calling
2596 * Tx and Rx functions before calling rte_eth_dev_reset( ). For thread
2597 * safety, all these controlling functions should be called from the same
2601 * The port identifier of the Ethernet device.
2604 * - (0) if successful.
2605 * - (-ENODEV) if *port_id* is invalid.
2606 * - (-ENOTSUP) if hardware doesn't support this function.
2607 * - (-EPERM) if not ran from the primary process.
2608 * - (-EIO) if re-initialisation failed or device is removed.
2609 * - (-ENOMEM) if the reset failed due to OOM.
2610 * - (-EAGAIN) if the reset temporarily failed and should be retried later.
2612 int rte_eth_dev_reset(uint16_t port_id);
2615 * Enable receipt in promiscuous mode for an Ethernet device.
2618 * The port identifier of the Ethernet device.
2620 * - (0) if successful.
2621 * - (-ENOTSUP) if support for promiscuous_enable() does not exist
2623 * - (-ENODEV) if *port_id* invalid.
2625 int rte_eth_promiscuous_enable(uint16_t port_id);
2628 * Disable receipt in promiscuous mode for an Ethernet device.
2631 * The port identifier of the Ethernet device.
2633 * - (0) if successful.
2634 * - (-ENOTSUP) if support for promiscuous_disable() does not exist
2636 * - (-ENODEV) if *port_id* invalid.
2638 int rte_eth_promiscuous_disable(uint16_t port_id);
2641 * Return the value of promiscuous mode for an Ethernet device.
2644 * The port identifier of the Ethernet device.
2646 * - (1) if promiscuous is enabled
2647 * - (0) if promiscuous is disabled.
2650 int rte_eth_promiscuous_get(uint16_t port_id);
2653 * Enable the receipt of any multicast frame by an Ethernet device.
2656 * The port identifier of the Ethernet device.
2658 * - (0) if successful.
2659 * - (-ENOTSUP) if support for allmulticast_enable() does not exist
2661 * - (-ENODEV) if *port_id* invalid.
2663 int rte_eth_allmulticast_enable(uint16_t port_id);
2666 * Disable the receipt of all multicast frames by an Ethernet device.
2669 * The port identifier of the Ethernet device.
2671 * - (0) if successful.
2672 * - (-ENOTSUP) if support for allmulticast_disable() does not exist
2674 * - (-ENODEV) if *port_id* invalid.
2676 int rte_eth_allmulticast_disable(uint16_t port_id);
2679 * Return the value of allmulticast mode for an Ethernet device.
2682 * The port identifier of the Ethernet device.
2684 * - (1) if allmulticast is enabled
2685 * - (0) if allmulticast is disabled.
2688 int rte_eth_allmulticast_get(uint16_t port_id);
2691 * Retrieve the link status (up/down), the duplex mode (half/full),
2692 * the negotiation (auto/fixed), and if available, the speed (Mbps).
2694 * It might need to wait up to 9 seconds.
2695 * @see rte_eth_link_get_nowait.
2698 * The port identifier of the Ethernet device.
2700 * Link information written back.
2702 * - (0) if successful.
2703 * - (-ENOTSUP) if the function is not supported in PMD driver.
2704 * - (-ENODEV) if *port_id* invalid.
2705 * - (-EINVAL) if bad parameter.
2707 int rte_eth_link_get(uint16_t port_id, struct rte_eth_link *link);
2710 * Retrieve the link status (up/down), the duplex mode (half/full),
2711 * the negotiation (auto/fixed), and if available, the speed (Mbps).
2714 * The port identifier of the Ethernet device.
2716 * Link information written back.
2718 * - (0) if successful.
2719 * - (-ENOTSUP) if the function is not supported in PMD driver.
2720 * - (-ENODEV) if *port_id* invalid.
2721 * - (-EINVAL) if bad parameter.
2723 int rte_eth_link_get_nowait(uint16_t port_id, struct rte_eth_link *link);
2727 * @b EXPERIMENTAL: this API may change without prior notice.
2729 * The function converts a link_speed to a string. It handles all special
2730 * values like unknown or none speed.
2733 * link_speed of rte_eth_link struct
2735 * Link speed in textual format. It's pointer to immutable memory.
2736 * No free is required.
2739 const char *rte_eth_link_speed_to_str(uint32_t link_speed);
2743 * @b EXPERIMENTAL: this API may change without prior notice.
2745 * The function converts a rte_eth_link struct representing a link status to
2749 * A pointer to a string to be filled with textual representation of
2750 * device status. At least ETH_LINK_MAX_STR_LEN bytes should be allocated to
2751 * store default link status text.
2753 * Length of available memory at 'str' string.
2755 * Link status returned by rte_eth_link_get function
2757 * Number of bytes written to str array or -EINVAL if bad parameter.
2760 int rte_eth_link_to_str(char *str, size_t len,
2761 const struct rte_eth_link *eth_link);
2764 * Retrieve the general I/O statistics of an Ethernet device.
2767 * The port identifier of the Ethernet device.
2769 * A pointer to a structure of type *rte_eth_stats* to be filled with
2770 * the values of device counters for the following set of statistics:
2771 * - *ipackets* with the total of successfully received packets.
2772 * - *opackets* with the total of successfully transmitted packets.
2773 * - *ibytes* with the total of successfully received bytes.
2774 * - *obytes* with the total of successfully transmitted bytes.
2775 * - *ierrors* with the total of erroneous received packets.
2776 * - *oerrors* with the total of failed transmitted packets.
2778 * Zero if successful. Non-zero otherwise.
2780 int rte_eth_stats_get(uint16_t port_id, struct rte_eth_stats *stats);
2783 * Reset the general I/O statistics of an Ethernet device.
2786 * The port identifier of the Ethernet device.
2788 * - (0) if device notified to reset stats.
2789 * - (-ENOTSUP) if hardware doesn't support.
2790 * - (-ENODEV) if *port_id* invalid.
2791 * - (<0): Error code of the driver stats reset function.
2793 int rte_eth_stats_reset(uint16_t port_id);
2796 * Retrieve names of extended statistics of an Ethernet device.
2798 * There is an assumption that 'xstat_names' and 'xstats' arrays are matched
2800 * xstats_names[i].name => xstats[i].value
2802 * And the array index is same with id field of 'struct rte_eth_xstat':
2805 * This assumption makes key-value pair matching less flexible but simpler.
2808 * The port identifier of the Ethernet device.
2809 * @param xstats_names
2810 * An rte_eth_xstat_name array of at least *size* elements to
2811 * be filled. If set to NULL, the function returns the required number
2814 * The size of the xstats_names array (number of elements).
2816 * - A positive value lower or equal to size: success. The return value
2817 * is the number of entries filled in the stats table.
2818 * - A positive value higher than size: error, the given statistics table
2819 * is too small. The return value corresponds to the size that should
2820 * be given to succeed. The entries in the table are not valid and
2821 * shall not be used by the caller.
2822 * - A negative value on error (invalid port id).
2824 int rte_eth_xstats_get_names(uint16_t port_id,
2825 struct rte_eth_xstat_name *xstats_names,
2829 * Retrieve extended statistics of an Ethernet device.
2831 * There is an assumption that 'xstat_names' and 'xstats' arrays are matched
2833 * xstats_names[i].name => xstats[i].value
2835 * And the array index is same with id field of 'struct rte_eth_xstat':
2838 * This assumption makes key-value pair matching less flexible but simpler.
2841 * The port identifier of the Ethernet device.
2843 * A pointer to a table of structure of type *rte_eth_xstat*
2844 * to be filled with device statistics ids and values.
2845 * This parameter can be set to NULL if n is 0.
2847 * The size of the xstats array (number of elements).
2849 * - A positive value lower or equal to n: success. The return value
2850 * is the number of entries filled in the stats table.
2851 * - A positive value higher than n: error, the given statistics table
2852 * is too small. The return value corresponds to the size that should
2853 * be given to succeed. The entries in the table are not valid and
2854 * shall not be used by the caller.
2855 * - A negative value on error (invalid port id).
2857 int rte_eth_xstats_get(uint16_t port_id, struct rte_eth_xstat *xstats,
2861 * Retrieve names of extended statistics of an Ethernet device.
2864 * The port identifier of the Ethernet device.
2865 * @param xstats_names
2866 * Array to be filled in with names of requested device statistics.
2867 * Must not be NULL if @p ids are specified (not NULL).
2869 * Number of elements in @p xstats_names array (if not NULL) and in
2870 * @p ids array (if not NULL). Must be 0 if both array pointers are NULL.
2872 * IDs array given by app to retrieve specific statistics. May be NULL to
2873 * retrieve names of all available statistics or, if @p xstats_names is
2874 * NULL as well, just the number of available statistics.
2876 * - A positive value lower or equal to size: success. The return value
2877 * is the number of entries filled in the stats table.
2878 * - A positive value higher than size: success. The given statistics table
2879 * is too small. The return value corresponds to the size that should
2880 * be given to succeed. The entries in the table are not valid and
2881 * shall not be used by the caller.
2882 * - A negative value on error.
2885 rte_eth_xstats_get_names_by_id(uint16_t port_id,
2886 struct rte_eth_xstat_name *xstats_names, unsigned int size,
2890 * Retrieve extended statistics of an Ethernet device.
2893 * The port identifier of the Ethernet device.
2895 * IDs array given by app to retrieve specific statistics. May be NULL to
2896 * retrieve all available statistics or, if @p values is NULL as well,
2897 * just the number of available statistics.
2899 * Array to be filled in with requested device statistics.
2900 * Must not be NULL if ids are specified (not NULL).
2902 * Number of elements in @p values array (if not NULL) and in @p ids
2903 * array (if not NULL). Must be 0 if both array pointers are NULL.
2905 * - A positive value lower or equal to size: success. The return value
2906 * is the number of entries filled in the stats table.
2907 * - A positive value higher than size: success: The given statistics table
2908 * is too small. The return value corresponds to the size that should
2909 * be given to succeed. The entries in the table are not valid and
2910 * shall not be used by the caller.
2911 * - A negative value on error.
2913 int rte_eth_xstats_get_by_id(uint16_t port_id, const uint64_t *ids,
2914 uint64_t *values, unsigned int size);
2917 * Gets the ID of a statistic from its name.
2919 * This function searches for the statistics using string compares, and
2920 * as such should not be used on the fast-path. For fast-path retrieval of
2921 * specific statistics, store the ID as provided in *id* from this function,
2922 * and pass the ID to rte_eth_xstats_get()
2924 * @param port_id The port to look up statistics from
2925 * @param xstat_name The name of the statistic to return
2926 * @param[out] id A pointer to an app-supplied uint64_t which should be
2927 * set to the ID of the stat if the stat exists.
2930 * -ENODEV for invalid port_id,
2931 * -EIO if device is removed,
2932 * -EINVAL if the xstat_name doesn't exist in port_id
2933 * -ENOMEM if bad parameter.
2935 int rte_eth_xstats_get_id_by_name(uint16_t port_id, const char *xstat_name,
2939 * Reset extended statistics of an Ethernet device.
2942 * The port identifier of the Ethernet device.
2944 * - (0) if device notified to reset extended stats.
2945 * - (-ENOTSUP) if pmd doesn't support both
2946 * extended stats and basic stats reset.
2947 * - (-ENODEV) if *port_id* invalid.
2948 * - (<0): Error code of the driver xstats reset function.
2950 int rte_eth_xstats_reset(uint16_t port_id);
2953 * Set a mapping for the specified transmit queue to the specified per-queue
2954 * statistics counter.
2957 * The port identifier of the Ethernet device.
2958 * @param tx_queue_id
2959 * The index of the transmit queue for which a queue stats mapping is required.
2960 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2961 * to rte_eth_dev_configure().
2963 * The per-queue packet statistics functionality number that the transmit
2964 * queue is to be assigned.
2965 * The value must be in the range [0, RTE_ETHDEV_QUEUE_STAT_CNTRS - 1].
2966 * Max RTE_ETHDEV_QUEUE_STAT_CNTRS being 256.
2968 * Zero if successful. Non-zero otherwise.
2970 int rte_eth_dev_set_tx_queue_stats_mapping(uint16_t port_id,
2971 uint16_t tx_queue_id, uint8_t stat_idx);
2974 * Set a mapping for the specified receive queue to the specified per-queue
2975 * statistics counter.
2978 * The port identifier of the Ethernet device.
2979 * @param rx_queue_id
2980 * The index of the receive queue for which a queue stats mapping is required.
2981 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2982 * to rte_eth_dev_configure().
2984 * The per-queue packet statistics functionality number that the receive
2985 * queue is to be assigned.
2986 * The value must be in the range [0, RTE_ETHDEV_QUEUE_STAT_CNTRS - 1].
2987 * Max RTE_ETHDEV_QUEUE_STAT_CNTRS being 256.
2989 * Zero if successful. Non-zero otherwise.
2991 int rte_eth_dev_set_rx_queue_stats_mapping(uint16_t port_id,
2992 uint16_t rx_queue_id,
2996 * Retrieve the Ethernet address of an Ethernet device.
2999 * The port identifier of the Ethernet device.
3001 * A pointer to a structure of type *ether_addr* to be filled with
3002 * the Ethernet address of the Ethernet device.
3004 * - (0) if successful
3005 * - (-ENODEV) if *port_id* invalid.
3006 * - (-EINVAL) if bad parameter.
3008 int rte_eth_macaddr_get(uint16_t port_id, struct rte_ether_addr *mac_addr);
3011 * Retrieve the contextual information of an Ethernet device.
3013 * As part of this function, a number of of fields in dev_info will be
3014 * initialized as follows:
3019 * Where lim is defined within the rte_eth_dev_info_get as
3021 * const struct rte_eth_desc_lim lim = {
3022 * .nb_max = UINT16_MAX,
3025 * .nb_seg_max = UINT16_MAX,
3026 * .nb_mtu_seg_max = UINT16_MAX,
3029 * device = dev->device
3030 * min_mtu = RTE_ETHER_MIN_MTU
3031 * max_mtu = UINT16_MAX
3033 * The following fields will be populated if support for dev_infos_get()
3034 * exists for the device and the rte_eth_dev 'dev' has been populated
3035 * successfully with a call to it:
3037 * driver_name = dev->device->driver->name
3038 * nb_rx_queues = dev->data->nb_rx_queues
3039 * nb_tx_queues = dev->data->nb_tx_queues
3040 * dev_flags = &dev->data->dev_flags
3043 * The port identifier of the Ethernet device.
3045 * A pointer to a structure of type *rte_eth_dev_info* to be filled with
3046 * the contextual information of the Ethernet device.
3048 * - (0) if successful.
3049 * - (-ENOTSUP) if support for dev_infos_get() does not exist for the device.
3050 * - (-ENODEV) if *port_id* invalid.
3051 * - (-EINVAL) if bad parameter.
3053 int rte_eth_dev_info_get(uint16_t port_id, struct rte_eth_dev_info *dev_info);
3056 * Retrieve the firmware version of a device.
3059 * The port identifier of the device.
3061 * A pointer to a string array storing the firmware version of a device,
3062 * the string includes terminating null. This pointer is allocated by caller.
3064 * The size of the string array pointed by fw_version, which should be
3065 * large enough to store firmware version of the device.
3067 * - (0) if successful.
3068 * - (-ENOTSUP) if operation is not supported.
3069 * - (-ENODEV) if *port_id* invalid.
3070 * - (-EIO) if device is removed.
3071 * - (-EINVAL) if bad parameter.
3072 * - (>0) if *fw_size* is not enough to store firmware version, return
3073 * the size of the non truncated string.
3075 int rte_eth_dev_fw_version_get(uint16_t port_id,
3076 char *fw_version, size_t fw_size);
3079 * Retrieve the supported packet types of an Ethernet device.
3081 * When a packet type is announced as supported, it *must* be recognized by
3082 * the PMD. For instance, if RTE_PTYPE_L2_ETHER, RTE_PTYPE_L2_ETHER_VLAN
3083 * and RTE_PTYPE_L3_IPV4 are announced, the PMD must return the following
3084 * packet types for these packets:
3085 * - Ether/IPv4 -> RTE_PTYPE_L2_ETHER | RTE_PTYPE_L3_IPV4
3086 * - Ether/Vlan/IPv4 -> RTE_PTYPE_L2_ETHER_VLAN | RTE_PTYPE_L3_IPV4
3087 * - Ether/[anything else] -> RTE_PTYPE_L2_ETHER
3088 * - Ether/Vlan/[anything else] -> RTE_PTYPE_L2_ETHER_VLAN
3090 * When a packet is received by a PMD, the most precise type must be
3091 * returned among the ones supported. However a PMD is allowed to set
3092 * packet type that is not in the supported list, at the condition that it
3093 * is more precise. Therefore, a PMD announcing no supported packet types
3094 * can still set a matching packet type in a received packet.
3097 * Better to invoke this API after the device is already started or rx burst
3098 * function is decided, to obtain correct supported ptypes.
3100 * if a given PMD does not report what ptypes it supports, then the supported
3101 * ptype count is reported as 0.
3103 * The port identifier of the Ethernet device.
3105 * A hint of what kind of packet type which the caller is interested in.
3107 * An array pointer to store adequate packet types, allocated by caller.
3109 * Size of the array pointed by param ptypes.
3111 * - (>=0) Number of supported ptypes. If the number of types exceeds num,
3112 * only num entries will be filled into the ptypes array, but the full
3113 * count of supported ptypes will be returned.
3114 * - (-ENODEV) if *port_id* invalid.
3115 * - (-EINVAL) if bad parameter.
3117 int rte_eth_dev_get_supported_ptypes(uint16_t port_id, uint32_t ptype_mask,
3118 uint32_t *ptypes, int num);
3120 * Inform Ethernet device about reduced range of packet types to handle.
3122 * Application can use this function to set only specific ptypes that it's
3123 * interested. This information can be used by the PMD to optimize Rx path.
3125 * The function accepts an array `set_ptypes` allocated by the caller to
3126 * store the packet types set by the driver, the last element of the array
3127 * is set to RTE_PTYPE_UNKNOWN. The size of the `set_ptype` array should be
3128 * `rte_eth_dev_get_supported_ptypes() + 1` else it might only be filled
3132 * The port identifier of the Ethernet device.
3134 * The ptype family that application is interested in should be bitwise OR of
3135 * RTE_PTYPE_*_MASK or 0.
3137 * An array pointer to store set packet types, allocated by caller. The
3138 * function marks the end of array with RTE_PTYPE_UNKNOWN.
3140 * Size of the array pointed by param ptypes.
3141 * Should be rte_eth_dev_get_supported_ptypes() + 1 to accommodate the
3145 * - (-ENODEV) if *port_id* invalid.
3146 * - (-EINVAL) if *ptype_mask* is invalid (or) set_ptypes is NULL and
3149 int rte_eth_dev_set_ptypes(uint16_t port_id, uint32_t ptype_mask,
3150 uint32_t *set_ptypes, unsigned int num);
3153 * Retrieve the MTU of an Ethernet device.
3156 * The port identifier of the Ethernet device.
3158 * A pointer to a uint16_t where the retrieved MTU is to be stored.
3160 * - (0) if successful.
3161 * - (-ENODEV) if *port_id* invalid.
3162 * - (-EINVAL) if bad parameter.
3164 int rte_eth_dev_get_mtu(uint16_t port_id, uint16_t *mtu);
3167 * Change the MTU of an Ethernet device.
3170 * The port identifier of the Ethernet device.
3172 * A uint16_t for the MTU to be applied.
3174 * - (0) if successful.
3175 * - (-ENOTSUP) if operation is not supported.
3176 * - (-ENODEV) if *port_id* invalid.
3177 * - (-EIO) if device is removed.
3178 * - (-EINVAL) if *mtu* invalid, validation of mtu can occur within
3179 * rte_eth_dev_set_mtu if dev_infos_get is supported by the device or
3180 * when the mtu is set using dev->dev_ops->mtu_set.
3181 * - (-EBUSY) if operation is not allowed when the port is running
3183 int rte_eth_dev_set_mtu(uint16_t port_id, uint16_t mtu);
3186 * Enable/Disable hardware filtering by an Ethernet device of received
3187 * VLAN packets tagged with a given VLAN Tag Identifier.
3190 * The port identifier of the Ethernet device.
3192 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
3194 * If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*.
3195 * Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*.
3197 * - (0) if successful.
3198 * - (-ENOTSUP) if hardware-assisted VLAN filtering not configured.
3199 * - (-ENODEV) if *port_id* invalid.
3200 * - (-EIO) if device is removed.
3201 * - (-ENOSYS) if VLAN filtering on *port_id* disabled.
3202 * - (-EINVAL) if *vlan_id* > 4095.
3204 int rte_eth_dev_vlan_filter(uint16_t port_id, uint16_t vlan_id, int on);
3207 * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
3210 * The port identifier of the Ethernet device.
3211 * @param rx_queue_id
3212 * The index of the receive queue for which a queue stats mapping is required.
3213 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3214 * to rte_eth_dev_configure().
3216 * If 1, Enable VLAN Stripping of the receive queue of the Ethernet port.
3217 * If 0, Disable VLAN Stripping of the receive queue of the Ethernet port.
3219 * - (0) if successful.
3220 * - (-ENOTSUP) if hardware-assisted VLAN stripping not configured.
3221 * - (-ENODEV) if *port_id* invalid.
3222 * - (-EINVAL) if *rx_queue_id* invalid.
3224 int rte_eth_dev_set_vlan_strip_on_queue(uint16_t port_id, uint16_t rx_queue_id,
3228 * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
3232 * The port identifier of the Ethernet device.
3236 * The Tag Protocol ID
3238 * - (0) if successful.
3239 * - (-ENOTSUP) if hardware-assisted VLAN TPID setup is not supported.
3240 * - (-ENODEV) if *port_id* invalid.
3241 * - (-EIO) if device is removed.
3243 int rte_eth_dev_set_vlan_ether_type(uint16_t port_id,
3244 enum rte_vlan_type vlan_type,
3248 * Set VLAN offload configuration on an Ethernet device.
3251 * The port identifier of the Ethernet device.
3252 * @param offload_mask
3253 * The VLAN Offload bit mask can be mixed use with "OR"
3254 * ETH_VLAN_STRIP_OFFLOAD
3255 * ETH_VLAN_FILTER_OFFLOAD
3256 * ETH_VLAN_EXTEND_OFFLOAD
3257 * ETH_QINQ_STRIP_OFFLOAD
3259 * - (0) if successful.
3260 * - (-ENOTSUP) if hardware-assisted VLAN filtering not configured.
3261 * - (-ENODEV) if *port_id* invalid.
3262 * - (-EIO) if device is removed.
3264 int rte_eth_dev_set_vlan_offload(uint16_t port_id, int offload_mask);
3267 * Read VLAN Offload configuration from an Ethernet device
3270 * The port identifier of the Ethernet device.
3272 * - (>0) if successful. Bit mask to indicate
3273 * ETH_VLAN_STRIP_OFFLOAD
3274 * ETH_VLAN_FILTER_OFFLOAD
3275 * ETH_VLAN_EXTEND_OFFLOAD
3276 * ETH_QINQ_STRIP_OFFLOAD
3277 * - (-ENODEV) if *port_id* invalid.
3279 int rte_eth_dev_get_vlan_offload(uint16_t port_id);
3282 * Set port based TX VLAN insertion on or off.
3285 * The port identifier of the Ethernet device.
3287 * Port based TX VLAN identifier together with user priority.
3289 * Turn on or off the port based TX VLAN insertion.
3292 * - (0) if successful.
3293 * - negative if failed.
3295 int rte_eth_dev_set_vlan_pvid(uint16_t port_id, uint16_t pvid, int on);
3297 typedef void (*buffer_tx_error_fn)(struct rte_mbuf **unsent, uint16_t count,
3301 * Structure used to buffer packets for future TX
3302 * Used by APIs rte_eth_tx_buffer and rte_eth_tx_buffer_flush
3304 struct rte_eth_dev_tx_buffer {
3305 buffer_tx_error_fn error_callback;
3306 void *error_userdata;
3307 uint16_t size; /**< Size of buffer for buffered tx */
3308 uint16_t length; /**< Number of packets in the array */
3309 struct rte_mbuf *pkts[];
3310 /**< Pending packets to be sent on explicit flush or when full */
3314 * Calculate the size of the tx buffer.
3317 * Number of stored packets.
3319 #define RTE_ETH_TX_BUFFER_SIZE(sz) \
3320 (sizeof(struct rte_eth_dev_tx_buffer) + (sz) * sizeof(struct rte_mbuf *))
3323 * Initialize default values for buffered transmitting
3326 * Tx buffer to be initialized.
3333 rte_eth_tx_buffer_init(struct rte_eth_dev_tx_buffer *buffer, uint16_t size);
3336 * Configure a callback for buffered packets which cannot be sent
3338 * Register a specific callback to be called when an attempt is made to send
3339 * all packets buffered on an ethernet port, but not all packets can
3340 * successfully be sent. The callback registered here will be called only
3341 * from calls to rte_eth_tx_buffer() and rte_eth_tx_buffer_flush() APIs.
3342 * The default callback configured for each queue by default just frees the
3343 * packets back to the calling mempool. If additional behaviour is required,
3344 * for example, to count dropped packets, or to retry transmission of packets
3345 * which cannot be sent, this function should be used to register a suitable
3346 * callback function to implement the desired behaviour.
3347 * The example callback "rte_eth_count_unsent_packet_callback()" is also
3348 * provided as reference.
3351 * The port identifier of the Ethernet device.
3353 * The function to be used as the callback.
3355 * Arbitrary parameter to be passed to the callback function
3357 * 0 on success, or -EINVAL if bad parameter
3360 rte_eth_tx_buffer_set_err_callback(struct rte_eth_dev_tx_buffer *buffer,
3361 buffer_tx_error_fn callback, void *userdata);
3364 * Callback function for silently dropping unsent buffered packets.
3366 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
3367 * adjust the default behavior when buffered packets cannot be sent. This
3368 * function drops any unsent packets silently and is used by tx buffered
3369 * operations as default behavior.
3371 * NOTE: this function should not be called directly, instead it should be used
3372 * as a callback for packet buffering.
3374 * NOTE: when configuring this function as a callback with
3375 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
3376 * should point to an uint64_t value.
3379 * The previously buffered packets which could not be sent
3381 * The number of unsent packets in the pkts array
3386 rte_eth_tx_buffer_drop_callback(struct rte_mbuf **pkts, uint16_t unsent,
3390 * Callback function for tracking unsent buffered packets.
3392 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
3393 * adjust the default behavior when buffered packets cannot be sent. This
3394 * function drops any unsent packets, but also updates a user-supplied counter
3395 * to track the overall number of packets dropped. The counter should be an
3396 * uint64_t variable.
3398 * NOTE: this function should not be called directly, instead it should be used
3399 * as a callback for packet buffering.
3401 * NOTE: when configuring this function as a callback with
3402 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
3403 * should point to an uint64_t value.
3406 * The previously buffered packets which could not be sent
3408 * The number of unsent packets in the pkts array
3410 * Pointer to an uint64_t value, which will be incremented by unsent
3413 rte_eth_tx_buffer_count_callback(struct rte_mbuf **pkts, uint16_t unsent,
3417 * Request the driver to free mbufs currently cached by the driver. The
3418 * driver will only free the mbuf if it is no longer in use. It is the
3419 * application's responsibility to ensure rte_eth_tx_buffer_flush(..) is
3423 * The port identifier of the Ethernet device.
3425 * The index of the transmit queue through which output packets must be
3427 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3428 * to rte_eth_dev_configure().
3430 * Maximum number of packets to free. Use 0 to indicate all possible packets
3431 * should be freed. Note that a packet may be using multiple mbufs.
3434 * -ENODEV: Invalid interface
3435 * -EIO: device is removed
3436 * -ENOTSUP: Driver does not support function
3438 * 0-n: Number of packets freed. More packets may still remain in ring that
3442 rte_eth_tx_done_cleanup(uint16_t port_id, uint16_t queue_id, uint32_t free_cnt);
3445 * Subtypes for IPsec offload event(@ref RTE_ETH_EVENT_IPSEC) raised by
3448 enum rte_eth_event_ipsec_subtype {
3449 RTE_ETH_EVENT_IPSEC_UNKNOWN = 0,
3450 /**< Unknown event type */
3451 RTE_ETH_EVENT_IPSEC_ESN_OVERFLOW,
3452 /**< Sequence number overflow */
3453 RTE_ETH_EVENT_IPSEC_SA_TIME_EXPIRY,
3454 /**< Soft time expiry of SA */
3455 RTE_ETH_EVENT_IPSEC_SA_BYTE_EXPIRY,
3456 /**< Soft byte expiry of SA */
3457 RTE_ETH_EVENT_IPSEC_MAX
3458 /**< Max value of this enum */
3462 * Descriptor for @ref RTE_ETH_EVENT_IPSEC event. Used by eth dev to send extra
3463 * information of the IPsec offload event.
3465 struct rte_eth_event_ipsec_desc {
3466 enum rte_eth_event_ipsec_subtype subtype;
3467 /**< Type of RTE_ETH_EVENT_IPSEC_* event */
3469 /**< Event specific metadata
3471 * For the following events, *userdata* registered
3472 * with the *rte_security_session* would be returned
3475 * - @ref RTE_ETH_EVENT_IPSEC_ESN_OVERFLOW
3476 * - @ref RTE_ETH_EVENT_IPSEC_SA_TIME_EXPIRY
3477 * - @ref RTE_ETH_EVENT_IPSEC_SA_BYTE_EXPIRY
3479 * @see struct rte_security_session_conf
3485 * The eth device event type for interrupt, and maybe others in the future.
3487 enum rte_eth_event_type {
3488 RTE_ETH_EVENT_UNKNOWN, /**< unknown event type */
3489 RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
3490 RTE_ETH_EVENT_QUEUE_STATE,
3491 /**< queue state event (enabled/disabled) */
3492 RTE_ETH_EVENT_INTR_RESET,
3493 /**< reset interrupt event, sent to VF on PF reset */
3494 RTE_ETH_EVENT_VF_MBOX, /**< message from the VF received by PF */
3495 RTE_ETH_EVENT_MACSEC, /**< MACsec offload related event */
3496 RTE_ETH_EVENT_INTR_RMV, /**< device removal event */
3497 RTE_ETH_EVENT_NEW, /**< port is probed */
3498 RTE_ETH_EVENT_DESTROY, /**< port is released */
3499 RTE_ETH_EVENT_IPSEC, /**< IPsec offload related event */
3500 RTE_ETH_EVENT_FLOW_AGED,/**< New aged-out flows is detected */
3501 RTE_ETH_EVENT_MAX /**< max value of this enum */
3504 typedef int (*rte_eth_dev_cb_fn)(uint16_t port_id,
3505 enum rte_eth_event_type event, void *cb_arg, void *ret_param);
3506 /**< user application callback to be registered for interrupts */
3509 * Register a callback function for port event.
3513 * RTE_ETH_ALL means register the event for all port ids.
3517 * User supplied callback function to be called.
3519 * Pointer to the parameters for the registered callback.
3522 * - On success, zero.
3523 * - On failure, a negative value.
3525 int rte_eth_dev_callback_register(uint16_t port_id,
3526 enum rte_eth_event_type event,
3527 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
3530 * Unregister a callback function for port event.
3534 * RTE_ETH_ALL means unregister the event for all port ids.
3538 * User supplied callback function to be called.
3540 * Pointer to the parameters for the registered callback. -1 means to
3541 * remove all for the same callback address and same event.
3544 * - On success, zero.
3545 * - On failure, a negative value.
3547 int rte_eth_dev_callback_unregister(uint16_t port_id,
3548 enum rte_eth_event_type event,
3549 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
3552 * When there is no rx packet coming in Rx Queue for a long time, we can
3553 * sleep lcore related to RX Queue for power saving, and enable rx interrupt
3554 * to be triggered when Rx packet arrives.
3556 * The rte_eth_dev_rx_intr_enable() function enables rx queue
3557 * interrupt on specific rx queue of a port.
3560 * The port identifier of the Ethernet device.
3562 * The index of the receive queue from which to retrieve input packets.
3563 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3564 * to rte_eth_dev_configure().
3566 * - (0) if successful.
3567 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3569 * - (-ENODEV) if *port_id* invalid.
3570 * - (-EIO) if device is removed.
3572 int rte_eth_dev_rx_intr_enable(uint16_t port_id, uint16_t queue_id);
3575 * When lcore wakes up from rx interrupt indicating packet coming, disable rx
3576 * interrupt and returns to polling mode.
3578 * The rte_eth_dev_rx_intr_disable() function disables rx queue
3579 * interrupt on specific rx queue of a port.
3582 * The port identifier of the Ethernet device.
3584 * The index of the receive queue from which to retrieve input packets.
3585 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3586 * to rte_eth_dev_configure().
3588 * - (0) if successful.
3589 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3591 * - (-ENODEV) if *port_id* invalid.
3592 * - (-EIO) if device is removed.
3594 int rte_eth_dev_rx_intr_disable(uint16_t port_id, uint16_t queue_id);
3597 * RX Interrupt control per port.
3600 * The port identifier of the Ethernet device.
3602 * Epoll instance fd which the intr vector associated to.
3603 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
3605 * The operation be performed for the vector.
3606 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
3610 * - On success, zero.
3611 * - On failure, a negative value.
3613 int rte_eth_dev_rx_intr_ctl(uint16_t port_id, int epfd, int op, void *data);
3616 * RX Interrupt control per queue.
3619 * The port identifier of the Ethernet device.
3621 * The index of the receive queue from which to retrieve input packets.
3622 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3623 * to rte_eth_dev_configure().
3625 * Epoll instance fd which the intr vector associated to.
3626 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
3628 * The operation be performed for the vector.
3629 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
3633 * - On success, zero.
3634 * - On failure, a negative value.
3636 int rte_eth_dev_rx_intr_ctl_q(uint16_t port_id, uint16_t queue_id,
3637 int epfd, int op, void *data);
3640 * Get interrupt fd per Rx queue.
3643 * The port identifier of the Ethernet device.
3645 * The index of the receive queue from which to retrieve input packets.
3646 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3647 * to rte_eth_dev_configure().
3649 * - (>=0) the interrupt fd associated to the requested Rx queue if
3654 rte_eth_dev_rx_intr_ctl_q_get_fd(uint16_t port_id, uint16_t queue_id);
3657 * Turn on the LED on the Ethernet device.
3658 * This function turns on the LED on the Ethernet device.
3661 * The port identifier of the Ethernet device.
3663 * - (0) if successful.
3664 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3666 * - (-ENODEV) if *port_id* invalid.
3667 * - (-EIO) if device is removed.
3669 int rte_eth_led_on(uint16_t port_id);
3672 * Turn off the LED on the Ethernet device.
3673 * This function turns off the LED on the Ethernet device.
3676 * The port identifier of the Ethernet device.
3678 * - (0) if successful.
3679 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3681 * - (-ENODEV) if *port_id* invalid.
3682 * - (-EIO) if device is removed.
3684 int rte_eth_led_off(uint16_t port_id);
3688 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
3690 * Get Forward Error Correction(FEC) capability.
3693 * The port identifier of the Ethernet device.
3694 * @param speed_fec_capa
3695 * speed_fec_capa is out only with per-speed capabilities.
3696 * If set to NULL, the function returns the required number
3697 * of required array entries.
3699 * a number of elements in an speed_fec_capa array.
3702 * - A non-negative value lower or equal to num: success. The return value
3703 * is the number of entries filled in the fec capa array.
3704 * - A non-negative value higher than num: error, the given fec capa array
3705 * is too small. The return value corresponds to the num that should
3706 * be given to succeed. The entries in fec capa array are not valid and
3707 * shall not be used by the caller.
3708 * - (-ENOTSUP) if underlying hardware OR driver doesn't support.
3710 * - (-EIO) if device is removed.
3711 * - (-ENODEV) if *port_id* invalid.
3712 * - (-EINVAL) if *num* or *speed_fec_capa* invalid
3715 int rte_eth_fec_get_capability(uint16_t port_id,
3716 struct rte_eth_fec_capa *speed_fec_capa,
3721 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
3723 * Get current Forward Error Correction(FEC) mode.
3724 * If link is down and AUTO is enabled, AUTO is returned, otherwise,
3725 * configured FEC mode is returned.
3726 * If link is up, current FEC mode is returned.
3729 * The port identifier of the Ethernet device.
3731 * A bitmask of enabled FEC modes. If AUTO bit is set, other
3732 * bits specify FEC modes which may be negotiated. If AUTO
3733 * bit is clear, specify FEC modes to be used (only one valid
3734 * mode per speed may be set).
3736 * - (0) if successful.
3737 * - (-ENOTSUP) if underlying hardware OR driver doesn't support.
3739 * - (-EIO) if device is removed.
3740 * - (-ENODEV) if *port_id* invalid.
3743 int rte_eth_fec_get(uint16_t port_id, uint32_t *fec_capa);
3747 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
3749 * Set Forward Error Correction(FEC) mode.
3752 * The port identifier of the Ethernet device.
3754 * A bitmask of allowed FEC modes. If AUTO bit is set, other
3755 * bits specify FEC modes which may be negotiated. If AUTO
3756 * bit is clear, specify FEC modes to be used (only one valid
3757 * mode per speed may be set).
3759 * - (0) if successful.
3760 * - (-EINVAL) if the FEC mode is not valid.
3761 * - (-ENOTSUP) if underlying hardware OR driver doesn't support.
3762 * - (-EIO) if device is removed.
3763 * - (-ENODEV) if *port_id* invalid.
3766 int rte_eth_fec_set(uint16_t port_id, uint32_t fec_capa);
3769 * Get current status of the Ethernet link flow control for Ethernet device
3772 * The port identifier of the Ethernet device.
3774 * The pointer to the structure where to store the flow control parameters.
3776 * - (0) if successful.
3777 * - (-ENOTSUP) if hardware doesn't support flow control.
3778 * - (-ENODEV) if *port_id* invalid.
3779 * - (-EIO) if device is removed.
3780 * - (-EINVAL) if bad parameter.
3782 int rte_eth_dev_flow_ctrl_get(uint16_t port_id,
3783 struct rte_eth_fc_conf *fc_conf);
3786 * Configure the Ethernet link flow control for Ethernet device
3789 * The port identifier of the Ethernet device.
3791 * The pointer to the structure of the flow control parameters.
3793 * - (0) if successful.
3794 * - (-ENOTSUP) if hardware doesn't support flow control mode.
3795 * - (-ENODEV) if *port_id* invalid.
3796 * - (-EINVAL) if bad parameter
3797 * - (-EIO) if flow control setup failure or device is removed.
3799 int rte_eth_dev_flow_ctrl_set(uint16_t port_id,
3800 struct rte_eth_fc_conf *fc_conf);
3803 * Configure the Ethernet priority flow control under DCB environment
3804 * for Ethernet device.
3807 * The port identifier of the Ethernet device.
3809 * The pointer to the structure of the priority flow control parameters.
3811 * - (0) if successful.
3812 * - (-ENOTSUP) if hardware doesn't support priority flow control mode.
3813 * - (-ENODEV) if *port_id* invalid.
3814 * - (-EINVAL) if bad parameter
3815 * - (-EIO) if flow control setup failure or device is removed.
3817 int rte_eth_dev_priority_flow_ctrl_set(uint16_t port_id,
3818 struct rte_eth_pfc_conf *pfc_conf);
3821 * Add a MAC address to the set used for filtering incoming packets.
3824 * The port identifier of the Ethernet device.
3826 * The MAC address to add.
3828 * VMDq pool index to associate address with (if VMDq is enabled). If VMDq is
3829 * not enabled, this should be set to 0.
3831 * - (0) if successfully added or *mac_addr* was already added.
3832 * - (-ENOTSUP) if hardware doesn't support this feature.
3833 * - (-ENODEV) if *port* is invalid.
3834 * - (-EIO) if device is removed.
3835 * - (-ENOSPC) if no more MAC addresses can be added.
3836 * - (-EINVAL) if MAC address is invalid.
3838 int rte_eth_dev_mac_addr_add(uint16_t port_id, struct rte_ether_addr *mac_addr,
3842 * Remove a MAC address from the internal array of addresses.
3845 * The port identifier of the Ethernet device.
3847 * MAC address to remove.
3849 * - (0) if successful, or *mac_addr* didn't exist.
3850 * - (-ENOTSUP) if hardware doesn't support.
3851 * - (-ENODEV) if *port* invalid.
3852 * - (-EADDRINUSE) if attempting to remove the default MAC address.
3853 * - (-EINVAL) if MAC address is invalid.
3855 int rte_eth_dev_mac_addr_remove(uint16_t port_id,
3856 struct rte_ether_addr *mac_addr);
3859 * Set the default MAC address.
3862 * The port identifier of the Ethernet device.
3864 * New default MAC address.
3866 * - (0) if successful, or *mac_addr* didn't exist.
3867 * - (-ENOTSUP) if hardware doesn't support.
3868 * - (-ENODEV) if *port* invalid.
3869 * - (-EINVAL) if MAC address is invalid.
3871 int rte_eth_dev_default_mac_addr_set(uint16_t port_id,
3872 struct rte_ether_addr *mac_addr);
3875 * Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3878 * The port identifier of the Ethernet device.
3882 * Redirection table size. The table size can be queried by
3883 * rte_eth_dev_info_get().
3885 * - (0) if successful.
3886 * - (-ENODEV) if *port_id* is invalid.
3887 * - (-ENOTSUP) if hardware doesn't support.
3888 * - (-EINVAL) if bad parameter.
3889 * - (-EIO) if device is removed.
3891 int rte_eth_dev_rss_reta_update(uint16_t port_id,
3892 struct rte_eth_rss_reta_entry64 *reta_conf,
3893 uint16_t reta_size);
3896 * Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3899 * The port identifier of the Ethernet device.
3901 * RETA to query. For each requested reta entry, corresponding bit
3902 * in mask must be set.
3904 * Redirection table size. The table size can be queried by
3905 * rte_eth_dev_info_get().
3907 * - (0) if successful.
3908 * - (-ENODEV) if *port_id* is invalid.
3909 * - (-ENOTSUP) if hardware doesn't support.
3910 * - (-EINVAL) if bad parameter.
3911 * - (-EIO) if device is removed.
3913 int rte_eth_dev_rss_reta_query(uint16_t port_id,
3914 struct rte_eth_rss_reta_entry64 *reta_conf,
3915 uint16_t reta_size);
3918 * Updates unicast hash table for receiving packet with the given destination
3919 * MAC address, and the packet is routed to all VFs for which the RX mode is
3920 * accept packets that match the unicast hash table.
3923 * The port identifier of the Ethernet device.
3925 * Unicast MAC address.
3927 * 1 - Set an unicast hash bit for receiving packets with the MAC address.
3928 * 0 - Clear an unicast hash bit.
3930 * - (0) if successful.
3931 * - (-ENOTSUP) if hardware doesn't support.
3932 * - (-ENODEV) if *port_id* invalid.
3933 * - (-EIO) if device is removed.
3934 * - (-EINVAL) if bad parameter.
3936 int rte_eth_dev_uc_hash_table_set(uint16_t port_id, struct rte_ether_addr *addr,
3940 * Updates all unicast hash bitmaps for receiving packet with any Unicast
3941 * Ethernet MAC addresses,the packet is routed to all VFs for which the RX
3942 * mode is accept packets that match the unicast hash table.
3945 * The port identifier of the Ethernet device.
3947 * 1 - Set all unicast hash bitmaps for receiving all the Ethernet
3949 * 0 - Clear all unicast hash bitmaps
3951 * - (0) if successful.
3952 * - (-ENOTSUP) if hardware doesn't support.
3953 * - (-ENODEV) if *port_id* invalid.
3954 * - (-EIO) if device is removed.
3955 * - (-EINVAL) if bad parameter.
3957 int rte_eth_dev_uc_all_hash_table_set(uint16_t port_id, uint8_t on);
3960 * Set the rate limitation for a queue on an Ethernet device.
3963 * The port identifier of the Ethernet device.
3967 * The tx rate in Mbps. Allocated from the total port link speed.
3969 * - (0) if successful.
3970 * - (-ENOTSUP) if hardware doesn't support this feature.
3971 * - (-ENODEV) if *port_id* invalid.
3972 * - (-EIO) if device is removed.
3973 * - (-EINVAL) if bad parameter.
3975 int rte_eth_set_queue_rate_limit(uint16_t port_id, uint16_t queue_idx,
3979 * Configuration of Receive Side Scaling hash computation of Ethernet device.
3982 * The port identifier of the Ethernet device.
3984 * The new configuration to use for RSS hash computation on the port.
3986 * - (0) if successful.
3987 * - (-ENODEV) if port identifier is invalid.
3988 * - (-EIO) if device is removed.
3989 * - (-ENOTSUP) if hardware doesn't support.
3990 * - (-EINVAL) if bad parameter.
3992 int rte_eth_dev_rss_hash_update(uint16_t port_id,
3993 struct rte_eth_rss_conf *rss_conf);
3996 * Retrieve current configuration of Receive Side Scaling hash computation
3997 * of Ethernet device.
4000 * The port identifier of the Ethernet device.
4002 * Where to store the current RSS hash configuration of the Ethernet device.
4004 * - (0) if successful.
4005 * - (-ENODEV) if port identifier is invalid.
4006 * - (-EIO) if device is removed.
4007 * - (-ENOTSUP) if hardware doesn't support RSS.
4008 * - (-EINVAL) if bad parameter.
4011 rte_eth_dev_rss_hash_conf_get(uint16_t port_id,
4012 struct rte_eth_rss_conf *rss_conf);
4015 * Add UDP tunneling port for a type of tunnel.
4017 * Some NICs may require such configuration to properly parse a tunnel
4018 * with any standard or custom UDP port.
4019 * The packets with this UDP port will be parsed for this type of tunnel.
4020 * The device parser will also check the rest of the tunnel headers
4021 * before classifying the packet.
4023 * With some devices, this API will affect packet classification, i.e.:
4024 * - mbuf.packet_type reported on Rx
4025 * - rte_flow rules with tunnel items
4028 * The port identifier of the Ethernet device.
4030 * UDP tunneling configuration.
4033 * - (0) if successful.
4034 * - (-ENODEV) if port identifier is invalid.
4035 * - (-EIO) if device is removed.
4036 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4039 rte_eth_dev_udp_tunnel_port_add(uint16_t port_id,
4040 struct rte_eth_udp_tunnel *tunnel_udp);
4043 * Delete UDP tunneling port for a type of tunnel.
4045 * The packets with this UDP port will not be classified as this type of tunnel
4046 * anymore if the device use such mapping for tunnel packet classification.
4048 * @see rte_eth_dev_udp_tunnel_port_add
4051 * The port identifier of the Ethernet device.
4053 * UDP tunneling configuration.
4056 * - (0) if successful.
4057 * - (-ENODEV) if port identifier is invalid.
4058 * - (-EIO) if device is removed.
4059 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4062 rte_eth_dev_udp_tunnel_port_delete(uint16_t port_id,
4063 struct rte_eth_udp_tunnel *tunnel_udp);
4066 * Get DCB information on an Ethernet device.
4069 * The port identifier of the Ethernet device.
4073 * - (0) if successful.
4074 * - (-ENODEV) if port identifier is invalid.
4075 * - (-EIO) if device is removed.
4076 * - (-ENOTSUP) if hardware doesn't support.
4077 * - (-EINVAL) if bad parameter.
4079 int rte_eth_dev_get_dcb_info(uint16_t port_id,
4080 struct rte_eth_dcb_info *dcb_info);
4082 struct rte_eth_rxtx_callback;
4085 * Add a callback to be called on packet RX on a given port and queue.
4087 * This API configures a function to be called for each burst of
4088 * packets received on a given NIC port queue. The return value is a pointer
4089 * that can be used to later remove the callback using
4090 * rte_eth_remove_rx_callback().
4092 * Multiple functions are called in the order that they are added.
4095 * The port identifier of the Ethernet device.
4097 * The queue on the Ethernet device on which the callback is to be added.
4099 * The callback function
4101 * A generic pointer parameter which will be passed to each invocation of the
4102 * callback function on this port and queue. Inter-thread synchronization
4103 * of any user data changes is the responsibility of the user.
4107 * On success, a pointer value which can later be used to remove the callback.
4109 const struct rte_eth_rxtx_callback *
4110 rte_eth_add_rx_callback(uint16_t port_id, uint16_t queue_id,
4111 rte_rx_callback_fn fn, void *user_param);
4114 * Add a callback that must be called first on packet RX on a given port
4117 * This API configures a first function to be called for each burst of
4118 * packets received on a given NIC port queue. The return value is a pointer
4119 * that can be used to later remove the callback using
4120 * rte_eth_remove_rx_callback().
4122 * Multiple functions are called in the order that they are added.
4125 * The port identifier of the Ethernet device.
4127 * The queue on the Ethernet device on which the callback is to be added.
4129 * The callback function
4131 * A generic pointer parameter which will be passed to each invocation of the
4132 * callback function on this port and queue. Inter-thread synchronization
4133 * of any user data changes is the responsibility of the user.
4137 * On success, a pointer value which can later be used to remove the callback.
4139 const struct rte_eth_rxtx_callback *
4140 rte_eth_add_first_rx_callback(uint16_t port_id, uint16_t queue_id,
4141 rte_rx_callback_fn fn, void *user_param);
4144 * Add a callback to be called on packet TX on a given port and queue.
4146 * This API configures a function to be called for each burst of
4147 * packets sent on a given NIC port queue. The return value is a pointer
4148 * that can be used to later remove the callback using
4149 * rte_eth_remove_tx_callback().
4151 * Multiple functions are called in the order that they are added.
4154 * The port identifier of the Ethernet device.
4156 * The queue on the Ethernet device on which the callback is to be added.
4158 * The callback function
4160 * A generic pointer parameter which will be passed to each invocation of the
4161 * callback function on this port and queue. Inter-thread synchronization
4162 * of any user data changes is the responsibility of the user.
4166 * On success, a pointer value which can later be used to remove the callback.
4168 const struct rte_eth_rxtx_callback *
4169 rte_eth_add_tx_callback(uint16_t port_id, uint16_t queue_id,
4170 rte_tx_callback_fn fn, void *user_param);
4173 * Remove an RX packet callback from a given port and queue.
4175 * This function is used to removed callbacks that were added to a NIC port
4176 * queue using rte_eth_add_rx_callback().
4178 * Note: the callback is removed from the callback list but it isn't freed
4179 * since the it may still be in use. The memory for the callback can be
4180 * subsequently freed back by the application by calling rte_free():
4182 * - Immediately - if the port is stopped, or the user knows that no
4183 * callbacks are in flight e.g. if called from the thread doing RX/TX
4186 * - After a short delay - where the delay is sufficient to allow any
4187 * in-flight callbacks to complete. Alternately, the RCU mechanism can be
4188 * used to detect when data plane threads have ceased referencing the
4192 * The port identifier of the Ethernet device.
4194 * The queue on the Ethernet device from which the callback is to be removed.
4196 * User supplied callback created via rte_eth_add_rx_callback().
4199 * - 0: Success. Callback was removed.
4200 * - -ENODEV: If *port_id* is invalid.
4201 * - -ENOTSUP: Callback support is not available.
4202 * - -EINVAL: The queue_id is out of range, or the callback
4203 * is NULL or not found for the port/queue.
4205 int rte_eth_remove_rx_callback(uint16_t port_id, uint16_t queue_id,
4206 const struct rte_eth_rxtx_callback *user_cb);
4209 * Remove a TX packet callback from a given port and queue.
4211 * This function is used to removed callbacks that were added to a NIC port
4212 * queue using rte_eth_add_tx_callback().
4214 * Note: the callback is removed from the callback list but it isn't freed
4215 * since the it may still be in use. The memory for the callback can be
4216 * subsequently freed back by the application by calling rte_free():
4218 * - Immediately - if the port is stopped, or the user knows that no
4219 * callbacks are in flight e.g. if called from the thread doing RX/TX
4222 * - After a short delay - where the delay is sufficient to allow any
4223 * in-flight callbacks to complete. Alternately, the RCU mechanism can be
4224 * used to detect when data plane threads have ceased referencing the
4228 * The port identifier of the Ethernet device.
4230 * The queue on the Ethernet device from which the callback is to be removed.
4232 * User supplied callback created via rte_eth_add_tx_callback().
4235 * - 0: Success. Callback was removed.
4236 * - -ENODEV: If *port_id* is invalid.
4237 * - -ENOTSUP: Callback support is not available.
4238 * - -EINVAL: The queue_id is out of range, or the callback
4239 * is NULL or not found for the port/queue.
4241 int rte_eth_remove_tx_callback(uint16_t port_id, uint16_t queue_id,
4242 const struct rte_eth_rxtx_callback *user_cb);
4245 * Retrieve information about given port's RX queue.
4248 * The port identifier of the Ethernet device.
4250 * The RX queue on the Ethernet device for which information
4251 * will be retrieved.
4253 * A pointer to a structure of type *rte_eth_rxq_info_info* to be filled with
4254 * the information of the Ethernet device.
4258 * - -ENODEV: If *port_id* is invalid.
4259 * - -ENOTSUP: routine is not supported by the device PMD.
4260 * - -EINVAL: The queue_id is out of range, or the queue
4263 int rte_eth_rx_queue_info_get(uint16_t port_id, uint16_t queue_id,
4264 struct rte_eth_rxq_info *qinfo);
4267 * Retrieve information about given port's TX queue.
4270 * The port identifier of the Ethernet device.
4272 * The TX queue on the Ethernet device for which information
4273 * will be retrieved.
4275 * A pointer to a structure of type *rte_eth_txq_info_info* to be filled with
4276 * the information of the Ethernet device.
4280 * - -ENODEV: If *port_id* is invalid.
4281 * - -ENOTSUP: routine is not supported by the device PMD.
4282 * - -EINVAL: The queue_id is out of range, or the queue
4285 int rte_eth_tx_queue_info_get(uint16_t port_id, uint16_t queue_id,
4286 struct rte_eth_txq_info *qinfo);
4289 * Retrieve information about the Rx packet burst mode.
4292 * The port identifier of the Ethernet device.
4294 * The Rx queue on the Ethernet device for which information
4295 * will be retrieved.
4297 * A pointer to a structure of type *rte_eth_burst_mode* to be filled
4298 * with the information of the packet burst mode.
4302 * - -ENODEV: If *port_id* is invalid.
4303 * - -ENOTSUP: routine is not supported by the device PMD.
4304 * - -EINVAL: The queue_id is out of range.
4306 int rte_eth_rx_burst_mode_get(uint16_t port_id, uint16_t queue_id,
4307 struct rte_eth_burst_mode *mode);
4310 * Retrieve information about the Tx packet burst mode.
4313 * The port identifier of the Ethernet device.
4315 * The Tx queue on the Ethernet device for which information
4316 * will be retrieved.
4318 * A pointer to a structure of type *rte_eth_burst_mode* to be filled
4319 * with the information of the packet burst mode.
4323 * - -ENODEV: If *port_id* is invalid.
4324 * - -ENOTSUP: routine is not supported by the device PMD.
4325 * - -EINVAL: The queue_id is out of range.
4327 int rte_eth_tx_burst_mode_get(uint16_t port_id, uint16_t queue_id,
4328 struct rte_eth_burst_mode *mode);
4332 * @b EXPERIMENTAL: this API may change without prior notice.
4334 * Retrieve the monitor condition for a given receive queue.
4337 * The port identifier of the Ethernet device.
4339 * The Rx queue on the Ethernet device for which information
4340 * will be retrieved.
4342 * The pointer to power-optimized monitoring condition structure.
4346 * -ENOTSUP: Operation not supported.
4347 * -EINVAL: Invalid parameters.
4348 * -ENODEV: Invalid port ID.
4351 int rte_eth_get_monitor_addr(uint16_t port_id, uint16_t queue_id,
4352 struct rte_power_monitor_cond *pmc);
4355 * Retrieve device registers and register attributes (number of registers and
4359 * The port identifier of the Ethernet device.
4361 * Pointer to rte_dev_reg_info structure to fill in. If info->data is
4362 * NULL the function fills in the width and length fields. If non-NULL
4363 * the registers are put into the buffer pointed at by the data field.
4365 * - (0) if successful.
4366 * - (-ENOTSUP) if hardware doesn't support.
4367 * - (-EINVAL) if bad parameter.
4368 * - (-ENODEV) if *port_id* invalid.
4369 * - (-EIO) if device is removed.
4370 * - others depends on the specific operations implementation.
4372 int rte_eth_dev_get_reg_info(uint16_t port_id, struct rte_dev_reg_info *info);
4375 * Retrieve size of device EEPROM
4378 * The port identifier of the Ethernet device.
4380 * - (>=0) EEPROM size if successful.
4381 * - (-ENOTSUP) if hardware doesn't support.
4382 * - (-ENODEV) if *port_id* invalid.
4383 * - (-EIO) if device is removed.
4384 * - others depends on the specific operations implementation.
4386 int rte_eth_dev_get_eeprom_length(uint16_t port_id);
4389 * Retrieve EEPROM and EEPROM attribute
4392 * The port identifier of the Ethernet device.
4394 * The template includes buffer for return EEPROM data and
4395 * EEPROM attributes to be filled.
4397 * - (0) if successful.
4398 * - (-ENOTSUP) if hardware doesn't support.
4399 * - (-EINVAL) if bad parameter.
4400 * - (-ENODEV) if *port_id* invalid.
4401 * - (-EIO) if device is removed.
4402 * - others depends on the specific operations implementation.
4404 int rte_eth_dev_get_eeprom(uint16_t port_id, struct rte_dev_eeprom_info *info);
4407 * Program EEPROM with provided data
4410 * The port identifier of the Ethernet device.
4412 * The template includes EEPROM data for programming and
4413 * EEPROM attributes to be filled
4415 * - (0) if successful.
4416 * - (-ENOTSUP) if hardware doesn't support.
4417 * - (-ENODEV) if *port_id* invalid.
4418 * - (-EINVAL) if bad parameter.
4419 * - (-EIO) if device is removed.
4420 * - others depends on the specific operations implementation.
4422 int rte_eth_dev_set_eeprom(uint16_t port_id, struct rte_dev_eeprom_info *info);
4426 * @b EXPERIMENTAL: this API may change without prior notice.
4428 * Retrieve the type and size of plugin module EEPROM
4431 * The port identifier of the Ethernet device.
4433 * The type and size of plugin module EEPROM.
4435 * - (0) if successful.
4436 * - (-ENOTSUP) if hardware doesn't support.
4437 * - (-ENODEV) if *port_id* invalid.
4438 * - (-EINVAL) if bad parameter.
4439 * - (-EIO) if device is removed.
4440 * - others depends on the specific operations implementation.
4444 rte_eth_dev_get_module_info(uint16_t port_id,
4445 struct rte_eth_dev_module_info *modinfo);
4449 * @b EXPERIMENTAL: this API may change without prior notice.
4451 * Retrieve the data of plugin module EEPROM
4454 * The port identifier of the Ethernet device.
4456 * The template includes the plugin module EEPROM attributes, and the
4457 * buffer for return plugin module EEPROM data.
4459 * - (0) if successful.
4460 * - (-ENOTSUP) if hardware doesn't support.
4461 * - (-EINVAL) if bad parameter.
4462 * - (-ENODEV) if *port_id* invalid.
4463 * - (-EIO) if device is removed.
4464 * - others depends on the specific operations implementation.
4468 rte_eth_dev_get_module_eeprom(uint16_t port_id,
4469 struct rte_dev_eeprom_info *info);
4472 * Set the list of multicast addresses to filter on an Ethernet device.
4475 * The port identifier of the Ethernet device.
4476 * @param mc_addr_set
4477 * The array of multicast addresses to set. Equal to NULL when the function
4478 * is invoked to flush the set of filtered addresses.
4480 * The number of multicast addresses in the *mc_addr_set* array. Equal to 0
4481 * when the function is invoked to flush the set of filtered addresses.
4483 * - (0) if successful.
4484 * - (-ENODEV) if *port_id* invalid.
4485 * - (-EIO) if device is removed.
4486 * - (-ENOTSUP) if PMD of *port_id* doesn't support multicast filtering.
4487 * - (-ENOSPC) if *port_id* has not enough multicast filtering resources.
4488 * - (-EINVAL) if bad parameter.
4490 int rte_eth_dev_set_mc_addr_list(uint16_t port_id,
4491 struct rte_ether_addr *mc_addr_set,
4492 uint32_t nb_mc_addr);
4495 * Enable IEEE1588/802.1AS timestamping for an Ethernet device.
4498 * The port identifier of the Ethernet device.
4502 * - -ENODEV: The port ID is invalid.
4503 * - -EIO: if device is removed.
4504 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4506 int rte_eth_timesync_enable(uint16_t port_id);
4509 * Disable IEEE1588/802.1AS timestamping for an Ethernet device.
4512 * The port identifier of the Ethernet device.
4516 * - -ENODEV: The port ID is invalid.
4517 * - -EIO: if device is removed.
4518 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4520 int rte_eth_timesync_disable(uint16_t port_id);
4523 * Read an IEEE1588/802.1AS RX timestamp from an Ethernet device.
4526 * The port identifier of the Ethernet device.
4528 * Pointer to the timestamp struct.
4530 * Device specific flags. Used to pass the RX timesync register index to
4531 * i40e. Unused in igb/ixgbe, pass 0 instead.
4535 * - -EINVAL: No timestamp is available.
4536 * - -ENODEV: The port ID is invalid.
4537 * - -EIO: if device is removed.
4538 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4540 int rte_eth_timesync_read_rx_timestamp(uint16_t port_id,
4541 struct timespec *timestamp, uint32_t flags);
4544 * Read an IEEE1588/802.1AS TX timestamp from an Ethernet device.
4547 * The port identifier of the Ethernet device.
4549 * Pointer to the timestamp struct.
4553 * - -EINVAL: No timestamp is available.
4554 * - -ENODEV: The port ID is invalid.
4555 * - -EIO: if device is removed.
4556 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4558 int rte_eth_timesync_read_tx_timestamp(uint16_t port_id,
4559 struct timespec *timestamp);
4562 * Adjust the timesync clock on an Ethernet device.
4564 * This is usually used in conjunction with other Ethdev timesync functions to
4565 * synchronize the device time using the IEEE1588/802.1AS protocol.
4568 * The port identifier of the Ethernet device.
4570 * The adjustment in nanoseconds.
4574 * - -ENODEV: The port ID is invalid.
4575 * - -EIO: if device is removed.
4576 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4578 int rte_eth_timesync_adjust_time(uint16_t port_id, int64_t delta);
4581 * Read the time from the timesync clock on an Ethernet device.
4583 * This is usually used in conjunction with other Ethdev timesync functions to
4584 * synchronize the device time using the IEEE1588/802.1AS protocol.
4587 * The port identifier of the Ethernet device.
4589 * Pointer to the timespec struct that holds the time.
4593 * - -EINVAL: Bad parameter.
4595 int rte_eth_timesync_read_time(uint16_t port_id, struct timespec *time);
4598 * Set the time of the timesync clock on an Ethernet device.
4600 * This is usually used in conjunction with other Ethdev timesync functions to
4601 * synchronize the device time using the IEEE1588/802.1AS protocol.
4604 * The port identifier of the Ethernet device.
4606 * Pointer to the timespec struct that holds the time.
4610 * - -EINVAL: No timestamp is available.
4611 * - -ENODEV: The port ID is invalid.
4612 * - -EIO: if device is removed.
4613 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4615 int rte_eth_timesync_write_time(uint16_t port_id, const struct timespec *time);
4619 * @b EXPERIMENTAL: this API may change without prior notice.
4621 * Read the current clock counter of an Ethernet device
4623 * This returns the current raw clock value of an Ethernet device. It is
4624 * a raw amount of ticks, with no given time reference.
4625 * The value returned here is from the same clock than the one
4626 * filling timestamp field of Rx packets when using hardware timestamp
4627 * offload. Therefore it can be used to compute a precise conversion of
4628 * the device clock to the real time.
4630 * E.g, a simple heuristic to derivate the frequency would be:
4631 * uint64_t start, end;
4632 * rte_eth_read_clock(port, start);
4633 * rte_delay_ms(100);
4634 * rte_eth_read_clock(port, end);
4635 * double freq = (end - start) * 10;
4637 * Compute a common reference with:
4638 * uint64_t base_time_sec = current_time();
4639 * uint64_t base_clock;
4640 * rte_eth_read_clock(port, base_clock);
4642 * Then, convert the raw mbuf timestamp with:
4643 * base_time_sec + (double)(*timestamp_dynfield(mbuf) - base_clock) / freq;
4645 * This simple example will not provide a very good accuracy. One must
4646 * at least measure multiple times the frequency and do a regression.
4647 * To avoid deviation from the system time, the common reference can
4648 * be repeated from time to time. The integer division can also be
4649 * converted by a multiplication and a shift for better performance.
4652 * The port identifier of the Ethernet device.
4654 * Pointer to the uint64_t that holds the raw clock value.
4658 * - -ENODEV: The port ID is invalid.
4659 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4660 * - -EINVAL: if bad parameter.
4664 rte_eth_read_clock(uint16_t port_id, uint64_t *clock);
4667 * Get the port id from device name. The device name should be specified
4669 * - PCIe address (Domain:Bus:Device.Function), for example- 0000:2:00.0
4670 * - SoC device name, for example- fsl-gmac0
4671 * - vdev dpdk name, for example- net_[pcap0|null0|tap0]
4674 * pci address or name of the device
4676 * pointer to port identifier of the device
4678 * - (0) if successful and port_id is filled.
4679 * - (-ENODEV or -EINVAL) on failure.
4682 rte_eth_dev_get_port_by_name(const char *name, uint16_t *port_id);
4685 * Get the device name from port id. The device name is specified as below:
4686 * - PCIe address (Domain:Bus:Device.Function), for example- 0000:02:00.0
4687 * - SoC device name, for example- fsl-gmac0
4688 * - vdev dpdk name, for example- net_[pcap0|null0|tun0|tap0]
4691 * Port identifier of the device.
4693 * Buffer of size RTE_ETH_NAME_MAX_LEN to store the name.
4695 * - (0) if successful.
4696 * - (-ENODEV) if *port_id* is invalid.
4697 * - (-EINVAL) on failure.
4700 rte_eth_dev_get_name_by_port(uint16_t port_id, char *name);
4703 * Check that numbers of Rx and Tx descriptors satisfy descriptors limits from
4704 * the ethernet device information, otherwise adjust them to boundaries.
4707 * The port identifier of the Ethernet device.
4709 * A pointer to a uint16_t where the number of receive
4710 * descriptors stored.
4712 * A pointer to a uint16_t where the number of transmit
4713 * descriptors stored.
4715 * - (0) if successful.
4716 * - (-ENOTSUP, -ENODEV or -EINVAL) on failure.
4718 int rte_eth_dev_adjust_nb_rx_tx_desc(uint16_t port_id,
4719 uint16_t *nb_rx_desc,
4720 uint16_t *nb_tx_desc);
4723 * Test if a port supports specific mempool ops.
4726 * Port identifier of the Ethernet device.
4728 * The name of the pool operations to test.
4730 * - 0: best mempool ops choice for this port.
4731 * - 1: mempool ops are supported for this port.
4732 * - -ENOTSUP: mempool ops not supported for this port.
4733 * - -ENODEV: Invalid port Identifier.
4734 * - -EINVAL: Pool param is null.
4737 rte_eth_dev_pool_ops_supported(uint16_t port_id, const char *pool);
4740 * Get the security context for the Ethernet device.
4743 * Port identifier of the Ethernet device
4746 * - pointer to security context on success.
4749 rte_eth_dev_get_sec_ctx(uint16_t port_id);
4753 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
4755 * Query the device hairpin capabilities.
4758 * The port identifier of the Ethernet device.
4760 * Pointer to a structure that will hold the hairpin capabilities.
4762 * - (0) if successful.
4763 * - (-ENOTSUP) if hardware doesn't support.
4764 * - (-EINVAL) if bad parameter.
4767 int rte_eth_dev_hairpin_capability_get(uint16_t port_id,
4768 struct rte_eth_hairpin_cap *cap);
4772 * @b EXPERIMENTAL: this structure may change without prior notice.
4774 * ethernet device representor ID range entry
4776 struct rte_eth_representor_range {
4777 enum rte_eth_representor_type type; /**< Representor type */
4778 int controller; /**< Controller index */
4779 int pf; /**< Physical function index */
4782 int vf; /**< VF start index */
4783 int sf; /**< SF start index */
4785 uint32_t id_base; /**< Representor ID start index */
4786 uint32_t id_end; /**< Representor ID end index */
4787 char name[RTE_DEV_NAME_MAX_LEN]; /**< Representor name */
4792 * @b EXPERIMENTAL: this structure may change without prior notice.
4794 * Ethernet device representor information
4796 struct rte_eth_representor_info {
4797 uint16_t controller; /**< Controller ID of caller device. */
4798 uint16_t pf; /**< Physical function ID of caller device. */
4799 uint32_t nb_ranges_alloc; /**< Size of the ranges array. */
4800 uint32_t nb_ranges; /**< Number of initialized ranges. */
4801 struct rte_eth_representor_range ranges[];/**< Representor ID range. */
4805 * Retrieve the representor info of the device.
4807 * Get device representor info to be able to calculate a unique
4808 * representor ID. @see rte_eth_representor_id_get helper.
4811 * The port identifier of the device.
4813 * A pointer to a representor info structure.
4814 * NULL to return number of range entries and allocate memory
4815 * for next call to store detail.
4816 * The number of ranges that were written into this structure
4817 * will be placed into its nb_ranges field. This number cannot be
4818 * larger than the nb_ranges_alloc that by the user before calling
4819 * this function. It can be smaller than the value returned by the
4820 * function, however.
4822 * - (-ENOTSUP) if operation is not supported.
4823 * - (-ENODEV) if *port_id* invalid.
4824 * - (-EIO) if device is removed.
4825 * - (>=0) number of available representor range entries.
4828 int rte_eth_representor_info_get(uint16_t port_id,
4829 struct rte_eth_representor_info *info);
4831 #include <rte_ethdev_core.h>
4835 * Retrieve a burst of input packets from a receive queue of an Ethernet
4836 * device. The retrieved packets are stored in *rte_mbuf* structures whose
4837 * pointers are supplied in the *rx_pkts* array.
4839 * The rte_eth_rx_burst() function loops, parsing the RX ring of the
4840 * receive queue, up to *nb_pkts* packets, and for each completed RX
4841 * descriptor in the ring, it performs the following operations:
4843 * - Initialize the *rte_mbuf* data structure associated with the
4844 * RX descriptor according to the information provided by the NIC into
4845 * that RX descriptor.
4847 * - Store the *rte_mbuf* data structure into the next entry of the
4850 * - Replenish the RX descriptor with a new *rte_mbuf* buffer
4851 * allocated from the memory pool associated with the receive queue at
4852 * initialization time.
4854 * When retrieving an input packet that was scattered by the controller
4855 * into multiple receive descriptors, the rte_eth_rx_burst() function
4856 * appends the associated *rte_mbuf* buffers to the first buffer of the
4859 * The rte_eth_rx_burst() function returns the number of packets
4860 * actually retrieved, which is the number of *rte_mbuf* data structures
4861 * effectively supplied into the *rx_pkts* array.
4862 * A return value equal to *nb_pkts* indicates that the RX queue contained
4863 * at least *rx_pkts* packets, and this is likely to signify that other
4864 * received packets remain in the input queue. Applications implementing
4865 * a "retrieve as much received packets as possible" policy can check this
4866 * specific case and keep invoking the rte_eth_rx_burst() function until
4867 * a value less than *nb_pkts* is returned.
4869 * This receive method has the following advantages:
4871 * - It allows a run-to-completion network stack engine to retrieve and
4872 * to immediately process received packets in a fast burst-oriented
4873 * approach, avoiding the overhead of unnecessary intermediate packet
4874 * queue/dequeue operations.
4876 * - Conversely, it also allows an asynchronous-oriented processing
4877 * method to retrieve bursts of received packets and to immediately
4878 * queue them for further parallel processing by another logical core,
4879 * for instance. However, instead of having received packets being
4880 * individually queued by the driver, this approach allows the caller
4881 * of the rte_eth_rx_burst() function to queue a burst of retrieved
4882 * packets at a time and therefore dramatically reduce the cost of
4883 * enqueue/dequeue operations per packet.
4885 * - It allows the rte_eth_rx_burst() function of the driver to take
4886 * advantage of burst-oriented hardware features (CPU cache,
4887 * prefetch instructions, and so on) to minimize the number of CPU
4888 * cycles per packet.
4890 * To summarize, the proposed receive API enables many
4891 * burst-oriented optimizations in both synchronous and asynchronous
4892 * packet processing environments with no overhead in both cases.
4895 * Some drivers using vector instructions require that *nb_pkts* is
4896 * divisible by 4 or 8, depending on the driver implementation.
4898 * The rte_eth_rx_burst() function does not provide any error
4899 * notification to avoid the corresponding overhead. As a hint, the
4900 * upper-level application might check the status of the device link once
4901 * being systematically returned a 0 value for a given number of tries.
4904 * The port identifier of the Ethernet device.
4906 * The index of the receive queue from which to retrieve input packets.
4907 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
4908 * to rte_eth_dev_configure().
4910 * The address of an array of pointers to *rte_mbuf* structures that
4911 * must be large enough to store *nb_pkts* pointers in it.
4913 * The maximum number of packets to retrieve.
4914 * The value must be divisible by 8 in order to work with any driver.
4916 * The number of packets actually retrieved, which is the number
4917 * of pointers to *rte_mbuf* structures effectively supplied to the
4920 static inline uint16_t
4921 rte_eth_rx_burst(uint16_t port_id, uint16_t queue_id,
4922 struct rte_mbuf **rx_pkts, const uint16_t nb_pkts)
4924 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
4927 #ifdef RTE_ETHDEV_DEBUG_RX
4928 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
4929 RTE_FUNC_PTR_OR_ERR_RET(*dev->rx_pkt_burst, 0);
4931 if (queue_id >= dev->data->nb_rx_queues) {
4932 RTE_ETHDEV_LOG(ERR, "Invalid RX queue_id=%u\n", queue_id);
4936 nb_rx = (*dev->rx_pkt_burst)(dev->data->rx_queues[queue_id],
4939 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
4940 struct rte_eth_rxtx_callback *cb;
4942 /* __ATOMIC_RELEASE memory order was used when the
4943 * call back was inserted into the list.
4944 * Since there is a clear dependency between loading
4945 * cb and cb->fn/cb->next, __ATOMIC_ACQUIRE memory order is
4948 cb = __atomic_load_n(&dev->post_rx_burst_cbs[queue_id],
4951 if (unlikely(cb != NULL)) {
4953 nb_rx = cb->fn.rx(port_id, queue_id, rx_pkts, nb_rx,
4954 nb_pkts, cb->param);
4956 } while (cb != NULL);
4960 rte_ethdev_trace_rx_burst(port_id, queue_id, (void **)rx_pkts, nb_rx);
4965 * Get the number of used descriptors of a rx queue
4968 * The port identifier of the Ethernet device.
4970 * The queue id on the specific port.
4972 * The number of used descriptors in the specific queue, or:
4973 * - (-ENODEV) if *port_id* is invalid.
4974 * (-EINVAL) if *queue_id* is invalid
4975 * (-ENOTSUP) if the device does not support this function
4978 rte_eth_rx_queue_count(uint16_t port_id, uint16_t queue_id)
4980 struct rte_eth_dev *dev;
4982 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
4983 dev = &rte_eth_devices[port_id];
4984 RTE_FUNC_PTR_OR_ERR_RET(*dev->rx_queue_count, -ENOTSUP);
4985 if (queue_id >= dev->data->nb_rx_queues ||
4986 dev->data->rx_queues[queue_id] == NULL)
4989 return (int)(*dev->rx_queue_count)(dev, queue_id);
4993 * Check if the DD bit of the specific RX descriptor in the queue has been set
4996 * The port identifier of the Ethernet device.
4998 * The queue id on the specific port.
5000 * The offset of the descriptor ID from tail.
5002 * - (1) if the specific DD bit is set.
5003 * - (0) if the specific DD bit is not set.
5004 * - (-ENODEV) if *port_id* invalid.
5005 * - (-ENOTSUP) if the device does not support this function
5009 rte_eth_rx_descriptor_done(uint16_t port_id, uint16_t queue_id, uint16_t offset)
5011 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
5012 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
5013 RTE_FUNC_PTR_OR_ERR_RET(*dev->rx_descriptor_done, -ENOTSUP);
5014 return (*dev->rx_descriptor_done)(dev->data->rx_queues[queue_id], offset);
5017 /**@{@name Rx hardware descriptor states
5018 * @see rte_eth_rx_descriptor_status
5020 #define RTE_ETH_RX_DESC_AVAIL 0 /**< Desc available for hw. */
5021 #define RTE_ETH_RX_DESC_DONE 1 /**< Desc done, filled by hw. */
5022 #define RTE_ETH_RX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */
5026 * Check the status of a Rx descriptor in the queue
5028 * It should be called in a similar context than the Rx function:
5029 * - on a dataplane core
5030 * - not concurrently on the same queue
5032 * Since it's a dataplane function, no check is performed on port_id and
5033 * queue_id. The caller must therefore ensure that the port is enabled
5034 * and the queue is configured and running.
5036 * Note: accessing to a random descriptor in the ring may trigger cache
5037 * misses and have a performance impact.
5040 * A valid port identifier of the Ethernet device which.
5042 * A valid Rx queue identifier on this port.
5044 * The offset of the descriptor starting from tail (0 is the next
5045 * packet to be received by the driver).
5048 * - (RTE_ETH_RX_DESC_AVAIL): Descriptor is available for the hardware to
5050 * - (RTE_ETH_RX_DESC_DONE): Descriptor is done, it is filled by hw, but
5051 * not yet processed by the driver (i.e. in the receive queue).
5052 * - (RTE_ETH_RX_DESC_UNAVAIL): Descriptor is unavailable, either hold by
5053 * the driver and not yet returned to hw, or reserved by the hw.
5054 * - (-EINVAL) bad descriptor offset.
5055 * - (-ENOTSUP) if the device does not support this function.
5056 * - (-ENODEV) bad port or queue (only if compiled with debug).
5059 rte_eth_rx_descriptor_status(uint16_t port_id, uint16_t queue_id,
5062 struct rte_eth_dev *dev;
5065 #ifdef RTE_ETHDEV_DEBUG_RX
5066 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
5068 dev = &rte_eth_devices[port_id];
5069 #ifdef RTE_ETHDEV_DEBUG_RX
5070 if (queue_id >= dev->data->nb_rx_queues)
5073 RTE_FUNC_PTR_OR_ERR_RET(*dev->rx_descriptor_status, -ENOTSUP);
5074 rxq = dev->data->rx_queues[queue_id];
5076 return (*dev->rx_descriptor_status)(rxq, offset);
5079 /**@{@name Tx hardware descriptor states
5080 * @see rte_eth_tx_descriptor_status
5082 #define RTE_ETH_TX_DESC_FULL 0 /**< Desc filled for hw, waiting xmit. */
5083 #define RTE_ETH_TX_DESC_DONE 1 /**< Desc done, packet is transmitted. */
5084 #define RTE_ETH_TX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */
5088 * Check the status of a Tx descriptor in the queue.
5090 * It should be called in a similar context than the Tx function:
5091 * - on a dataplane core
5092 * - not concurrently on the same queue
5094 * Since it's a dataplane function, no check is performed on port_id and
5095 * queue_id. The caller must therefore ensure that the port is enabled
5096 * and the queue is configured and running.
5098 * Note: accessing to a random descriptor in the ring may trigger cache
5099 * misses and have a performance impact.
5102 * A valid port identifier of the Ethernet device which.
5104 * A valid Tx queue identifier on this port.
5106 * The offset of the descriptor starting from tail (0 is the place where
5107 * the next packet will be send).
5110 * - (RTE_ETH_TX_DESC_FULL) Descriptor is being processed by the hw, i.e.
5111 * in the transmit queue.
5112 * - (RTE_ETH_TX_DESC_DONE) Hardware is done with this descriptor, it can
5113 * be reused by the driver.
5114 * - (RTE_ETH_TX_DESC_UNAVAIL): Descriptor is unavailable, reserved by the
5115 * driver or the hardware.
5116 * - (-EINVAL) bad descriptor offset.
5117 * - (-ENOTSUP) if the device does not support this function.
5118 * - (-ENODEV) bad port or queue (only if compiled with debug).
5120 static inline int rte_eth_tx_descriptor_status(uint16_t port_id,
5121 uint16_t queue_id, uint16_t offset)
5123 struct rte_eth_dev *dev;
5126 #ifdef RTE_ETHDEV_DEBUG_TX
5127 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
5129 dev = &rte_eth_devices[port_id];
5130 #ifdef RTE_ETHDEV_DEBUG_TX
5131 if (queue_id >= dev->data->nb_tx_queues)
5134 RTE_FUNC_PTR_OR_ERR_RET(*dev->tx_descriptor_status, -ENOTSUP);
5135 txq = dev->data->tx_queues[queue_id];
5137 return (*dev->tx_descriptor_status)(txq, offset);
5141 * Send a burst of output packets on a transmit queue of an Ethernet device.
5143 * The rte_eth_tx_burst() function is invoked to transmit output packets
5144 * on the output queue *queue_id* of the Ethernet device designated by its
5146 * The *nb_pkts* parameter is the number of packets to send which are
5147 * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
5148 * allocated from a pool created with rte_pktmbuf_pool_create().
5149 * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
5150 * up to the number of transmit descriptors available in the TX ring of the
5152 * For each packet to send, the rte_eth_tx_burst() function performs
5153 * the following operations:
5155 * - Pick up the next available descriptor in the transmit ring.
5157 * - Free the network buffer previously sent with that descriptor, if any.
5159 * - Initialize the transmit descriptor with the information provided
5160 * in the *rte_mbuf data structure.
5162 * In the case of a segmented packet composed of a list of *rte_mbuf* buffers,
5163 * the rte_eth_tx_burst() function uses several transmit descriptors
5166 * The rte_eth_tx_burst() function returns the number of packets it
5167 * actually sent. A return value equal to *nb_pkts* means that all packets
5168 * have been sent, and this is likely to signify that other output packets
5169 * could be immediately transmitted again. Applications that implement a
5170 * "send as many packets to transmit as possible" policy can check this
5171 * specific case and keep invoking the rte_eth_tx_burst() function until
5172 * a value less than *nb_pkts* is returned.
5174 * It is the responsibility of the rte_eth_tx_burst() function to
5175 * transparently free the memory buffers of packets previously sent.
5176 * This feature is driven by the *tx_free_thresh* value supplied to the
5177 * rte_eth_dev_configure() function at device configuration time.
5178 * When the number of free TX descriptors drops below this threshold, the
5179 * rte_eth_tx_burst() function must [attempt to] free the *rte_mbuf* buffers
5180 * of those packets whose transmission was effectively completed.
5182 * If the PMD is DEV_TX_OFFLOAD_MT_LOCKFREE capable, multiple threads can
5183 * invoke this function concurrently on the same tx queue without SW lock.
5184 * @see rte_eth_dev_info_get, struct rte_eth_txconf::offloads
5186 * @see rte_eth_tx_prepare to perform some prior checks or adjustments
5190 * The port identifier of the Ethernet device.
5192 * The index of the transmit queue through which output packets must be
5194 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
5195 * to rte_eth_dev_configure().
5197 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
5198 * which contain the output packets.
5200 * The maximum number of packets to transmit.
5202 * The number of output packets actually stored in transmit descriptors of
5203 * the transmit ring. The return value can be less than the value of the
5204 * *tx_pkts* parameter when the transmit ring is full or has been filled up.
5206 static inline uint16_t
5207 rte_eth_tx_burst(uint16_t port_id, uint16_t queue_id,
5208 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
5210 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
5212 #ifdef RTE_ETHDEV_DEBUG_TX
5213 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
5214 RTE_FUNC_PTR_OR_ERR_RET(*dev->tx_pkt_burst, 0);
5216 if (queue_id >= dev->data->nb_tx_queues) {
5217 RTE_ETHDEV_LOG(ERR, "Invalid TX queue_id=%u\n", queue_id);
5222 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
5223 struct rte_eth_rxtx_callback *cb;
5225 /* __ATOMIC_RELEASE memory order was used when the
5226 * call back was inserted into the list.
5227 * Since there is a clear dependency between loading
5228 * cb and cb->fn/cb->next, __ATOMIC_ACQUIRE memory order is
5231 cb = __atomic_load_n(&dev->pre_tx_burst_cbs[queue_id],
5234 if (unlikely(cb != NULL)) {
5236 nb_pkts = cb->fn.tx(port_id, queue_id, tx_pkts, nb_pkts,
5239 } while (cb != NULL);
5243 rte_ethdev_trace_tx_burst(port_id, queue_id, (void **)tx_pkts,
5245 return (*dev->tx_pkt_burst)(dev->data->tx_queues[queue_id], tx_pkts, nb_pkts);
5249 * Process a burst of output packets on a transmit queue of an Ethernet device.
5251 * The rte_eth_tx_prepare() function is invoked to prepare output packets to be
5252 * transmitted on the output queue *queue_id* of the Ethernet device designated
5254 * The *nb_pkts* parameter is the number of packets to be prepared which are
5255 * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
5256 * allocated from a pool created with rte_pktmbuf_pool_create().
5257 * For each packet to send, the rte_eth_tx_prepare() function performs
5258 * the following operations:
5260 * - Check if packet meets devices requirements for tx offloads.
5262 * - Check limitations about number of segments.
5264 * - Check additional requirements when debug is enabled.
5266 * - Update and/or reset required checksums when tx offload is set for packet.
5268 * Since this function can modify packet data, provided mbufs must be safely
5269 * writable (e.g. modified data cannot be in shared segment).
5271 * The rte_eth_tx_prepare() function returns the number of packets ready to be
5272 * sent. A return value equal to *nb_pkts* means that all packets are valid and
5273 * ready to be sent, otherwise stops processing on the first invalid packet and
5274 * leaves the rest packets untouched.
5276 * When this functionality is not implemented in the driver, all packets are
5277 * are returned untouched.
5280 * The port identifier of the Ethernet device.
5281 * The value must be a valid port id.
5283 * The index of the transmit queue through which output packets must be
5285 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
5286 * to rte_eth_dev_configure().
5288 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
5289 * which contain the output packets.
5291 * The maximum number of packets to process.
5293 * The number of packets correct and ready to be sent. The return value can be
5294 * less than the value of the *tx_pkts* parameter when some packet doesn't
5295 * meet devices requirements with rte_errno set appropriately:
5296 * - EINVAL: offload flags are not correctly set
5297 * - ENOTSUP: the offload feature is not supported by the hardware
5298 * - ENODEV: if *port_id* is invalid (with debug enabled only)
5302 #ifndef RTE_ETHDEV_TX_PREPARE_NOOP
5304 static inline uint16_t
5305 rte_eth_tx_prepare(uint16_t port_id, uint16_t queue_id,
5306 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
5308 struct rte_eth_dev *dev;
5310 #ifdef RTE_ETHDEV_DEBUG_TX
5311 if (!rte_eth_dev_is_valid_port(port_id)) {
5312 RTE_ETHDEV_LOG(ERR, "Invalid TX port_id=%u\n", port_id);
5318 dev = &rte_eth_devices[port_id];
5320 #ifdef RTE_ETHDEV_DEBUG_TX
5321 if (queue_id >= dev->data->nb_tx_queues) {
5322 RTE_ETHDEV_LOG(ERR, "Invalid TX queue_id=%u\n", queue_id);
5328 if (!dev->tx_pkt_prepare)
5331 return (*dev->tx_pkt_prepare)(dev->data->tx_queues[queue_id],
5338 * Native NOOP operation for compilation targets which doesn't require any
5339 * preparations steps, and functional NOOP may introduce unnecessary performance
5342 * Generally this is not a good idea to turn it on globally and didn't should
5343 * be used if behavior of tx_preparation can change.
5346 static inline uint16_t
5347 rte_eth_tx_prepare(__rte_unused uint16_t port_id,
5348 __rte_unused uint16_t queue_id,
5349 __rte_unused struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
5357 * Send any packets queued up for transmission on a port and HW queue
5359 * This causes an explicit flush of packets previously buffered via the
5360 * rte_eth_tx_buffer() function. It returns the number of packets successfully
5361 * sent to the NIC, and calls the error callback for any unsent packets. Unless
5362 * explicitly set up otherwise, the default callback simply frees the unsent
5363 * packets back to the owning mempool.
5366 * The port identifier of the Ethernet device.
5368 * The index of the transmit queue through which output packets must be
5370 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
5371 * to rte_eth_dev_configure().
5373 * Buffer of packets to be transmit.
5375 * The number of packets successfully sent to the Ethernet device. The error
5376 * callback is called for any packets which could not be sent.
5378 static inline uint16_t
5379 rte_eth_tx_buffer_flush(uint16_t port_id, uint16_t queue_id,
5380 struct rte_eth_dev_tx_buffer *buffer)
5383 uint16_t to_send = buffer->length;
5388 sent = rte_eth_tx_burst(port_id, queue_id, buffer->pkts, to_send);
5392 /* All packets sent, or to be dealt with by callback below */
5393 if (unlikely(sent != to_send))
5394 buffer->error_callback(&buffer->pkts[sent],
5395 (uint16_t)(to_send - sent),
5396 buffer->error_userdata);
5402 * Buffer a single packet for future transmission on a port and queue
5404 * This function takes a single mbuf/packet and buffers it for later
5405 * transmission on the particular port and queue specified. Once the buffer is
5406 * full of packets, an attempt will be made to transmit all the buffered
5407 * packets. In case of error, where not all packets can be transmitted, a
5408 * callback is called with the unsent packets as a parameter. If no callback
5409 * is explicitly set up, the unsent packets are just freed back to the owning
5410 * mempool. The function returns the number of packets actually sent i.e.
5411 * 0 if no buffer flush occurred, otherwise the number of packets successfully
5415 * The port identifier of the Ethernet device.
5417 * The index of the transmit queue through which output packets must be
5419 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
5420 * to rte_eth_dev_configure().
5422 * Buffer used to collect packets to be sent.
5424 * Pointer to the packet mbuf to be sent.
5426 * 0 = packet has been buffered for later transmission
5427 * N > 0 = packet has been buffered, and the buffer was subsequently flushed,
5428 * causing N packets to be sent, and the error callback to be called for
5431 static __rte_always_inline uint16_t
5432 rte_eth_tx_buffer(uint16_t port_id, uint16_t queue_id,
5433 struct rte_eth_dev_tx_buffer *buffer, struct rte_mbuf *tx_pkt)
5435 buffer->pkts[buffer->length++] = tx_pkt;
5436 if (buffer->length < buffer->size)
5439 return rte_eth_tx_buffer_flush(port_id, queue_id, buffer);
5446 #endif /* _RTE_ETHDEV_H_ */