1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2017 Intel Corporation
11 * RTE Ethernet Device API
13 * The Ethernet Device API is composed of two parts:
15 * - The application-oriented Ethernet API that includes functions to setup
16 * an Ethernet device (configure it, setup its RX and TX queues and start it),
17 * to get its MAC address, the speed and the status of its physical link,
18 * to receive and to transmit packets, and so on.
20 * - The driver-oriented Ethernet API that exports functions allowing
21 * an Ethernet Poll Mode Driver (PMD) to allocate an Ethernet device instance,
22 * create memzone for HW rings and process registered callbacks, and so on.
23 * PMDs should include rte_ethdev_driver.h instead of this header.
25 * By default, all the functions of the Ethernet Device API exported by a PMD
26 * are lock-free functions which assume to not be invoked in parallel on
27 * different logical cores to work on the same target object. For instance,
28 * the receive function of a PMD cannot be invoked in parallel on two logical
29 * cores to poll the same RX queue [of the same port]. Of course, this function
30 * can be invoked in parallel by different logical cores on different RX queues.
31 * It is the responsibility of the upper level application to enforce this rule.
33 * If needed, parallel accesses by multiple logical cores to shared queues
34 * shall be explicitly protected by dedicated inline lock-aware functions
35 * built on top of their corresponding lock-free functions of the PMD API.
37 * In all functions of the Ethernet API, the Ethernet device is
38 * designated by an integer >= 0 named the device port identifier.
40 * At the Ethernet driver level, Ethernet devices are represented by a generic
41 * data structure of type *rte_eth_dev*.
43 * Ethernet devices are dynamically registered during the PCI probing phase
44 * performed at EAL initialization time.
45 * When an Ethernet device is being probed, an *rte_eth_dev* structure and
46 * a new port identifier are allocated for that device. Then, the eth_dev_init()
47 * function supplied by the Ethernet driver matching the probed PCI
48 * device is invoked to properly initialize the device.
50 * The role of the device init function consists of resetting the hardware,
51 * checking access to Non-volatile Memory (NVM), reading the MAC address
54 * If the device init operation is successful, the correspondence between
55 * the port identifier assigned to the new device and its associated
56 * *rte_eth_dev* structure is effectively registered.
57 * Otherwise, both the *rte_eth_dev* structure and the port identifier are
60 * The functions exported by the application Ethernet API to setup a device
61 * designated by its port identifier must be invoked in the following order:
62 * - rte_eth_dev_configure()
63 * - rte_eth_tx_queue_setup()
64 * - rte_eth_rx_queue_setup()
65 * - rte_eth_dev_start()
67 * Then, the network application can invoke, in any order, the functions
68 * exported by the Ethernet API to get the MAC address of a given device, to
69 * get the speed and the status of a device physical link, to receive/transmit
70 * [burst of] packets, and so on.
72 * If the application wants to change the configuration (i.e. call
73 * rte_eth_dev_configure(), rte_eth_tx_queue_setup(), or
74 * rte_eth_rx_queue_setup()), it must call rte_eth_dev_stop() first to stop the
75 * device and then do the reconfiguration before calling rte_eth_dev_start()
76 * again. The transmit and receive functions should not be invoked when the
79 * Please note that some configuration is not stored between calls to
80 * rte_eth_dev_stop()/rte_eth_dev_start(). The following configuration will
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 #include <rte_compat.h>
153 #include <rte_interrupts.h>
155 #include <rte_devargs.h>
156 #include <rte_errno.h>
157 #include <rte_common.h>
158 #include <rte_config.h>
159 #include <rte_ether.h>
161 #include "rte_ethdev_trace_fp.h"
162 #include "rte_dev_info.h"
164 extern int rte_eth_dev_logtype;
166 #define RTE_ETHDEV_LOG(level, ...) \
167 rte_log(RTE_LOG_ ## level, rte_eth_dev_logtype, "" __VA_ARGS__)
172 * Initializes a device iterator.
174 * This iterator allows accessing a list of devices matching some devargs.
177 * Device iterator handle initialized by the function.
178 * The fields bus_str and cls_str might be dynamically allocated,
179 * and could be freed by calling rte_eth_iterator_cleanup().
182 * Device description string.
185 * 0 on successful initialization, negative otherwise.
187 int rte_eth_iterator_init(struct rte_dev_iterator *iter, const char *devargs);
190 * Iterates on devices with devargs filter.
191 * The ownership is not checked.
193 * The next port id is returned, and the iterator is updated.
196 * Device iterator handle initialized by rte_eth_iterator_init().
197 * Some fields bus_str and cls_str might be freed when no more port is found,
198 * by calling rte_eth_iterator_cleanup().
201 * A port id if found, RTE_MAX_ETHPORTS otherwise.
203 uint16_t rte_eth_iterator_next(struct rte_dev_iterator *iter);
206 * Free some allocated fields of the iterator.
208 * This function is automatically called by rte_eth_iterator_next()
209 * on the last iteration (i.e. when no more matching port is found).
211 * It is safe to call this function twice; it will do nothing more.
214 * Device iterator handle initialized by rte_eth_iterator_init().
215 * The fields bus_str and cls_str are freed if needed.
217 void rte_eth_iterator_cleanup(struct rte_dev_iterator *iter);
220 * Macro to iterate over all ethdev ports matching some devargs.
222 * If a break is done before the end of the loop,
223 * the function rte_eth_iterator_cleanup() must be called.
226 * Iterated port id of type uint16_t.
228 * Device parameters input as string of type char*.
230 * Iterator handle of type struct rte_dev_iterator, used internally.
232 #define RTE_ETH_FOREACH_MATCHING_DEV(id, devargs, iter) \
233 for (rte_eth_iterator_init(iter, devargs), \
234 id = rte_eth_iterator_next(iter); \
235 id != RTE_MAX_ETHPORTS; \
236 id = rte_eth_iterator_next(iter))
239 * A structure used to retrieve statistics for an Ethernet port.
240 * Not all statistics fields in struct rte_eth_stats are supported
241 * by any type of network interface card (NIC). If any statistics
242 * field is not supported, its value is 0.
244 struct rte_eth_stats {
245 uint64_t ipackets; /**< Total number of successfully received packets. */
246 uint64_t opackets; /**< Total number of successfully transmitted packets.*/
247 uint64_t ibytes; /**< Total number of successfully received bytes. */
248 uint64_t obytes; /**< Total number of successfully transmitted bytes. */
250 /**< Total of RX packets dropped by the HW,
251 * because there are no available buffer (i.e. RX queues are full).
253 uint64_t ierrors; /**< Total number of erroneous received packets. */
254 uint64_t oerrors; /**< Total number of failed transmitted packets. */
255 uint64_t rx_nombuf; /**< Total number of RX mbuf allocation failures. */
256 uint64_t q_ipackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
257 /**< Total number of queue RX packets. */
258 uint64_t q_opackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
259 /**< Total number of queue TX packets. */
260 uint64_t q_ibytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
261 /**< Total number of successfully received queue bytes. */
262 uint64_t q_obytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
263 /**< Total number of successfully transmitted queue bytes. */
264 uint64_t q_errors[RTE_ETHDEV_QUEUE_STAT_CNTRS];
265 /**< Total number of queue packets received that are dropped. */
269 * Device supported speeds bitmap flags
271 #define ETH_LINK_SPEED_AUTONEG (0 << 0) /**< Autonegotiate (all speeds) */
272 #define ETH_LINK_SPEED_FIXED (1 << 0) /**< Disable autoneg (fixed speed) */
273 #define ETH_LINK_SPEED_10M_HD (1 << 1) /**< 10 Mbps half-duplex */
274 #define ETH_LINK_SPEED_10M (1 << 2) /**< 10 Mbps full-duplex */
275 #define ETH_LINK_SPEED_100M_HD (1 << 3) /**< 100 Mbps half-duplex */
276 #define ETH_LINK_SPEED_100M (1 << 4) /**< 100 Mbps full-duplex */
277 #define ETH_LINK_SPEED_1G (1 << 5) /**< 1 Gbps */
278 #define ETH_LINK_SPEED_2_5G (1 << 6) /**< 2.5 Gbps */
279 #define ETH_LINK_SPEED_5G (1 << 7) /**< 5 Gbps */
280 #define ETH_LINK_SPEED_10G (1 << 8) /**< 10 Gbps */
281 #define ETH_LINK_SPEED_20G (1 << 9) /**< 20 Gbps */
282 #define ETH_LINK_SPEED_25G (1 << 10) /**< 25 Gbps */
283 #define ETH_LINK_SPEED_40G (1 << 11) /**< 40 Gbps */
284 #define ETH_LINK_SPEED_50G (1 << 12) /**< 50 Gbps */
285 #define ETH_LINK_SPEED_56G (1 << 13) /**< 56 Gbps */
286 #define ETH_LINK_SPEED_100G (1 << 14) /**< 100 Gbps */
287 #define ETH_LINK_SPEED_200G (1 << 15) /**< 200 Gbps */
290 * Ethernet numeric link speeds in Mbps
292 #define ETH_SPEED_NUM_NONE 0 /**< Not defined */
293 #define ETH_SPEED_NUM_10M 10 /**< 10 Mbps */
294 #define ETH_SPEED_NUM_100M 100 /**< 100 Mbps */
295 #define ETH_SPEED_NUM_1G 1000 /**< 1 Gbps */
296 #define ETH_SPEED_NUM_2_5G 2500 /**< 2.5 Gbps */
297 #define ETH_SPEED_NUM_5G 5000 /**< 5 Gbps */
298 #define ETH_SPEED_NUM_10G 10000 /**< 10 Gbps */
299 #define ETH_SPEED_NUM_20G 20000 /**< 20 Gbps */
300 #define ETH_SPEED_NUM_25G 25000 /**< 25 Gbps */
301 #define ETH_SPEED_NUM_40G 40000 /**< 40 Gbps */
302 #define ETH_SPEED_NUM_50G 50000 /**< 50 Gbps */
303 #define ETH_SPEED_NUM_56G 56000 /**< 56 Gbps */
304 #define ETH_SPEED_NUM_100G 100000 /**< 100 Gbps */
305 #define ETH_SPEED_NUM_200G 200000 /**< 200 Gbps */
306 #define ETH_SPEED_NUM_UNKNOWN UINT32_MAX /**< Unknown */
309 * A structure used to retrieve link-level information of an Ethernet port.
312 struct rte_eth_link {
313 uint32_t link_speed; /**< ETH_SPEED_NUM_ */
314 uint16_t link_duplex : 1; /**< ETH_LINK_[HALF/FULL]_DUPLEX */
315 uint16_t link_autoneg : 1; /**< ETH_LINK_[AUTONEG/FIXED] */
316 uint16_t link_status : 1; /**< ETH_LINK_[DOWN/UP] */
317 } __rte_aligned(8); /**< aligned for atomic64 read/write */
319 /* Utility constants */
320 #define ETH_LINK_HALF_DUPLEX 0 /**< Half-duplex connection (see link_duplex). */
321 #define ETH_LINK_FULL_DUPLEX 1 /**< Full-duplex connection (see link_duplex). */
322 #define ETH_LINK_DOWN 0 /**< Link is down (see link_status). */
323 #define ETH_LINK_UP 1 /**< Link is up (see link_status). */
324 #define ETH_LINK_FIXED 0 /**< No autonegotiation (see link_autoneg). */
325 #define ETH_LINK_AUTONEG 1 /**< Autonegotiated (see link_autoneg). */
328 * A structure used to configure the ring threshold registers of an RX/TX
329 * queue for an Ethernet port.
331 struct rte_eth_thresh {
332 uint8_t pthresh; /**< Ring prefetch threshold. */
333 uint8_t hthresh; /**< Ring host threshold. */
334 uint8_t wthresh; /**< Ring writeback threshold. */
338 * Simple flags are used for rte_eth_conf.rxmode.mq_mode.
340 #define ETH_MQ_RX_RSS_FLAG 0x1
341 #define ETH_MQ_RX_DCB_FLAG 0x2
342 #define ETH_MQ_RX_VMDQ_FLAG 0x4
345 * A set of values to identify what method is to be used to route
346 * packets to multiple queues.
348 enum rte_eth_rx_mq_mode {
349 /** None of DCB,RSS or VMDQ mode */
352 /** For RX side, only RSS is on */
353 ETH_MQ_RX_RSS = ETH_MQ_RX_RSS_FLAG,
354 /** For RX side,only DCB is on. */
355 ETH_MQ_RX_DCB = ETH_MQ_RX_DCB_FLAG,
356 /** Both DCB and RSS enable */
357 ETH_MQ_RX_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG,
359 /** Only VMDQ, no RSS nor DCB */
360 ETH_MQ_RX_VMDQ_ONLY = ETH_MQ_RX_VMDQ_FLAG,
361 /** RSS mode with VMDQ */
362 ETH_MQ_RX_VMDQ_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_VMDQ_FLAG,
363 /** Use VMDQ+DCB to route traffic to queues */
364 ETH_MQ_RX_VMDQ_DCB = ETH_MQ_RX_VMDQ_FLAG | ETH_MQ_RX_DCB_FLAG,
365 /** Enable both VMDQ and DCB in VMDq */
366 ETH_MQ_RX_VMDQ_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG |
371 * for rx mq mode backward compatible
373 #define ETH_RSS ETH_MQ_RX_RSS
374 #define VMDQ_DCB ETH_MQ_RX_VMDQ_DCB
375 #define ETH_DCB_RX ETH_MQ_RX_DCB
378 * A set of values to identify what method is to be used to transmit
379 * packets using multi-TCs.
381 enum rte_eth_tx_mq_mode {
382 ETH_MQ_TX_NONE = 0, /**< It is in neither DCB nor VT mode. */
383 ETH_MQ_TX_DCB, /**< For TX side,only DCB is on. */
384 ETH_MQ_TX_VMDQ_DCB, /**< For TX side,both DCB and VT is on. */
385 ETH_MQ_TX_VMDQ_ONLY, /**< Only VT on, no DCB */
389 * for tx mq mode backward compatible
391 #define ETH_DCB_NONE ETH_MQ_TX_NONE
392 #define ETH_VMDQ_DCB_TX ETH_MQ_TX_VMDQ_DCB
393 #define ETH_DCB_TX ETH_MQ_TX_DCB
396 * A structure used to configure the RX features of an Ethernet port.
398 struct rte_eth_rxmode {
399 /** The multi-queue packet distribution mode to be used, e.g. RSS. */
400 enum rte_eth_rx_mq_mode mq_mode;
401 uint32_t max_rx_pkt_len; /**< Only used if JUMBO_FRAME enabled. */
402 /** Maximum allowed size of LRO aggregated packet. */
403 uint32_t max_lro_pkt_size;
404 uint16_t split_hdr_size; /**< hdr buf size (header_split enabled).*/
406 * Per-port Rx offloads to be set using DEV_RX_OFFLOAD_* flags.
407 * Only offloads set on rx_offload_capa field on rte_eth_dev_info
408 * structure are allowed to be set.
412 uint64_t reserved_64s[2]; /**< Reserved for future fields */
413 void *reserved_ptrs[2]; /**< Reserved for future fields */
417 * VLAN types to indicate if it is for single VLAN, inner VLAN or outer VLAN.
418 * Note that single VLAN is treated the same as inner VLAN.
421 ETH_VLAN_TYPE_UNKNOWN = 0,
422 ETH_VLAN_TYPE_INNER, /**< Inner VLAN. */
423 ETH_VLAN_TYPE_OUTER, /**< Single VLAN, or outer VLAN. */
428 * A structure used to describe a vlan filter.
429 * If the bit corresponding to a VID is set, such VID is on.
431 struct rte_vlan_filter_conf {
436 * A structure used to configure the Receive Side Scaling (RSS) feature
437 * of an Ethernet port.
438 * If not NULL, the *rss_key* pointer of the *rss_conf* structure points
439 * to an array holding the RSS key to use for hashing specific header
440 * fields of received packets. The length of this array should be indicated
441 * by *rss_key_len* below. Otherwise, a default random hash key is used by
444 * The *rss_key_len* field of the *rss_conf* structure indicates the length
445 * in bytes of the array pointed by *rss_key*. To be compatible, this length
446 * will be checked in i40e only. Others assume 40 bytes to be used as before.
448 * The *rss_hf* field of the *rss_conf* structure indicates the different
449 * types of IPv4/IPv6 packets to which the RSS hashing must be applied.
450 * Supplying an *rss_hf* equal to zero disables the RSS feature.
452 struct rte_eth_rss_conf {
453 uint8_t *rss_key; /**< If not NULL, 40-byte hash key. */
454 uint8_t rss_key_len; /**< hash key length in bytes. */
455 uint64_t rss_hf; /**< Hash functions to apply - see below. */
459 * A packet can be identified by hardware as different flow types. Different
460 * NIC hardware may support different flow types.
461 * Basically, the NIC hardware identifies the flow type as deep protocol as
462 * possible, and exclusively. For example, if a packet is identified as
463 * 'RTE_ETH_FLOW_NONFRAG_IPV4_TCP', it will not be any of other flow types,
464 * though it is an actual IPV4 packet.
466 #define RTE_ETH_FLOW_UNKNOWN 0
467 #define RTE_ETH_FLOW_RAW 1
468 #define RTE_ETH_FLOW_IPV4 2
469 #define RTE_ETH_FLOW_FRAG_IPV4 3
470 #define RTE_ETH_FLOW_NONFRAG_IPV4_TCP 4
471 #define RTE_ETH_FLOW_NONFRAG_IPV4_UDP 5
472 #define RTE_ETH_FLOW_NONFRAG_IPV4_SCTP 6
473 #define RTE_ETH_FLOW_NONFRAG_IPV4_OTHER 7
474 #define RTE_ETH_FLOW_IPV6 8
475 #define RTE_ETH_FLOW_FRAG_IPV6 9
476 #define RTE_ETH_FLOW_NONFRAG_IPV6_TCP 10
477 #define RTE_ETH_FLOW_NONFRAG_IPV6_UDP 11
478 #define RTE_ETH_FLOW_NONFRAG_IPV6_SCTP 12
479 #define RTE_ETH_FLOW_NONFRAG_IPV6_OTHER 13
480 #define RTE_ETH_FLOW_L2_PAYLOAD 14
481 #define RTE_ETH_FLOW_IPV6_EX 15
482 #define RTE_ETH_FLOW_IPV6_TCP_EX 16
483 #define RTE_ETH_FLOW_IPV6_UDP_EX 17
484 #define RTE_ETH_FLOW_PORT 18
485 /**< Consider device port number as a flow differentiator */
486 #define RTE_ETH_FLOW_VXLAN 19 /**< VXLAN protocol based flow */
487 #define RTE_ETH_FLOW_GENEVE 20 /**< GENEVE protocol based flow */
488 #define RTE_ETH_FLOW_NVGRE 21 /**< NVGRE protocol based flow */
489 #define RTE_ETH_FLOW_VXLAN_GPE 22 /**< VXLAN-GPE protocol based flow */
490 #define RTE_ETH_FLOW_GTPU 23 /**< GTPU protocol based flow */
491 #define RTE_ETH_FLOW_MAX 24
494 * Below macros are defined for RSS offload types, they can be used to
495 * fill rte_eth_rss_conf.rss_hf or rte_flow_action_rss.types.
497 #define ETH_RSS_IPV4 (1ULL << 2)
498 #define ETH_RSS_FRAG_IPV4 (1ULL << 3)
499 #define ETH_RSS_NONFRAG_IPV4_TCP (1ULL << 4)
500 #define ETH_RSS_NONFRAG_IPV4_UDP (1ULL << 5)
501 #define ETH_RSS_NONFRAG_IPV4_SCTP (1ULL << 6)
502 #define ETH_RSS_NONFRAG_IPV4_OTHER (1ULL << 7)
503 #define ETH_RSS_IPV6 (1ULL << 8)
504 #define ETH_RSS_FRAG_IPV6 (1ULL << 9)
505 #define ETH_RSS_NONFRAG_IPV6_TCP (1ULL << 10)
506 #define ETH_RSS_NONFRAG_IPV6_UDP (1ULL << 11)
507 #define ETH_RSS_NONFRAG_IPV6_SCTP (1ULL << 12)
508 #define ETH_RSS_NONFRAG_IPV6_OTHER (1ULL << 13)
509 #define ETH_RSS_L2_PAYLOAD (1ULL << 14)
510 #define ETH_RSS_IPV6_EX (1ULL << 15)
511 #define ETH_RSS_IPV6_TCP_EX (1ULL << 16)
512 #define ETH_RSS_IPV6_UDP_EX (1ULL << 17)
513 #define ETH_RSS_PORT (1ULL << 18)
514 #define ETH_RSS_VXLAN (1ULL << 19)
515 #define ETH_RSS_GENEVE (1ULL << 20)
516 #define ETH_RSS_NVGRE (1ULL << 21)
517 #define ETH_RSS_GTPU (1ULL << 23)
518 #define ETH_RSS_ETH (1ULL << 24)
519 #define ETH_RSS_S_VLAN (1ULL << 25)
520 #define ETH_RSS_C_VLAN (1ULL << 26)
521 #define ETH_RSS_ESP (1ULL << 27)
522 #define ETH_RSS_AH (1ULL << 28)
523 #define ETH_RSS_L2TPV3 (1ULL << 29)
524 #define ETH_RSS_PFCP (1ULL << 30)
525 #define ETH_RSS_PPPOE (1ULL << 31)
528 * We use the following macros to combine with above ETH_RSS_* for
529 * more specific input set selection. These bits are defined starting
530 * from the high end of the 64 bits.
531 * Note: If we use above ETH_RSS_* without SRC/DST_ONLY, it represents
532 * both SRC and DST are taken into account. If SRC_ONLY and DST_ONLY of
533 * the same level are used simultaneously, it is the same case as none of
536 #define ETH_RSS_L3_SRC_ONLY (1ULL << 63)
537 #define ETH_RSS_L3_DST_ONLY (1ULL << 62)
538 #define ETH_RSS_L4_SRC_ONLY (1ULL << 61)
539 #define ETH_RSS_L4_DST_ONLY (1ULL << 60)
540 #define ETH_RSS_L2_SRC_ONLY (1ULL << 59)
541 #define ETH_RSS_L2_DST_ONLY (1ULL << 58)
544 * Only select IPV6 address prefix as RSS input set according to
545 * https://tools.ietf.org/html/rfc6052
546 * Must be combined with ETH_RSS_IPV6, ETH_RSS_NONFRAG_IPV6_UDP,
547 * ETH_RSS_NONFRAG_IPV6_TCP, ETH_RSS_NONFRAG_IPV6_SCTP.
549 #define RTE_ETH_RSS_L3_PRE32 (1ULL << 57)
550 #define RTE_ETH_RSS_L3_PRE40 (1ULL << 56)
551 #define RTE_ETH_RSS_L3_PRE48 (1ULL << 55)
552 #define RTE_ETH_RSS_L3_PRE56 (1ULL << 54)
553 #define RTE_ETH_RSS_L3_PRE64 (1ULL << 53)
554 #define RTE_ETH_RSS_L3_PRE96 (1ULL << 52)
557 * Use the following macros to combine with the above layers
558 * to choose inner and outer layers or both for RSS computation.
559 * Bits 50 and 51 are reserved for this.
563 * level 0, requests the default behavior.
564 * Depending on the packet type, it can mean outermost, innermost,
565 * anything in between or even no RSS.
566 * It basically stands for the innermost encapsulation level RSS
567 * can be performed on according to PMD and device capabilities.
569 #define ETH_RSS_LEVEL_PMD_DEFAULT (0ULL << 50)
572 * level 1, requests RSS to be performed on the outermost packet
573 * encapsulation level.
575 #define ETH_RSS_LEVEL_OUTERMOST (1ULL << 50)
578 * level 2, requests RSS to be performed on the specified inner packet
579 * encapsulation level, from outermost to innermost (lower to higher values).
581 #define ETH_RSS_LEVEL_INNERMOST (2ULL << 50)
582 #define ETH_RSS_LEVEL_MASK (3ULL << 50)
584 #define ETH_RSS_LEVEL(rss_hf) ((rss_hf & ETH_RSS_LEVEL_MASK) >> 50)
587 * For input set change of hash filter, if SRC_ONLY and DST_ONLY of
588 * the same level are used simultaneously, it is the same case as
589 * none of them are added.
592 * RSS types with SRC/DST_ONLY.
596 static inline uint64_t
597 rte_eth_rss_hf_refine(uint64_t rss_hf)
599 if ((rss_hf & ETH_RSS_L3_SRC_ONLY) && (rss_hf & ETH_RSS_L3_DST_ONLY))
600 rss_hf &= ~(ETH_RSS_L3_SRC_ONLY | ETH_RSS_L3_DST_ONLY);
602 if ((rss_hf & ETH_RSS_L4_SRC_ONLY) && (rss_hf & ETH_RSS_L4_DST_ONLY))
603 rss_hf &= ~(ETH_RSS_L4_SRC_ONLY | ETH_RSS_L4_DST_ONLY);
608 #define ETH_RSS_IPV6_PRE32 ( \
610 RTE_ETH_RSS_L3_PRE32)
612 #define ETH_RSS_IPV6_PRE40 ( \
614 RTE_ETH_RSS_L3_PRE40)
616 #define ETH_RSS_IPV6_PRE48 ( \
618 RTE_ETH_RSS_L3_PRE48)
620 #define ETH_RSS_IPV6_PRE56 ( \
622 RTE_ETH_RSS_L3_PRE56)
624 #define ETH_RSS_IPV6_PRE64 ( \
626 RTE_ETH_RSS_L3_PRE64)
628 #define ETH_RSS_IPV6_PRE96 ( \
630 RTE_ETH_RSS_L3_PRE96)
632 #define ETH_RSS_IPV6_PRE32_UDP ( \
633 ETH_RSS_NONFRAG_IPV6_UDP | \
634 RTE_ETH_RSS_L3_PRE32)
636 #define ETH_RSS_IPV6_PRE40_UDP ( \
637 ETH_RSS_NONFRAG_IPV6_UDP | \
638 RTE_ETH_RSS_L3_PRE40)
640 #define ETH_RSS_IPV6_PRE48_UDP ( \
641 ETH_RSS_NONFRAG_IPV6_UDP | \
642 RTE_ETH_RSS_L3_PRE48)
644 #define ETH_RSS_IPV6_PRE56_UDP ( \
645 ETH_RSS_NONFRAG_IPV6_UDP | \
646 RTE_ETH_RSS_L3_PRE56)
648 #define ETH_RSS_IPV6_PRE64_UDP ( \
649 ETH_RSS_NONFRAG_IPV6_UDP | \
650 RTE_ETH_RSS_L3_PRE64)
652 #define ETH_RSS_IPV6_PRE96_UDP ( \
653 ETH_RSS_NONFRAG_IPV6_UDP | \
654 RTE_ETH_RSS_L3_PRE96)
656 #define ETH_RSS_IPV6_PRE32_TCP ( \
657 ETH_RSS_NONFRAG_IPV6_TCP | \
658 RTE_ETH_RSS_L3_PRE32)
660 #define ETH_RSS_IPV6_PRE40_TCP ( \
661 ETH_RSS_NONFRAG_IPV6_TCP | \
662 RTE_ETH_RSS_L3_PRE40)
664 #define ETH_RSS_IPV6_PRE48_TCP ( \
665 ETH_RSS_NONFRAG_IPV6_TCP | \
666 RTE_ETH_RSS_L3_PRE48)
668 #define ETH_RSS_IPV6_PRE56_TCP ( \
669 ETH_RSS_NONFRAG_IPV6_TCP | \
670 RTE_ETH_RSS_L3_PRE56)
672 #define ETH_RSS_IPV6_PRE64_TCP ( \
673 ETH_RSS_NONFRAG_IPV6_TCP | \
674 RTE_ETH_RSS_L3_PRE64)
676 #define ETH_RSS_IPV6_PRE96_TCP ( \
677 ETH_RSS_NONFRAG_IPV6_TCP | \
678 RTE_ETH_RSS_L3_PRE96)
680 #define ETH_RSS_IPV6_PRE32_SCTP ( \
681 ETH_RSS_NONFRAG_IPV6_SCTP | \
682 RTE_ETH_RSS_L3_PRE32)
684 #define ETH_RSS_IPV6_PRE40_SCTP ( \
685 ETH_RSS_NONFRAG_IPV6_SCTP | \
686 RTE_ETH_RSS_L3_PRE40)
688 #define ETH_RSS_IPV6_PRE48_SCTP ( \
689 ETH_RSS_NONFRAG_IPV6_SCTP | \
690 RTE_ETH_RSS_L3_PRE48)
692 #define ETH_RSS_IPV6_PRE56_SCTP ( \
693 ETH_RSS_NONFRAG_IPV6_SCTP | \
694 RTE_ETH_RSS_L3_PRE56)
696 #define ETH_RSS_IPV6_PRE64_SCTP ( \
697 ETH_RSS_NONFRAG_IPV6_SCTP | \
698 RTE_ETH_RSS_L3_PRE64)
700 #define ETH_RSS_IPV6_PRE96_SCTP ( \
701 ETH_RSS_NONFRAG_IPV6_SCTP | \
702 RTE_ETH_RSS_L3_PRE96)
704 #define ETH_RSS_IP ( \
706 ETH_RSS_FRAG_IPV4 | \
707 ETH_RSS_NONFRAG_IPV4_OTHER | \
709 ETH_RSS_FRAG_IPV6 | \
710 ETH_RSS_NONFRAG_IPV6_OTHER | \
713 #define ETH_RSS_UDP ( \
714 ETH_RSS_NONFRAG_IPV4_UDP | \
715 ETH_RSS_NONFRAG_IPV6_UDP | \
718 #define ETH_RSS_TCP ( \
719 ETH_RSS_NONFRAG_IPV4_TCP | \
720 ETH_RSS_NONFRAG_IPV6_TCP | \
723 #define ETH_RSS_SCTP ( \
724 ETH_RSS_NONFRAG_IPV4_SCTP | \
725 ETH_RSS_NONFRAG_IPV6_SCTP)
727 #define ETH_RSS_TUNNEL ( \
732 #define ETH_RSS_VLAN ( \
736 /**< Mask of valid RSS hash protocols */
737 #define ETH_RSS_PROTO_MASK ( \
739 ETH_RSS_FRAG_IPV4 | \
740 ETH_RSS_NONFRAG_IPV4_TCP | \
741 ETH_RSS_NONFRAG_IPV4_UDP | \
742 ETH_RSS_NONFRAG_IPV4_SCTP | \
743 ETH_RSS_NONFRAG_IPV4_OTHER | \
745 ETH_RSS_FRAG_IPV6 | \
746 ETH_RSS_NONFRAG_IPV6_TCP | \
747 ETH_RSS_NONFRAG_IPV6_UDP | \
748 ETH_RSS_NONFRAG_IPV6_SCTP | \
749 ETH_RSS_NONFRAG_IPV6_OTHER | \
750 ETH_RSS_L2_PAYLOAD | \
752 ETH_RSS_IPV6_TCP_EX | \
753 ETH_RSS_IPV6_UDP_EX | \
760 * Definitions used for redirection table entry size.
761 * Some RSS RETA sizes may not be supported by some drivers, check the
762 * documentation or the description of relevant functions for more details.
764 #define ETH_RSS_RETA_SIZE_64 64
765 #define ETH_RSS_RETA_SIZE_128 128
766 #define ETH_RSS_RETA_SIZE_256 256
767 #define ETH_RSS_RETA_SIZE_512 512
768 #define RTE_RETA_GROUP_SIZE 64
770 /* Definitions used for VMDQ and DCB functionality */
771 #define ETH_VMDQ_MAX_VLAN_FILTERS 64 /**< Maximum nb. of VMDQ vlan filters. */
772 #define ETH_DCB_NUM_USER_PRIORITIES 8 /**< Maximum nb. of DCB priorities. */
773 #define ETH_VMDQ_DCB_NUM_QUEUES 128 /**< Maximum nb. of VMDQ DCB queues. */
774 #define ETH_DCB_NUM_QUEUES 128 /**< Maximum nb. of DCB queues. */
776 /* DCB capability defines */
777 #define ETH_DCB_PG_SUPPORT 0x00000001 /**< Priority Group(ETS) support. */
778 #define ETH_DCB_PFC_SUPPORT 0x00000002 /**< Priority Flow Control support. */
780 /* Definitions used for VLAN Offload functionality */
781 #define ETH_VLAN_STRIP_OFFLOAD 0x0001 /**< VLAN Strip On/Off */
782 #define ETH_VLAN_FILTER_OFFLOAD 0x0002 /**< VLAN Filter On/Off */
783 #define ETH_VLAN_EXTEND_OFFLOAD 0x0004 /**< VLAN Extend On/Off */
784 #define ETH_QINQ_STRIP_OFFLOAD 0x0008 /**< QINQ Strip On/Off */
786 /* Definitions used for mask VLAN setting */
787 #define ETH_VLAN_STRIP_MASK 0x0001 /**< VLAN Strip setting mask */
788 #define ETH_VLAN_FILTER_MASK 0x0002 /**< VLAN Filter setting mask*/
789 #define ETH_VLAN_EXTEND_MASK 0x0004 /**< VLAN Extend setting mask*/
790 #define ETH_QINQ_STRIP_MASK 0x0008 /**< QINQ Strip setting mask */
791 #define ETH_VLAN_ID_MAX 0x0FFF /**< VLAN ID is in lower 12 bits*/
793 /* Definitions used for receive MAC address */
794 #define ETH_NUM_RECEIVE_MAC_ADDR 128 /**< Maximum nb. of receive mac addr. */
796 /* Definitions used for unicast hash */
797 #define ETH_VMDQ_NUM_UC_HASH_ARRAY 128 /**< Maximum nb. of UC hash array. */
799 /* Definitions used for VMDQ pool rx mode setting */
800 #define ETH_VMDQ_ACCEPT_UNTAG 0x0001 /**< accept untagged packets. */
801 #define ETH_VMDQ_ACCEPT_HASH_MC 0x0002 /**< accept packets in multicast table . */
802 #define ETH_VMDQ_ACCEPT_HASH_UC 0x0004 /**< accept packets in unicast table. */
803 #define ETH_VMDQ_ACCEPT_BROADCAST 0x0008 /**< accept broadcast packets. */
804 #define ETH_VMDQ_ACCEPT_MULTICAST 0x0010 /**< multicast promiscuous. */
806 /** Maximum nb. of vlan per mirror rule */
807 #define ETH_MIRROR_MAX_VLANS 64
809 #define ETH_MIRROR_VIRTUAL_POOL_UP 0x01 /**< Virtual Pool uplink Mirroring. */
810 #define ETH_MIRROR_UPLINK_PORT 0x02 /**< Uplink Port Mirroring. */
811 #define ETH_MIRROR_DOWNLINK_PORT 0x04 /**< Downlink Port Mirroring. */
812 #define ETH_MIRROR_VLAN 0x08 /**< VLAN Mirroring. */
813 #define ETH_MIRROR_VIRTUAL_POOL_DOWN 0x10 /**< Virtual Pool downlink Mirroring. */
816 * A structure used to configure VLAN traffic mirror of an Ethernet port.
818 struct rte_eth_vlan_mirror {
819 uint64_t vlan_mask; /**< mask for valid VLAN ID. */
820 /** VLAN ID list for vlan mirroring. */
821 uint16_t vlan_id[ETH_MIRROR_MAX_VLANS];
825 * A structure used to configure traffic mirror of an Ethernet port.
827 struct rte_eth_mirror_conf {
828 uint8_t rule_type; /**< Mirroring rule type */
829 uint8_t dst_pool; /**< Destination pool for this mirror rule. */
830 uint64_t pool_mask; /**< Bitmap of pool for pool mirroring */
831 /** VLAN ID setting for VLAN mirroring. */
832 struct rte_eth_vlan_mirror vlan;
836 * A structure used to configure 64 entries of Redirection Table of the
837 * Receive Side Scaling (RSS) feature of an Ethernet port. To configure
838 * more than 64 entries supported by hardware, an array of this structure
841 struct rte_eth_rss_reta_entry64 {
843 /**< Mask bits indicate which entries need to be updated/queried. */
844 uint16_t reta[RTE_RETA_GROUP_SIZE];
845 /**< Group of 64 redirection table entries. */
849 * This enum indicates the possible number of traffic classes
850 * in DCB configurations
852 enum rte_eth_nb_tcs {
853 ETH_4_TCS = 4, /**< 4 TCs with DCB. */
854 ETH_8_TCS = 8 /**< 8 TCs with DCB. */
858 * This enum indicates the possible number of queue pools
859 * in VMDQ configurations.
861 enum rte_eth_nb_pools {
862 ETH_8_POOLS = 8, /**< 8 VMDq pools. */
863 ETH_16_POOLS = 16, /**< 16 VMDq pools. */
864 ETH_32_POOLS = 32, /**< 32 VMDq pools. */
865 ETH_64_POOLS = 64 /**< 64 VMDq pools. */
868 /* This structure may be extended in future. */
869 struct rte_eth_dcb_rx_conf {
870 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs */
871 /** Traffic class each UP mapped to. */
872 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
875 struct rte_eth_vmdq_dcb_tx_conf {
876 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools. */
877 /** Traffic class each UP mapped to. */
878 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
881 struct rte_eth_dcb_tx_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_tx_conf {
888 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq mode, 64 pools. */
892 * A structure used to configure the VMDQ+DCB feature
893 * of an Ethernet port.
895 * Using this feature, packets are routed to a pool of queues, based
896 * on the vlan id in the vlan tag, and then to a specific queue within
897 * that pool, using the user priority vlan tag field.
899 * A default pool may be used, if desired, to route all traffic which
900 * does not match the vlan filter rules.
902 struct rte_eth_vmdq_dcb_conf {
903 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools */
904 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
905 uint8_t default_pool; /**< The default pool, if applicable */
906 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
908 uint16_t vlan_id; /**< The vlan id of the received frame */
909 uint64_t pools; /**< Bitmask of pools for packet rx */
910 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
911 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
912 /**< Selects a queue in a pool */
916 * A structure used to configure the VMDQ feature of an Ethernet port when
917 * not combined with the DCB feature.
919 * Using this feature, packets are routed to a pool of queues. By default,
920 * the pool selection is based on the MAC address, the vlan id in the
921 * vlan tag as specified in the pool_map array.
922 * Passing the ETH_VMDQ_ACCEPT_UNTAG in the rx_mode field allows pool
923 * selection using only the MAC address. MAC address to pool mapping is done
924 * using the rte_eth_dev_mac_addr_add function, with the pool parameter
925 * corresponding to the pool id.
927 * Queue selection within the selected pool will be done using RSS when
928 * it is enabled or revert to the first queue of the pool if not.
930 * A default pool may be used, if desired, to route all traffic which
931 * does not match the vlan filter rules or any pool MAC address.
933 struct rte_eth_vmdq_rx_conf {
934 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq only mode, 8 or 64 pools */
935 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
936 uint8_t default_pool; /**< The default pool, if applicable */
937 uint8_t enable_loop_back; /**< Enable VT loop back */
938 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
939 uint32_t rx_mode; /**< Flags from ETH_VMDQ_ACCEPT_* */
941 uint16_t vlan_id; /**< The vlan id of the received frame */
942 uint64_t pools; /**< Bitmask of pools for packet rx */
943 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
947 * A structure used to configure the TX features of an Ethernet port.
949 struct rte_eth_txmode {
950 enum rte_eth_tx_mq_mode mq_mode; /**< TX multi-queues mode. */
952 * Per-port Tx offloads to be set using DEV_TX_OFFLOAD_* flags.
953 * Only offloads set on tx_offload_capa field on rte_eth_dev_info
954 * structure are allowed to be set.
960 uint8_t hw_vlan_reject_tagged : 1,
961 /**< If set, reject sending out tagged pkts */
962 hw_vlan_reject_untagged : 1,
963 /**< If set, reject sending out untagged pkts */
964 hw_vlan_insert_pvid : 1;
965 /**< If set, enable port based VLAN insertion */
967 uint64_t reserved_64s[2]; /**< Reserved for future fields */
968 void *reserved_ptrs[2]; /**< Reserved for future fields */
972 * A structure used to configure an RX ring of an Ethernet port.
974 struct rte_eth_rxconf {
975 struct rte_eth_thresh rx_thresh; /**< RX ring threshold registers. */
976 uint16_t rx_free_thresh; /**< Drives the freeing of RX descriptors. */
977 uint8_t rx_drop_en; /**< Drop packets if no descriptors are available. */
978 uint8_t rx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
980 * Per-queue Rx offloads to be set using DEV_RX_OFFLOAD_* flags.
981 * Only offloads set on rx_queue_offload_capa or rx_offload_capa
982 * fields on rte_eth_dev_info structure are allowed to be set.
986 uint64_t reserved_64s[2]; /**< Reserved for future fields */
987 void *reserved_ptrs[2]; /**< Reserved for future fields */
991 * A structure used to configure a TX ring of an Ethernet port.
993 struct rte_eth_txconf {
994 struct rte_eth_thresh tx_thresh; /**< TX ring threshold registers. */
995 uint16_t tx_rs_thresh; /**< Drives the setting of RS bit on TXDs. */
996 uint16_t tx_free_thresh; /**< Start freeing TX buffers if there are
997 less free descriptors than this value. */
999 uint8_t tx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
1001 * Per-queue Tx offloads to be set using DEV_TX_OFFLOAD_* flags.
1002 * Only offloads set on tx_queue_offload_capa or tx_offload_capa
1003 * fields on rte_eth_dev_info structure are allowed to be set.
1007 uint64_t reserved_64s[2]; /**< Reserved for future fields */
1008 void *reserved_ptrs[2]; /**< Reserved for future fields */
1013 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
1015 * A structure used to return the hairpin capabilities that are supported.
1017 struct rte_eth_hairpin_cap {
1018 /** The max number of hairpin queues (different bindings). */
1019 uint16_t max_nb_queues;
1020 /** Max number of Rx queues to be connected to one Tx queue. */
1021 uint16_t max_rx_2_tx;
1022 /** Max number of Tx queues to be connected to one Rx queue. */
1023 uint16_t max_tx_2_rx;
1024 uint16_t max_nb_desc; /**< The max num of descriptors. */
1027 #define RTE_ETH_MAX_HAIRPIN_PEERS 32
1031 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
1033 * A structure used to hold hairpin peer data.
1035 struct rte_eth_hairpin_peer {
1036 uint16_t port; /**< Peer port. */
1037 uint16_t queue; /**< Peer queue. */
1042 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
1044 * A structure used to configure hairpin binding.
1046 struct rte_eth_hairpin_conf {
1047 uint16_t peer_count; /**< The number of peers. */
1048 struct rte_eth_hairpin_peer peers[RTE_ETH_MAX_HAIRPIN_PEERS];
1052 * A structure contains information about HW descriptor ring limitations.
1054 struct rte_eth_desc_lim {
1055 uint16_t nb_max; /**< Max allowed number of descriptors. */
1056 uint16_t nb_min; /**< Min allowed number of descriptors. */
1057 uint16_t nb_align; /**< Number of descriptors should be aligned to. */
1060 * Max allowed number of segments per whole packet.
1062 * - For TSO packet this is the total number of data descriptors allowed
1065 * @see nb_mtu_seg_max
1067 uint16_t nb_seg_max;
1070 * Max number of segments per one MTU.
1072 * - For non-TSO packet, this is the maximum allowed number of segments
1073 * in a single transmit packet.
1075 * - For TSO packet each segment within the TSO may span up to this
1080 uint16_t nb_mtu_seg_max;
1084 * This enum indicates the flow control mode
1086 enum rte_eth_fc_mode {
1087 RTE_FC_NONE = 0, /**< Disable flow control. */
1088 RTE_FC_RX_PAUSE, /**< RX pause frame, enable flowctrl on TX side. */
1089 RTE_FC_TX_PAUSE, /**< TX pause frame, enable flowctrl on RX side. */
1090 RTE_FC_FULL /**< Enable flow control on both side. */
1094 * A structure used to configure Ethernet flow control parameter.
1095 * These parameters will be configured into the register of the NIC.
1096 * Please refer to the corresponding data sheet for proper value.
1098 struct rte_eth_fc_conf {
1099 uint32_t high_water; /**< High threshold value to trigger XOFF */
1100 uint32_t low_water; /**< Low threshold value to trigger XON */
1101 uint16_t pause_time; /**< Pause quota in the Pause frame */
1102 uint16_t send_xon; /**< Is XON frame need be sent */
1103 enum rte_eth_fc_mode mode; /**< Link flow control mode */
1104 uint8_t mac_ctrl_frame_fwd; /**< Forward MAC control frames */
1105 uint8_t autoneg; /**< Use Pause autoneg */
1109 * A structure used to configure Ethernet priority flow control parameter.
1110 * These parameters will be configured into the register of the NIC.
1111 * Please refer to the corresponding data sheet for proper value.
1113 struct rte_eth_pfc_conf {
1114 struct rte_eth_fc_conf fc; /**< General flow control parameter. */
1115 uint8_t priority; /**< VLAN User Priority. */
1121 enum rte_eth_tunnel_type {
1122 RTE_TUNNEL_TYPE_NONE = 0,
1123 RTE_TUNNEL_TYPE_VXLAN,
1124 RTE_TUNNEL_TYPE_GENEVE,
1125 RTE_TUNNEL_TYPE_TEREDO,
1126 RTE_TUNNEL_TYPE_NVGRE,
1127 RTE_TUNNEL_TYPE_IP_IN_GRE,
1128 RTE_L2_TUNNEL_TYPE_E_TAG,
1129 RTE_TUNNEL_TYPE_VXLAN_GPE,
1130 RTE_TUNNEL_TYPE_MAX,
1133 /* Deprecated API file for rte_eth_dev_filter_* functions */
1134 #include "rte_eth_ctrl.h"
1137 * Memory space that can be configured to store Flow Director filters
1138 * in the board memory.
1140 enum rte_fdir_pballoc_type {
1141 RTE_FDIR_PBALLOC_64K = 0, /**< 64k. */
1142 RTE_FDIR_PBALLOC_128K, /**< 128k. */
1143 RTE_FDIR_PBALLOC_256K, /**< 256k. */
1147 * Select report mode of FDIR hash information in RX descriptors.
1149 enum rte_fdir_status_mode {
1150 RTE_FDIR_NO_REPORT_STATUS = 0, /**< Never report FDIR hash. */
1151 RTE_FDIR_REPORT_STATUS, /**< Only report FDIR hash for matching pkts. */
1152 RTE_FDIR_REPORT_STATUS_ALWAYS, /**< Always report FDIR hash. */
1156 * A structure used to configure the Flow Director (FDIR) feature
1157 * of an Ethernet port.
1159 * If mode is RTE_FDIR_MODE_NONE, the pballoc value is ignored.
1161 struct rte_fdir_conf {
1162 enum rte_fdir_mode mode; /**< Flow Director mode. */
1163 enum rte_fdir_pballoc_type pballoc; /**< Space for FDIR filters. */
1164 enum rte_fdir_status_mode status; /**< How to report FDIR hash. */
1165 /** RX queue of packets matching a "drop" filter in perfect mode. */
1167 struct rte_eth_fdir_masks mask;
1168 struct rte_eth_fdir_flex_conf flex_conf;
1169 /**< Flex payload configuration. */
1173 * UDP tunneling configuration.
1174 * Used to config the UDP port for a type of tunnel.
1175 * NICs need the UDP port to identify the tunnel type.
1176 * Normally a type of tunnel has a default UDP port, this structure can be used
1177 * in case if the users want to change or support more UDP port.
1179 struct rte_eth_udp_tunnel {
1180 uint16_t udp_port; /**< UDP port used for the tunnel. */
1181 uint8_t prot_type; /**< Tunnel type. Defined in rte_eth_tunnel_type. */
1185 * A structure used to enable/disable specific device interrupts.
1187 struct rte_intr_conf {
1188 /** enable/disable lsc interrupt. 0 (default) - disable, 1 enable */
1190 /** enable/disable rxq interrupt. 0 (default) - disable, 1 enable */
1192 /** enable/disable rmv interrupt. 0 (default) - disable, 1 enable */
1197 * A structure used to configure an Ethernet port.
1198 * Depending upon the RX multi-queue mode, extra advanced
1199 * configuration settings may be needed.
1201 struct rte_eth_conf {
1202 uint32_t link_speeds; /**< bitmap of ETH_LINK_SPEED_XXX of speeds to be
1203 used. ETH_LINK_SPEED_FIXED disables link
1204 autonegotiation, and a unique speed shall be
1205 set. Otherwise, the bitmap defines the set of
1206 speeds to be advertised. If the special value
1207 ETH_LINK_SPEED_AUTONEG (0) is used, all speeds
1208 supported are advertised. */
1209 struct rte_eth_rxmode rxmode; /**< Port RX configuration. */
1210 struct rte_eth_txmode txmode; /**< Port TX configuration. */
1211 uint32_t lpbk_mode; /**< Loopback operation mode. By default the value
1212 is 0, meaning the loopback mode is disabled.
1213 Read the datasheet of given ethernet controller
1214 for details. The possible values of this field
1215 are defined in implementation of each driver. */
1217 struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
1218 struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
1219 /**< Port vmdq+dcb configuration. */
1220 struct rte_eth_dcb_rx_conf dcb_rx_conf;
1221 /**< Port dcb RX configuration. */
1222 struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
1223 /**< Port vmdq RX configuration. */
1224 } rx_adv_conf; /**< Port RX filtering configuration. */
1226 struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
1227 /**< Port vmdq+dcb TX configuration. */
1228 struct rte_eth_dcb_tx_conf dcb_tx_conf;
1229 /**< Port dcb TX configuration. */
1230 struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
1231 /**< Port vmdq TX configuration. */
1232 } tx_adv_conf; /**< Port TX DCB configuration (union). */
1233 /** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
1234 is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
1235 uint32_t dcb_capability_en;
1236 struct rte_fdir_conf fdir_conf; /**< FDIR configuration. DEPRECATED */
1237 struct rte_intr_conf intr_conf; /**< Interrupt mode configuration. */
1241 * RX offload capabilities of a device.
1243 #define DEV_RX_OFFLOAD_VLAN_STRIP 0x00000001
1244 #define DEV_RX_OFFLOAD_IPV4_CKSUM 0x00000002
1245 #define DEV_RX_OFFLOAD_UDP_CKSUM 0x00000004
1246 #define DEV_RX_OFFLOAD_TCP_CKSUM 0x00000008
1247 #define DEV_RX_OFFLOAD_TCP_LRO 0x00000010
1248 #define DEV_RX_OFFLOAD_QINQ_STRIP 0x00000020
1249 #define DEV_RX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000040
1250 #define DEV_RX_OFFLOAD_MACSEC_STRIP 0x00000080
1251 #define DEV_RX_OFFLOAD_HEADER_SPLIT 0x00000100
1252 #define DEV_RX_OFFLOAD_VLAN_FILTER 0x00000200
1253 #define DEV_RX_OFFLOAD_VLAN_EXTEND 0x00000400
1254 #define DEV_RX_OFFLOAD_JUMBO_FRAME 0x00000800
1255 #define DEV_RX_OFFLOAD_SCATTER 0x00002000
1256 #define DEV_RX_OFFLOAD_TIMESTAMP 0x00004000
1257 #define DEV_RX_OFFLOAD_SECURITY 0x00008000
1258 #define DEV_RX_OFFLOAD_KEEP_CRC 0x00010000
1259 #define DEV_RX_OFFLOAD_SCTP_CKSUM 0x00020000
1260 #define DEV_RX_OFFLOAD_OUTER_UDP_CKSUM 0x00040000
1261 #define DEV_RX_OFFLOAD_RSS_HASH 0x00080000
1263 #define DEV_RX_OFFLOAD_CHECKSUM (DEV_RX_OFFLOAD_IPV4_CKSUM | \
1264 DEV_RX_OFFLOAD_UDP_CKSUM | \
1265 DEV_RX_OFFLOAD_TCP_CKSUM)
1266 #define DEV_RX_OFFLOAD_VLAN (DEV_RX_OFFLOAD_VLAN_STRIP | \
1267 DEV_RX_OFFLOAD_VLAN_FILTER | \
1268 DEV_RX_OFFLOAD_VLAN_EXTEND | \
1269 DEV_RX_OFFLOAD_QINQ_STRIP)
1272 * If new Rx offload capabilities are defined, they also must be
1273 * mentioned in rte_rx_offload_names in rte_ethdev.c file.
1277 * TX offload capabilities of a device.
1279 #define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001
1280 #define DEV_TX_OFFLOAD_IPV4_CKSUM 0x00000002
1281 #define DEV_TX_OFFLOAD_UDP_CKSUM 0x00000004
1282 #define DEV_TX_OFFLOAD_TCP_CKSUM 0x00000008
1283 #define DEV_TX_OFFLOAD_SCTP_CKSUM 0x00000010
1284 #define DEV_TX_OFFLOAD_TCP_TSO 0x00000020
1285 #define DEV_TX_OFFLOAD_UDP_TSO 0x00000040
1286 #define DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000080 /**< Used for tunneling packet. */
1287 #define DEV_TX_OFFLOAD_QINQ_INSERT 0x00000100
1288 #define DEV_TX_OFFLOAD_VXLAN_TNL_TSO 0x00000200 /**< Used for tunneling packet. */
1289 #define DEV_TX_OFFLOAD_GRE_TNL_TSO 0x00000400 /**< Used for tunneling packet. */
1290 #define DEV_TX_OFFLOAD_IPIP_TNL_TSO 0x00000800 /**< Used for tunneling packet. */
1291 #define DEV_TX_OFFLOAD_GENEVE_TNL_TSO 0x00001000 /**< Used for tunneling packet. */
1292 #define DEV_TX_OFFLOAD_MACSEC_INSERT 0x00002000
1293 #define DEV_TX_OFFLOAD_MT_LOCKFREE 0x00004000
1294 /**< Multiple threads can invoke rte_eth_tx_burst() concurrently on the same
1295 * tx queue without SW lock.
1297 #define DEV_TX_OFFLOAD_MULTI_SEGS 0x00008000
1298 /**< Device supports multi segment send. */
1299 #define DEV_TX_OFFLOAD_MBUF_FAST_FREE 0x00010000
1300 /**< Device supports optimization for fast release of mbufs.
1301 * When set application must guarantee that per-queue all mbufs comes from
1302 * the same mempool and has refcnt = 1.
1304 #define DEV_TX_OFFLOAD_SECURITY 0x00020000
1306 * Device supports generic UDP tunneled packet TSO.
1307 * Application must set PKT_TX_TUNNEL_UDP and other mbuf fields required
1310 #define DEV_TX_OFFLOAD_UDP_TNL_TSO 0x00040000
1312 * Device supports generic IP tunneled packet TSO.
1313 * Application must set PKT_TX_TUNNEL_IP and other mbuf fields required
1316 #define DEV_TX_OFFLOAD_IP_TNL_TSO 0x00080000
1317 /** Device supports outer UDP checksum */
1318 #define DEV_TX_OFFLOAD_OUTER_UDP_CKSUM 0x00100000
1320 /** Device supports send on timestamp */
1321 #define DEV_TX_OFFLOAD_SEND_ON_TIMESTAMP 0x00200000
1324 #define RTE_ETH_DEV_CAPA_RUNTIME_RX_QUEUE_SETUP 0x00000001
1325 /**< Device supports Rx queue setup after device started*/
1326 #define RTE_ETH_DEV_CAPA_RUNTIME_TX_QUEUE_SETUP 0x00000002
1327 /**< Device supports Tx queue setup after device started*/
1330 * If new Tx offload capabilities are defined, they also must be
1331 * mentioned in rte_tx_offload_names in rte_ethdev.c file.
1335 * Fallback default preferred Rx/Tx port parameters.
1336 * These are used if an application requests default parameters
1337 * but the PMD does not provide preferred values.
1339 #define RTE_ETH_DEV_FALLBACK_RX_RINGSIZE 512
1340 #define RTE_ETH_DEV_FALLBACK_TX_RINGSIZE 512
1341 #define RTE_ETH_DEV_FALLBACK_RX_NBQUEUES 1
1342 #define RTE_ETH_DEV_FALLBACK_TX_NBQUEUES 1
1345 * Preferred Rx/Tx port parameters.
1346 * There are separate instances of this structure for transmission
1347 * and reception respectively.
1349 struct rte_eth_dev_portconf {
1350 uint16_t burst_size; /**< Device-preferred burst size */
1351 uint16_t ring_size; /**< Device-preferred size of queue rings */
1352 uint16_t nb_queues; /**< Device-preferred number of queues */
1356 * Default values for switch domain id when ethdev does not support switch
1357 * domain definitions.
1359 #define RTE_ETH_DEV_SWITCH_DOMAIN_ID_INVALID (UINT16_MAX)
1362 * Ethernet device associated switch information
1364 struct rte_eth_switch_info {
1365 const char *name; /**< switch name */
1366 uint16_t domain_id; /**< switch domain id */
1369 * mapping to the devices physical switch port as enumerated from the
1370 * perspective of the embedded interconnect/switch. For SR-IOV enabled
1371 * device this may correspond to the VF_ID of each virtual function,
1372 * but each driver should explicitly define the mapping of switch
1373 * port identifier to that physical interconnect/switch
1378 * Ethernet device information
1382 * A structure used to retrieve the contextual information of
1383 * an Ethernet device, such as the controlling driver of the
1386 struct rte_eth_dev_info {
1387 struct rte_device *device; /** Generic device information */
1388 const char *driver_name; /**< Device Driver name. */
1389 unsigned int if_index; /**< Index to bound host interface, or 0 if none.
1390 Use if_indextoname() to translate into an interface name. */
1391 uint16_t min_mtu; /**< Minimum MTU allowed */
1392 uint16_t max_mtu; /**< Maximum MTU allowed */
1393 const uint32_t *dev_flags; /**< Device flags */
1394 uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
1395 uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
1396 /** Maximum configurable size of LRO aggregated packet. */
1397 uint32_t max_lro_pkt_size;
1398 uint16_t max_rx_queues; /**< Maximum number of RX queues. */
1399 uint16_t max_tx_queues; /**< Maximum number of TX queues. */
1400 uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
1401 uint32_t max_hash_mac_addrs;
1402 /** Maximum number of hash MAC addresses for MTA and UTA. */
1403 uint16_t max_vfs; /**< Maximum number of VFs. */
1404 uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
1405 uint64_t rx_offload_capa;
1406 /**< All RX offload capabilities including all per-queue ones */
1407 uint64_t tx_offload_capa;
1408 /**< All TX offload capabilities including all per-queue ones */
1409 uint64_t rx_queue_offload_capa;
1410 /**< Device per-queue RX offload capabilities. */
1411 uint64_t tx_queue_offload_capa;
1412 /**< Device per-queue TX offload capabilities. */
1414 /**< Device redirection table size, the total number of entries. */
1415 uint8_t hash_key_size; /**< Hash key size in bytes */
1416 /** Bit mask of RSS offloads, the bit offset also means flow type */
1417 uint64_t flow_type_rss_offloads;
1418 struct rte_eth_rxconf default_rxconf; /**< Default RX configuration */
1419 struct rte_eth_txconf default_txconf; /**< Default TX configuration */
1420 uint16_t vmdq_queue_base; /**< First queue ID for VMDQ pools. */
1421 uint16_t vmdq_queue_num; /**< Queue number for VMDQ pools. */
1422 uint16_t vmdq_pool_base; /**< First ID of VMDQ pools. */
1423 struct rte_eth_desc_lim rx_desc_lim; /**< RX descriptors limits */
1424 struct rte_eth_desc_lim tx_desc_lim; /**< TX descriptors limits */
1425 uint32_t speed_capa; /**< Supported speeds bitmap (ETH_LINK_SPEED_). */
1426 /** Configured number of rx/tx queues */
1427 uint16_t nb_rx_queues; /**< Number of RX queues. */
1428 uint16_t nb_tx_queues; /**< Number of TX queues. */
1429 /** Rx parameter recommendations */
1430 struct rte_eth_dev_portconf default_rxportconf;
1431 /** Tx parameter recommendations */
1432 struct rte_eth_dev_portconf default_txportconf;
1433 /** Generic device capabilities (RTE_ETH_DEV_CAPA_). */
1436 * Switching information for ports on a device with a
1437 * embedded managed interconnect/switch.
1439 struct rte_eth_switch_info switch_info;
1441 uint64_t reserved_64s[2]; /**< Reserved for future fields */
1442 void *reserved_ptrs[2]; /**< Reserved for future fields */
1446 * Ethernet device RX queue information structure.
1447 * Used to retrieve information about configured queue.
1449 struct rte_eth_rxq_info {
1450 struct rte_mempool *mp; /**< mempool used by that queue. */
1451 struct rte_eth_rxconf conf; /**< queue config parameters. */
1452 uint8_t scattered_rx; /**< scattered packets RX supported. */
1453 uint16_t nb_desc; /**< configured number of RXDs. */
1454 } __rte_cache_min_aligned;
1457 * Ethernet device TX queue information structure.
1458 * Used to retrieve information about configured queue.
1460 struct rte_eth_txq_info {
1461 struct rte_eth_txconf conf; /**< queue config parameters. */
1462 uint16_t nb_desc; /**< configured number of TXDs. */
1463 } __rte_cache_min_aligned;
1465 /* Generic Burst mode flag definition, values can be ORed. */
1468 * If the queues have different burst mode description, this bit will be set
1469 * by PMD, then the application can iterate to retrieve burst description for
1472 #define RTE_ETH_BURST_FLAG_PER_QUEUE (1ULL << 0)
1475 * Ethernet device RX/TX queue packet burst mode information structure.
1476 * Used to retrieve information about packet burst mode setting.
1478 struct rte_eth_burst_mode {
1479 uint64_t flags; /**< The ORed values of RTE_ETH_BURST_FLAG_xxx */
1481 #define RTE_ETH_BURST_MODE_INFO_SIZE 1024 /**< Maximum size for information */
1482 char info[RTE_ETH_BURST_MODE_INFO_SIZE]; /**< burst mode information */
1485 /** Maximum name length for extended statistics counters */
1486 #define RTE_ETH_XSTATS_NAME_SIZE 64
1489 * An Ethernet device extended statistic structure
1491 * This structure is used by rte_eth_xstats_get() to provide
1492 * statistics that are not provided in the generic *rte_eth_stats*
1494 * It maps a name id, corresponding to an index in the array returned
1495 * by rte_eth_xstats_get_names(), to a statistic value.
1497 struct rte_eth_xstat {
1498 uint64_t id; /**< The index in xstats name array. */
1499 uint64_t value; /**< The statistic counter value. */
1503 * A name element for extended statistics.
1505 * An array of this structure is returned by rte_eth_xstats_get_names().
1506 * It lists the names of extended statistics for a PMD. The *rte_eth_xstat*
1507 * structure references these names by their array index.
1509 struct rte_eth_xstat_name {
1510 char name[RTE_ETH_XSTATS_NAME_SIZE]; /**< The statistic name. */
1513 #define ETH_DCB_NUM_TCS 8
1514 #define ETH_MAX_VMDQ_POOL 64
1517 * A structure used to get the information of queue and
1518 * TC mapping on both TX and RX paths.
1520 struct rte_eth_dcb_tc_queue_mapping {
1521 /** rx queues assigned to tc per Pool */
1525 } tc_rxq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
1526 /** rx queues assigned to tc per Pool */
1530 } tc_txq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
1534 * A structure used to get the information of DCB.
1535 * It includes TC UP mapping and queue TC mapping.
1537 struct rte_eth_dcb_info {
1538 uint8_t nb_tcs; /**< number of TCs */
1539 uint8_t prio_tc[ETH_DCB_NUM_USER_PRIORITIES]; /**< Priority to tc */
1540 uint8_t tc_bws[ETH_DCB_NUM_TCS]; /**< TX BW percentage for each TC */
1541 /** rx queues assigned to tc */
1542 struct rte_eth_dcb_tc_queue_mapping tc_queue;
1545 #define RTE_ETH_ALL RTE_MAX_ETHPORTS
1547 /* Macros to check for valid port */
1548 #define RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, retval) do { \
1549 if (!rte_eth_dev_is_valid_port(port_id)) { \
1550 RTE_ETHDEV_LOG(ERR, "Invalid port_id=%u\n", port_id); \
1555 #define RTE_ETH_VALID_PORTID_OR_RET(port_id) do { \
1556 if (!rte_eth_dev_is_valid_port(port_id)) { \
1557 RTE_ETHDEV_LOG(ERR, "Invalid port_id=%u\n", port_id); \
1563 * l2 tunnel configuration.
1566 /**< l2 tunnel enable mask */
1567 #define ETH_L2_TUNNEL_ENABLE_MASK 0x00000001
1568 /**< l2 tunnel insertion mask */
1569 #define ETH_L2_TUNNEL_INSERTION_MASK 0x00000002
1570 /**< l2 tunnel stripping mask */
1571 #define ETH_L2_TUNNEL_STRIPPING_MASK 0x00000004
1572 /**< l2 tunnel forwarding mask */
1573 #define ETH_L2_TUNNEL_FORWARDING_MASK 0x00000008
1576 * Function type used for RX packet processing packet callbacks.
1578 * The callback function is called on RX with a burst of packets that have
1579 * been received on the given port and queue.
1582 * The Ethernet port on which RX is being performed.
1584 * The queue on the Ethernet port which is being used to receive the packets.
1586 * The burst of packets that have just been received.
1588 * The number of packets in the burst pointed to by "pkts".
1590 * The max number of packets that can be stored in the "pkts" array.
1592 * The arbitrary user parameter passed in by the application when the callback
1593 * was originally configured.
1595 * The number of packets returned to the user.
1597 typedef uint16_t (*rte_rx_callback_fn)(uint16_t port_id, uint16_t queue,
1598 struct rte_mbuf *pkts[], uint16_t nb_pkts, uint16_t max_pkts,
1602 * Function type used for TX packet processing packet callbacks.
1604 * The callback function is called on TX with a burst of packets immediately
1605 * before the packets are put onto the hardware queue for transmission.
1608 * The Ethernet port on which TX is being performed.
1610 * The queue on the Ethernet port which is being used to transmit the packets.
1612 * The burst of packets that are about to be transmitted.
1614 * The number of packets in the burst pointed to by "pkts".
1616 * The arbitrary user parameter passed in by the application when the callback
1617 * was originally configured.
1619 * The number of packets to be written to the NIC.
1621 typedef uint16_t (*rte_tx_callback_fn)(uint16_t port_id, uint16_t queue,
1622 struct rte_mbuf *pkts[], uint16_t nb_pkts, void *user_param);
1625 * Possible states of an ethdev port.
1627 enum rte_eth_dev_state {
1628 /** Device is unused before being probed. */
1629 RTE_ETH_DEV_UNUSED = 0,
1630 /** Device is attached when allocated in probing. */
1631 RTE_ETH_DEV_ATTACHED,
1632 /** Device is in removed state when plug-out is detected. */
1633 RTE_ETH_DEV_REMOVED,
1636 struct rte_eth_dev_sriov {
1637 uint8_t active; /**< SRIOV is active with 16, 32 or 64 pools */
1638 uint8_t nb_q_per_pool; /**< rx queue number per pool */
1639 uint16_t def_vmdq_idx; /**< Default pool num used for PF */
1640 uint16_t def_pool_q_idx; /**< Default pool queue start reg index */
1642 #define RTE_ETH_DEV_SRIOV(dev) ((dev)->data->sriov)
1644 #define RTE_ETH_NAME_MAX_LEN RTE_DEV_NAME_MAX_LEN
1646 #define RTE_ETH_DEV_NO_OWNER 0
1648 #define RTE_ETH_MAX_OWNER_NAME_LEN 64
1650 struct rte_eth_dev_owner {
1651 uint64_t id; /**< The owner unique identifier. */
1652 char name[RTE_ETH_MAX_OWNER_NAME_LEN]; /**< The owner name. */
1656 * Port is released (i.e. totally freed and data erased) on close.
1657 * Temporary flag for PMD migration to new rte_eth_dev_close() behaviour.
1659 #define RTE_ETH_DEV_CLOSE_REMOVE 0x0001
1660 /** Device supports link state interrupt */
1661 #define RTE_ETH_DEV_INTR_LSC 0x0002
1662 /** Device is a bonded slave */
1663 #define RTE_ETH_DEV_BONDED_SLAVE 0x0004
1664 /** Device supports device removal interrupt */
1665 #define RTE_ETH_DEV_INTR_RMV 0x0008
1666 /** Device is port representor */
1667 #define RTE_ETH_DEV_REPRESENTOR 0x0010
1668 /** Device does not support MAC change after started */
1669 #define RTE_ETH_DEV_NOLIVE_MAC_ADDR 0x0020
1672 * Iterates over valid ethdev ports owned by a specific owner.
1675 * The id of the next possible valid owned port.
1677 * The owner identifier.
1678 * RTE_ETH_DEV_NO_OWNER means iterate over all valid ownerless ports.
1680 * Next valid port id owned by owner_id, RTE_MAX_ETHPORTS if there is none.
1682 uint64_t rte_eth_find_next_owned_by(uint16_t port_id,
1683 const uint64_t owner_id);
1686 * Macro to iterate over all enabled ethdev ports owned by a specific owner.
1688 #define RTE_ETH_FOREACH_DEV_OWNED_BY(p, o) \
1689 for (p = rte_eth_find_next_owned_by(0, o); \
1690 (unsigned int)p < (unsigned int)RTE_MAX_ETHPORTS; \
1691 p = rte_eth_find_next_owned_by(p + 1, o))
1694 * Iterates over valid ethdev ports.
1697 * The id of the next possible valid port.
1699 * Next valid port id, RTE_MAX_ETHPORTS if there is none.
1701 uint16_t rte_eth_find_next(uint16_t port_id);
1704 * Macro to iterate over all enabled and ownerless ethdev ports.
1706 #define RTE_ETH_FOREACH_DEV(p) \
1707 RTE_ETH_FOREACH_DEV_OWNED_BY(p, RTE_ETH_DEV_NO_OWNER)
1711 * @b EXPERIMENTAL: this API may change without prior notice.
1713 * Iterates over ethdev ports of a specified device.
1715 * @param port_id_start
1716 * The id of the next possible valid port.
1718 * The generic device behind the ports to iterate.
1720 * Next port id of the device, possibly port_id_start,
1721 * RTE_MAX_ETHPORTS if there is none.
1725 rte_eth_find_next_of(uint16_t port_id_start,
1726 const struct rte_device *parent);
1729 * Macro to iterate over all ethdev ports of a specified device.
1732 * The id of the matching port being iterated.
1734 * The rte_device pointer matching the iterated ports.
1736 #define RTE_ETH_FOREACH_DEV_OF(port_id, parent) \
1737 for (port_id = rte_eth_find_next_of(0, parent); \
1738 port_id < RTE_MAX_ETHPORTS; \
1739 port_id = rte_eth_find_next_of(port_id + 1, parent))
1743 * @b EXPERIMENTAL: this API may change without prior notice.
1745 * Iterates over sibling ethdev ports (i.e. sharing the same rte_device).
1747 * @param port_id_start
1748 * The id of the next possible valid sibling port.
1749 * @param ref_port_id
1750 * The id of a reference port to compare rte_device with.
1752 * Next sibling port id, possibly port_id_start or ref_port_id itself,
1753 * RTE_MAX_ETHPORTS if there is none.
1757 rte_eth_find_next_sibling(uint16_t port_id_start, uint16_t ref_port_id);
1760 * Macro to iterate over all ethdev ports sharing the same rte_device
1761 * as the specified port.
1762 * Note: the specified reference port is part of the loop iterations.
1765 * The id of the matching port being iterated.
1766 * @param ref_port_id
1767 * The id of the port being compared.
1769 #define RTE_ETH_FOREACH_DEV_SIBLING(port_id, ref_port_id) \
1770 for (port_id = rte_eth_find_next_sibling(0, ref_port_id); \
1771 port_id < RTE_MAX_ETHPORTS; \
1772 port_id = rte_eth_find_next_sibling(port_id + 1, ref_port_id))
1776 * @b EXPERIMENTAL: this API may change without prior notice.
1778 * Get a new unique owner identifier.
1779 * An owner identifier is used to owns Ethernet devices by only one DPDK entity
1780 * to avoid multiple management of device by different entities.
1783 * Owner identifier pointer.
1785 * Negative errno value on error, 0 on success.
1788 int rte_eth_dev_owner_new(uint64_t *owner_id);
1792 * @b EXPERIMENTAL: this API may change without prior notice.
1794 * Set an Ethernet device owner.
1797 * The identifier of the port to own.
1799 * The owner pointer.
1801 * Negative errno value on error, 0 on success.
1804 int rte_eth_dev_owner_set(const uint16_t port_id,
1805 const struct rte_eth_dev_owner *owner);
1809 * @b EXPERIMENTAL: this API may change without prior notice.
1811 * Unset Ethernet device owner to make the device ownerless.
1814 * The identifier of port to make ownerless.
1816 * The owner identifier.
1818 * 0 on success, negative errno value on error.
1821 int rte_eth_dev_owner_unset(const uint16_t port_id,
1822 const uint64_t owner_id);
1826 * @b EXPERIMENTAL: this API may change without prior notice.
1828 * Remove owner from all Ethernet devices owned by a specific owner.
1831 * The owner identifier.
1833 * 0 on success, negative errno value on error.
1836 int rte_eth_dev_owner_delete(const uint64_t owner_id);
1840 * @b EXPERIMENTAL: this API may change without prior notice.
1842 * Get the owner of an Ethernet device.
1845 * The port identifier.
1847 * The owner structure pointer to fill.
1849 * 0 on success, negative errno value on error..
1852 int rte_eth_dev_owner_get(const uint16_t port_id,
1853 struct rte_eth_dev_owner *owner);
1856 * Get the number of ports which are usable for the application.
1858 * These devices must be iterated by using the macro
1859 * ``RTE_ETH_FOREACH_DEV`` or ``RTE_ETH_FOREACH_DEV_OWNED_BY``
1860 * to deal with non-contiguous ranges of devices.
1863 * The count of available Ethernet devices.
1865 uint16_t rte_eth_dev_count_avail(void);
1868 * Get the total number of ports which are allocated.
1870 * Some devices may not be available for the application.
1873 * The total count of Ethernet devices.
1875 uint16_t rte_eth_dev_count_total(void);
1878 * Convert a numerical speed in Mbps to a bitmap flag that can be used in
1879 * the bitmap link_speeds of the struct rte_eth_conf
1882 * Numerical speed value in Mbps
1884 * ETH_LINK_[HALF/FULL]_DUPLEX (only for 10/100M speeds)
1886 * 0 if the speed cannot be mapped
1888 uint32_t rte_eth_speed_bitflag(uint32_t speed, int duplex);
1891 * Get DEV_RX_OFFLOAD_* flag name.
1896 * Offload name or 'UNKNOWN' if the flag cannot be recognised.
1898 const char *rte_eth_dev_rx_offload_name(uint64_t offload);
1901 * Get DEV_TX_OFFLOAD_* flag name.
1906 * Offload name or 'UNKNOWN' if the flag cannot be recognised.
1908 const char *rte_eth_dev_tx_offload_name(uint64_t offload);
1911 * Configure an Ethernet device.
1912 * This function must be invoked first before any other function in the
1913 * Ethernet API. This function can also be re-invoked when a device is in the
1917 * The port identifier of the Ethernet device to configure.
1918 * @param nb_rx_queue
1919 * The number of receive queues to set up for the Ethernet device.
1920 * @param nb_tx_queue
1921 * The number of transmit queues to set up for the Ethernet device.
1923 * The pointer to the configuration data to be used for the Ethernet device.
1924 * The *rte_eth_conf* structure includes:
1925 * - the hardware offload features to activate, with dedicated fields for
1926 * each statically configurable offload hardware feature provided by
1927 * Ethernet devices, such as IP checksum or VLAN tag stripping for
1929 * The Rx offload bitfield API is obsolete and will be deprecated.
1930 * Applications should set the ignore_bitfield_offloads bit on *rxmode*
1931 * structure and use offloads field to set per-port offloads instead.
1932 * - Any offloading set in eth_conf->[rt]xmode.offloads must be within
1933 * the [rt]x_offload_capa returned from rte_eth_dev_info_get().
1934 * Any type of device supported offloading set in the input argument
1935 * eth_conf->[rt]xmode.offloads to rte_eth_dev_configure() is enabled
1936 * on all queues and it can't be disabled in rte_eth_[rt]x_queue_setup()
1937 * - the Receive Side Scaling (RSS) configuration when using multiple RX
1938 * queues per port. Any RSS hash function set in eth_conf->rss_conf.rss_hf
1939 * must be within the flow_type_rss_offloads provided by drivers via
1940 * rte_eth_dev_info_get() API.
1942 * Embedding all configuration information in a single data structure
1943 * is the more flexible method that allows the addition of new features
1944 * without changing the syntax of the API.
1946 * - 0: Success, device configured.
1947 * - <0: Error code returned by the driver configuration function.
1949 int rte_eth_dev_configure(uint16_t port_id, uint16_t nb_rx_queue,
1950 uint16_t nb_tx_queue, const struct rte_eth_conf *eth_conf);
1954 * @b EXPERIMENTAL: this API may change without prior notice.
1956 * Check if an Ethernet device was physically removed.
1959 * The port identifier of the Ethernet device.
1961 * 1 when the Ethernet device is removed, otherwise 0.
1965 rte_eth_dev_is_removed(uint16_t port_id);
1968 * Allocate and set up a receive queue for an Ethernet device.
1970 * The function allocates a contiguous block of memory for *nb_rx_desc*
1971 * receive descriptors from a memory zone associated with *socket_id*
1972 * and initializes each receive descriptor with a network buffer allocated
1973 * from the memory pool *mb_pool*.
1976 * The port identifier of the Ethernet device.
1977 * @param rx_queue_id
1978 * The index of the receive queue to set up.
1979 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1980 * to rte_eth_dev_configure().
1982 * The number of receive descriptors to allocate for the receive ring.
1984 * The *socket_id* argument is the socket identifier in case of NUMA.
1985 * The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1986 * the DMA memory allocated for the receive descriptors of the ring.
1988 * The pointer to the configuration data to be used for the receive queue.
1989 * NULL value is allowed, in which case default RX configuration
1991 * The *rx_conf* structure contains an *rx_thresh* structure with the values
1992 * of the Prefetch, Host, and Write-Back threshold registers of the receive
1994 * In addition it contains the hardware offloads features to activate using
1995 * the DEV_RX_OFFLOAD_* flags.
1996 * If an offloading set in rx_conf->offloads
1997 * hasn't been set in the input argument eth_conf->rxmode.offloads
1998 * to rte_eth_dev_configure(), it is a new added offloading, it must be
1999 * per-queue type and it is enabled for the queue.
2000 * No need to repeat any bit in rx_conf->offloads which has already been
2001 * enabled in rte_eth_dev_configure() at port level. An offloading enabled
2002 * at port level can't be disabled at queue level.
2004 * The pointer to the memory pool from which to allocate *rte_mbuf* network
2005 * memory buffers to populate each descriptor of the receive ring.
2007 * - 0: Success, receive queue correctly set up.
2008 * - -EIO: if device is removed.
2009 * - -EINVAL: The memory pool pointer is null or the size of network buffers
2010 * which can be allocated from this memory pool does not fit the various
2011 * buffer sizes allowed by the device controller.
2012 * - -ENOMEM: Unable to allocate the receive ring descriptors or to
2013 * allocate network memory buffers from the memory pool when
2014 * initializing receive descriptors.
2016 int rte_eth_rx_queue_setup(uint16_t port_id, uint16_t rx_queue_id,
2017 uint16_t nb_rx_desc, unsigned int socket_id,
2018 const struct rte_eth_rxconf *rx_conf,
2019 struct rte_mempool *mb_pool);
2023 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
2025 * Allocate and set up a hairpin receive queue for an Ethernet device.
2027 * The function set up the selected queue to be used in hairpin.
2030 * The port identifier of the Ethernet device.
2031 * @param rx_queue_id
2032 * The index of the receive queue to set up.
2033 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2034 * to rte_eth_dev_configure().
2036 * The number of receive descriptors to allocate for the receive ring.
2037 * 0 means the PMD will use default value.
2039 * The pointer to the hairpin configuration.
2042 * - (0) if successful.
2043 * - (-ENOTSUP) if hardware doesn't support.
2044 * - (-EINVAL) if bad parameter.
2045 * - (-ENOMEM) if unable to allocate the resources.
2048 int rte_eth_rx_hairpin_queue_setup
2049 (uint16_t port_id, uint16_t rx_queue_id, uint16_t nb_rx_desc,
2050 const struct rte_eth_hairpin_conf *conf);
2053 * Allocate and set up a transmit queue for an Ethernet device.
2056 * The port identifier of the Ethernet device.
2057 * @param tx_queue_id
2058 * The index of the transmit queue to set up.
2059 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2060 * to rte_eth_dev_configure().
2062 * The number of transmit descriptors to allocate for the transmit ring.
2064 * The *socket_id* argument is the socket identifier in case of NUMA.
2065 * Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
2066 * the DMA memory allocated for the transmit descriptors of the ring.
2068 * The pointer to the configuration data to be used for the transmit queue.
2069 * NULL value is allowed, in which case default TX configuration
2071 * The *tx_conf* structure contains the following data:
2072 * - The *tx_thresh* structure with the values of the Prefetch, Host, and
2073 * Write-Back threshold registers of the transmit ring.
2074 * When setting Write-Back threshold to the value greater then zero,
2075 * *tx_rs_thresh* value should be explicitly set to one.
2076 * - The *tx_free_thresh* value indicates the [minimum] number of network
2077 * buffers that must be pending in the transmit ring to trigger their
2078 * [implicit] freeing by the driver transmit function.
2079 * - The *tx_rs_thresh* value indicates the [minimum] number of transmit
2080 * descriptors that must be pending in the transmit ring before setting the
2081 * RS bit on a descriptor by the driver transmit function.
2082 * The *tx_rs_thresh* value should be less or equal then
2083 * *tx_free_thresh* value, and both of them should be less then
2085 * - The *offloads* member contains Tx offloads to be enabled.
2086 * If an offloading set in tx_conf->offloads
2087 * hasn't been set in the input argument eth_conf->txmode.offloads
2088 * to rte_eth_dev_configure(), it is a new added offloading, it must be
2089 * per-queue type and it is enabled for the queue.
2090 * No need to repeat any bit in tx_conf->offloads which has already been
2091 * enabled in rte_eth_dev_configure() at port level. An offloading enabled
2092 * at port level can't be disabled at queue level.
2094 * Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces
2095 * the transmit function to use default values.
2097 * - 0: Success, the transmit queue is correctly set up.
2098 * - -ENOMEM: Unable to allocate the transmit ring descriptors.
2100 int rte_eth_tx_queue_setup(uint16_t port_id, uint16_t tx_queue_id,
2101 uint16_t nb_tx_desc, unsigned int socket_id,
2102 const struct rte_eth_txconf *tx_conf);
2106 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
2108 * Allocate and set up a transmit hairpin queue for an Ethernet device.
2111 * The port identifier of the Ethernet device.
2112 * @param tx_queue_id
2113 * The index of the transmit queue to set up.
2114 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2115 * to rte_eth_dev_configure().
2117 * The number of transmit descriptors to allocate for the transmit ring.
2118 * 0 to set default PMD value.
2120 * The hairpin configuration.
2123 * - (0) if successful.
2124 * - (-ENOTSUP) if hardware doesn't support.
2125 * - (-EINVAL) if bad parameter.
2126 * - (-ENOMEM) if unable to allocate the resources.
2129 int rte_eth_tx_hairpin_queue_setup
2130 (uint16_t port_id, uint16_t tx_queue_id, uint16_t nb_tx_desc,
2131 const struct rte_eth_hairpin_conf *conf);
2134 * Return the NUMA socket to which an Ethernet device is connected
2137 * The port identifier of the Ethernet device
2139 * The NUMA socket id to which the Ethernet device is connected or
2140 * a default of zero if the socket could not be determined.
2141 * -1 is returned is the port_id value is out of range.
2143 int rte_eth_dev_socket_id(uint16_t port_id);
2146 * Check if port_id of device is attached
2149 * The port identifier of the Ethernet device
2151 * - 0 if port is out of range or not attached
2152 * - 1 if device is attached
2154 int rte_eth_dev_is_valid_port(uint16_t port_id);
2157 * Start specified RX queue of a port. It is used when rx_deferred_start
2158 * flag of the specified queue is true.
2161 * The port identifier of the Ethernet device
2162 * @param rx_queue_id
2163 * The index of the rx queue to update the ring.
2164 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2165 * to rte_eth_dev_configure().
2167 * - 0: Success, the receive queue is started.
2168 * - -EINVAL: The port_id or the queue_id out of range or belong to hairpin.
2169 * - -EIO: if device is removed.
2170 * - -ENOTSUP: The function not supported in PMD driver.
2172 int rte_eth_dev_rx_queue_start(uint16_t port_id, uint16_t rx_queue_id);
2175 * Stop specified RX queue of a port
2178 * The port identifier of the Ethernet device
2179 * @param rx_queue_id
2180 * The index of the rx queue to update the ring.
2181 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2182 * to rte_eth_dev_configure().
2184 * - 0: Success, the receive queue is stopped.
2185 * - -EINVAL: The port_id or the queue_id out of range or belong to hairpin.
2186 * - -EIO: if device is removed.
2187 * - -ENOTSUP: The function not supported in PMD driver.
2189 int rte_eth_dev_rx_queue_stop(uint16_t port_id, uint16_t rx_queue_id);
2192 * Start TX for specified queue of a port. It is used when tx_deferred_start
2193 * flag of the specified queue is true.
2196 * The port identifier of the Ethernet device
2197 * @param tx_queue_id
2198 * The index of the tx queue to update the ring.
2199 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2200 * to rte_eth_dev_configure().
2202 * - 0: Success, the transmit queue is started.
2203 * - -EINVAL: The port_id or the queue_id out of range or belong to hairpin.
2204 * - -EIO: if device is removed.
2205 * - -ENOTSUP: The function not supported in PMD driver.
2207 int rte_eth_dev_tx_queue_start(uint16_t port_id, uint16_t tx_queue_id);
2210 * Stop specified TX queue of a port
2213 * The port identifier of the Ethernet device
2214 * @param tx_queue_id
2215 * The index of the tx queue to update the ring.
2216 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2217 * to rte_eth_dev_configure().
2219 * - 0: Success, the transmit queue is stopped.
2220 * - -EINVAL: The port_id or the queue_id out of range or belong to hairpin.
2221 * - -EIO: if device is removed.
2222 * - -ENOTSUP: The function not supported in PMD driver.
2224 int rte_eth_dev_tx_queue_stop(uint16_t port_id, uint16_t tx_queue_id);
2227 * Start an Ethernet device.
2229 * The device start step is the last one and consists of setting the configured
2230 * offload features and in starting the transmit and the receive units of the
2233 * Device RTE_ETH_DEV_NOLIVE_MAC_ADDR flag causes MAC address to be set before
2234 * PMD port start callback function is invoked.
2236 * On success, all basic functions exported by the Ethernet API (link status,
2237 * receive/transmit, and so on) can be invoked.
2240 * The port identifier of the Ethernet device.
2242 * - 0: Success, Ethernet device started.
2243 * - <0: Error code of the driver device start function.
2245 int rte_eth_dev_start(uint16_t port_id);
2248 * Stop an Ethernet device. The device can be restarted with a call to
2249 * rte_eth_dev_start()
2252 * The port identifier of the Ethernet device.
2254 void rte_eth_dev_stop(uint16_t port_id);
2257 * Link up an Ethernet device.
2259 * Set device link up will re-enable the device rx/tx
2260 * functionality after it is previously set device linked down.
2263 * The port identifier of the Ethernet device.
2265 * - 0: Success, Ethernet device linked up.
2266 * - <0: Error code of the driver device link up function.
2268 int rte_eth_dev_set_link_up(uint16_t port_id);
2271 * Link down an Ethernet device.
2272 * The device rx/tx functionality will be disabled if success,
2273 * and it can be re-enabled with a call to
2274 * rte_eth_dev_set_link_up()
2277 * The port identifier of the Ethernet device.
2279 int rte_eth_dev_set_link_down(uint16_t port_id);
2282 * Close a stopped Ethernet device. The device cannot be restarted!
2283 * The function frees all port resources if the driver supports
2284 * the flag RTE_ETH_DEV_CLOSE_REMOVE.
2287 * The port identifier of the Ethernet device.
2289 void rte_eth_dev_close(uint16_t port_id);
2292 * Reset a Ethernet device and keep its port id.
2294 * When a port has to be reset passively, the DPDK application can invoke
2295 * this function. For example when a PF is reset, all its VFs should also
2296 * be reset. Normally a DPDK application can invoke this function when
2297 * RTE_ETH_EVENT_INTR_RESET event is detected, but can also use it to start
2298 * a port reset in other circumstances.
2300 * When this function is called, it first stops the port and then calls the
2301 * PMD specific dev_uninit( ) and dev_init( ) to return the port to initial
2302 * state, in which no Tx and Rx queues are setup, as if the port has been
2303 * reset and not started. The port keeps the port id it had before the
2306 * After calling rte_eth_dev_reset( ), the application should use
2307 * rte_eth_dev_configure( ), rte_eth_rx_queue_setup( ),
2308 * rte_eth_tx_queue_setup( ), and rte_eth_dev_start( )
2309 * to reconfigure the device as appropriate.
2311 * Note: To avoid unexpected behavior, the application should stop calling
2312 * Tx and Rx functions before calling rte_eth_dev_reset( ). For thread
2313 * safety, all these controlling functions should be called from the same
2317 * The port identifier of the Ethernet device.
2320 * - (0) if successful.
2321 * - (-EINVAL) if port identifier is invalid.
2322 * - (-ENOTSUP) if hardware doesn't support this function.
2323 * - (-EPERM) if not ran from the primary process.
2324 * - (-EIO) if re-initialisation failed or device is removed.
2325 * - (-ENOMEM) if the reset failed due to OOM.
2326 * - (-EAGAIN) if the reset temporarily failed and should be retried later.
2328 int rte_eth_dev_reset(uint16_t port_id);
2331 * Enable receipt in promiscuous mode for an Ethernet device.
2334 * The port identifier of the Ethernet device.
2336 * - (0) if successful.
2337 * - (-ENOTSUP) if support for promiscuous_enable() does not exist
2339 * - (-ENODEV) if *port_id* invalid.
2341 int rte_eth_promiscuous_enable(uint16_t port_id);
2344 * Disable receipt in promiscuous mode for an Ethernet device.
2347 * The port identifier of the Ethernet device.
2349 * - (0) if successful.
2350 * - (-ENOTSUP) if support for promiscuous_disable() does not exist
2352 * - (-ENODEV) if *port_id* invalid.
2354 int rte_eth_promiscuous_disable(uint16_t port_id);
2357 * Return the value of promiscuous mode for an Ethernet device.
2360 * The port identifier of the Ethernet device.
2362 * - (1) if promiscuous is enabled
2363 * - (0) if promiscuous is disabled.
2366 int rte_eth_promiscuous_get(uint16_t port_id);
2369 * Enable the receipt of any multicast frame by an Ethernet device.
2372 * The port identifier of the Ethernet device.
2374 * - (0) if successful.
2375 * - (-ENOTSUP) if support for allmulticast_enable() does not exist
2377 * - (-ENODEV) if *port_id* invalid.
2379 int rte_eth_allmulticast_enable(uint16_t port_id);
2382 * Disable the receipt of all multicast frames by an Ethernet device.
2385 * The port identifier of the Ethernet device.
2387 * - (0) if successful.
2388 * - (-ENOTSUP) if support for allmulticast_disable() does not exist
2390 * - (-ENODEV) if *port_id* invalid.
2392 int rte_eth_allmulticast_disable(uint16_t port_id);
2395 * Return the value of allmulticast mode for an Ethernet device.
2398 * The port identifier of the Ethernet device.
2400 * - (1) if allmulticast is enabled
2401 * - (0) if allmulticast is disabled.
2404 int rte_eth_allmulticast_get(uint16_t port_id);
2407 * Retrieve the link status (up/down), the duplex mode (half/full),
2408 * the negotiation (auto/fixed), and if available, the speed (Mbps).
2410 * It might need to wait up to 9 seconds.
2411 * @see rte_eth_link_get_nowait.
2414 * The port identifier of the Ethernet device.
2416 * Link information written back.
2418 * - (0) if successful.
2419 * - (-ENOTSUP) if the function is not supported in PMD driver.
2420 * - (-ENODEV) if *port_id* invalid.
2422 int rte_eth_link_get(uint16_t port_id, struct rte_eth_link *link);
2425 * Retrieve the link status (up/down), the duplex mode (half/full),
2426 * the negotiation (auto/fixed), and if available, the speed (Mbps).
2429 * The port identifier of the Ethernet device.
2431 * Link information written back.
2433 * - (0) if successful.
2434 * - (-ENOTSUP) if the function is not supported in PMD driver.
2435 * - (-ENODEV) if *port_id* invalid.
2437 int rte_eth_link_get_nowait(uint16_t port_id, struct rte_eth_link *link);
2440 * Retrieve the general I/O statistics of an Ethernet device.
2443 * The port identifier of the Ethernet device.
2445 * A pointer to a structure of type *rte_eth_stats* to be filled with
2446 * the values of device counters for the following set of statistics:
2447 * - *ipackets* with the total of successfully received packets.
2448 * - *opackets* with the total of successfully transmitted packets.
2449 * - *ibytes* with the total of successfully received bytes.
2450 * - *obytes* with the total of successfully transmitted bytes.
2451 * - *ierrors* with the total of erroneous received packets.
2452 * - *oerrors* with the total of failed transmitted packets.
2454 * Zero if successful. Non-zero otherwise.
2456 int rte_eth_stats_get(uint16_t port_id, struct rte_eth_stats *stats);
2459 * Reset the general I/O statistics of an Ethernet device.
2462 * The port identifier of the Ethernet device.
2464 * - (0) if device notified to reset stats.
2465 * - (-ENOTSUP) if hardware doesn't support.
2466 * - (-ENODEV) if *port_id* invalid.
2467 * - (<0): Error code of the driver stats reset function.
2469 int rte_eth_stats_reset(uint16_t port_id);
2472 * Retrieve names of extended statistics of an Ethernet device.
2474 * There is an assumption that 'xstat_names' and 'xstats' arrays are matched
2476 * xstats_names[i].name => xstats[i].value
2478 * And the array index is same with id field of 'struct rte_eth_xstat':
2481 * This assumption makes key-value pair matching less flexible but simpler.
2484 * The port identifier of the Ethernet device.
2485 * @param xstats_names
2486 * An rte_eth_xstat_name array of at least *size* elements to
2487 * be filled. If set to NULL, the function returns the required number
2490 * The size of the xstats_names array (number of elements).
2492 * - A positive value lower or equal to size: success. The return value
2493 * is the number of entries filled in the stats table.
2494 * - A positive value higher than size: error, the given statistics table
2495 * is too small. The return value corresponds to the size that should
2496 * be given to succeed. The entries in the table are not valid and
2497 * shall not be used by the caller.
2498 * - A negative value on error (invalid port id).
2500 int rte_eth_xstats_get_names(uint16_t port_id,
2501 struct rte_eth_xstat_name *xstats_names,
2505 * Retrieve extended statistics of an Ethernet device.
2507 * There is an assumption that 'xstat_names' and 'xstats' arrays are matched
2509 * xstats_names[i].name => xstats[i].value
2511 * And the array index is same with id field of 'struct rte_eth_xstat':
2514 * This assumption makes key-value pair matching less flexible but simpler.
2517 * The port identifier of the Ethernet device.
2519 * A pointer to a table of structure of type *rte_eth_xstat*
2520 * to be filled with device statistics ids and values.
2521 * This parameter can be set to NULL if n is 0.
2523 * The size of the xstats array (number of elements).
2525 * - A positive value lower or equal to n: success. The return value
2526 * is the number of entries filled in the stats table.
2527 * - A positive value higher than n: error, the given statistics table
2528 * is too small. The return value corresponds to the size that should
2529 * be given to succeed. The entries in the table are not valid and
2530 * shall not be used by the caller.
2531 * - A negative value on error (invalid port id).
2533 int rte_eth_xstats_get(uint16_t port_id, struct rte_eth_xstat *xstats,
2537 * Retrieve names of extended statistics of an Ethernet device.
2540 * The port identifier of the Ethernet device.
2541 * @param xstats_names
2542 * An rte_eth_xstat_name array of at least *size* elements to
2543 * be filled. If set to NULL, the function returns the required number
2546 * IDs array given by app to retrieve specific statistics
2548 * The size of the xstats_names array (number of elements).
2550 * - A positive value lower or equal to size: success. The return value
2551 * is the number of entries filled in the stats table.
2552 * - A positive value higher than size: error, the given statistics table
2553 * is too small. The return value corresponds to the size that should
2554 * be given to succeed. The entries in the table are not valid and
2555 * shall not be used by the caller.
2556 * - A negative value on error (invalid port id).
2559 rte_eth_xstats_get_names_by_id(uint16_t port_id,
2560 struct rte_eth_xstat_name *xstats_names, unsigned int size,
2564 * Retrieve extended statistics of an Ethernet device.
2567 * The port identifier of the Ethernet device.
2569 * A pointer to an ids array passed by application. This tells which
2570 * statistics values function should retrieve. This parameter
2571 * can be set to NULL if size is 0. In this case function will retrieve
2572 * all available statistics.
2574 * A pointer to a table to be filled with device statistics values.
2576 * The size of the ids array (number of elements).
2578 * - A positive value lower or equal to size: success. The return value
2579 * is the number of entries filled in the stats table.
2580 * - A positive value higher than size: error, the given statistics table
2581 * is too small. The return value corresponds to the size that should
2582 * be given to succeed. The entries in the table are not valid and
2583 * shall not be used by the caller.
2584 * - A negative value on error (invalid port id).
2586 int rte_eth_xstats_get_by_id(uint16_t port_id, const uint64_t *ids,
2587 uint64_t *values, unsigned int size);
2590 * Gets the ID of a statistic from its name.
2592 * This function searches for the statistics using string compares, and
2593 * as such should not be used on the fast-path. For fast-path retrieval of
2594 * specific statistics, store the ID as provided in *id* from this function,
2595 * and pass the ID to rte_eth_xstats_get()
2597 * @param port_id The port to look up statistics from
2598 * @param xstat_name The name of the statistic to return
2599 * @param[out] id A pointer to an app-supplied uint64_t which should be
2600 * set to the ID of the stat if the stat exists.
2603 * -ENODEV for invalid port_id,
2604 * -EIO if device is removed,
2605 * -EINVAL if the xstat_name doesn't exist in port_id
2607 int rte_eth_xstats_get_id_by_name(uint16_t port_id, const char *xstat_name,
2611 * Reset extended statistics of an Ethernet device.
2614 * The port identifier of the Ethernet device.
2616 * - (0) if device notified to reset extended stats.
2617 * - (-ENOTSUP) if pmd doesn't support both
2618 * extended stats and basic stats reset.
2619 * - (-ENODEV) if *port_id* invalid.
2620 * - (<0): Error code of the driver xstats reset function.
2622 int rte_eth_xstats_reset(uint16_t port_id);
2625 * Set a mapping for the specified transmit queue to the specified per-queue
2626 * statistics counter.
2629 * The port identifier of the Ethernet device.
2630 * @param tx_queue_id
2631 * The index of the transmit queue for which a queue stats mapping is required.
2632 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2633 * to rte_eth_dev_configure().
2635 * The per-queue packet statistics functionality number that the transmit
2636 * queue is to be assigned.
2637 * The value must be in the range [0, RTE_ETHDEV_QUEUE_STAT_CNTRS - 1].
2639 * Zero if successful. Non-zero otherwise.
2641 int rte_eth_dev_set_tx_queue_stats_mapping(uint16_t port_id,
2642 uint16_t tx_queue_id, uint8_t stat_idx);
2645 * Set a mapping for the specified receive queue to the specified per-queue
2646 * statistics counter.
2649 * The port identifier of the Ethernet device.
2650 * @param rx_queue_id
2651 * The index of the receive queue for which a queue stats mapping is required.
2652 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2653 * to rte_eth_dev_configure().
2655 * The per-queue packet statistics functionality number that the receive
2656 * queue is to be assigned.
2657 * The value must be in the range [0, RTE_ETHDEV_QUEUE_STAT_CNTRS - 1].
2659 * Zero if successful. Non-zero otherwise.
2661 int rte_eth_dev_set_rx_queue_stats_mapping(uint16_t port_id,
2662 uint16_t rx_queue_id,
2666 * Retrieve the Ethernet address of an Ethernet device.
2669 * The port identifier of the Ethernet device.
2671 * A pointer to a structure of type *ether_addr* to be filled with
2672 * the Ethernet address of the Ethernet device.
2674 * - (0) if successful
2675 * - (-ENODEV) if *port_id* invalid.
2677 int rte_eth_macaddr_get(uint16_t port_id, struct rte_ether_addr *mac_addr);
2680 * Retrieve the contextual information of an Ethernet device.
2682 * As part of this function, a number of of fields in dev_info will be
2683 * initialized as follows:
2688 * Where lim is defined within the rte_eth_dev_info_get as
2690 * const struct rte_eth_desc_lim lim = {
2691 * .nb_max = UINT16_MAX,
2694 * .nb_seg_max = UINT16_MAX,
2695 * .nb_mtu_seg_max = UINT16_MAX,
2698 * device = dev->device
2699 * min_mtu = RTE_ETHER_MIN_MTU
2700 * max_mtu = UINT16_MAX
2702 * The following fields will be populated if support for dev_infos_get()
2703 * exists for the device and the rte_eth_dev 'dev' has been populated
2704 * successfully with a call to it:
2706 * driver_name = dev->device->driver->name
2707 * nb_rx_queues = dev->data->nb_rx_queues
2708 * nb_tx_queues = dev->data->nb_tx_queues
2709 * dev_flags = &dev->data->dev_flags
2712 * The port identifier of the Ethernet device.
2714 * A pointer to a structure of type *rte_eth_dev_info* to be filled with
2715 * the contextual information of the Ethernet device.
2717 * - (0) if successful.
2718 * - (-ENOTSUP) if support for dev_infos_get() does not exist for the device.
2719 * - (-ENODEV) if *port_id* invalid.
2721 int rte_eth_dev_info_get(uint16_t port_id, struct rte_eth_dev_info *dev_info);
2724 * Retrieve the firmware version of a device.
2727 * The port identifier of the device.
2729 * A pointer to a string array storing the firmware version of a device,
2730 * the string includes terminating null. This pointer is allocated by caller.
2732 * The size of the string array pointed by fw_version, which should be
2733 * large enough to store firmware version of the device.
2735 * - (0) if successful.
2736 * - (-ENOTSUP) if operation is not supported.
2737 * - (-ENODEV) if *port_id* invalid.
2738 * - (-EIO) if device is removed.
2739 * - (>0) if *fw_size* is not enough to store firmware version, return
2740 * the size of the non truncated string.
2742 int rte_eth_dev_fw_version_get(uint16_t port_id,
2743 char *fw_version, size_t fw_size);
2746 * Retrieve the supported packet types of an Ethernet device.
2748 * When a packet type is announced as supported, it *must* be recognized by
2749 * the PMD. For instance, if RTE_PTYPE_L2_ETHER, RTE_PTYPE_L2_ETHER_VLAN
2750 * and RTE_PTYPE_L3_IPV4 are announced, the PMD must return the following
2751 * packet types for these packets:
2752 * - Ether/IPv4 -> RTE_PTYPE_L2_ETHER | RTE_PTYPE_L3_IPV4
2753 * - Ether/Vlan/IPv4 -> RTE_PTYPE_L2_ETHER_VLAN | RTE_PTYPE_L3_IPV4
2754 * - Ether/[anything else] -> RTE_PTYPE_L2_ETHER
2755 * - Ether/Vlan/[anything else] -> RTE_PTYPE_L2_ETHER_VLAN
2757 * When a packet is received by a PMD, the most precise type must be
2758 * returned among the ones supported. However a PMD is allowed to set
2759 * packet type that is not in the supported list, at the condition that it
2760 * is more precise. Therefore, a PMD announcing no supported packet types
2761 * can still set a matching packet type in a received packet.
2764 * Better to invoke this API after the device is already started or rx burst
2765 * function is decided, to obtain correct supported ptypes.
2767 * if a given PMD does not report what ptypes it supports, then the supported
2768 * ptype count is reported as 0.
2770 * The port identifier of the Ethernet device.
2772 * A hint of what kind of packet type which the caller is interested in.
2774 * An array pointer to store adequate packet types, allocated by caller.
2776 * Size of the array pointed by param ptypes.
2778 * - (>=0) Number of supported ptypes. If the number of types exceeds num,
2779 * only num entries will be filled into the ptypes array, but the full
2780 * count of supported ptypes will be returned.
2781 * - (-ENODEV) if *port_id* invalid.
2783 int rte_eth_dev_get_supported_ptypes(uint16_t port_id, uint32_t ptype_mask,
2784 uint32_t *ptypes, int num);
2787 * @b EXPERIMENTAL: this API may change without prior notice.
2789 * Inform Ethernet device about reduced range of packet types to handle.
2791 * Application can use this function to set only specific ptypes that it's
2792 * interested. This information can be used by the PMD to optimize Rx path.
2794 * The function accepts an array `set_ptypes` allocated by the caller to
2795 * store the packet types set by the driver, the last element of the array
2796 * is set to RTE_PTYPE_UNKNOWN. The size of the `set_ptype` array should be
2797 * `rte_eth_dev_get_supported_ptypes() + 1` else it might only be filled
2801 * The port identifier of the Ethernet device.
2803 * The ptype family that application is interested in should be bitwise OR of
2804 * RTE_PTYPE_*_MASK or 0.
2806 * An array pointer to store set packet types, allocated by caller. The
2807 * function marks the end of array with RTE_PTYPE_UNKNOWN.
2809 * Size of the array pointed by param ptypes.
2810 * Should be rte_eth_dev_get_supported_ptypes() + 1 to accommodate the
2814 * - (-ENODEV) if *port_id* invalid.
2815 * - (-EINVAL) if *ptype_mask* is invalid (or) set_ptypes is NULL and
2819 int rte_eth_dev_set_ptypes(uint16_t port_id, uint32_t ptype_mask,
2820 uint32_t *set_ptypes, unsigned int num);
2823 * Retrieve the MTU of an Ethernet device.
2826 * The port identifier of the Ethernet device.
2828 * A pointer to a uint16_t where the retrieved MTU is to be stored.
2830 * - (0) if successful.
2831 * - (-ENODEV) if *port_id* invalid.
2833 int rte_eth_dev_get_mtu(uint16_t port_id, uint16_t *mtu);
2836 * Change the MTU of an Ethernet device.
2839 * The port identifier of the Ethernet device.
2841 * A uint16_t for the MTU to be applied.
2843 * - (0) if successful.
2844 * - (-ENOTSUP) if operation is not supported.
2845 * - (-ENODEV) if *port_id* invalid.
2846 * - (-EIO) if device is removed.
2847 * - (-EINVAL) if *mtu* invalid, validation of mtu can occur within
2848 * rte_eth_dev_set_mtu if dev_infos_get is supported by the device or
2849 * when the mtu is set using dev->dev_ops->mtu_set.
2850 * - (-EBUSY) if operation is not allowed when the port is running
2852 int rte_eth_dev_set_mtu(uint16_t port_id, uint16_t mtu);
2855 * Enable/Disable hardware filtering by an Ethernet device of received
2856 * VLAN packets tagged with a given VLAN Tag Identifier.
2859 * The port identifier of the Ethernet device.
2861 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
2863 * If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*.
2864 * Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*.
2866 * - (0) if successful.
2867 * - (-ENOTSUP) if hardware-assisted VLAN filtering not configured.
2868 * - (-ENODEV) if *port_id* invalid.
2869 * - (-EIO) if device is removed.
2870 * - (-ENOSYS) if VLAN filtering on *port_id* disabled.
2871 * - (-EINVAL) if *vlan_id* > 4095.
2873 int rte_eth_dev_vlan_filter(uint16_t port_id, uint16_t vlan_id, int on);
2876 * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
2879 * The port identifier of the Ethernet device.
2880 * @param rx_queue_id
2881 * The index of the receive queue for which a queue stats mapping is required.
2882 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2883 * to rte_eth_dev_configure().
2885 * If 1, Enable VLAN Stripping of the receive queue of the Ethernet port.
2886 * If 0, Disable VLAN Stripping of the receive queue of the Ethernet port.
2888 * - (0) if successful.
2889 * - (-ENOTSUP) if hardware-assisted VLAN stripping not configured.
2890 * - (-ENODEV) if *port_id* invalid.
2891 * - (-EINVAL) if *rx_queue_id* invalid.
2893 int rte_eth_dev_set_vlan_strip_on_queue(uint16_t port_id, uint16_t rx_queue_id,
2897 * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
2901 * The port identifier of the Ethernet device.
2905 * The Tag Protocol ID
2907 * - (0) if successful.
2908 * - (-ENOTSUP) if hardware-assisted VLAN TPID setup is not supported.
2909 * - (-ENODEV) if *port_id* invalid.
2910 * - (-EIO) if device is removed.
2912 int rte_eth_dev_set_vlan_ether_type(uint16_t port_id,
2913 enum rte_vlan_type vlan_type,
2917 * Set VLAN offload configuration on an Ethernet device.
2920 * The port identifier of the Ethernet device.
2921 * @param offload_mask
2922 * The VLAN Offload bit mask can be mixed use with "OR"
2923 * ETH_VLAN_STRIP_OFFLOAD
2924 * ETH_VLAN_FILTER_OFFLOAD
2925 * ETH_VLAN_EXTEND_OFFLOAD
2926 * ETH_QINQ_STRIP_OFFLOAD
2928 * - (0) if successful.
2929 * - (-ENOTSUP) if hardware-assisted VLAN filtering not configured.
2930 * - (-ENODEV) if *port_id* invalid.
2931 * - (-EIO) if device is removed.
2933 int rte_eth_dev_set_vlan_offload(uint16_t port_id, int offload_mask);
2936 * Read VLAN Offload configuration from an Ethernet device
2939 * The port identifier of the Ethernet device.
2941 * - (>0) if successful. Bit mask to indicate
2942 * ETH_VLAN_STRIP_OFFLOAD
2943 * ETH_VLAN_FILTER_OFFLOAD
2944 * ETH_VLAN_EXTEND_OFFLOAD
2945 * ETH_QINQ_STRIP_OFFLOAD
2946 * - (-ENODEV) if *port_id* invalid.
2948 int rte_eth_dev_get_vlan_offload(uint16_t port_id);
2951 * Set port based TX VLAN insertion on or off.
2954 * The port identifier of the Ethernet device.
2956 * Port based TX VLAN identifier together with user priority.
2958 * Turn on or off the port based TX VLAN insertion.
2961 * - (0) if successful.
2962 * - negative if failed.
2964 int rte_eth_dev_set_vlan_pvid(uint16_t port_id, uint16_t pvid, int on);
2966 typedef void (*buffer_tx_error_fn)(struct rte_mbuf **unsent, uint16_t count,
2970 * Structure used to buffer packets for future TX
2971 * Used by APIs rte_eth_tx_buffer and rte_eth_tx_buffer_flush
2973 struct rte_eth_dev_tx_buffer {
2974 buffer_tx_error_fn error_callback;
2975 void *error_userdata;
2976 uint16_t size; /**< Size of buffer for buffered tx */
2977 uint16_t length; /**< Number of packets in the array */
2978 struct rte_mbuf *pkts[];
2979 /**< Pending packets to be sent on explicit flush or when full */
2983 * Calculate the size of the tx buffer.
2986 * Number of stored packets.
2988 #define RTE_ETH_TX_BUFFER_SIZE(sz) \
2989 (sizeof(struct rte_eth_dev_tx_buffer) + (sz) * sizeof(struct rte_mbuf *))
2992 * Initialize default values for buffered transmitting
2995 * Tx buffer to be initialized.
3002 rte_eth_tx_buffer_init(struct rte_eth_dev_tx_buffer *buffer, uint16_t size);
3005 * Configure a callback for buffered packets which cannot be sent
3007 * Register a specific callback to be called when an attempt is made to send
3008 * all packets buffered on an ethernet port, but not all packets can
3009 * successfully be sent. The callback registered here will be called only
3010 * from calls to rte_eth_tx_buffer() and rte_eth_tx_buffer_flush() APIs.
3011 * The default callback configured for each queue by default just frees the
3012 * packets back to the calling mempool. If additional behaviour is required,
3013 * for example, to count dropped packets, or to retry transmission of packets
3014 * which cannot be sent, this function should be used to register a suitable
3015 * callback function to implement the desired behaviour.
3016 * The example callback "rte_eth_count_unsent_packet_callback()" is also
3017 * provided as reference.
3020 * The port identifier of the Ethernet device.
3022 * The function to be used as the callback.
3024 * Arbitrary parameter to be passed to the callback function
3026 * 0 on success, or -1 on error with rte_errno set appropriately
3029 rte_eth_tx_buffer_set_err_callback(struct rte_eth_dev_tx_buffer *buffer,
3030 buffer_tx_error_fn callback, void *userdata);
3033 * Callback function for silently dropping unsent buffered packets.
3035 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
3036 * adjust the default behavior when buffered packets cannot be sent. This
3037 * function drops any unsent packets silently and is used by tx buffered
3038 * operations as default behavior.
3040 * NOTE: this function should not be called directly, instead it should be used
3041 * as a callback for packet buffering.
3043 * NOTE: when configuring this function as a callback with
3044 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
3045 * should point to an uint64_t value.
3048 * The previously buffered packets which could not be sent
3050 * The number of unsent packets in the pkts array
3055 rte_eth_tx_buffer_drop_callback(struct rte_mbuf **pkts, uint16_t unsent,
3059 * Callback function for tracking unsent buffered packets.
3061 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
3062 * adjust the default behavior when buffered packets cannot be sent. This
3063 * function drops any unsent packets, but also updates a user-supplied counter
3064 * to track the overall number of packets dropped. The counter should be an
3065 * uint64_t variable.
3067 * NOTE: this function should not be called directly, instead it should be used
3068 * as a callback for packet buffering.
3070 * NOTE: when configuring this function as a callback with
3071 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
3072 * should point to an uint64_t value.
3075 * The previously buffered packets which could not be sent
3077 * The number of unsent packets in the pkts array
3079 * Pointer to an uint64_t value, which will be incremented by unsent
3082 rte_eth_tx_buffer_count_callback(struct rte_mbuf **pkts, uint16_t unsent,
3086 * Request the driver to free mbufs currently cached by the driver. The
3087 * driver will only free the mbuf if it is no longer in use. It is the
3088 * application's responsibility to ensure rte_eth_tx_buffer_flush(..) is
3092 * The port identifier of the Ethernet device.
3094 * The index of the transmit queue through which output packets must be
3096 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3097 * to rte_eth_dev_configure().
3099 * Maximum number of packets to free. Use 0 to indicate all possible packets
3100 * should be freed. Note that a packet may be using multiple mbufs.
3103 * -ENODEV: Invalid interface
3104 * -EIO: device is removed
3105 * -ENOTSUP: Driver does not support function
3107 * 0-n: Number of packets freed. More packets may still remain in ring that
3111 rte_eth_tx_done_cleanup(uint16_t port_id, uint16_t queue_id, uint32_t free_cnt);
3114 * Subtypes for IPsec offload event(@ref RTE_ETH_EVENT_IPSEC) raised by
3117 enum rte_eth_event_ipsec_subtype {
3118 RTE_ETH_EVENT_IPSEC_UNKNOWN = 0,
3119 /**< Unknown event type */
3120 RTE_ETH_EVENT_IPSEC_ESN_OVERFLOW,
3121 /**< Sequence number overflow */
3122 RTE_ETH_EVENT_IPSEC_SA_TIME_EXPIRY,
3123 /**< Soft time expiry of SA */
3124 RTE_ETH_EVENT_IPSEC_SA_BYTE_EXPIRY,
3125 /**< Soft byte expiry of SA */
3126 RTE_ETH_EVENT_IPSEC_MAX
3127 /**< Max value of this enum */
3131 * Descriptor for @ref RTE_ETH_EVENT_IPSEC event. Used by eth dev to send extra
3132 * information of the IPsec offload event.
3134 struct rte_eth_event_ipsec_desc {
3135 enum rte_eth_event_ipsec_subtype subtype;
3136 /**< Type of RTE_ETH_EVENT_IPSEC_* event */
3138 /**< Event specific metadata
3140 * For the following events, *userdata* registered
3141 * with the *rte_security_session* would be returned
3144 * - @ref RTE_ETH_EVENT_IPSEC_ESN_OVERFLOW
3145 * - @ref RTE_ETH_EVENT_IPSEC_SA_TIME_EXPIRY
3146 * - @ref RTE_ETH_EVENT_IPSEC_SA_BYTE_EXPIRY
3148 * @see struct rte_security_session_conf
3154 * The eth device event type for interrupt, and maybe others in the future.
3156 enum rte_eth_event_type {
3157 RTE_ETH_EVENT_UNKNOWN, /**< unknown event type */
3158 RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
3159 RTE_ETH_EVENT_QUEUE_STATE,
3160 /**< queue state event (enabled/disabled) */
3161 RTE_ETH_EVENT_INTR_RESET,
3162 /**< reset interrupt event, sent to VF on PF reset */
3163 RTE_ETH_EVENT_VF_MBOX, /**< message from the VF received by PF */
3164 RTE_ETH_EVENT_MACSEC, /**< MACsec offload related event */
3165 RTE_ETH_EVENT_INTR_RMV, /**< device removal event */
3166 RTE_ETH_EVENT_NEW, /**< port is probed */
3167 RTE_ETH_EVENT_DESTROY, /**< port is released */
3168 RTE_ETH_EVENT_IPSEC, /**< IPsec offload related event */
3169 RTE_ETH_EVENT_FLOW_AGED,/**< New aged-out flows is detected */
3170 RTE_ETH_EVENT_MAX /**< max value of this enum */
3173 typedef int (*rte_eth_dev_cb_fn)(uint16_t port_id,
3174 enum rte_eth_event_type event, void *cb_arg, void *ret_param);
3175 /**< user application callback to be registered for interrupts */
3178 * Register a callback function for port event.
3182 * RTE_ETH_ALL means register the event for all port ids.
3186 * User supplied callback function to be called.
3188 * Pointer to the parameters for the registered callback.
3191 * - On success, zero.
3192 * - On failure, a negative value.
3194 int rte_eth_dev_callback_register(uint16_t port_id,
3195 enum rte_eth_event_type event,
3196 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
3199 * Unregister a callback function for port event.
3203 * RTE_ETH_ALL means unregister the event for all port ids.
3207 * User supplied callback function to be called.
3209 * Pointer to the parameters for the registered callback. -1 means to
3210 * remove all for the same callback address and same event.
3213 * - On success, zero.
3214 * - On failure, a negative value.
3216 int rte_eth_dev_callback_unregister(uint16_t port_id,
3217 enum rte_eth_event_type event,
3218 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
3221 * When there is no rx packet coming in Rx Queue for a long time, we can
3222 * sleep lcore related to RX Queue for power saving, and enable rx interrupt
3223 * to be triggered when Rx packet arrives.
3225 * The rte_eth_dev_rx_intr_enable() function enables rx queue
3226 * interrupt on specific rx queue of a port.
3229 * The port identifier of the Ethernet device.
3231 * The index of the receive queue from which to retrieve input packets.
3232 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3233 * to rte_eth_dev_configure().
3235 * - (0) if successful.
3236 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3238 * - (-ENODEV) if *port_id* invalid.
3239 * - (-EIO) if device is removed.
3241 int rte_eth_dev_rx_intr_enable(uint16_t port_id, uint16_t queue_id);
3244 * When lcore wakes up from rx interrupt indicating packet coming, disable rx
3245 * interrupt and returns to polling mode.
3247 * The rte_eth_dev_rx_intr_disable() function disables rx queue
3248 * interrupt on specific rx queue of a port.
3251 * The port identifier of the Ethernet device.
3253 * The index of the receive queue from which to retrieve input packets.
3254 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3255 * to rte_eth_dev_configure().
3257 * - (0) if successful.
3258 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3260 * - (-ENODEV) if *port_id* invalid.
3261 * - (-EIO) if device is removed.
3263 int rte_eth_dev_rx_intr_disable(uint16_t port_id, uint16_t queue_id);
3266 * RX Interrupt control per port.
3269 * The port identifier of the Ethernet device.
3271 * Epoll instance fd which the intr vector associated to.
3272 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
3274 * The operation be performed for the vector.
3275 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
3279 * - On success, zero.
3280 * - On failure, a negative value.
3282 int rte_eth_dev_rx_intr_ctl(uint16_t port_id, int epfd, int op, void *data);
3285 * RX Interrupt control per queue.
3288 * The port identifier of the Ethernet device.
3290 * The index of the receive queue from which to retrieve input packets.
3291 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3292 * to rte_eth_dev_configure().
3294 * Epoll instance fd which the intr vector associated to.
3295 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
3297 * The operation be performed for the vector.
3298 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
3302 * - On success, zero.
3303 * - On failure, a negative value.
3305 int rte_eth_dev_rx_intr_ctl_q(uint16_t port_id, uint16_t queue_id,
3306 int epfd, int op, void *data);
3310 * @b EXPERIMENTAL: this API may change without prior notice.
3312 * Get interrupt fd per Rx queue.
3315 * The port identifier of the Ethernet device.
3317 * The index of the receive queue from which to retrieve input packets.
3318 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3319 * to rte_eth_dev_configure().
3321 * - (>=0) the interrupt fd associated to the requested Rx queue if
3327 rte_eth_dev_rx_intr_ctl_q_get_fd(uint16_t port_id, uint16_t queue_id);
3330 * Turn on the LED on the Ethernet device.
3331 * This function turns on the LED on the Ethernet device.
3334 * The port identifier of the Ethernet device.
3336 * - (0) if successful.
3337 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3339 * - (-ENODEV) if *port_id* invalid.
3340 * - (-EIO) if device is removed.
3342 int rte_eth_led_on(uint16_t port_id);
3345 * Turn off the LED on the Ethernet device.
3346 * This function turns off the LED on the Ethernet device.
3349 * The port identifier of the Ethernet device.
3351 * - (0) if successful.
3352 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3354 * - (-ENODEV) if *port_id* invalid.
3355 * - (-EIO) if device is removed.
3357 int rte_eth_led_off(uint16_t port_id);
3360 * Get current status of the Ethernet link flow control for Ethernet device
3363 * The port identifier of the Ethernet device.
3365 * The pointer to the structure where to store the flow control parameters.
3367 * - (0) if successful.
3368 * - (-ENOTSUP) if hardware doesn't support flow control.
3369 * - (-ENODEV) if *port_id* invalid.
3370 * - (-EIO) if device is removed.
3372 int rte_eth_dev_flow_ctrl_get(uint16_t port_id,
3373 struct rte_eth_fc_conf *fc_conf);
3376 * Configure the Ethernet link flow control for Ethernet device
3379 * The port identifier of the Ethernet device.
3381 * The pointer to the structure of the flow control parameters.
3383 * - (0) if successful.
3384 * - (-ENOTSUP) if hardware doesn't support flow control mode.
3385 * - (-ENODEV) if *port_id* invalid.
3386 * - (-EINVAL) if bad parameter
3387 * - (-EIO) if flow control setup failure or device is removed.
3389 int rte_eth_dev_flow_ctrl_set(uint16_t port_id,
3390 struct rte_eth_fc_conf *fc_conf);
3393 * Configure the Ethernet priority flow control under DCB environment
3394 * for Ethernet device.
3397 * The port identifier of the Ethernet device.
3399 * The pointer to the structure of the priority flow control parameters.
3401 * - (0) if successful.
3402 * - (-ENOTSUP) if hardware doesn't support priority flow control mode.
3403 * - (-ENODEV) if *port_id* invalid.
3404 * - (-EINVAL) if bad parameter
3405 * - (-EIO) if flow control setup failure or device is removed.
3407 int rte_eth_dev_priority_flow_ctrl_set(uint16_t port_id,
3408 struct rte_eth_pfc_conf *pfc_conf);
3411 * Add a MAC address to the set used for filtering incoming packets.
3414 * The port identifier of the Ethernet device.
3416 * The MAC address to add.
3418 * VMDq pool index to associate address with (if VMDq is enabled). If VMDq is
3419 * not enabled, this should be set to 0.
3421 * - (0) if successfully added or *mac_addr* was already added.
3422 * - (-ENOTSUP) if hardware doesn't support this feature.
3423 * - (-ENODEV) if *port* is invalid.
3424 * - (-EIO) if device is removed.
3425 * - (-ENOSPC) if no more MAC addresses can be added.
3426 * - (-EINVAL) if MAC address is invalid.
3428 int rte_eth_dev_mac_addr_add(uint16_t port_id, struct rte_ether_addr *mac_addr,
3432 * Remove a MAC address from the internal array of addresses.
3435 * The port identifier of the Ethernet device.
3437 * MAC address to remove.
3439 * - (0) if successful, or *mac_addr* didn't exist.
3440 * - (-ENOTSUP) if hardware doesn't support.
3441 * - (-ENODEV) if *port* invalid.
3442 * - (-EADDRINUSE) if attempting to remove the default MAC address
3444 int rte_eth_dev_mac_addr_remove(uint16_t port_id,
3445 struct rte_ether_addr *mac_addr);
3448 * Set the default MAC address.
3451 * The port identifier of the Ethernet device.
3453 * New default MAC address.
3455 * - (0) if successful, or *mac_addr* didn't exist.
3456 * - (-ENOTSUP) if hardware doesn't support.
3457 * - (-ENODEV) if *port* invalid.
3458 * - (-EINVAL) if MAC address is invalid.
3460 int rte_eth_dev_default_mac_addr_set(uint16_t port_id,
3461 struct rte_ether_addr *mac_addr);
3464 * Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3467 * The port identifier of the Ethernet device.
3471 * Redirection table size. The table size can be queried by
3472 * rte_eth_dev_info_get().
3474 * - (0) if successful.
3475 * - (-ENOTSUP) if hardware doesn't support.
3476 * - (-EINVAL) if bad parameter.
3477 * - (-EIO) if device is removed.
3479 int rte_eth_dev_rss_reta_update(uint16_t port_id,
3480 struct rte_eth_rss_reta_entry64 *reta_conf,
3481 uint16_t reta_size);
3484 * Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3487 * The port identifier of the Ethernet device.
3489 * RETA to query. For each requested reta entry, corresponding bit
3490 * in mask must be set.
3492 * Redirection table size. The table size can be queried by
3493 * rte_eth_dev_info_get().
3495 * - (0) if successful.
3496 * - (-ENOTSUP) if hardware doesn't support.
3497 * - (-EINVAL) if bad parameter.
3498 * - (-EIO) if device is removed.
3500 int rte_eth_dev_rss_reta_query(uint16_t port_id,
3501 struct rte_eth_rss_reta_entry64 *reta_conf,
3502 uint16_t reta_size);
3505 * Updates unicast hash table for receiving packet with the given destination
3506 * MAC address, and the packet is routed to all VFs for which the RX mode is
3507 * accept packets that match the unicast hash table.
3510 * The port identifier of the Ethernet device.
3512 * Unicast MAC address.
3514 * 1 - Set an unicast hash bit for receiving packets with the MAC address.
3515 * 0 - Clear an unicast hash bit.
3517 * - (0) if successful.
3518 * - (-ENOTSUP) if hardware doesn't support.
3519 * - (-ENODEV) if *port_id* invalid.
3520 * - (-EIO) if device is removed.
3521 * - (-EINVAL) if bad parameter.
3523 int rte_eth_dev_uc_hash_table_set(uint16_t port_id, struct rte_ether_addr *addr,
3527 * Updates all unicast hash bitmaps for receiving packet with any Unicast
3528 * Ethernet MAC addresses,the packet is routed to all VFs for which the RX
3529 * mode is accept packets that match the unicast hash table.
3532 * The port identifier of the Ethernet device.
3534 * 1 - Set all unicast hash bitmaps for receiving all the Ethernet
3536 * 0 - Clear all unicast hash bitmaps
3538 * - (0) if successful.
3539 * - (-ENOTSUP) if hardware doesn't support.
3540 * - (-ENODEV) if *port_id* invalid.
3541 * - (-EIO) if device is removed.
3542 * - (-EINVAL) if bad parameter.
3544 int rte_eth_dev_uc_all_hash_table_set(uint16_t port_id, uint8_t on);
3547 * Set a traffic mirroring rule on an Ethernet device
3550 * The port identifier of the Ethernet device.
3551 * @param mirror_conf
3552 * The pointer to the traffic mirroring structure describing the mirroring rule.
3553 * The *rte_eth_vm_mirror_conf* structure includes the type of mirroring rule,
3554 * destination pool and the value of rule if enable vlan or pool mirroring.
3557 * The index of traffic mirroring rule, we support four separated rules.
3559 * 1 - Enable a mirroring rule.
3560 * 0 - Disable a mirroring rule.
3562 * - (0) if successful.
3563 * - (-ENOTSUP) if hardware doesn't support this feature.
3564 * - (-ENODEV) if *port_id* invalid.
3565 * - (-EIO) if device is removed.
3566 * - (-EINVAL) if the mr_conf information is not correct.
3568 int rte_eth_mirror_rule_set(uint16_t port_id,
3569 struct rte_eth_mirror_conf *mirror_conf,
3574 * Reset a traffic mirroring rule on an Ethernet device.
3577 * The port identifier of the Ethernet device.
3579 * The index of traffic mirroring rule, we support four separated rules.
3581 * - (0) if successful.
3582 * - (-ENOTSUP) if hardware doesn't support this feature.
3583 * - (-ENODEV) if *port_id* invalid.
3584 * - (-EIO) if device is removed.
3585 * - (-EINVAL) if bad parameter.
3587 int rte_eth_mirror_rule_reset(uint16_t port_id,
3591 * Set the rate limitation for a queue on an Ethernet device.
3594 * The port identifier of the Ethernet device.
3598 * The tx rate in Mbps. Allocated from the total port link speed.
3600 * - (0) if successful.
3601 * - (-ENOTSUP) if hardware doesn't support this feature.
3602 * - (-ENODEV) if *port_id* invalid.
3603 * - (-EIO) if device is removed.
3604 * - (-EINVAL) if bad parameter.
3606 int rte_eth_set_queue_rate_limit(uint16_t port_id, uint16_t queue_idx,
3610 * Configuration of Receive Side Scaling hash computation of Ethernet device.
3613 * The port identifier of the Ethernet device.
3615 * The new configuration to use for RSS hash computation on the port.
3617 * - (0) if successful.
3618 * - (-ENODEV) if port identifier is invalid.
3619 * - (-EIO) if device is removed.
3620 * - (-ENOTSUP) if hardware doesn't support.
3621 * - (-EINVAL) if bad parameter.
3623 int rte_eth_dev_rss_hash_update(uint16_t port_id,
3624 struct rte_eth_rss_conf *rss_conf);
3627 * Retrieve current configuration of Receive Side Scaling hash computation
3628 * of Ethernet device.
3631 * The port identifier of the Ethernet device.
3633 * Where to store the current RSS hash configuration of the Ethernet device.
3635 * - (0) if successful.
3636 * - (-ENODEV) if port identifier is invalid.
3637 * - (-EIO) if device is removed.
3638 * - (-ENOTSUP) if hardware doesn't support RSS.
3641 rte_eth_dev_rss_hash_conf_get(uint16_t port_id,
3642 struct rte_eth_rss_conf *rss_conf);
3645 * Add UDP tunneling port for a specific type of tunnel.
3646 * The packets with this UDP port will be identified as this type of tunnel.
3647 * Before enabling any offloading function for a tunnel, users can call this API
3648 * to change or add more UDP port for the tunnel. So the offloading function
3649 * can take effect on the packets with the specific UDP port.
3652 * The port identifier of the Ethernet device.
3654 * UDP tunneling configuration.
3657 * - (0) if successful.
3658 * - (-ENODEV) if port identifier is invalid.
3659 * - (-EIO) if device is removed.
3660 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3663 rte_eth_dev_udp_tunnel_port_add(uint16_t port_id,
3664 struct rte_eth_udp_tunnel *tunnel_udp);
3667 * Delete UDP tunneling port a specific type of tunnel.
3668 * The packets with this UDP port will not be identified as this type of tunnel
3670 * Before enabling any offloading function for a tunnel, users can call this API
3671 * to delete a UDP port for the tunnel. So the offloading function will not take
3672 * effect on the packets with the specific UDP port.
3675 * The port identifier of the Ethernet device.
3677 * UDP tunneling configuration.
3680 * - (0) if successful.
3681 * - (-ENODEV) if port identifier is invalid.
3682 * - (-EIO) if device is removed.
3683 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3686 rte_eth_dev_udp_tunnel_port_delete(uint16_t port_id,
3687 struct rte_eth_udp_tunnel *tunnel_udp);
3690 * Check whether the filter type is supported on an Ethernet device.
3691 * All the supported filter types are defined in 'rte_eth_ctrl.h'.
3694 * The port identifier of the Ethernet device.
3695 * @param filter_type
3698 * - (0) if successful.
3699 * - (-ENOTSUP) if hardware doesn't support this filter type.
3700 * - (-ENODEV) if *port_id* invalid.
3701 * - (-EIO) if device is removed.
3704 int rte_eth_dev_filter_supported(uint16_t port_id,
3705 enum rte_filter_type filter_type);
3708 * Take operations to assigned filter type on an Ethernet device.
3709 * All the supported operations and filter types are defined in 'rte_eth_ctrl.h'.
3712 * The port identifier of the Ethernet device.
3713 * @param filter_type
3716 * Type of operation.
3718 * A pointer to arguments defined specifically for the operation.
3720 * - (0) if successful.
3721 * - (-ENOTSUP) if hardware doesn't support.
3722 * - (-ENODEV) if *port_id* invalid.
3723 * - (-EIO) if device is removed.
3724 * - others depends on the specific operations implementation.
3727 int rte_eth_dev_filter_ctrl(uint16_t port_id, enum rte_filter_type filter_type,
3728 enum rte_filter_op filter_op, void *arg);
3731 * Get DCB information on an Ethernet device.
3734 * The port identifier of the Ethernet device.
3738 * - (0) if successful.
3739 * - (-ENODEV) if port identifier is invalid.
3740 * - (-EIO) if device is removed.
3741 * - (-ENOTSUP) if hardware doesn't support.
3743 int rte_eth_dev_get_dcb_info(uint16_t port_id,
3744 struct rte_eth_dcb_info *dcb_info);
3746 struct rte_eth_rxtx_callback;
3749 * Add a callback to be called on packet RX on a given port and queue.
3751 * This API configures a function to be called for each burst of
3752 * packets received on a given NIC port queue. The return value is a pointer
3753 * that can be used to later remove the callback using
3754 * rte_eth_remove_rx_callback().
3756 * Multiple functions are called in the order that they are added.
3759 * The port identifier of the Ethernet device.
3761 * The queue on the Ethernet device on which the callback is to be added.
3763 * The callback function
3765 * A generic pointer parameter which will be passed to each invocation of the
3766 * callback function on this port and queue.
3770 * On success, a pointer value which can later be used to remove the callback.
3772 const struct rte_eth_rxtx_callback *
3773 rte_eth_add_rx_callback(uint16_t port_id, uint16_t queue_id,
3774 rte_rx_callback_fn fn, void *user_param);
3777 * Add a callback that must be called first on packet RX on a given port
3780 * This API configures a first function to be called for each burst of
3781 * packets received on a given NIC port queue. The return value is a pointer
3782 * that can be used to later remove the callback using
3783 * rte_eth_remove_rx_callback().
3785 * Multiple functions are called in the order that they are added.
3788 * The port identifier of the Ethernet device.
3790 * The queue on the Ethernet device on which the callback is to be added.
3792 * The callback function
3794 * A generic pointer parameter which will be passed to each invocation of the
3795 * callback function on this port and queue.
3799 * On success, a pointer value which can later be used to remove the callback.
3801 const struct rte_eth_rxtx_callback *
3802 rte_eth_add_first_rx_callback(uint16_t port_id, uint16_t queue_id,
3803 rte_rx_callback_fn fn, void *user_param);
3806 * Add a callback to be called on packet TX on a given port and queue.
3808 * This API configures a function to be called for each burst of
3809 * packets sent on a given NIC port queue. The return value is a pointer
3810 * that can be used to later remove the callback using
3811 * rte_eth_remove_tx_callback().
3813 * Multiple functions are called in the order that they are added.
3816 * The port identifier of the Ethernet device.
3818 * The queue on the Ethernet device on which the callback is to be added.
3820 * The callback function
3822 * A generic pointer parameter which will be passed to each invocation of the
3823 * callback function on this port and queue.
3827 * On success, a pointer value which can later be used to remove the callback.
3829 const struct rte_eth_rxtx_callback *
3830 rte_eth_add_tx_callback(uint16_t port_id, uint16_t queue_id,
3831 rte_tx_callback_fn fn, void *user_param);
3834 * Remove an RX packet callback from a given port and queue.
3836 * This function is used to removed callbacks that were added to a NIC port
3837 * queue using rte_eth_add_rx_callback().
3839 * Note: the callback is removed from the callback list but it isn't freed
3840 * since the it may still be in use. The memory for the callback can be
3841 * subsequently freed back by the application by calling rte_free():
3843 * - Immediately - if the port is stopped, or the user knows that no
3844 * callbacks are in flight e.g. if called from the thread doing RX/TX
3847 * - After a short delay - where the delay is sufficient to allow any
3848 * in-flight callbacks to complete.
3851 * The port identifier of the Ethernet device.
3853 * The queue on the Ethernet device from which the callback is to be removed.
3855 * User supplied callback created via rte_eth_add_rx_callback().
3858 * - 0: Success. Callback was removed.
3859 * - -ENOTSUP: Callback support is not available.
3860 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
3861 * is NULL or not found for the port/queue.
3863 int rte_eth_remove_rx_callback(uint16_t port_id, uint16_t queue_id,
3864 const struct rte_eth_rxtx_callback *user_cb);
3867 * Remove a TX packet callback from a given port and queue.
3869 * This function is used to removed callbacks that were added to a NIC port
3870 * queue using rte_eth_add_tx_callback().
3872 * Note: the callback is removed from the callback list but it isn't freed
3873 * since the it may still be in use. The memory for the callback can be
3874 * subsequently freed back by the application by calling rte_free():
3876 * - Immediately - if the port is stopped, or the user knows that no
3877 * callbacks are in flight e.g. if called from the thread doing RX/TX
3880 * - After a short delay - where the delay is sufficient to allow any
3881 * in-flight callbacks to complete.
3884 * The port identifier of the Ethernet device.
3886 * The queue on the Ethernet device from which the callback is to be removed.
3888 * User supplied callback created via rte_eth_add_tx_callback().
3891 * - 0: Success. Callback was removed.
3892 * - -ENOTSUP: Callback support is not available.
3893 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
3894 * is NULL or not found for the port/queue.
3896 int rte_eth_remove_tx_callback(uint16_t port_id, uint16_t queue_id,
3897 const struct rte_eth_rxtx_callback *user_cb);
3900 * Retrieve information about given port's RX queue.
3903 * The port identifier of the Ethernet device.
3905 * The RX queue on the Ethernet device for which information
3906 * will be retrieved.
3908 * A pointer to a structure of type *rte_eth_rxq_info_info* to be filled with
3909 * the information of the Ethernet device.
3913 * - -ENOTSUP: routine is not supported by the device PMD.
3914 * - -EINVAL: The port_id or the queue_id is out of range, or the queue
3917 int rte_eth_rx_queue_info_get(uint16_t port_id, uint16_t queue_id,
3918 struct rte_eth_rxq_info *qinfo);
3921 * Retrieve information about given port's TX queue.
3924 * The port identifier of the Ethernet device.
3926 * The TX queue on the Ethernet device for which information
3927 * will be retrieved.
3929 * A pointer to a structure of type *rte_eth_txq_info_info* to be filled with
3930 * the information of the Ethernet device.
3934 * - -ENOTSUP: routine is not supported by the device PMD.
3935 * - -EINVAL: The port_id or the queue_id is out of range, or the queue
3938 int rte_eth_tx_queue_info_get(uint16_t port_id, uint16_t queue_id,
3939 struct rte_eth_txq_info *qinfo);
3942 * Retrieve information about the Rx packet burst mode.
3945 * The port identifier of the Ethernet device.
3947 * The Rx queue on the Ethernet device for which information
3948 * will be retrieved.
3950 * A pointer to a structure of type *rte_eth_burst_mode* to be filled
3951 * with the information of the packet burst mode.
3955 * - -ENOTSUP: routine is not supported by the device PMD.
3956 * - -EINVAL: The port_id or the queue_id is out of range.
3959 int rte_eth_rx_burst_mode_get(uint16_t port_id, uint16_t queue_id,
3960 struct rte_eth_burst_mode *mode);
3963 * Retrieve information about the Tx packet burst mode.
3966 * The port identifier of the Ethernet device.
3968 * The Tx queue on the Ethernet device for which information
3969 * will be retrieved.
3971 * A pointer to a structure of type *rte_eth_burst_mode* to be filled
3972 * with the information of the packet burst mode.
3976 * - -ENOTSUP: routine is not supported by the device PMD.
3977 * - -EINVAL: The port_id or the queue_id is out of range.
3980 int rte_eth_tx_burst_mode_get(uint16_t port_id, uint16_t queue_id,
3981 struct rte_eth_burst_mode *mode);
3984 * Retrieve device registers and register attributes (number of registers and
3988 * The port identifier of the Ethernet device.
3990 * Pointer to rte_dev_reg_info structure to fill in. If info->data is
3991 * NULL the function fills in the width and length fields. If non-NULL
3992 * the registers are put into the buffer pointed at by the data field.
3994 * - (0) if successful.
3995 * - (-ENOTSUP) if hardware doesn't support.
3996 * - (-ENODEV) if *port_id* invalid.
3997 * - (-EIO) if device is removed.
3998 * - others depends on the specific operations implementation.
4000 int rte_eth_dev_get_reg_info(uint16_t port_id, struct rte_dev_reg_info *info);
4003 * Retrieve size of device EEPROM
4006 * The port identifier of the Ethernet device.
4008 * - (>=0) EEPROM size if successful.
4009 * - (-ENOTSUP) if hardware doesn't support.
4010 * - (-ENODEV) if *port_id* invalid.
4011 * - (-EIO) if device is removed.
4012 * - others depends on the specific operations implementation.
4014 int rte_eth_dev_get_eeprom_length(uint16_t port_id);
4017 * Retrieve EEPROM and EEPROM attribute
4020 * The port identifier of the Ethernet device.
4022 * The template includes buffer for return EEPROM data and
4023 * EEPROM attributes to be filled.
4025 * - (0) if successful.
4026 * - (-ENOTSUP) if hardware doesn't support.
4027 * - (-ENODEV) if *port_id* invalid.
4028 * - (-EIO) if device is removed.
4029 * - others depends on the specific operations implementation.
4031 int rte_eth_dev_get_eeprom(uint16_t port_id, struct rte_dev_eeprom_info *info);
4034 * Program EEPROM with provided data
4037 * The port identifier of the Ethernet device.
4039 * The template includes EEPROM data for programming and
4040 * EEPROM attributes to be filled
4042 * - (0) if successful.
4043 * - (-ENOTSUP) if hardware doesn't support.
4044 * - (-ENODEV) if *port_id* invalid.
4045 * - (-EIO) if device is removed.
4046 * - others depends on the specific operations implementation.
4048 int rte_eth_dev_set_eeprom(uint16_t port_id, struct rte_dev_eeprom_info *info);
4052 * @b EXPERIMENTAL: this API may change without prior notice.
4054 * Retrieve the type and size of plugin module EEPROM
4057 * The port identifier of the Ethernet device.
4059 * The type and size of plugin module EEPROM.
4061 * - (0) if successful.
4062 * - (-ENOTSUP) if hardware doesn't support.
4063 * - (-ENODEV) if *port_id* invalid.
4064 * - (-EIO) if device is removed.
4065 * - others depends on the specific operations implementation.
4069 rte_eth_dev_get_module_info(uint16_t port_id,
4070 struct rte_eth_dev_module_info *modinfo);
4074 * @b EXPERIMENTAL: this API may change without prior notice.
4076 * Retrieve the data of plugin module EEPROM
4079 * The port identifier of the Ethernet device.
4081 * The template includes the plugin module EEPROM attributes, and the
4082 * buffer for return plugin module EEPROM data.
4084 * - (0) if successful.
4085 * - (-ENOTSUP) if hardware doesn't support.
4086 * - (-ENODEV) if *port_id* invalid.
4087 * - (-EIO) if device is removed.
4088 * - others depends on the specific operations implementation.
4092 rte_eth_dev_get_module_eeprom(uint16_t port_id,
4093 struct rte_dev_eeprom_info *info);
4096 * Set the list of multicast addresses to filter on an Ethernet device.
4099 * The port identifier of the Ethernet device.
4100 * @param mc_addr_set
4101 * The array of multicast addresses to set. Equal to NULL when the function
4102 * is invoked to flush the set of filtered addresses.
4104 * The number of multicast addresses in the *mc_addr_set* array. Equal to 0
4105 * when the function is invoked to flush the set of filtered addresses.
4107 * - (0) if successful.
4108 * - (-ENODEV) if *port_id* invalid.
4109 * - (-EIO) if device is removed.
4110 * - (-ENOTSUP) if PMD of *port_id* doesn't support multicast filtering.
4111 * - (-ENOSPC) if *port_id* has not enough multicast filtering resources.
4113 int rte_eth_dev_set_mc_addr_list(uint16_t port_id,
4114 struct rte_ether_addr *mc_addr_set,
4115 uint32_t nb_mc_addr);
4118 * Enable IEEE1588/802.1AS timestamping for an Ethernet device.
4121 * The port identifier of the Ethernet device.
4125 * - -ENODEV: The port ID is invalid.
4126 * - -EIO: if device is removed.
4127 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4129 int rte_eth_timesync_enable(uint16_t port_id);
4132 * Disable IEEE1588/802.1AS timestamping for an Ethernet device.
4135 * The port identifier of the Ethernet device.
4139 * - -ENODEV: The port ID is invalid.
4140 * - -EIO: if device is removed.
4141 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4143 int rte_eth_timesync_disable(uint16_t port_id);
4146 * Read an IEEE1588/802.1AS RX timestamp from an Ethernet device.
4149 * The port identifier of the Ethernet device.
4151 * Pointer to the timestamp struct.
4153 * Device specific flags. Used to pass the RX timesync register index to
4154 * i40e. Unused in igb/ixgbe, pass 0 instead.
4158 * - -EINVAL: No timestamp is available.
4159 * - -ENODEV: The port ID is invalid.
4160 * - -EIO: if device is removed.
4161 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4163 int rte_eth_timesync_read_rx_timestamp(uint16_t port_id,
4164 struct timespec *timestamp, uint32_t flags);
4167 * Read an IEEE1588/802.1AS TX timestamp from an Ethernet device.
4170 * The port identifier of the Ethernet device.
4172 * Pointer to the timestamp struct.
4176 * - -EINVAL: No timestamp is available.
4177 * - -ENODEV: The port ID is invalid.
4178 * - -EIO: if device is removed.
4179 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4181 int rte_eth_timesync_read_tx_timestamp(uint16_t port_id,
4182 struct timespec *timestamp);
4185 * Adjust the timesync clock on an Ethernet device.
4187 * This is usually used in conjunction with other Ethdev timesync functions to
4188 * synchronize the device time using the IEEE1588/802.1AS protocol.
4191 * The port identifier of the Ethernet device.
4193 * The adjustment in nanoseconds.
4197 * - -ENODEV: The port ID is invalid.
4198 * - -EIO: if device is removed.
4199 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4201 int rte_eth_timesync_adjust_time(uint16_t port_id, int64_t delta);
4204 * Read the time from the timesync clock on an Ethernet device.
4206 * This is usually used in conjunction with other Ethdev timesync functions to
4207 * synchronize the device time using the IEEE1588/802.1AS protocol.
4210 * The port identifier of the Ethernet device.
4212 * Pointer to the timespec struct that holds the time.
4217 int rte_eth_timesync_read_time(uint16_t port_id, struct timespec *time);
4220 * Set the time of the timesync clock on an Ethernet device.
4222 * This is usually used in conjunction with other Ethdev timesync functions to
4223 * synchronize the device time using the IEEE1588/802.1AS protocol.
4226 * The port identifier of the Ethernet device.
4228 * Pointer to the timespec struct that holds the time.
4232 * - -EINVAL: No timestamp is available.
4233 * - -ENODEV: The port ID is invalid.
4234 * - -EIO: if device is removed.
4235 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4237 int rte_eth_timesync_write_time(uint16_t port_id, const struct timespec *time);
4241 * @b EXPERIMENTAL: this API may change without prior notice.
4243 * Read the current clock counter of an Ethernet device
4245 * This returns the current raw clock value of an Ethernet device. It is
4246 * a raw amount of ticks, with no given time reference.
4247 * The value returned here is from the same clock than the one
4248 * filling timestamp field of Rx packets when using hardware timestamp
4249 * offload. Therefore it can be used to compute a precise conversion of
4250 * the device clock to the real time.
4252 * E.g, a simple heuristic to derivate the frequency would be:
4253 * uint64_t start, end;
4254 * rte_eth_read_clock(port, start);
4255 * rte_delay_ms(100);
4256 * rte_eth_read_clock(port, end);
4257 * double freq = (end - start) * 10;
4259 * Compute a common reference with:
4260 * uint64_t base_time_sec = current_time();
4261 * uint64_t base_clock;
4262 * rte_eth_read_clock(port, base_clock);
4264 * Then, convert the raw mbuf timestamp with:
4265 * base_time_sec + (double)(mbuf->timestamp - base_clock) / freq;
4267 * This simple example will not provide a very good accuracy. One must
4268 * at least measure multiple times the frequency and do a regression.
4269 * To avoid deviation from the system time, the common reference can
4270 * be repeated from time to time. The integer division can also be
4271 * converted by a multiplication and a shift for better performance.
4274 * The port identifier of the Ethernet device.
4276 * Pointer to the uint64_t that holds the raw clock value.
4280 * - -ENODEV: The port ID is invalid.
4281 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4285 rte_eth_read_clock(uint16_t port_id, uint64_t *clock);
4288 * Config l2 tunnel ether type of an Ethernet device for filtering specific
4289 * tunnel packets by ether type.
4292 * The port identifier of the Ethernet device.
4294 * l2 tunnel configuration.
4297 * - (0) if successful.
4298 * - (-ENODEV) if port identifier is invalid.
4299 * - (-EIO) if device is removed.
4300 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4303 rte_eth_dev_l2_tunnel_eth_type_conf(uint16_t port_id,
4304 struct rte_eth_l2_tunnel_conf *l2_tunnel);
4307 * Enable/disable l2 tunnel offload functions. Include,
4308 * 1, The ability of parsing a type of l2 tunnel of an Ethernet device.
4309 * Filtering, forwarding and offloading this type of tunnel packets depend on
4311 * 2, Stripping the l2 tunnel tag.
4312 * 3, Insertion of the l2 tunnel tag.
4313 * 4, Forwarding the packets based on the l2 tunnel tag.
4316 * The port identifier of the Ethernet device.
4318 * l2 tunnel parameters.
4320 * Indicate the offload function.
4322 * Enable or disable this function.
4325 * - (0) if successful.
4326 * - (-ENODEV) if port identifier is invalid.
4327 * - (-EIO) if device is removed.
4328 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4331 rte_eth_dev_l2_tunnel_offload_set(uint16_t port_id,
4332 struct rte_eth_l2_tunnel_conf *l2_tunnel,
4337 * Get the port id from device name. The device name should be specified
4339 * - PCIe address (Domain:Bus:Device.Function), for example- 0000:2:00.0
4340 * - SoC device name, for example- fsl-gmac0
4341 * - vdev dpdk name, for example- net_[pcap0|null0|tap0]
4344 * pci address or name of the device
4346 * pointer to port identifier of the device
4348 * - (0) if successful and port_id is filled.
4349 * - (-ENODEV or -EINVAL) on failure.
4352 rte_eth_dev_get_port_by_name(const char *name, uint16_t *port_id);
4355 * Get the device name from port id. The device name is specified as below:
4356 * - PCIe address (Domain:Bus:Device.Function), for example- 0000:02:00.0
4357 * - SoC device name, for example- fsl-gmac0
4358 * - vdev dpdk name, for example- net_[pcap0|null0|tun0|tap0]
4361 * Port identifier of the device.
4363 * Buffer of size RTE_ETH_NAME_MAX_LEN to store the name.
4365 * - (0) if successful.
4366 * - (-EINVAL) on failure.
4369 rte_eth_dev_get_name_by_port(uint16_t port_id, char *name);
4372 * Check that numbers of Rx and Tx descriptors satisfy descriptors limits from
4373 * the ethernet device information, otherwise adjust them to boundaries.
4376 * The port identifier of the Ethernet device.
4378 * A pointer to a uint16_t where the number of receive
4379 * descriptors stored.
4381 * A pointer to a uint16_t where the number of transmit
4382 * descriptors stored.
4384 * - (0) if successful.
4385 * - (-ENOTSUP, -ENODEV or -EINVAL) on failure.
4387 int rte_eth_dev_adjust_nb_rx_tx_desc(uint16_t port_id,
4388 uint16_t *nb_rx_desc,
4389 uint16_t *nb_tx_desc);
4392 * Test if a port supports specific mempool ops.
4395 * Port identifier of the Ethernet device.
4397 * The name of the pool operations to test.
4399 * - 0: best mempool ops choice for this port.
4400 * - 1: mempool ops are supported for this port.
4401 * - -ENOTSUP: mempool ops not supported for this port.
4402 * - -ENODEV: Invalid port Identifier.
4403 * - -EINVAL: Pool param is null.
4406 rte_eth_dev_pool_ops_supported(uint16_t port_id, const char *pool);
4409 * Get the security context for the Ethernet device.
4412 * Port identifier of the Ethernet device
4415 * - pointer to security context on success.
4418 rte_eth_dev_get_sec_ctx(uint16_t port_id);
4422 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
4424 * Query the device hairpin capabilities.
4427 * The port identifier of the Ethernet device.
4429 * Pointer to a structure that will hold the hairpin capabilities.
4431 * - (0) if successful.
4432 * - (-ENOTSUP) if hardware doesn't support.
4435 int rte_eth_dev_hairpin_capability_get(uint16_t port_id,
4436 struct rte_eth_hairpin_cap *cap);
4438 #include <rte_ethdev_core.h>
4442 * Retrieve a burst of input packets from a receive queue of an Ethernet
4443 * device. The retrieved packets are stored in *rte_mbuf* structures whose
4444 * pointers are supplied in the *rx_pkts* array.
4446 * The rte_eth_rx_burst() function loops, parsing the RX ring of the
4447 * receive queue, up to *nb_pkts* packets, and for each completed RX
4448 * descriptor in the ring, it performs the following operations:
4450 * - Initialize the *rte_mbuf* data structure associated with the
4451 * RX descriptor according to the information provided by the NIC into
4452 * that RX descriptor.
4454 * - Store the *rte_mbuf* data structure into the next entry of the
4457 * - Replenish the RX descriptor with a new *rte_mbuf* buffer
4458 * allocated from the memory pool associated with the receive queue at
4459 * initialization time.
4461 * When retrieving an input packet that was scattered by the controller
4462 * into multiple receive descriptors, the rte_eth_rx_burst() function
4463 * appends the associated *rte_mbuf* buffers to the first buffer of the
4466 * The rte_eth_rx_burst() function returns the number of packets
4467 * actually retrieved, which is the number of *rte_mbuf* data structures
4468 * effectively supplied into the *rx_pkts* array.
4469 * A return value equal to *nb_pkts* indicates that the RX queue contained
4470 * at least *rx_pkts* packets, and this is likely to signify that other
4471 * received packets remain in the input queue. Applications implementing
4472 * a "retrieve as much received packets as possible" policy can check this
4473 * specific case and keep invoking the rte_eth_rx_burst() function until
4474 * a value less than *nb_pkts* is returned.
4476 * This receive method has the following advantages:
4478 * - It allows a run-to-completion network stack engine to retrieve and
4479 * to immediately process received packets in a fast burst-oriented
4480 * approach, avoiding the overhead of unnecessary intermediate packet
4481 * queue/dequeue operations.
4483 * - Conversely, it also allows an asynchronous-oriented processing
4484 * method to retrieve bursts of received packets and to immediately
4485 * queue them for further parallel processing by another logical core,
4486 * for instance. However, instead of having received packets being
4487 * individually queued by the driver, this approach allows the caller
4488 * of the rte_eth_rx_burst() function to queue a burst of retrieved
4489 * packets at a time and therefore dramatically reduce the cost of
4490 * enqueue/dequeue operations per packet.
4492 * - It allows the rte_eth_rx_burst() function of the driver to take
4493 * advantage of burst-oriented hardware features (CPU cache,
4494 * prefetch instructions, and so on) to minimize the number of CPU
4495 * cycles per packet.
4497 * To summarize, the proposed receive API enables many
4498 * burst-oriented optimizations in both synchronous and asynchronous
4499 * packet processing environments with no overhead in both cases.
4501 * The rte_eth_rx_burst() function does not provide any error
4502 * notification to avoid the corresponding overhead. As a hint, the
4503 * upper-level application might check the status of the device link once
4504 * being systematically returned a 0 value for a given number of tries.
4507 * The port identifier of the Ethernet device.
4509 * The index of the receive queue from which to retrieve input packets.
4510 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
4511 * to rte_eth_dev_configure().
4513 * The address of an array of pointers to *rte_mbuf* structures that
4514 * must be large enough to store *nb_pkts* pointers in it.
4516 * The maximum number of packets to retrieve.
4518 * The number of packets actually retrieved, which is the number
4519 * of pointers to *rte_mbuf* structures effectively supplied to the
4522 static inline uint16_t
4523 rte_eth_rx_burst(uint16_t port_id, uint16_t queue_id,
4524 struct rte_mbuf **rx_pkts, const uint16_t nb_pkts)
4526 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
4529 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4530 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
4531 RTE_FUNC_PTR_OR_ERR_RET(*dev->rx_pkt_burst, 0);
4533 if (queue_id >= dev->data->nb_rx_queues) {
4534 RTE_ETHDEV_LOG(ERR, "Invalid RX queue_id=%u\n", queue_id);
4538 nb_rx = (*dev->rx_pkt_burst)(dev->data->rx_queues[queue_id],
4541 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
4542 if (unlikely(dev->post_rx_burst_cbs[queue_id] != NULL)) {
4543 struct rte_eth_rxtx_callback *cb =
4544 dev->post_rx_burst_cbs[queue_id];
4547 nb_rx = cb->fn.rx(port_id, queue_id, rx_pkts, nb_rx,
4548 nb_pkts, cb->param);
4550 } while (cb != NULL);
4554 rte_ethdev_trace_rx_burst(port_id, queue_id, (void **)rx_pkts, nb_rx);
4559 * Get the number of used descriptors of a rx queue
4562 * The port identifier of the Ethernet device.
4564 * The queue id on the specific port.
4566 * The number of used descriptors in the specific queue, or:
4567 * (-EINVAL) if *port_id* or *queue_id* is invalid
4568 * (-ENOTSUP) if the device does not support this function
4571 rte_eth_rx_queue_count(uint16_t port_id, uint16_t queue_id)
4573 struct rte_eth_dev *dev;
4575 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -EINVAL);
4576 dev = &rte_eth_devices[port_id];
4577 RTE_FUNC_PTR_OR_ERR_RET(*dev->rx_queue_count, -ENOTSUP);
4578 if (queue_id >= dev->data->nb_rx_queues)
4581 return (int)(*dev->rx_queue_count)(dev, queue_id);
4585 * Check if the DD bit of the specific RX descriptor in the queue has been set
4588 * The port identifier of the Ethernet device.
4590 * The queue id on the specific port.
4592 * The offset of the descriptor ID from tail.
4594 * - (1) if the specific DD bit is set.
4595 * - (0) if the specific DD bit is not set.
4596 * - (-ENODEV) if *port_id* invalid.
4597 * - (-ENOTSUP) if the device does not support this function
4601 rte_eth_rx_descriptor_done(uint16_t port_id, uint16_t queue_id, uint16_t offset)
4603 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
4604 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
4605 RTE_FUNC_PTR_OR_ERR_RET(*dev->rx_descriptor_done, -ENOTSUP);
4606 return (*dev->rx_descriptor_done)(dev->data->rx_queues[queue_id], offset);
4609 #define RTE_ETH_RX_DESC_AVAIL 0 /**< Desc available for hw. */
4610 #define RTE_ETH_RX_DESC_DONE 1 /**< Desc done, filled by hw. */
4611 #define RTE_ETH_RX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */
4614 * Check the status of a Rx descriptor in the queue
4616 * It should be called in a similar context than the Rx function:
4617 * - on a dataplane core
4618 * - not concurrently on the same queue
4620 * Since it's a dataplane function, no check is performed on port_id and
4621 * queue_id. The caller must therefore ensure that the port is enabled
4622 * and the queue is configured and running.
4624 * Note: accessing to a random descriptor in the ring may trigger cache
4625 * misses and have a performance impact.
4628 * A valid port identifier of the Ethernet device which.
4630 * A valid Rx queue identifier on this port.
4632 * The offset of the descriptor starting from tail (0 is the next
4633 * packet to be received by the driver).
4636 * - (RTE_ETH_RX_DESC_AVAIL): Descriptor is available for the hardware to
4638 * - (RTE_ETH_RX_DESC_DONE): Descriptor is done, it is filled by hw, but
4639 * not yet processed by the driver (i.e. in the receive queue).
4640 * - (RTE_ETH_RX_DESC_UNAVAIL): Descriptor is unavailable, either hold by
4641 * the driver and not yet returned to hw, or reserved by the hw.
4642 * - (-EINVAL) bad descriptor offset.
4643 * - (-ENOTSUP) if the device does not support this function.
4644 * - (-ENODEV) bad port or queue (only if compiled with debug).
4647 rte_eth_rx_descriptor_status(uint16_t port_id, uint16_t queue_id,
4650 struct rte_eth_dev *dev;
4653 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4654 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
4656 dev = &rte_eth_devices[port_id];
4657 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4658 if (queue_id >= dev->data->nb_rx_queues)
4661 RTE_FUNC_PTR_OR_ERR_RET(*dev->rx_descriptor_status, -ENOTSUP);
4662 rxq = dev->data->rx_queues[queue_id];
4664 return (*dev->rx_descriptor_status)(rxq, offset);
4667 #define RTE_ETH_TX_DESC_FULL 0 /**< Desc filled for hw, waiting xmit. */
4668 #define RTE_ETH_TX_DESC_DONE 1 /**< Desc done, packet is transmitted. */
4669 #define RTE_ETH_TX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */
4672 * Check the status of a Tx descriptor in the queue.
4674 * It should be called in a similar context than the Tx function:
4675 * - on a dataplane core
4676 * - not concurrently on the same queue
4678 * Since it's a dataplane function, no check is performed on port_id and
4679 * queue_id. The caller must therefore ensure that the port is enabled
4680 * and the queue is configured and running.
4682 * Note: accessing to a random descriptor in the ring may trigger cache
4683 * misses and have a performance impact.
4686 * A valid port identifier of the Ethernet device which.
4688 * A valid Tx queue identifier on this port.
4690 * The offset of the descriptor starting from tail (0 is the place where
4691 * the next packet will be send).
4694 * - (RTE_ETH_TX_DESC_FULL) Descriptor is being processed by the hw, i.e.
4695 * in the transmit queue.
4696 * - (RTE_ETH_TX_DESC_DONE) Hardware is done with this descriptor, it can
4697 * be reused by the driver.
4698 * - (RTE_ETH_TX_DESC_UNAVAIL): Descriptor is unavailable, reserved by the
4699 * driver or the hardware.
4700 * - (-EINVAL) bad descriptor offset.
4701 * - (-ENOTSUP) if the device does not support this function.
4702 * - (-ENODEV) bad port or queue (only if compiled with debug).
4704 static inline int rte_eth_tx_descriptor_status(uint16_t port_id,
4705 uint16_t queue_id, uint16_t offset)
4707 struct rte_eth_dev *dev;
4710 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4711 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
4713 dev = &rte_eth_devices[port_id];
4714 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4715 if (queue_id >= dev->data->nb_tx_queues)
4718 RTE_FUNC_PTR_OR_ERR_RET(*dev->tx_descriptor_status, -ENOTSUP);
4719 txq = dev->data->tx_queues[queue_id];
4721 return (*dev->tx_descriptor_status)(txq, offset);
4725 * Send a burst of output packets on a transmit queue of an Ethernet device.
4727 * The rte_eth_tx_burst() function is invoked to transmit output packets
4728 * on the output queue *queue_id* of the Ethernet device designated by its
4730 * The *nb_pkts* parameter is the number of packets to send which are
4731 * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
4732 * allocated from a pool created with rte_pktmbuf_pool_create().
4733 * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
4734 * up to the number of transmit descriptors available in the TX ring of the
4736 * For each packet to send, the rte_eth_tx_burst() function performs
4737 * the following operations:
4739 * - Pick up the next available descriptor in the transmit ring.
4741 * - Free the network buffer previously sent with that descriptor, if any.
4743 * - Initialize the transmit descriptor with the information provided
4744 * in the *rte_mbuf data structure.
4746 * In the case of a segmented packet composed of a list of *rte_mbuf* buffers,
4747 * the rte_eth_tx_burst() function uses several transmit descriptors
4750 * The rte_eth_tx_burst() function returns the number of packets it
4751 * actually sent. A return value equal to *nb_pkts* means that all packets
4752 * have been sent, and this is likely to signify that other output packets
4753 * could be immediately transmitted again. Applications that implement a
4754 * "send as many packets to transmit as possible" policy can check this
4755 * specific case and keep invoking the rte_eth_tx_burst() function until
4756 * a value less than *nb_pkts* is returned.
4758 * It is the responsibility of the rte_eth_tx_burst() function to
4759 * transparently free the memory buffers of packets previously sent.
4760 * This feature is driven by the *tx_free_thresh* value supplied to the
4761 * rte_eth_dev_configure() function at device configuration time.
4762 * When the number of free TX descriptors drops below this threshold, the
4763 * rte_eth_tx_burst() function must [attempt to] free the *rte_mbuf* buffers
4764 * of those packets whose transmission was effectively completed.
4766 * If the PMD is DEV_TX_OFFLOAD_MT_LOCKFREE capable, multiple threads can
4767 * invoke this function concurrently on the same tx queue without SW lock.
4768 * @see rte_eth_dev_info_get, struct rte_eth_txconf::offloads
4770 * @see rte_eth_tx_prepare to perform some prior checks or adjustments
4774 * The port identifier of the Ethernet device.
4776 * The index of the transmit queue through which output packets must be
4778 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
4779 * to rte_eth_dev_configure().
4781 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
4782 * which contain the output packets.
4784 * The maximum number of packets to transmit.
4786 * The number of output packets actually stored in transmit descriptors of
4787 * the transmit ring. The return value can be less than the value of the
4788 * *tx_pkts* parameter when the transmit ring is full or has been filled up.
4790 static inline uint16_t
4791 rte_eth_tx_burst(uint16_t port_id, uint16_t queue_id,
4792 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
4794 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
4796 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4797 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
4798 RTE_FUNC_PTR_OR_ERR_RET(*dev->tx_pkt_burst, 0);
4800 if (queue_id >= dev->data->nb_tx_queues) {
4801 RTE_ETHDEV_LOG(ERR, "Invalid TX queue_id=%u\n", queue_id);
4806 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
4807 struct rte_eth_rxtx_callback *cb = dev->pre_tx_burst_cbs[queue_id];
4809 if (unlikely(cb != NULL)) {
4811 nb_pkts = cb->fn.tx(port_id, queue_id, tx_pkts, nb_pkts,
4814 } while (cb != NULL);
4818 rte_ethdev_trace_tx_burst(port_id, queue_id, (void **)tx_pkts,
4820 return (*dev->tx_pkt_burst)(dev->data->tx_queues[queue_id], tx_pkts, nb_pkts);
4824 * Process a burst of output packets on a transmit queue of an Ethernet device.
4826 * The rte_eth_tx_prepare() function is invoked to prepare output packets to be
4827 * transmitted on the output queue *queue_id* of the Ethernet device designated
4829 * The *nb_pkts* parameter is the number of packets to be prepared which are
4830 * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
4831 * allocated from a pool created with rte_pktmbuf_pool_create().
4832 * For each packet to send, the rte_eth_tx_prepare() function performs
4833 * the following operations:
4835 * - Check if packet meets devices requirements for tx offloads.
4837 * - Check limitations about number of segments.
4839 * - Check additional requirements when debug is enabled.
4841 * - Update and/or reset required checksums when tx offload is set for packet.
4843 * Since this function can modify packet data, provided mbufs must be safely
4844 * writable (e.g. modified data cannot be in shared segment).
4846 * The rte_eth_tx_prepare() function returns the number of packets ready to be
4847 * sent. A return value equal to *nb_pkts* means that all packets are valid and
4848 * ready to be sent, otherwise stops processing on the first invalid packet and
4849 * leaves the rest packets untouched.
4851 * When this functionality is not implemented in the driver, all packets are
4852 * are returned untouched.
4855 * The port identifier of the Ethernet device.
4856 * The value must be a valid port id.
4858 * The index of the transmit queue through which output packets must be
4860 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
4861 * to rte_eth_dev_configure().
4863 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
4864 * which contain the output packets.
4866 * The maximum number of packets to process.
4868 * The number of packets correct and ready to be sent. The return value can be
4869 * less than the value of the *tx_pkts* parameter when some packet doesn't
4870 * meet devices requirements with rte_errno set appropriately:
4871 * - EINVAL: offload flags are not correctly set
4872 * - ENOTSUP: the offload feature is not supported by the hardware
4876 #ifndef RTE_ETHDEV_TX_PREPARE_NOOP
4878 static inline uint16_t
4879 rte_eth_tx_prepare(uint16_t port_id, uint16_t queue_id,
4880 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
4882 struct rte_eth_dev *dev;
4884 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4885 if (!rte_eth_dev_is_valid_port(port_id)) {
4886 RTE_ETHDEV_LOG(ERR, "Invalid TX port_id=%u\n", port_id);
4892 dev = &rte_eth_devices[port_id];
4894 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4895 if (queue_id >= dev->data->nb_tx_queues) {
4896 RTE_ETHDEV_LOG(ERR, "Invalid TX queue_id=%u\n", queue_id);
4902 if (!dev->tx_pkt_prepare)
4905 return (*dev->tx_pkt_prepare)(dev->data->tx_queues[queue_id],
4912 * Native NOOP operation for compilation targets which doesn't require any
4913 * preparations steps, and functional NOOP may introduce unnecessary performance
4916 * Generally this is not a good idea to turn it on globally and didn't should
4917 * be used if behavior of tx_preparation can change.
4920 static inline uint16_t
4921 rte_eth_tx_prepare(__rte_unused uint16_t port_id,
4922 __rte_unused uint16_t queue_id,
4923 __rte_unused struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
4931 * Send any packets queued up for transmission on a port and HW queue
4933 * This causes an explicit flush of packets previously buffered via the
4934 * rte_eth_tx_buffer() function. It returns the number of packets successfully
4935 * sent to the NIC, and calls the error callback for any unsent packets. Unless
4936 * explicitly set up otherwise, the default callback simply frees the unsent
4937 * packets back to the owning mempool.
4940 * The port identifier of the Ethernet device.
4942 * The index of the transmit queue through which output packets must be
4944 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
4945 * to rte_eth_dev_configure().
4947 * Buffer of packets to be transmit.
4949 * The number of packets successfully sent to the Ethernet device. The error
4950 * callback is called for any packets which could not be sent.
4952 static inline uint16_t
4953 rte_eth_tx_buffer_flush(uint16_t port_id, uint16_t queue_id,
4954 struct rte_eth_dev_tx_buffer *buffer)
4957 uint16_t to_send = buffer->length;
4962 sent = rte_eth_tx_burst(port_id, queue_id, buffer->pkts, to_send);
4966 /* All packets sent, or to be dealt with by callback below */
4967 if (unlikely(sent != to_send))
4968 buffer->error_callback(&buffer->pkts[sent],
4969 (uint16_t)(to_send - sent),
4970 buffer->error_userdata);
4976 * Buffer a single packet for future transmission on a port and queue
4978 * This function takes a single mbuf/packet and buffers it for later
4979 * transmission on the particular port and queue specified. Once the buffer is
4980 * full of packets, an attempt will be made to transmit all the buffered
4981 * packets. In case of error, where not all packets can be transmitted, a
4982 * callback is called with the unsent packets as a parameter. If no callback
4983 * is explicitly set up, the unsent packets are just freed back to the owning
4984 * mempool. The function returns the number of packets actually sent i.e.
4985 * 0 if no buffer flush occurred, otherwise the number of packets successfully
4989 * The port identifier of the Ethernet device.
4991 * The index of the transmit queue through which output packets must be
4993 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
4994 * to rte_eth_dev_configure().
4996 * Buffer used to collect packets to be sent.
4998 * Pointer to the packet mbuf to be sent.
5000 * 0 = packet has been buffered for later transmission
5001 * N > 0 = packet has been buffered, and the buffer was subsequently flushed,
5002 * causing N packets to be sent, and the error callback to be called for
5005 static __rte_always_inline uint16_t
5006 rte_eth_tx_buffer(uint16_t port_id, uint16_t queue_id,
5007 struct rte_eth_dev_tx_buffer *buffer, struct rte_mbuf *tx_pkt)
5009 buffer->pkts[buffer->length++] = tx_pkt;
5010 if (buffer->length < buffer->size)
5013 return rte_eth_tx_buffer_flush(port_id, queue_id, buffer);
5020 #endif /* _RTE_ETHDEV_H_ */