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>
160 #include "rte_ether.h"
161 #include "rte_dev_info.h"
163 extern int rte_eth_dev_logtype;
165 #define RTE_ETHDEV_LOG(level, ...) \
166 rte_log(RTE_LOG_ ## level, rte_eth_dev_logtype, "" __VA_ARGS__)
171 * Initializes a device iterator.
173 * This iterator allows accessing a list of devices matching some devargs.
176 * Device iterator handle initialized by the function.
177 * The fields bus_str and cls_str might be dynamically allocated,
178 * and could be freed by calling rte_eth_iterator_cleanup().
181 * Device description string.
184 * 0 on successful initialization, negative otherwise.
186 int rte_eth_iterator_init(struct rte_dev_iterator *iter, const char *devargs);
189 * Iterates on devices with devargs filter.
190 * The ownership is not checked.
192 * The next port id is returned, and the iterator is updated.
195 * Device iterator handle initialized by rte_eth_iterator_init().
196 * Some fields bus_str and cls_str might be freed when no more port is found,
197 * by calling rte_eth_iterator_cleanup().
200 * A port id if found, RTE_MAX_ETHPORTS otherwise.
202 uint16_t rte_eth_iterator_next(struct rte_dev_iterator *iter);
205 * Free some allocated fields of the iterator.
207 * This function is automatically called by rte_eth_iterator_next()
208 * on the last iteration (i.e. when no more matching port is found).
210 * It is safe to call this function twice; it will do nothing more.
213 * Device iterator handle initialized by rte_eth_iterator_init().
214 * The fields bus_str and cls_str are freed if needed.
216 void rte_eth_iterator_cleanup(struct rte_dev_iterator *iter);
219 * Macro to iterate over all ethdev ports matching some devargs.
221 * If a break is done before the end of the loop,
222 * the function rte_eth_iterator_cleanup() must be called.
225 * Iterated port id of type uint16_t.
227 * Device parameters input as string of type char*.
229 * Iterator handle of type struct rte_dev_iterator, used internally.
231 #define RTE_ETH_FOREACH_MATCHING_DEV(id, devargs, iter) \
232 for (rte_eth_iterator_init(iter, devargs), \
233 id = rte_eth_iterator_next(iter); \
234 id != RTE_MAX_ETHPORTS; \
235 id = rte_eth_iterator_next(iter))
238 * A structure used to retrieve statistics for an Ethernet port.
239 * Not all statistics fields in struct rte_eth_stats are supported
240 * by any type of network interface card (NIC). If any statistics
241 * field is not supported, its value is 0.
243 struct rte_eth_stats {
244 uint64_t ipackets; /**< Total number of successfully received packets. */
245 uint64_t opackets; /**< Total number of successfully transmitted packets.*/
246 uint64_t ibytes; /**< Total number of successfully received bytes. */
247 uint64_t obytes; /**< Total number of successfully transmitted bytes. */
249 /**< Total of RX packets dropped by the HW,
250 * because there are no available buffer (i.e. RX queues are full).
252 uint64_t ierrors; /**< Total number of erroneous received packets. */
253 uint64_t oerrors; /**< Total number of failed transmitted packets. */
254 uint64_t rx_nombuf; /**< Total number of RX mbuf allocation failures. */
255 uint64_t q_ipackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
256 /**< Total number of queue RX packets. */
257 uint64_t q_opackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
258 /**< Total number of queue TX packets. */
259 uint64_t q_ibytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
260 /**< Total number of successfully received queue bytes. */
261 uint64_t q_obytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
262 /**< Total number of successfully transmitted queue bytes. */
263 uint64_t q_errors[RTE_ETHDEV_QUEUE_STAT_CNTRS];
264 /**< Total number of queue packets received that are dropped. */
268 * Device supported speeds bitmap flags
270 #define ETH_LINK_SPEED_AUTONEG (0 << 0) /**< Autonegotiate (all speeds) */
271 #define ETH_LINK_SPEED_FIXED (1 << 0) /**< Disable autoneg (fixed speed) */
272 #define ETH_LINK_SPEED_10M_HD (1 << 1) /**< 10 Mbps half-duplex */
273 #define ETH_LINK_SPEED_10M (1 << 2) /**< 10 Mbps full-duplex */
274 #define ETH_LINK_SPEED_100M_HD (1 << 3) /**< 100 Mbps half-duplex */
275 #define ETH_LINK_SPEED_100M (1 << 4) /**< 100 Mbps full-duplex */
276 #define ETH_LINK_SPEED_1G (1 << 5) /**< 1 Gbps */
277 #define ETH_LINK_SPEED_2_5G (1 << 6) /**< 2.5 Gbps */
278 #define ETH_LINK_SPEED_5G (1 << 7) /**< 5 Gbps */
279 #define ETH_LINK_SPEED_10G (1 << 8) /**< 10 Gbps */
280 #define ETH_LINK_SPEED_20G (1 << 9) /**< 20 Gbps */
281 #define ETH_LINK_SPEED_25G (1 << 10) /**< 25 Gbps */
282 #define ETH_LINK_SPEED_40G (1 << 11) /**< 40 Gbps */
283 #define ETH_LINK_SPEED_50G (1 << 12) /**< 50 Gbps */
284 #define ETH_LINK_SPEED_56G (1 << 13) /**< 56 Gbps */
285 #define ETH_LINK_SPEED_100G (1 << 14) /**< 100 Gbps */
288 * Ethernet numeric link speeds in Mbps
290 #define ETH_SPEED_NUM_NONE 0 /**< Not defined */
291 #define ETH_SPEED_NUM_10M 10 /**< 10 Mbps */
292 #define ETH_SPEED_NUM_100M 100 /**< 100 Mbps */
293 #define ETH_SPEED_NUM_1G 1000 /**< 1 Gbps */
294 #define ETH_SPEED_NUM_2_5G 2500 /**< 2.5 Gbps */
295 #define ETH_SPEED_NUM_5G 5000 /**< 5 Gbps */
296 #define ETH_SPEED_NUM_10G 10000 /**< 10 Gbps */
297 #define ETH_SPEED_NUM_20G 20000 /**< 20 Gbps */
298 #define ETH_SPEED_NUM_25G 25000 /**< 25 Gbps */
299 #define ETH_SPEED_NUM_40G 40000 /**< 40 Gbps */
300 #define ETH_SPEED_NUM_50G 50000 /**< 50 Gbps */
301 #define ETH_SPEED_NUM_56G 56000 /**< 56 Gbps */
302 #define ETH_SPEED_NUM_100G 100000 /**< 100 Gbps */
305 * A structure used to retrieve link-level information of an Ethernet port.
308 struct rte_eth_link {
309 uint32_t link_speed; /**< ETH_SPEED_NUM_ */
310 uint16_t link_duplex : 1; /**< ETH_LINK_[HALF/FULL]_DUPLEX */
311 uint16_t link_autoneg : 1; /**< ETH_LINK_[AUTONEG/FIXED] */
312 uint16_t link_status : 1; /**< ETH_LINK_[DOWN/UP] */
313 } __attribute__((aligned(8))); /**< aligned for atomic64 read/write */
315 /* Utility constants */
316 #define ETH_LINK_HALF_DUPLEX 0 /**< Half-duplex connection (see link_duplex). */
317 #define ETH_LINK_FULL_DUPLEX 1 /**< Full-duplex connection (see link_duplex). */
318 #define ETH_LINK_DOWN 0 /**< Link is down (see link_status). */
319 #define ETH_LINK_UP 1 /**< Link is up (see link_status). */
320 #define ETH_LINK_FIXED 0 /**< No autonegotiation (see link_autoneg). */
321 #define ETH_LINK_AUTONEG 1 /**< Autonegotiated (see link_autoneg). */
324 * A structure used to configure the ring threshold registers of an RX/TX
325 * queue for an Ethernet port.
327 struct rte_eth_thresh {
328 uint8_t pthresh; /**< Ring prefetch threshold. */
329 uint8_t hthresh; /**< Ring host threshold. */
330 uint8_t wthresh; /**< Ring writeback threshold. */
334 * Simple flags are used for rte_eth_conf.rxmode.mq_mode.
336 #define ETH_MQ_RX_RSS_FLAG 0x1
337 #define ETH_MQ_RX_DCB_FLAG 0x2
338 #define ETH_MQ_RX_VMDQ_FLAG 0x4
341 * A set of values to identify what method is to be used to route
342 * packets to multiple queues.
344 enum rte_eth_rx_mq_mode {
345 /** None of DCB,RSS or VMDQ mode */
348 /** For RX side, only RSS is on */
349 ETH_MQ_RX_RSS = ETH_MQ_RX_RSS_FLAG,
350 /** For RX side,only DCB is on. */
351 ETH_MQ_RX_DCB = ETH_MQ_RX_DCB_FLAG,
352 /** Both DCB and RSS enable */
353 ETH_MQ_RX_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG,
355 /** Only VMDQ, no RSS nor DCB */
356 ETH_MQ_RX_VMDQ_ONLY = ETH_MQ_RX_VMDQ_FLAG,
357 /** RSS mode with VMDQ */
358 ETH_MQ_RX_VMDQ_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_VMDQ_FLAG,
359 /** Use VMDQ+DCB to route traffic to queues */
360 ETH_MQ_RX_VMDQ_DCB = ETH_MQ_RX_VMDQ_FLAG | ETH_MQ_RX_DCB_FLAG,
361 /** Enable both VMDQ and DCB in VMDq */
362 ETH_MQ_RX_VMDQ_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG |
367 * for rx mq mode backward compatible
369 #define ETH_RSS ETH_MQ_RX_RSS
370 #define VMDQ_DCB ETH_MQ_RX_VMDQ_DCB
371 #define ETH_DCB_RX ETH_MQ_RX_DCB
374 * A set of values to identify what method is to be used to transmit
375 * packets using multi-TCs.
377 enum rte_eth_tx_mq_mode {
378 ETH_MQ_TX_NONE = 0, /**< It is in neither DCB nor VT mode. */
379 ETH_MQ_TX_DCB, /**< For TX side,only DCB is on. */
380 ETH_MQ_TX_VMDQ_DCB, /**< For TX side,both DCB and VT is on. */
381 ETH_MQ_TX_VMDQ_ONLY, /**< Only VT on, no DCB */
385 * for tx mq mode backward compatible
387 #define ETH_DCB_NONE ETH_MQ_TX_NONE
388 #define ETH_VMDQ_DCB_TX ETH_MQ_TX_VMDQ_DCB
389 #define ETH_DCB_TX ETH_MQ_TX_DCB
392 * A structure used to configure the RX features of an Ethernet port.
394 struct rte_eth_rxmode {
395 /** The multi-queue packet distribution mode to be used, e.g. RSS. */
396 enum rte_eth_rx_mq_mode mq_mode;
397 uint32_t max_rx_pkt_len; /**< Only used if JUMBO_FRAME enabled. */
398 uint16_t split_hdr_size; /**< hdr buf size (header_split enabled).*/
400 * Per-port Rx offloads to be set using DEV_RX_OFFLOAD_* flags.
401 * Only offloads set on rx_offload_capa field on rte_eth_dev_info
402 * structure are allowed to be set.
408 * VLAN types to indicate if it is for single VLAN, inner VLAN or outer VLAN.
409 * Note that single VLAN is treated the same as inner VLAN.
412 ETH_VLAN_TYPE_UNKNOWN = 0,
413 ETH_VLAN_TYPE_INNER, /**< Inner VLAN. */
414 ETH_VLAN_TYPE_OUTER, /**< Single VLAN, or outer VLAN. */
419 * A structure used to describe a vlan filter.
420 * If the bit corresponding to a VID is set, such VID is on.
422 struct rte_vlan_filter_conf {
427 * A structure used to configure the Receive Side Scaling (RSS) feature
428 * of an Ethernet port.
429 * If not NULL, the *rss_key* pointer of the *rss_conf* structure points
430 * to an array holding the RSS key to use for hashing specific header
431 * fields of received packets. The length of this array should be indicated
432 * by *rss_key_len* below. Otherwise, a default random hash key is used by
435 * The *rss_key_len* field of the *rss_conf* structure indicates the length
436 * in bytes of the array pointed by *rss_key*. To be compatible, this length
437 * will be checked in i40e only. Others assume 40 bytes to be used as before.
439 * The *rss_hf* field of the *rss_conf* structure indicates the different
440 * types of IPv4/IPv6 packets to which the RSS hashing must be applied.
441 * Supplying an *rss_hf* equal to zero disables the RSS feature.
443 struct rte_eth_rss_conf {
444 uint8_t *rss_key; /**< If not NULL, 40-byte hash key. */
445 uint8_t rss_key_len; /**< hash key length in bytes. */
446 uint64_t rss_hf; /**< Hash functions to apply - see below. */
450 * A packet can be identified by hardware as different flow types. Different
451 * NIC hardware may support different flow types.
452 * Basically, the NIC hardware identifies the flow type as deep protocol as
453 * possible, and exclusively. For example, if a packet is identified as
454 * 'RTE_ETH_FLOW_NONFRAG_IPV4_TCP', it will not be any of other flow types,
455 * though it is an actual IPV4 packet.
456 * Note that the flow types are used to define RSS offload types.
458 #define RTE_ETH_FLOW_UNKNOWN 0
459 #define RTE_ETH_FLOW_RAW 1
460 #define RTE_ETH_FLOW_IPV4 2
461 #define RTE_ETH_FLOW_FRAG_IPV4 3
462 #define RTE_ETH_FLOW_NONFRAG_IPV4_TCP 4
463 #define RTE_ETH_FLOW_NONFRAG_IPV4_UDP 5
464 #define RTE_ETH_FLOW_NONFRAG_IPV4_SCTP 6
465 #define RTE_ETH_FLOW_NONFRAG_IPV4_OTHER 7
466 #define RTE_ETH_FLOW_IPV6 8
467 #define RTE_ETH_FLOW_FRAG_IPV6 9
468 #define RTE_ETH_FLOW_NONFRAG_IPV6_TCP 10
469 #define RTE_ETH_FLOW_NONFRAG_IPV6_UDP 11
470 #define RTE_ETH_FLOW_NONFRAG_IPV6_SCTP 12
471 #define RTE_ETH_FLOW_NONFRAG_IPV6_OTHER 13
472 #define RTE_ETH_FLOW_L2_PAYLOAD 14
473 #define RTE_ETH_FLOW_IPV6_EX 15
474 #define RTE_ETH_FLOW_IPV6_TCP_EX 16
475 #define RTE_ETH_FLOW_IPV6_UDP_EX 17
476 #define RTE_ETH_FLOW_PORT 18
477 /**< Consider device port number as a flow differentiator */
478 #define RTE_ETH_FLOW_VXLAN 19 /**< VXLAN protocol based flow */
479 #define RTE_ETH_FLOW_GENEVE 20 /**< GENEVE protocol based flow */
480 #define RTE_ETH_FLOW_NVGRE 21 /**< NVGRE protocol based flow */
481 #define RTE_ETH_FLOW_VXLAN_GPE 22 /**< VXLAN-GPE protocol based flow */
482 #define RTE_ETH_FLOW_MAX 23
485 * The RSS offload types are defined based on flow types.
486 * Different NIC hardware may support different RSS offload
487 * types. The supported flow types or RSS offload types can be queried by
488 * rte_eth_dev_info_get().
490 #define ETH_RSS_IPV4 (1ULL << RTE_ETH_FLOW_IPV4)
491 #define ETH_RSS_FRAG_IPV4 (1ULL << RTE_ETH_FLOW_FRAG_IPV4)
492 #define ETH_RSS_NONFRAG_IPV4_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_TCP)
493 #define ETH_RSS_NONFRAG_IPV4_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_UDP)
494 #define ETH_RSS_NONFRAG_IPV4_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_SCTP)
495 #define ETH_RSS_NONFRAG_IPV4_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_OTHER)
496 #define ETH_RSS_IPV6 (1ULL << RTE_ETH_FLOW_IPV6)
497 #define ETH_RSS_FRAG_IPV6 (1ULL << RTE_ETH_FLOW_FRAG_IPV6)
498 #define ETH_RSS_NONFRAG_IPV6_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_TCP)
499 #define ETH_RSS_NONFRAG_IPV6_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_UDP)
500 #define ETH_RSS_NONFRAG_IPV6_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_SCTP)
501 #define ETH_RSS_NONFRAG_IPV6_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_OTHER)
502 #define ETH_RSS_L2_PAYLOAD (1ULL << RTE_ETH_FLOW_L2_PAYLOAD)
503 #define ETH_RSS_IPV6_EX (1ULL << RTE_ETH_FLOW_IPV6_EX)
504 #define ETH_RSS_IPV6_TCP_EX (1ULL << RTE_ETH_FLOW_IPV6_TCP_EX)
505 #define ETH_RSS_IPV6_UDP_EX (1ULL << RTE_ETH_FLOW_IPV6_UDP_EX)
506 #define ETH_RSS_PORT (1ULL << RTE_ETH_FLOW_PORT)
507 #define ETH_RSS_VXLAN (1ULL << RTE_ETH_FLOW_VXLAN)
508 #define ETH_RSS_GENEVE (1ULL << RTE_ETH_FLOW_GENEVE)
509 #define ETH_RSS_NVGRE (1ULL << RTE_ETH_FLOW_NVGRE)
511 #define ETH_RSS_IP ( \
513 ETH_RSS_FRAG_IPV4 | \
514 ETH_RSS_NONFRAG_IPV4_OTHER | \
516 ETH_RSS_FRAG_IPV6 | \
517 ETH_RSS_NONFRAG_IPV6_OTHER | \
520 #define ETH_RSS_UDP ( \
521 ETH_RSS_NONFRAG_IPV4_UDP | \
522 ETH_RSS_NONFRAG_IPV6_UDP | \
525 #define ETH_RSS_TCP ( \
526 ETH_RSS_NONFRAG_IPV4_TCP | \
527 ETH_RSS_NONFRAG_IPV6_TCP | \
530 #define ETH_RSS_SCTP ( \
531 ETH_RSS_NONFRAG_IPV4_SCTP | \
532 ETH_RSS_NONFRAG_IPV6_SCTP)
534 #define ETH_RSS_TUNNEL ( \
539 /**< Mask of valid RSS hash protocols */
540 #define ETH_RSS_PROTO_MASK ( \
542 ETH_RSS_FRAG_IPV4 | \
543 ETH_RSS_NONFRAG_IPV4_TCP | \
544 ETH_RSS_NONFRAG_IPV4_UDP | \
545 ETH_RSS_NONFRAG_IPV4_SCTP | \
546 ETH_RSS_NONFRAG_IPV4_OTHER | \
548 ETH_RSS_FRAG_IPV6 | \
549 ETH_RSS_NONFRAG_IPV6_TCP | \
550 ETH_RSS_NONFRAG_IPV6_UDP | \
551 ETH_RSS_NONFRAG_IPV6_SCTP | \
552 ETH_RSS_NONFRAG_IPV6_OTHER | \
553 ETH_RSS_L2_PAYLOAD | \
555 ETH_RSS_IPV6_TCP_EX | \
556 ETH_RSS_IPV6_UDP_EX | \
563 * Definitions used for redirection table entry size.
564 * Some RSS RETA sizes may not be supported by some drivers, check the
565 * documentation or the description of relevant functions for more details.
567 #define ETH_RSS_RETA_SIZE_64 64
568 #define ETH_RSS_RETA_SIZE_128 128
569 #define ETH_RSS_RETA_SIZE_256 256
570 #define ETH_RSS_RETA_SIZE_512 512
571 #define RTE_RETA_GROUP_SIZE 64
573 /* Definitions used for VMDQ and DCB functionality */
574 #define ETH_VMDQ_MAX_VLAN_FILTERS 64 /**< Maximum nb. of VMDQ vlan filters. */
575 #define ETH_DCB_NUM_USER_PRIORITIES 8 /**< Maximum nb. of DCB priorities. */
576 #define ETH_VMDQ_DCB_NUM_QUEUES 128 /**< Maximum nb. of VMDQ DCB queues. */
577 #define ETH_DCB_NUM_QUEUES 128 /**< Maximum nb. of DCB queues. */
579 /* DCB capability defines */
580 #define ETH_DCB_PG_SUPPORT 0x00000001 /**< Priority Group(ETS) support. */
581 #define ETH_DCB_PFC_SUPPORT 0x00000002 /**< Priority Flow Control support. */
583 /* Definitions used for VLAN Offload functionality */
584 #define ETH_VLAN_STRIP_OFFLOAD 0x0001 /**< VLAN Strip On/Off */
585 #define ETH_VLAN_FILTER_OFFLOAD 0x0002 /**< VLAN Filter On/Off */
586 #define ETH_VLAN_EXTEND_OFFLOAD 0x0004 /**< VLAN Extend On/Off */
588 /* Definitions used for mask VLAN setting */
589 #define ETH_VLAN_STRIP_MASK 0x0001 /**< VLAN Strip setting mask */
590 #define ETH_VLAN_FILTER_MASK 0x0002 /**< VLAN Filter setting mask*/
591 #define ETH_VLAN_EXTEND_MASK 0x0004 /**< VLAN Extend setting mask*/
592 #define ETH_VLAN_ID_MAX 0x0FFF /**< VLAN ID is in lower 12 bits*/
594 /* Definitions used for receive MAC address */
595 #define ETH_NUM_RECEIVE_MAC_ADDR 128 /**< Maximum nb. of receive mac addr. */
597 /* Definitions used for unicast hash */
598 #define ETH_VMDQ_NUM_UC_HASH_ARRAY 128 /**< Maximum nb. of UC hash array. */
600 /* Definitions used for VMDQ pool rx mode setting */
601 #define ETH_VMDQ_ACCEPT_UNTAG 0x0001 /**< accept untagged packets. */
602 #define ETH_VMDQ_ACCEPT_HASH_MC 0x0002 /**< accept packets in multicast table . */
603 #define ETH_VMDQ_ACCEPT_HASH_UC 0x0004 /**< accept packets in unicast table. */
604 #define ETH_VMDQ_ACCEPT_BROADCAST 0x0008 /**< accept broadcast packets. */
605 #define ETH_VMDQ_ACCEPT_MULTICAST 0x0010 /**< multicast promiscuous. */
607 /** Maximum nb. of vlan per mirror rule */
608 #define ETH_MIRROR_MAX_VLANS 64
610 #define ETH_MIRROR_VIRTUAL_POOL_UP 0x01 /**< Virtual Pool uplink Mirroring. */
611 #define ETH_MIRROR_UPLINK_PORT 0x02 /**< Uplink Port Mirroring. */
612 #define ETH_MIRROR_DOWNLINK_PORT 0x04 /**< Downlink Port Mirroring. */
613 #define ETH_MIRROR_VLAN 0x08 /**< VLAN Mirroring. */
614 #define ETH_MIRROR_VIRTUAL_POOL_DOWN 0x10 /**< Virtual Pool downlink Mirroring. */
617 * A structure used to configure VLAN traffic mirror of an Ethernet port.
619 struct rte_eth_vlan_mirror {
620 uint64_t vlan_mask; /**< mask for valid VLAN ID. */
621 /** VLAN ID list for vlan mirroring. */
622 uint16_t vlan_id[ETH_MIRROR_MAX_VLANS];
626 * A structure used to configure traffic mirror of an Ethernet port.
628 struct rte_eth_mirror_conf {
629 uint8_t rule_type; /**< Mirroring rule type */
630 uint8_t dst_pool; /**< Destination pool for this mirror rule. */
631 uint64_t pool_mask; /**< Bitmap of pool for pool mirroring */
632 /** VLAN ID setting for VLAN mirroring. */
633 struct rte_eth_vlan_mirror vlan;
637 * A structure used to configure 64 entries of Redirection Table of the
638 * Receive Side Scaling (RSS) feature of an Ethernet port. To configure
639 * more than 64 entries supported by hardware, an array of this structure
642 struct rte_eth_rss_reta_entry64 {
644 /**< Mask bits indicate which entries need to be updated/queried. */
645 uint16_t reta[RTE_RETA_GROUP_SIZE];
646 /**< Group of 64 redirection table entries. */
650 * This enum indicates the possible number of traffic classes
651 * in DCB configurations
653 enum rte_eth_nb_tcs {
654 ETH_4_TCS = 4, /**< 4 TCs with DCB. */
655 ETH_8_TCS = 8 /**< 8 TCs with DCB. */
659 * This enum indicates the possible number of queue pools
660 * in VMDQ configurations.
662 enum rte_eth_nb_pools {
663 ETH_8_POOLS = 8, /**< 8 VMDq pools. */
664 ETH_16_POOLS = 16, /**< 16 VMDq pools. */
665 ETH_32_POOLS = 32, /**< 32 VMDq pools. */
666 ETH_64_POOLS = 64 /**< 64 VMDq pools. */
669 /* This structure may be extended in future. */
670 struct rte_eth_dcb_rx_conf {
671 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs */
672 /** Traffic class each UP mapped to. */
673 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
676 struct rte_eth_vmdq_dcb_tx_conf {
677 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools. */
678 /** Traffic class each UP mapped to. */
679 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
682 struct rte_eth_dcb_tx_conf {
683 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs. */
684 /** Traffic class each UP mapped to. */
685 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
688 struct rte_eth_vmdq_tx_conf {
689 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq mode, 64 pools. */
693 * A structure used to configure the VMDQ+DCB feature
694 * of an Ethernet port.
696 * Using this feature, packets are routed to a pool of queues, based
697 * on the vlan id in the vlan tag, and then to a specific queue within
698 * that pool, using the user priority vlan tag field.
700 * A default pool may be used, if desired, to route all traffic which
701 * does not match the vlan filter rules.
703 struct rte_eth_vmdq_dcb_conf {
704 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools */
705 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
706 uint8_t default_pool; /**< The default pool, if applicable */
707 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
709 uint16_t vlan_id; /**< The vlan id of the received frame */
710 uint64_t pools; /**< Bitmask of pools for packet rx */
711 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
712 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
713 /**< Selects a queue in a pool */
717 * A structure used to configure the VMDQ feature of an Ethernet port when
718 * not combined with the DCB feature.
720 * Using this feature, packets are routed to a pool of queues. By default,
721 * the pool selection is based on the MAC address, the vlan id in the
722 * vlan tag as specified in the pool_map array.
723 * Passing the ETH_VMDQ_ACCEPT_UNTAG in the rx_mode field allows pool
724 * selection using only the MAC address. MAC address to pool mapping is done
725 * using the rte_eth_dev_mac_addr_add function, with the pool parameter
726 * corresponding to the pool id.
728 * Queue selection within the selected pool will be done using RSS when
729 * it is enabled or revert to the first queue of the pool if not.
731 * A default pool may be used, if desired, to route all traffic which
732 * does not match the vlan filter rules or any pool MAC address.
734 struct rte_eth_vmdq_rx_conf {
735 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq only mode, 8 or 64 pools */
736 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
737 uint8_t default_pool; /**< The default pool, if applicable */
738 uint8_t enable_loop_back; /**< Enable VT loop back */
739 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
740 uint32_t rx_mode; /**< Flags from ETH_VMDQ_ACCEPT_* */
742 uint16_t vlan_id; /**< The vlan id of the received frame */
743 uint64_t pools; /**< Bitmask of pools for packet rx */
744 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
748 * A structure used to configure the TX features of an Ethernet port.
750 struct rte_eth_txmode {
751 enum rte_eth_tx_mq_mode mq_mode; /**< TX multi-queues mode. */
753 * Per-port Tx offloads to be set using DEV_TX_OFFLOAD_* flags.
754 * Only offloads set on tx_offload_capa field on rte_eth_dev_info
755 * structure are allowed to be set.
759 /* For i40e specifically */
762 uint8_t hw_vlan_reject_tagged : 1,
763 /**< If set, reject sending out tagged pkts */
764 hw_vlan_reject_untagged : 1,
765 /**< If set, reject sending out untagged pkts */
766 hw_vlan_insert_pvid : 1;
767 /**< If set, enable port based VLAN insertion */
771 * A structure used to configure an RX ring of an Ethernet port.
773 struct rte_eth_rxconf {
774 struct rte_eth_thresh rx_thresh; /**< RX ring threshold registers. */
775 uint16_t rx_free_thresh; /**< Drives the freeing of RX descriptors. */
776 uint8_t rx_drop_en; /**< Drop packets if no descriptors are available. */
777 uint8_t rx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
779 * Per-queue Rx offloads to be set using DEV_RX_OFFLOAD_* flags.
780 * Only offloads set on rx_queue_offload_capa or rx_offload_capa
781 * fields on rte_eth_dev_info structure are allowed to be set.
787 * A structure used to configure a TX ring of an Ethernet port.
789 struct rte_eth_txconf {
790 struct rte_eth_thresh tx_thresh; /**< TX ring threshold registers. */
791 uint16_t tx_rs_thresh; /**< Drives the setting of RS bit on TXDs. */
792 uint16_t tx_free_thresh; /**< Start freeing TX buffers if there are
793 less free descriptors than this value. */
795 uint8_t tx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
797 * Per-queue Tx offloads to be set using DEV_TX_OFFLOAD_* flags.
798 * Only offloads set on tx_queue_offload_capa or tx_offload_capa
799 * fields on rte_eth_dev_info structure are allowed to be set.
805 * A structure contains information about HW descriptor ring limitations.
807 struct rte_eth_desc_lim {
808 uint16_t nb_max; /**< Max allowed number of descriptors. */
809 uint16_t nb_min; /**< Min allowed number of descriptors. */
810 uint16_t nb_align; /**< Number of descriptors should be aligned to. */
813 * Max allowed number of segments per whole packet.
815 * - For TSO packet this is the total number of data descriptors allowed
818 * @see nb_mtu_seg_max
823 * Max number of segments per one MTU.
825 * - For non-TSO packet, this is the maximum allowed number of segments
826 * in a single transmit packet.
828 * - For TSO packet each segment within the TSO may span up to this
833 uint16_t nb_mtu_seg_max;
837 * This enum indicates the flow control mode
839 enum rte_eth_fc_mode {
840 RTE_FC_NONE = 0, /**< Disable flow control. */
841 RTE_FC_RX_PAUSE, /**< RX pause frame, enable flowctrl on TX side. */
842 RTE_FC_TX_PAUSE, /**< TX pause frame, enable flowctrl on RX side. */
843 RTE_FC_FULL /**< Enable flow control on both side. */
847 * A structure used to configure Ethernet flow control parameter.
848 * These parameters will be configured into the register of the NIC.
849 * Please refer to the corresponding data sheet for proper value.
851 struct rte_eth_fc_conf {
852 uint32_t high_water; /**< High threshold value to trigger XOFF */
853 uint32_t low_water; /**< Low threshold value to trigger XON */
854 uint16_t pause_time; /**< Pause quota in the Pause frame */
855 uint16_t send_xon; /**< Is XON frame need be sent */
856 enum rte_eth_fc_mode mode; /**< Link flow control mode */
857 uint8_t mac_ctrl_frame_fwd; /**< Forward MAC control frames */
858 uint8_t autoneg; /**< Use Pause autoneg */
862 * A structure used to configure Ethernet priority flow control parameter.
863 * These parameters will be configured into the register of the NIC.
864 * Please refer to the corresponding data sheet for proper value.
866 struct rte_eth_pfc_conf {
867 struct rte_eth_fc_conf fc; /**< General flow control parameter. */
868 uint8_t priority; /**< VLAN User Priority. */
874 enum rte_eth_tunnel_type {
875 RTE_TUNNEL_TYPE_NONE = 0,
876 RTE_TUNNEL_TYPE_VXLAN,
877 RTE_TUNNEL_TYPE_GENEVE,
878 RTE_TUNNEL_TYPE_TEREDO,
879 RTE_TUNNEL_TYPE_NVGRE,
880 RTE_TUNNEL_TYPE_IP_IN_GRE,
881 RTE_L2_TUNNEL_TYPE_E_TAG,
882 RTE_TUNNEL_TYPE_VXLAN_GPE,
886 /* Deprecated API file for rte_eth_dev_filter_* functions */
887 #include "rte_eth_ctrl.h"
890 * Memory space that can be configured to store Flow Director filters
891 * in the board memory.
893 enum rte_fdir_pballoc_type {
894 RTE_FDIR_PBALLOC_64K = 0, /**< 64k. */
895 RTE_FDIR_PBALLOC_128K, /**< 128k. */
896 RTE_FDIR_PBALLOC_256K, /**< 256k. */
900 * Select report mode of FDIR hash information in RX descriptors.
902 enum rte_fdir_status_mode {
903 RTE_FDIR_NO_REPORT_STATUS = 0, /**< Never report FDIR hash. */
904 RTE_FDIR_REPORT_STATUS, /**< Only report FDIR hash for matching pkts. */
905 RTE_FDIR_REPORT_STATUS_ALWAYS, /**< Always report FDIR hash. */
909 * A structure used to configure the Flow Director (FDIR) feature
910 * of an Ethernet port.
912 * If mode is RTE_FDIR_DISABLE, the pballoc value is ignored.
914 struct rte_fdir_conf {
915 enum rte_fdir_mode mode; /**< Flow Director mode. */
916 enum rte_fdir_pballoc_type pballoc; /**< Space for FDIR filters. */
917 enum rte_fdir_status_mode status; /**< How to report FDIR hash. */
918 /** RX queue of packets matching a "drop" filter in perfect mode. */
920 struct rte_eth_fdir_masks mask;
921 struct rte_eth_fdir_flex_conf flex_conf;
922 /**< Flex payload configuration. */
926 * UDP tunneling configuration.
927 * Used to config the UDP port for a type of tunnel.
928 * NICs need the UDP port to identify the tunnel type.
929 * Normally a type of tunnel has a default UDP port, this structure can be used
930 * in case if the users want to change or support more UDP port.
932 struct rte_eth_udp_tunnel {
933 uint16_t udp_port; /**< UDP port used for the tunnel. */
934 uint8_t prot_type; /**< Tunnel type. Defined in rte_eth_tunnel_type. */
938 * A structure used to enable/disable specific device interrupts.
940 struct rte_intr_conf {
941 /** enable/disable lsc interrupt. 0 (default) - disable, 1 enable */
943 /** enable/disable rxq interrupt. 0 (default) - disable, 1 enable */
945 /** enable/disable rmv interrupt. 0 (default) - disable, 1 enable */
950 * A structure used to configure an Ethernet port.
951 * Depending upon the RX multi-queue mode, extra advanced
952 * configuration settings may be needed.
954 struct rte_eth_conf {
955 uint32_t link_speeds; /**< bitmap of ETH_LINK_SPEED_XXX of speeds to be
956 used. ETH_LINK_SPEED_FIXED disables link
957 autonegotiation, and a unique speed shall be
958 set. Otherwise, the bitmap defines the set of
959 speeds to be advertised. If the special value
960 ETH_LINK_SPEED_AUTONEG (0) is used, all speeds
961 supported are advertised. */
962 struct rte_eth_rxmode rxmode; /**< Port RX configuration. */
963 struct rte_eth_txmode txmode; /**< Port TX configuration. */
964 uint32_t lpbk_mode; /**< Loopback operation mode. By default the value
965 is 0, meaning the loopback mode is disabled.
966 Read the datasheet of given ethernet controller
967 for details. The possible values of this field
968 are defined in implementation of each driver. */
970 struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
971 struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
972 /**< Port vmdq+dcb configuration. */
973 struct rte_eth_dcb_rx_conf dcb_rx_conf;
974 /**< Port dcb RX configuration. */
975 struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
976 /**< Port vmdq RX configuration. */
977 } rx_adv_conf; /**< Port RX filtering configuration. */
979 struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
980 /**< Port vmdq+dcb TX configuration. */
981 struct rte_eth_dcb_tx_conf dcb_tx_conf;
982 /**< Port dcb TX configuration. */
983 struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
984 /**< Port vmdq TX configuration. */
985 } tx_adv_conf; /**< Port TX DCB configuration (union). */
986 /** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
987 is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
988 uint32_t dcb_capability_en;
989 struct rte_fdir_conf fdir_conf; /**< FDIR configuration. DEPRECATED */
990 struct rte_intr_conf intr_conf; /**< Interrupt mode configuration. */
994 * RX offload capabilities of a device.
996 #define DEV_RX_OFFLOAD_VLAN_STRIP 0x00000001
997 #define DEV_RX_OFFLOAD_IPV4_CKSUM 0x00000002
998 #define DEV_RX_OFFLOAD_UDP_CKSUM 0x00000004
999 #define DEV_RX_OFFLOAD_TCP_CKSUM 0x00000008
1000 #define DEV_RX_OFFLOAD_TCP_LRO 0x00000010
1001 #define DEV_RX_OFFLOAD_QINQ_STRIP 0x00000020
1002 #define DEV_RX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000040
1003 #define DEV_RX_OFFLOAD_MACSEC_STRIP 0x00000080
1004 #define DEV_RX_OFFLOAD_HEADER_SPLIT 0x00000100
1005 #define DEV_RX_OFFLOAD_VLAN_FILTER 0x00000200
1006 #define DEV_RX_OFFLOAD_VLAN_EXTEND 0x00000400
1007 #define DEV_RX_OFFLOAD_JUMBO_FRAME 0x00000800
1008 #define DEV_RX_OFFLOAD_SCATTER 0x00002000
1009 #define DEV_RX_OFFLOAD_TIMESTAMP 0x00004000
1010 #define DEV_RX_OFFLOAD_SECURITY 0x00008000
1011 #define DEV_RX_OFFLOAD_KEEP_CRC 0x00010000
1012 #define DEV_RX_OFFLOAD_SCTP_CKSUM 0x00020000
1013 #define DEV_RX_OFFLOAD_OUTER_UDP_CKSUM 0x00040000
1015 #define DEV_RX_OFFLOAD_CHECKSUM (DEV_RX_OFFLOAD_IPV4_CKSUM | \
1016 DEV_RX_OFFLOAD_UDP_CKSUM | \
1017 DEV_RX_OFFLOAD_TCP_CKSUM)
1018 #define DEV_RX_OFFLOAD_VLAN (DEV_RX_OFFLOAD_VLAN_STRIP | \
1019 DEV_RX_OFFLOAD_VLAN_FILTER | \
1020 DEV_RX_OFFLOAD_VLAN_EXTEND)
1023 * If new Rx offload capabilities are defined, they also must be
1024 * mentioned in rte_rx_offload_names in rte_ethdev.c file.
1028 * TX offload capabilities of a device.
1030 #define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001
1031 #define DEV_TX_OFFLOAD_IPV4_CKSUM 0x00000002
1032 #define DEV_TX_OFFLOAD_UDP_CKSUM 0x00000004
1033 #define DEV_TX_OFFLOAD_TCP_CKSUM 0x00000008
1034 #define DEV_TX_OFFLOAD_SCTP_CKSUM 0x00000010
1035 #define DEV_TX_OFFLOAD_TCP_TSO 0x00000020
1036 #define DEV_TX_OFFLOAD_UDP_TSO 0x00000040
1037 #define DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000080 /**< Used for tunneling packet. */
1038 #define DEV_TX_OFFLOAD_QINQ_INSERT 0x00000100
1039 #define DEV_TX_OFFLOAD_VXLAN_TNL_TSO 0x00000200 /**< Used for tunneling packet. */
1040 #define DEV_TX_OFFLOAD_GRE_TNL_TSO 0x00000400 /**< Used for tunneling packet. */
1041 #define DEV_TX_OFFLOAD_IPIP_TNL_TSO 0x00000800 /**< Used for tunneling packet. */
1042 #define DEV_TX_OFFLOAD_GENEVE_TNL_TSO 0x00001000 /**< Used for tunneling packet. */
1043 #define DEV_TX_OFFLOAD_MACSEC_INSERT 0x00002000
1044 #define DEV_TX_OFFLOAD_MT_LOCKFREE 0x00004000
1045 /**< Multiple threads can invoke rte_eth_tx_burst() concurrently on the same
1046 * tx queue without SW lock.
1048 #define DEV_TX_OFFLOAD_MULTI_SEGS 0x00008000
1049 /**< Device supports multi segment send. */
1050 #define DEV_TX_OFFLOAD_MBUF_FAST_FREE 0x00010000
1051 /**< Device supports optimization for fast release of mbufs.
1052 * When set application must guarantee that per-queue all mbufs comes from
1053 * the same mempool and has refcnt = 1.
1055 #define DEV_TX_OFFLOAD_SECURITY 0x00020000
1057 * Device supports generic UDP tunneled packet TSO.
1058 * Application must set PKT_TX_TUNNEL_UDP and other mbuf fields required
1061 #define DEV_TX_OFFLOAD_UDP_TNL_TSO 0x00040000
1063 * Device supports generic IP tunneled packet TSO.
1064 * Application must set PKT_TX_TUNNEL_IP and other mbuf fields required
1067 #define DEV_TX_OFFLOAD_IP_TNL_TSO 0x00080000
1068 /** Device supports outer UDP checksum */
1069 #define DEV_TX_OFFLOAD_OUTER_UDP_CKSUM 0x00100000
1071 * Device supports match on metadata Tx offload..
1072 * Application must set PKT_TX_METADATA and mbuf metadata field.
1074 #define DEV_TX_OFFLOAD_MATCH_METADATA 0x00200000
1076 #define RTE_ETH_DEV_CAPA_RUNTIME_RX_QUEUE_SETUP 0x00000001
1077 /**< Device supports Rx queue setup after device started*/
1078 #define RTE_ETH_DEV_CAPA_RUNTIME_TX_QUEUE_SETUP 0x00000002
1079 /**< Device supports Tx queue setup after device started*/
1082 * If new Tx offload capabilities are defined, they also must be
1083 * mentioned in rte_tx_offload_names in rte_ethdev.c file.
1087 * Fallback default preferred Rx/Tx port parameters.
1088 * These are used if an application requests default parameters
1089 * but the PMD does not provide preferred values.
1091 #define RTE_ETH_DEV_FALLBACK_RX_RINGSIZE 512
1092 #define RTE_ETH_DEV_FALLBACK_TX_RINGSIZE 512
1093 #define RTE_ETH_DEV_FALLBACK_RX_NBQUEUES 1
1094 #define RTE_ETH_DEV_FALLBACK_TX_NBQUEUES 1
1097 * Preferred Rx/Tx port parameters.
1098 * There are separate instances of this structure for transmission
1099 * and reception respectively.
1101 struct rte_eth_dev_portconf {
1102 uint16_t burst_size; /**< Device-preferred burst size */
1103 uint16_t ring_size; /**< Device-preferred size of queue rings */
1104 uint16_t nb_queues; /**< Device-preferred number of queues */
1108 * Default values for switch domain id when ethdev does not support switch
1109 * domain definitions.
1111 #define RTE_ETH_DEV_SWITCH_DOMAIN_ID_INVALID (0)
1114 * Ethernet device associated switch information
1116 struct rte_eth_switch_info {
1117 const char *name; /**< switch name */
1118 uint16_t domain_id; /**< switch domain id */
1121 * mapping to the devices physical switch port as enumerated from the
1122 * perspective of the embedded interconnect/switch. For SR-IOV enabled
1123 * device this may correspond to the VF_ID of each virtual function,
1124 * but each driver should explicitly define the mapping of switch
1125 * port identifier to that physical interconnect/switch
1130 * Ethernet device information
1134 * A structure used to retrieve the contextual information of
1135 * an Ethernet device, such as the controlling driver of the
1138 struct rte_eth_dev_info {
1139 struct rte_device *device; /** Generic device information */
1140 const char *driver_name; /**< Device Driver name. */
1141 unsigned int if_index; /**< Index to bound host interface, or 0 if none.
1142 Use if_indextoname() to translate into an interface name. */
1143 uint16_t min_mtu; /**< Minimum MTU allowed */
1144 uint16_t max_mtu; /**< Maximum MTU allowed */
1145 const uint32_t *dev_flags; /**< Device flags */
1146 uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
1147 uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
1148 uint16_t max_rx_queues; /**< Maximum number of RX queues. */
1149 uint16_t max_tx_queues; /**< Maximum number of TX queues. */
1150 uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
1151 uint32_t max_hash_mac_addrs;
1152 /** Maximum number of hash MAC addresses for MTA and UTA. */
1153 uint16_t max_vfs; /**< Maximum number of VFs. */
1154 uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
1155 uint64_t rx_offload_capa;
1156 /**< All RX offload capabilities including all per-queue ones */
1157 uint64_t tx_offload_capa;
1158 /**< All TX offload capabilities including all per-queue ones */
1159 uint64_t rx_queue_offload_capa;
1160 /**< Device per-queue RX offload capabilities. */
1161 uint64_t tx_queue_offload_capa;
1162 /**< Device per-queue TX offload capabilities. */
1164 /**< Device redirection table size, the total number of entries. */
1165 uint8_t hash_key_size; /**< Hash key size in bytes */
1166 /** Bit mask of RSS offloads, the bit offset also means flow type */
1167 uint64_t flow_type_rss_offloads;
1168 struct rte_eth_rxconf default_rxconf; /**< Default RX configuration */
1169 struct rte_eth_txconf default_txconf; /**< Default TX configuration */
1170 uint16_t vmdq_queue_base; /**< First queue ID for VMDQ pools. */
1171 uint16_t vmdq_queue_num; /**< Queue number for VMDQ pools. */
1172 uint16_t vmdq_pool_base; /**< First ID of VMDQ pools. */
1173 struct rte_eth_desc_lim rx_desc_lim; /**< RX descriptors limits */
1174 struct rte_eth_desc_lim tx_desc_lim; /**< TX descriptors limits */
1175 uint32_t speed_capa; /**< Supported speeds bitmap (ETH_LINK_SPEED_). */
1176 /** Configured number of rx/tx queues */
1177 uint16_t nb_rx_queues; /**< Number of RX queues. */
1178 uint16_t nb_tx_queues; /**< Number of TX queues. */
1179 /** Rx parameter recommendations */
1180 struct rte_eth_dev_portconf default_rxportconf;
1181 /** Tx parameter recommendations */
1182 struct rte_eth_dev_portconf default_txportconf;
1183 /** Generic device capabilities (RTE_ETH_DEV_CAPA_). */
1186 * Switching information for ports on a device with a
1187 * embedded managed interconnect/switch.
1189 struct rte_eth_switch_info switch_info;
1193 * Ethernet device RX queue information structure.
1194 * Used to retrieve information about configured queue.
1196 struct rte_eth_rxq_info {
1197 struct rte_mempool *mp; /**< mempool used by that queue. */
1198 struct rte_eth_rxconf conf; /**< queue config parameters. */
1199 uint8_t scattered_rx; /**< scattered packets RX supported. */
1200 uint16_t nb_desc; /**< configured number of RXDs. */
1201 } __rte_cache_min_aligned;
1204 * Ethernet device TX queue information structure.
1205 * Used to retrieve information about configured queue.
1207 struct rte_eth_txq_info {
1208 struct rte_eth_txconf conf; /**< queue config parameters. */
1209 uint16_t nb_desc; /**< configured number of TXDs. */
1210 } __rte_cache_min_aligned;
1212 /** Maximum name length for extended statistics counters */
1213 #define RTE_ETH_XSTATS_NAME_SIZE 64
1216 * An Ethernet device extended statistic structure
1218 * This structure is used by rte_eth_xstats_get() to provide
1219 * statistics that are not provided in the generic *rte_eth_stats*
1221 * It maps a name id, corresponding to an index in the array returned
1222 * by rte_eth_xstats_get_names(), to a statistic value.
1224 struct rte_eth_xstat {
1225 uint64_t id; /**< The index in xstats name array. */
1226 uint64_t value; /**< The statistic counter value. */
1230 * A name element for extended statistics.
1232 * An array of this structure is returned by rte_eth_xstats_get_names().
1233 * It lists the names of extended statistics for a PMD. The *rte_eth_xstat*
1234 * structure references these names by their array index.
1236 struct rte_eth_xstat_name {
1237 char name[RTE_ETH_XSTATS_NAME_SIZE]; /**< The statistic name. */
1240 #define ETH_DCB_NUM_TCS 8
1241 #define ETH_MAX_VMDQ_POOL 64
1244 * A structure used to get the information of queue and
1245 * TC mapping on both TX and RX paths.
1247 struct rte_eth_dcb_tc_queue_mapping {
1248 /** rx queues assigned to tc per Pool */
1252 } tc_rxq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
1253 /** rx queues assigned to tc per Pool */
1257 } tc_txq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
1261 * A structure used to get the information of DCB.
1262 * It includes TC UP mapping and queue TC mapping.
1264 struct rte_eth_dcb_info {
1265 uint8_t nb_tcs; /**< number of TCs */
1266 uint8_t prio_tc[ETH_DCB_NUM_USER_PRIORITIES]; /**< Priority to tc */
1267 uint8_t tc_bws[ETH_DCB_NUM_TCS]; /**< TX BW percentage for each TC */
1268 /** rx queues assigned to tc */
1269 struct rte_eth_dcb_tc_queue_mapping tc_queue;
1273 * RX/TX queue states
1275 #define RTE_ETH_QUEUE_STATE_STOPPED 0
1276 #define RTE_ETH_QUEUE_STATE_STARTED 1
1278 #define RTE_ETH_ALL RTE_MAX_ETHPORTS
1280 /* Macros to check for valid port */
1281 #define RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, retval) do { \
1282 if (!rte_eth_dev_is_valid_port(port_id)) { \
1283 RTE_ETHDEV_LOG(ERR, "Invalid port_id=%u\n", port_id); \
1288 #define RTE_ETH_VALID_PORTID_OR_RET(port_id) do { \
1289 if (!rte_eth_dev_is_valid_port(port_id)) { \
1290 RTE_ETHDEV_LOG(ERR, "Invalid port_id=%u\n", port_id); \
1296 * l2 tunnel configuration.
1299 /**< l2 tunnel enable mask */
1300 #define ETH_L2_TUNNEL_ENABLE_MASK 0x00000001
1301 /**< l2 tunnel insertion mask */
1302 #define ETH_L2_TUNNEL_INSERTION_MASK 0x00000002
1303 /**< l2 tunnel stripping mask */
1304 #define ETH_L2_TUNNEL_STRIPPING_MASK 0x00000004
1305 /**< l2 tunnel forwarding mask */
1306 #define ETH_L2_TUNNEL_FORWARDING_MASK 0x00000008
1309 * Function type used for RX packet processing packet callbacks.
1311 * The callback function is called on RX with a burst of packets that have
1312 * been received on the given port and queue.
1315 * The Ethernet port on which RX is being performed.
1317 * The queue on the Ethernet port which is being used to receive the packets.
1319 * The burst of packets that have just been received.
1321 * The number of packets in the burst pointed to by "pkts".
1323 * The max number of packets that can be stored in the "pkts" array.
1325 * The arbitrary user parameter passed in by the application when the callback
1326 * was originally configured.
1328 * The number of packets returned to the user.
1330 typedef uint16_t (*rte_rx_callback_fn)(uint16_t port_id, uint16_t queue,
1331 struct rte_mbuf *pkts[], uint16_t nb_pkts, uint16_t max_pkts,
1335 * Function type used for TX packet processing packet callbacks.
1337 * The callback function is called on TX with a burst of packets immediately
1338 * before the packets are put onto the hardware queue for transmission.
1341 * The Ethernet port on which TX is being performed.
1343 * The queue on the Ethernet port which is being used to transmit the packets.
1345 * The burst of packets that are about to be transmitted.
1347 * The number of packets in the burst pointed to by "pkts".
1349 * The arbitrary user parameter passed in by the application when the callback
1350 * was originally configured.
1352 * The number of packets to be written to the NIC.
1354 typedef uint16_t (*rte_tx_callback_fn)(uint16_t port_id, uint16_t queue,
1355 struct rte_mbuf *pkts[], uint16_t nb_pkts, void *user_param);
1358 * Possible states of an ethdev port.
1360 enum rte_eth_dev_state {
1361 /** Device is unused before being probed. */
1362 RTE_ETH_DEV_UNUSED = 0,
1363 /** Device is attached when allocated in probing. */
1364 RTE_ETH_DEV_ATTACHED,
1365 /** Device is in removed state when plug-out is detected. */
1366 RTE_ETH_DEV_REMOVED,
1369 struct rte_eth_dev_sriov {
1370 uint8_t active; /**< SRIOV is active with 16, 32 or 64 pools */
1371 uint8_t nb_q_per_pool; /**< rx queue number per pool */
1372 uint16_t def_vmdq_idx; /**< Default pool num used for PF */
1373 uint16_t def_pool_q_idx; /**< Default pool queue start reg index */
1375 #define RTE_ETH_DEV_SRIOV(dev) ((dev)->data->sriov)
1377 #define RTE_ETH_NAME_MAX_LEN RTE_DEV_NAME_MAX_LEN
1379 #define RTE_ETH_DEV_NO_OWNER 0
1381 #define RTE_ETH_MAX_OWNER_NAME_LEN 64
1383 struct rte_eth_dev_owner {
1384 uint64_t id; /**< The owner unique identifier. */
1385 char name[RTE_ETH_MAX_OWNER_NAME_LEN]; /**< The owner name. */
1389 * Port is released (i.e. totally freed and data erased) on close.
1390 * Temporary flag for PMD migration to new rte_eth_dev_close() behaviour.
1392 #define RTE_ETH_DEV_CLOSE_REMOVE 0x0001
1393 /** Device supports link state interrupt */
1394 #define RTE_ETH_DEV_INTR_LSC 0x0002
1395 /** Device is a bonded slave */
1396 #define RTE_ETH_DEV_BONDED_SLAVE 0x0004
1397 /** Device supports device removal interrupt */
1398 #define RTE_ETH_DEV_INTR_RMV 0x0008
1399 /** Device is port representor */
1400 #define RTE_ETH_DEV_REPRESENTOR 0x0010
1401 /** Device does not support MAC change after started */
1402 #define RTE_ETH_DEV_NOLIVE_MAC_ADDR 0x0020
1405 * Iterates over valid ethdev ports owned by a specific owner.
1408 * The id of the next possible valid owned port.
1410 * The owner identifier.
1411 * RTE_ETH_DEV_NO_OWNER means iterate over all valid ownerless ports.
1413 * Next valid port id owned by owner_id, RTE_MAX_ETHPORTS if there is none.
1415 uint64_t rte_eth_find_next_owned_by(uint16_t port_id,
1416 const uint64_t owner_id);
1419 * Macro to iterate over all enabled ethdev ports owned by a specific owner.
1421 #define RTE_ETH_FOREACH_DEV_OWNED_BY(p, o) \
1422 for (p = rte_eth_find_next_owned_by(0, o); \
1423 (unsigned int)p < (unsigned int)RTE_MAX_ETHPORTS; \
1424 p = rte_eth_find_next_owned_by(p + 1, o))
1427 * Iterates over valid ethdev ports.
1430 * The id of the next possible valid port.
1432 * Next valid port id, RTE_MAX_ETHPORTS if there is none.
1434 uint16_t rte_eth_find_next(uint16_t port_id);
1437 * Macro to iterate over all enabled and ownerless ethdev ports.
1439 #define RTE_ETH_FOREACH_DEV(p) \
1440 RTE_ETH_FOREACH_DEV_OWNED_BY(p, RTE_ETH_DEV_NO_OWNER)
1444 * @b EXPERIMENTAL: this API may change without prior notice.
1446 * Iterates over ethdev ports of a specified device.
1448 * @param port_id_start
1449 * The id of the next possible valid port.
1451 * The generic device behind the ports to iterate.
1453 * Next port id of the device, possibly port_id_start,
1454 * RTE_MAX_ETHPORTS if there is none.
1458 rte_eth_find_next_of(uint16_t port_id_start,
1459 const struct rte_device *parent);
1462 * Macro to iterate over all ethdev ports of a specified device.
1465 * The id of the matching port being iterated.
1467 * The rte_device pointer matching the iterated ports.
1469 #define RTE_ETH_FOREACH_DEV_OF(port_id, parent) \
1470 for (port_id = rte_eth_find_next_of(0, parent); \
1471 port_id < RTE_MAX_ETHPORTS; \
1472 port_id = rte_eth_find_next_of(port_id + 1, parent))
1476 * @b EXPERIMENTAL: this API may change without prior notice.
1478 * Iterates over sibling ethdev ports (i.e. sharing the same rte_device).
1480 * @param port_id_start
1481 * The id of the next possible valid sibling port.
1482 * @param ref_port_id
1483 * The id of a reference port to compare rte_device with.
1485 * Next sibling port id, possibly port_id_start or ref_port_id itself,
1486 * RTE_MAX_ETHPORTS if there is none.
1490 rte_eth_find_next_sibling(uint16_t port_id_start,
1491 uint16_t ref_port_id);
1494 * Macro to iterate over all ethdev ports sharing the same rte_device
1495 * as the specified port.
1496 * Note: the specified reference port is part of the loop iterations.
1499 * The id of the matching port being iterated.
1500 * @param ref_port_id
1501 * The id of the port being compared.
1503 #define RTE_ETH_FOREACH_DEV_SIBLING(port_id, ref_port_id) \
1504 for (port_id = rte_eth_find_next_sibling(0, ref_port_id); \
1505 port_id < RTE_MAX_ETHPORTS; \
1506 port_id = rte_eth_find_next_sibling(port_id + 1, ref_port_id))
1510 * @b EXPERIMENTAL: this API may change without prior notice.
1512 * Get a new unique owner identifier.
1513 * An owner identifier is used to owns Ethernet devices by only one DPDK entity
1514 * to avoid multiple management of device by different entities.
1517 * Owner identifier pointer.
1519 * Negative errno value on error, 0 on success.
1522 int rte_eth_dev_owner_new(uint64_t *owner_id);
1526 * @b EXPERIMENTAL: this API may change without prior notice.
1528 * Set an Ethernet device owner.
1531 * The identifier of the port to own.
1533 * The owner pointer.
1535 * Negative errno value on error, 0 on success.
1538 int rte_eth_dev_owner_set(const uint16_t port_id,
1539 const struct rte_eth_dev_owner *owner);
1543 * @b EXPERIMENTAL: this API may change without prior notice.
1545 * Unset Ethernet device owner to make the device ownerless.
1548 * The identifier of port to make ownerless.
1550 * The owner identifier.
1552 * 0 on success, negative errno value on error.
1555 int rte_eth_dev_owner_unset(const uint16_t port_id,
1556 const uint64_t owner_id);
1560 * @b EXPERIMENTAL: this API may change without prior notice.
1562 * Remove owner from all Ethernet devices owned by a specific owner.
1565 * The owner identifier.
1568 void rte_eth_dev_owner_delete(const uint64_t owner_id);
1572 * @b EXPERIMENTAL: this API may change without prior notice.
1574 * Get the owner of an Ethernet device.
1577 * The port identifier.
1579 * The owner structure pointer to fill.
1581 * 0 on success, negative errno value on error..
1584 int rte_eth_dev_owner_get(const uint16_t port_id,
1585 struct rte_eth_dev_owner *owner);
1588 * Get the total number of Ethernet devices that have been successfully
1589 * initialized by the matching Ethernet driver during the PCI probing phase
1590 * and that are available for applications to use. These devices must be
1591 * accessed by using the ``RTE_ETH_FOREACH_DEV()`` macro to deal with
1592 * non-contiguous ranges of devices.
1593 * These non-contiguous ranges can be created by calls to hotplug functions or
1597 * - The total number of usable Ethernet devices.
1600 uint16_t rte_eth_dev_count(void);
1603 * Get the number of ports which are usable for the application.
1605 * These devices must be iterated by using the macro
1606 * ``RTE_ETH_FOREACH_DEV`` or ``RTE_ETH_FOREACH_DEV_OWNED_BY``
1607 * to deal with non-contiguous ranges of devices.
1610 * The count of available Ethernet devices.
1612 uint16_t rte_eth_dev_count_avail(void);
1615 * Get the total number of ports which are allocated.
1617 * Some devices may not be available for the application.
1620 * The total count of Ethernet devices.
1622 uint16_t rte_eth_dev_count_total(void);
1625 * Convert a numerical speed in Mbps to a bitmap flag that can be used in
1626 * the bitmap link_speeds of the struct rte_eth_conf
1629 * Numerical speed value in Mbps
1631 * ETH_LINK_[HALF/FULL]_DUPLEX (only for 10/100M speeds)
1633 * 0 if the speed cannot be mapped
1635 uint32_t rte_eth_speed_bitflag(uint32_t speed, int duplex);
1638 * Get DEV_RX_OFFLOAD_* flag name.
1643 * Offload name or 'UNKNOWN' if the flag cannot be recognised.
1645 const char *rte_eth_dev_rx_offload_name(uint64_t offload);
1648 * Get DEV_TX_OFFLOAD_* flag name.
1653 * Offload name or 'UNKNOWN' if the flag cannot be recognised.
1655 const char *rte_eth_dev_tx_offload_name(uint64_t offload);
1658 * Configure an Ethernet device.
1659 * This function must be invoked first before any other function in the
1660 * Ethernet API. This function can also be re-invoked when a device is in the
1664 * The port identifier of the Ethernet device to configure.
1665 * @param nb_rx_queue
1666 * The number of receive queues to set up for the Ethernet device.
1667 * @param nb_tx_queue
1668 * The number of transmit queues to set up for the Ethernet device.
1670 * The pointer to the configuration data to be used for the Ethernet device.
1671 * The *rte_eth_conf* structure includes:
1672 * - the hardware offload features to activate, with dedicated fields for
1673 * each statically configurable offload hardware feature provided by
1674 * Ethernet devices, such as IP checksum or VLAN tag stripping for
1676 * The Rx offload bitfield API is obsolete and will be deprecated.
1677 * Applications should set the ignore_bitfield_offloads bit on *rxmode*
1678 * structure and use offloads field to set per-port offloads instead.
1679 * - Any offloading set in eth_conf->[rt]xmode.offloads must be within
1680 * the [rt]x_offload_capa returned from rte_eth_dev_info_get().
1681 * Any type of device supported offloading set in the input argument
1682 * eth_conf->[rt]xmode.offloads to rte_eth_dev_configure() is enabled
1683 * on all queues and it can't be disabled in rte_eth_[rt]x_queue_setup()
1684 * - the Receive Side Scaling (RSS) configuration when using multiple RX
1685 * queues per port. Any RSS hash function set in eth_conf->rss_conf.rss_hf
1686 * must be within the flow_type_rss_offloads provided by drivers via
1687 * rte_eth_dev_info_get() API.
1689 * Embedding all configuration information in a single data structure
1690 * is the more flexible method that allows the addition of new features
1691 * without changing the syntax of the API.
1693 * - 0: Success, device configured.
1694 * - <0: Error code returned by the driver configuration function.
1696 int rte_eth_dev_configure(uint16_t port_id, uint16_t nb_rx_queue,
1697 uint16_t nb_tx_queue, const struct rte_eth_conf *eth_conf);
1701 * @b EXPERIMENTAL: this API may change without prior notice.
1703 * Check if an Ethernet device was physically removed.
1706 * The port identifier of the Ethernet device.
1708 * 1 when the Ethernet device is removed, otherwise 0.
1712 rte_eth_dev_is_removed(uint16_t port_id);
1715 * Allocate and set up a receive queue for an Ethernet device.
1717 * The function allocates a contiguous block of memory for *nb_rx_desc*
1718 * receive descriptors from a memory zone associated with *socket_id*
1719 * and initializes each receive descriptor with a network buffer allocated
1720 * from the memory pool *mb_pool*.
1723 * The port identifier of the Ethernet device.
1724 * @param rx_queue_id
1725 * The index of the receive queue to set up.
1726 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1727 * to rte_eth_dev_configure().
1729 * The number of receive descriptors to allocate for the receive ring.
1731 * The *socket_id* argument is the socket identifier in case of NUMA.
1732 * The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1733 * the DMA memory allocated for the receive descriptors of the ring.
1735 * The pointer to the configuration data to be used for the receive queue.
1736 * NULL value is allowed, in which case default RX configuration
1738 * The *rx_conf* structure contains an *rx_thresh* structure with the values
1739 * of the Prefetch, Host, and Write-Back threshold registers of the receive
1741 * In addition it contains the hardware offloads features to activate using
1742 * the DEV_RX_OFFLOAD_* flags.
1743 * If an offloading set in rx_conf->offloads
1744 * hasn't been set in the input argument eth_conf->rxmode.offloads
1745 * to rte_eth_dev_configure(), it is a new added offloading, it must be
1746 * per-queue type and it is enabled for the queue.
1747 * No need to repeat any bit in rx_conf->offloads which has already been
1748 * enabled in rte_eth_dev_configure() at port level. An offloading enabled
1749 * at port level can't be disabled at queue level.
1751 * The pointer to the memory pool from which to allocate *rte_mbuf* network
1752 * memory buffers to populate each descriptor of the receive ring.
1754 * - 0: Success, receive queue correctly set up.
1755 * - -EIO: if device is removed.
1756 * - -EINVAL: The memory pool pointer is null or the size of network buffers
1757 * which can be allocated from this memory pool does not fit the various
1758 * buffer sizes allowed by the device controller.
1759 * - -ENOMEM: Unable to allocate the receive ring descriptors or to
1760 * allocate network memory buffers from the memory pool when
1761 * initializing receive descriptors.
1763 int rte_eth_rx_queue_setup(uint16_t port_id, uint16_t rx_queue_id,
1764 uint16_t nb_rx_desc, unsigned int socket_id,
1765 const struct rte_eth_rxconf *rx_conf,
1766 struct rte_mempool *mb_pool);
1769 * Allocate and set up a transmit queue for an Ethernet device.
1772 * The port identifier of the Ethernet device.
1773 * @param tx_queue_id
1774 * The index of the transmit queue to set up.
1775 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1776 * to rte_eth_dev_configure().
1778 * The number of transmit descriptors to allocate for the transmit ring.
1780 * The *socket_id* argument is the socket identifier in case of NUMA.
1781 * Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1782 * the DMA memory allocated for the transmit descriptors of the ring.
1784 * The pointer to the configuration data to be used for the transmit queue.
1785 * NULL value is allowed, in which case default TX configuration
1787 * The *tx_conf* structure contains the following data:
1788 * - The *tx_thresh* structure with the values of the Prefetch, Host, and
1789 * Write-Back threshold registers of the transmit ring.
1790 * When setting Write-Back threshold to the value greater then zero,
1791 * *tx_rs_thresh* value should be explicitly set to one.
1792 * - The *tx_free_thresh* value indicates the [minimum] number of network
1793 * buffers that must be pending in the transmit ring to trigger their
1794 * [implicit] freeing by the driver transmit function.
1795 * - The *tx_rs_thresh* value indicates the [minimum] number of transmit
1796 * descriptors that must be pending in the transmit ring before setting the
1797 * RS bit on a descriptor by the driver transmit function.
1798 * The *tx_rs_thresh* value should be less or equal then
1799 * *tx_free_thresh* value, and both of them should be less then
1801 * - The *offloads* member contains Tx offloads to be enabled.
1802 * If an offloading set in tx_conf->offloads
1803 * hasn't been set in the input argument eth_conf->txmode.offloads
1804 * to rte_eth_dev_configure(), it is a new added offloading, it must be
1805 * per-queue type and it is enabled for the queue.
1806 * No need to repeat any bit in tx_conf->offloads which has already been
1807 * enabled in rte_eth_dev_configure() at port level. An offloading enabled
1808 * at port level can't be disabled at queue level.
1810 * Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces
1811 * the transmit function to use default values.
1813 * - 0: Success, the transmit queue is correctly set up.
1814 * - -ENOMEM: Unable to allocate the transmit ring descriptors.
1816 int rte_eth_tx_queue_setup(uint16_t port_id, uint16_t tx_queue_id,
1817 uint16_t nb_tx_desc, unsigned int socket_id,
1818 const struct rte_eth_txconf *tx_conf);
1821 * Return the NUMA socket to which an Ethernet device is connected
1824 * The port identifier of the Ethernet device
1826 * The NUMA socket id to which the Ethernet device is connected or
1827 * a default of zero if the socket could not be determined.
1828 * -1 is returned is the port_id value is out of range.
1830 int rte_eth_dev_socket_id(uint16_t port_id);
1833 * Check if port_id of device is attached
1836 * The port identifier of the Ethernet device
1838 * - 0 if port is out of range or not attached
1839 * - 1 if device is attached
1841 int rte_eth_dev_is_valid_port(uint16_t port_id);
1844 * Start specified RX queue of a port. It is used when rx_deferred_start
1845 * flag of the specified queue is true.
1848 * The port identifier of the Ethernet device
1849 * @param rx_queue_id
1850 * The index of the rx queue to update the ring.
1851 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1852 * to rte_eth_dev_configure().
1854 * - 0: Success, the receive queue is started.
1855 * - -EINVAL: The port_id or the queue_id out of range.
1856 * - -EIO: if device is removed.
1857 * - -ENOTSUP: The function not supported in PMD driver.
1859 int rte_eth_dev_rx_queue_start(uint16_t port_id, uint16_t rx_queue_id);
1862 * Stop specified RX queue of a port
1865 * The port identifier of the Ethernet device
1866 * @param rx_queue_id
1867 * The index of the rx queue to update the ring.
1868 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1869 * to rte_eth_dev_configure().
1871 * - 0: Success, the receive queue is stopped.
1872 * - -EINVAL: The port_id or the queue_id out of range.
1873 * - -EIO: if device is removed.
1874 * - -ENOTSUP: The function not supported in PMD driver.
1876 int rte_eth_dev_rx_queue_stop(uint16_t port_id, uint16_t rx_queue_id);
1879 * Start TX for specified queue of a port. It is used when tx_deferred_start
1880 * flag of the specified queue is true.
1883 * The port identifier of the Ethernet device
1884 * @param tx_queue_id
1885 * The index of the tx queue to update the ring.
1886 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1887 * to rte_eth_dev_configure().
1889 * - 0: Success, the transmit queue is started.
1890 * - -EINVAL: The port_id or the queue_id out of range.
1891 * - -EIO: if device is removed.
1892 * - -ENOTSUP: The function not supported in PMD driver.
1894 int rte_eth_dev_tx_queue_start(uint16_t port_id, uint16_t tx_queue_id);
1897 * Stop specified TX queue of a port
1900 * The port identifier of the Ethernet device
1901 * @param tx_queue_id
1902 * The index of the tx queue to update the ring.
1903 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1904 * to rte_eth_dev_configure().
1906 * - 0: Success, the transmit queue is stopped.
1907 * - -EINVAL: The port_id or the queue_id out of range.
1908 * - -EIO: if device is removed.
1909 * - -ENOTSUP: The function not supported in PMD driver.
1911 int rte_eth_dev_tx_queue_stop(uint16_t port_id, uint16_t tx_queue_id);
1914 * Start an Ethernet device.
1916 * The device start step is the last one and consists of setting the configured
1917 * offload features and in starting the transmit and the receive units of the
1920 * Device RTE_ETH_DEV_NOLIVE_MAC_ADDR flag causes MAC address to be set before
1921 * PMD port start callback function is invoked.
1923 * On success, all basic functions exported by the Ethernet API (link status,
1924 * receive/transmit, and so on) can be invoked.
1927 * The port identifier of the Ethernet device.
1929 * - 0: Success, Ethernet device started.
1930 * - <0: Error code of the driver device start function.
1932 int rte_eth_dev_start(uint16_t port_id);
1935 * Stop an Ethernet device. The device can be restarted with a call to
1936 * rte_eth_dev_start()
1939 * The port identifier of the Ethernet device.
1941 void rte_eth_dev_stop(uint16_t port_id);
1944 * Link up an Ethernet device.
1946 * Set device link up will re-enable the device rx/tx
1947 * functionality after it is previously set device linked down.
1950 * The port identifier of the Ethernet device.
1952 * - 0: Success, Ethernet device linked up.
1953 * - <0: Error code of the driver device link up function.
1955 int rte_eth_dev_set_link_up(uint16_t port_id);
1958 * Link down an Ethernet device.
1959 * The device rx/tx functionality will be disabled if success,
1960 * and it can be re-enabled with a call to
1961 * rte_eth_dev_set_link_up()
1964 * The port identifier of the Ethernet device.
1966 int rte_eth_dev_set_link_down(uint16_t port_id);
1969 * Close a stopped Ethernet device. The device cannot be restarted!
1970 * The function frees all port resources if the driver supports
1971 * the flag RTE_ETH_DEV_CLOSE_REMOVE.
1974 * The port identifier of the Ethernet device.
1976 void rte_eth_dev_close(uint16_t port_id);
1979 * Reset a Ethernet device and keep its port id.
1981 * When a port has to be reset passively, the DPDK application can invoke
1982 * this function. For example when a PF is reset, all its VFs should also
1983 * be reset. Normally a DPDK application can invoke this function when
1984 * RTE_ETH_EVENT_INTR_RESET event is detected, but can also use it to start
1985 * a port reset in other circumstances.
1987 * When this function is called, it first stops the port and then calls the
1988 * PMD specific dev_uninit( ) and dev_init( ) to return the port to initial
1989 * state, in which no Tx and Rx queues are setup, as if the port has been
1990 * reset and not started. The port keeps the port id it had before the
1993 * After calling rte_eth_dev_reset( ), the application should use
1994 * rte_eth_dev_configure( ), rte_eth_rx_queue_setup( ),
1995 * rte_eth_tx_queue_setup( ), and rte_eth_dev_start( )
1996 * to reconfigure the device as appropriate.
1998 * Note: To avoid unexpected behavior, the application should stop calling
1999 * Tx and Rx functions before calling rte_eth_dev_reset( ). For thread
2000 * safety, all these controlling functions should be called from the same
2004 * The port identifier of the Ethernet device.
2007 * - (0) if successful.
2008 * - (-EINVAL) if port identifier is invalid.
2009 * - (-ENOTSUP) if hardware doesn't support this function.
2010 * - (-EPERM) if not ran from the primary process.
2011 * - (-EIO) if re-initialisation failed or device is removed.
2012 * - (-ENOMEM) if the reset failed due to OOM.
2013 * - (-EAGAIN) if the reset temporarily failed and should be retried later.
2015 int rte_eth_dev_reset(uint16_t port_id);
2018 * Enable receipt in promiscuous mode for an Ethernet device.
2021 * The port identifier of the Ethernet device.
2023 void rte_eth_promiscuous_enable(uint16_t port_id);
2026 * Disable receipt in promiscuous mode for an Ethernet device.
2029 * The port identifier of the Ethernet device.
2031 void rte_eth_promiscuous_disable(uint16_t port_id);
2034 * Return the value of promiscuous mode for an Ethernet device.
2037 * The port identifier of the Ethernet device.
2039 * - (1) if promiscuous is enabled
2040 * - (0) if promiscuous is disabled.
2043 int rte_eth_promiscuous_get(uint16_t port_id);
2046 * Enable the receipt of any multicast frame by an Ethernet device.
2049 * The port identifier of the Ethernet device.
2051 void rte_eth_allmulticast_enable(uint16_t port_id);
2054 * Disable the receipt of all multicast frames by an Ethernet device.
2057 * The port identifier of the Ethernet device.
2059 void rte_eth_allmulticast_disable(uint16_t port_id);
2062 * Return the value of allmulticast mode for an Ethernet device.
2065 * The port identifier of the Ethernet device.
2067 * - (1) if allmulticast is enabled
2068 * - (0) if allmulticast is disabled.
2071 int rte_eth_allmulticast_get(uint16_t port_id);
2074 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2075 * or FULL-DUPLEX) of the physical link of an Ethernet device. It might need
2076 * to wait up to 9 seconds in it.
2079 * The port identifier of the Ethernet device.
2081 * A pointer to an *rte_eth_link* structure to be filled with
2082 * the status, the speed and the mode of the Ethernet device link.
2084 void rte_eth_link_get(uint16_t port_id, struct rte_eth_link *link);
2087 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2088 * or FULL-DUPLEX) of the physical link of an Ethernet device. It is a no-wait
2089 * version of rte_eth_link_get().
2092 * The port identifier of the Ethernet device.
2094 * A pointer to an *rte_eth_link* structure to be filled with
2095 * the status, the speed and the mode of the Ethernet device link.
2097 void rte_eth_link_get_nowait(uint16_t port_id, struct rte_eth_link *link);
2100 * Retrieve the general I/O statistics of an Ethernet device.
2103 * The port identifier of the Ethernet device.
2105 * A pointer to a structure of type *rte_eth_stats* to be filled with
2106 * the values of device counters for the following set of statistics:
2107 * - *ipackets* with the total of successfully received packets.
2108 * - *opackets* with the total of successfully transmitted packets.
2109 * - *ibytes* with the total of successfully received bytes.
2110 * - *obytes* with the total of successfully transmitted bytes.
2111 * - *ierrors* with the total of erroneous received packets.
2112 * - *oerrors* with the total of failed transmitted packets.
2114 * Zero if successful. Non-zero otherwise.
2116 int rte_eth_stats_get(uint16_t port_id, struct rte_eth_stats *stats);
2119 * Reset the general I/O statistics of an Ethernet device.
2122 * The port identifier of the Ethernet device.
2124 * - (0) if device notified to reset stats.
2125 * - (-ENOTSUP) if hardware doesn't support.
2126 * - (-ENODEV) if *port_id* invalid.
2128 int rte_eth_stats_reset(uint16_t port_id);
2131 * Retrieve names of extended statistics of an Ethernet device.
2133 * There is an assumption that 'xstat_names' and 'xstats' arrays are matched
2135 * xstats_names[i].name => xstats[i].value
2137 * And the array index is same with id field of 'struct rte_eth_xstat':
2140 * This assumption makes key-value pair matching less flexible but simpler.
2143 * The port identifier of the Ethernet device.
2144 * @param xstats_names
2145 * An rte_eth_xstat_name array of at least *size* elements to
2146 * be filled. If set to NULL, the function returns the required number
2149 * The size of the xstats_names array (number of elements).
2151 * - A positive value lower or equal to size: success. The return value
2152 * is the number of entries filled in the stats table.
2153 * - A positive value higher than size: error, the given statistics table
2154 * is too small. The return value corresponds to the size that should
2155 * be given to succeed. The entries in the table are not valid and
2156 * shall not be used by the caller.
2157 * - A negative value on error (invalid port id).
2159 int rte_eth_xstats_get_names(uint16_t port_id,
2160 struct rte_eth_xstat_name *xstats_names,
2164 * Retrieve extended statistics of an Ethernet device.
2166 * There is an assumption that 'xstat_names' and 'xstats' arrays are matched
2168 * xstats_names[i].name => xstats[i].value
2170 * And the array index is same with id field of 'struct rte_eth_xstat':
2173 * This assumption makes key-value pair matching less flexible but simpler.
2176 * The port identifier of the Ethernet device.
2178 * A pointer to a table of structure of type *rte_eth_xstat*
2179 * to be filled with device statistics ids and values.
2180 * This parameter can be set to NULL if n is 0.
2182 * The size of the xstats array (number of elements).
2184 * - A positive value lower or equal to n: success. The return value
2185 * is the number of entries filled in the stats table.
2186 * - A positive value higher than n: error, the given statistics table
2187 * is too small. The return value corresponds to the size that should
2188 * be given to succeed. The entries in the table are not valid and
2189 * shall not be used by the caller.
2190 * - A negative value on error (invalid port id).
2192 int rte_eth_xstats_get(uint16_t port_id, struct rte_eth_xstat *xstats,
2196 * Retrieve names of extended statistics of an Ethernet device.
2199 * The port identifier of the Ethernet device.
2200 * @param xstats_names
2201 * An rte_eth_xstat_name array of at least *size* elements to
2202 * be filled. If set to NULL, the function returns the required number
2205 * IDs array given by app to retrieve specific statistics
2207 * The size of the xstats_names array (number of elements).
2209 * - A positive value lower or equal to size: success. The return value
2210 * is the number of entries filled in the stats table.
2211 * - A positive value higher than size: error, the given statistics table
2212 * is too small. The return value corresponds to the size that should
2213 * be given to succeed. The entries in the table are not valid and
2214 * shall not be used by the caller.
2215 * - A negative value on error (invalid port id).
2218 rte_eth_xstats_get_names_by_id(uint16_t port_id,
2219 struct rte_eth_xstat_name *xstats_names, unsigned int size,
2223 * Retrieve extended statistics of an Ethernet device.
2226 * The port identifier of the Ethernet device.
2228 * A pointer to an ids array passed by application. This tells which
2229 * statistics values function should retrieve. This parameter
2230 * can be set to NULL if size is 0. In this case function will retrieve
2231 * all available statistics.
2233 * A pointer to a table to be filled with device statistics values.
2235 * The size of the ids array (number of elements).
2237 * - A positive value lower or equal to size: success. The return value
2238 * is the number of entries filled in the stats table.
2239 * - A positive value higher than size: error, the given statistics table
2240 * is too small. The return value corresponds to the size that should
2241 * be given to succeed. The entries in the table are not valid and
2242 * shall not be used by the caller.
2243 * - A negative value on error (invalid port id).
2245 int rte_eth_xstats_get_by_id(uint16_t port_id, const uint64_t *ids,
2246 uint64_t *values, unsigned int size);
2249 * Gets the ID of a statistic from its name.
2251 * This function searches for the statistics using string compares, and
2252 * as such should not be used on the fast-path. For fast-path retrieval of
2253 * specific statistics, store the ID as provided in *id* from this function,
2254 * and pass the ID to rte_eth_xstats_get()
2256 * @param port_id The port to look up statistics from
2257 * @param xstat_name The name of the statistic to return
2258 * @param[out] id A pointer to an app-supplied uint64_t which should be
2259 * set to the ID of the stat if the stat exists.
2262 * -ENODEV for invalid port_id,
2263 * -EIO if device is removed,
2264 * -EINVAL if the xstat_name doesn't exist in port_id
2266 int rte_eth_xstats_get_id_by_name(uint16_t port_id, const char *xstat_name,
2270 * Reset extended statistics of an Ethernet device.
2273 * The port identifier of the Ethernet device.
2275 void rte_eth_xstats_reset(uint16_t port_id);
2278 * Set a mapping for the specified transmit queue to the specified per-queue
2279 * statistics counter.
2282 * The port identifier of the Ethernet device.
2283 * @param tx_queue_id
2284 * The index of the transmit queue for which a queue stats mapping is required.
2285 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2286 * to rte_eth_dev_configure().
2288 * The per-queue packet statistics functionality number that the transmit
2289 * queue is to be assigned.
2290 * The value must be in the range [0, RTE_ETHDEV_QUEUE_STAT_CNTRS - 1].
2292 * Zero if successful. Non-zero otherwise.
2294 int rte_eth_dev_set_tx_queue_stats_mapping(uint16_t port_id,
2295 uint16_t tx_queue_id, uint8_t stat_idx);
2298 * Set a mapping for the specified receive queue to the specified per-queue
2299 * statistics counter.
2302 * The port identifier of the Ethernet device.
2303 * @param rx_queue_id
2304 * The index of the receive queue for which a queue stats mapping is required.
2305 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2306 * to rte_eth_dev_configure().
2308 * The per-queue packet statistics functionality number that the receive
2309 * queue is to be assigned.
2310 * The value must be in the range [0, RTE_ETHDEV_QUEUE_STAT_CNTRS - 1].
2312 * Zero if successful. Non-zero otherwise.
2314 int rte_eth_dev_set_rx_queue_stats_mapping(uint16_t port_id,
2315 uint16_t rx_queue_id,
2319 * Retrieve the Ethernet address of an Ethernet device.
2322 * The port identifier of the Ethernet device.
2324 * A pointer to a structure of type *ether_addr* to be filled with
2325 * the Ethernet address of the Ethernet device.
2327 void rte_eth_macaddr_get(uint16_t port_id, struct rte_ether_addr *mac_addr);
2330 * Retrieve the contextual information of an Ethernet device.
2332 * As part of this function, a number of of fields in dev_info will be
2333 * initialized as follows:
2338 * Where lim is defined within the rte_eth_dev_info_get as
2340 * const struct rte_eth_desc_lim lim = {
2341 * .nb_max = UINT16_MAX,
2344 * .nb_seg_max = UINT16_MAX,
2345 * .nb_mtu_seg_max = UINT16_MAX,
2348 * device = dev->device
2349 * min_mtu = RTE_ETHER_MIN_MTU
2350 * max_mtu = UINT16_MAX
2352 * The following fields will be populated if support for dev_infos_get()
2353 * exists for the device and the rte_eth_dev 'dev' has been populated
2354 * successfully with a call to it:
2356 * driver_name = dev->device->driver->name
2357 * nb_rx_queues = dev->data->nb_rx_queues
2358 * nb_tx_queues = dev->data->nb_tx_queues
2359 * dev_flags = &dev->data->dev_flags
2362 * The port identifier of the Ethernet device.
2364 * A pointer to a structure of type *rte_eth_dev_info* to be filled with
2365 * the contextual information of the Ethernet device.
2367 void rte_eth_dev_info_get(uint16_t port_id, struct rte_eth_dev_info *dev_info);
2370 * Retrieve the firmware version of a device.
2373 * The port identifier of the device.
2375 * A pointer to a string array storing the firmware version of a device,
2376 * the string includes terminating null. This pointer is allocated by caller.
2378 * The size of the string array pointed by fw_version, which should be
2379 * large enough to store firmware version of the device.
2381 * - (0) if successful.
2382 * - (-ENOTSUP) if operation is not supported.
2383 * - (-ENODEV) if *port_id* invalid.
2384 * - (-EIO) if device is removed.
2385 * - (>0) if *fw_size* is not enough to store firmware version, return
2386 * the size of the non truncated string.
2388 int rte_eth_dev_fw_version_get(uint16_t port_id,
2389 char *fw_version, size_t fw_size);
2392 * Retrieve the supported packet types of an Ethernet device.
2394 * When a packet type is announced as supported, it *must* be recognized by
2395 * the PMD. For instance, if RTE_PTYPE_L2_ETHER, RTE_PTYPE_L2_ETHER_VLAN
2396 * and RTE_PTYPE_L3_IPV4 are announced, the PMD must return the following
2397 * packet types for these packets:
2398 * - Ether/IPv4 -> RTE_PTYPE_L2_ETHER | RTE_PTYPE_L3_IPV4
2399 * - Ether/Vlan/IPv4 -> RTE_PTYPE_L2_ETHER_VLAN | RTE_PTYPE_L3_IPV4
2400 * - Ether/[anything else] -> RTE_PTYPE_L2_ETHER
2401 * - Ether/Vlan/[anything else] -> RTE_PTYPE_L2_ETHER_VLAN
2403 * When a packet is received by a PMD, the most precise type must be
2404 * returned among the ones supported. However a PMD is allowed to set
2405 * packet type that is not in the supported list, at the condition that it
2406 * is more precise. Therefore, a PMD announcing no supported packet types
2407 * can still set a matching packet type in a received packet.
2410 * Better to invoke this API after the device is already started or rx burst
2411 * function is decided, to obtain correct supported ptypes.
2413 * if a given PMD does not report what ptypes it supports, then the supported
2414 * ptype count is reported as 0.
2416 * The port identifier of the Ethernet device.
2418 * A hint of what kind of packet type which the caller is interested in.
2420 * An array pointer to store adequate packet types, allocated by caller.
2422 * Size of the array pointed by param ptypes.
2424 * - (>=0) Number of supported ptypes. If the number of types exceeds num,
2425 * only num entries will be filled into the ptypes array, but the full
2426 * count of supported ptypes will be returned.
2427 * - (-ENODEV) if *port_id* invalid.
2429 int rte_eth_dev_get_supported_ptypes(uint16_t port_id, uint32_t ptype_mask,
2430 uint32_t *ptypes, int num);
2433 * Retrieve the MTU of an Ethernet device.
2436 * The port identifier of the Ethernet device.
2438 * A pointer to a uint16_t where the retrieved MTU is to be stored.
2440 * - (0) if successful.
2441 * - (-ENODEV) if *port_id* invalid.
2443 int rte_eth_dev_get_mtu(uint16_t port_id, uint16_t *mtu);
2446 * Change the MTU of an Ethernet device.
2449 * The port identifier of the Ethernet device.
2451 * A uint16_t for the MTU to be applied.
2453 * - (0) if successful.
2454 * - (-ENOTSUP) if operation is not supported.
2455 * - (-ENODEV) if *port_id* invalid.
2456 * - (-EIO) if device is removed.
2457 * - (-EINVAL) if *mtu* invalid, validation of mtu can occur within
2458 * rte_eth_dev_set_mtu if dev_infos_get is supported by the device or
2459 * when the mtu is set using dev->dev_ops->mtu_set.
2460 * - (-EBUSY) if operation is not allowed when the port is running
2462 int rte_eth_dev_set_mtu(uint16_t port_id, uint16_t mtu);
2465 * Enable/Disable hardware filtering by an Ethernet device of received
2466 * VLAN packets tagged with a given VLAN Tag Identifier.
2469 * The port identifier of the Ethernet device.
2471 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
2473 * If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*.
2474 * Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*.
2476 * - (0) if successful.
2477 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2478 * - (-ENODEV) if *port_id* invalid.
2479 * - (-EIO) if device is removed.
2480 * - (-ENOSYS) if VLAN filtering on *port_id* disabled.
2481 * - (-EINVAL) if *vlan_id* > 4095.
2483 int rte_eth_dev_vlan_filter(uint16_t port_id, uint16_t vlan_id, int on);
2486 * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
2487 * 82599/X540/X550 can support VLAN stripping at the rx queue level
2490 * The port identifier of the Ethernet device.
2491 * @param rx_queue_id
2492 * The index of the receive queue for which a queue stats mapping is required.
2493 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2494 * to rte_eth_dev_configure().
2496 * If 1, Enable VLAN Stripping of the receive queue of the Ethernet port.
2497 * If 0, Disable VLAN Stripping of the receive queue of the Ethernet port.
2499 * - (0) if successful.
2500 * - (-ENOSUP) if hardware-assisted VLAN stripping not configured.
2501 * - (-ENODEV) if *port_id* invalid.
2502 * - (-EINVAL) if *rx_queue_id* invalid.
2504 int rte_eth_dev_set_vlan_strip_on_queue(uint16_t port_id, uint16_t rx_queue_id,
2508 * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
2509 * the VLAN Header. This is a register setup available on some Intel NIC, not
2510 * but all, please check the data sheet for availability.
2513 * The port identifier of the Ethernet device.
2517 * The Tag Protocol ID
2519 * - (0) if successful.
2520 * - (-ENOSUP) if hardware-assisted VLAN TPID setup is not supported.
2521 * - (-ENODEV) if *port_id* invalid.
2522 * - (-EIO) if device is removed.
2524 int rte_eth_dev_set_vlan_ether_type(uint16_t port_id,
2525 enum rte_vlan_type vlan_type,
2529 * Set VLAN offload configuration on an Ethernet device
2530 * Enable/Disable Extended VLAN by an Ethernet device, This is a register setup
2531 * available on some Intel NIC, not but all, please check the data sheet for
2533 * Enable/Disable VLAN Strip can be done on rx queue for certain NIC, but here
2534 * the configuration is applied on the port level.
2537 * The port identifier of the Ethernet device.
2538 * @param offload_mask
2539 * The VLAN Offload bit mask can be mixed use with "OR"
2540 * ETH_VLAN_STRIP_OFFLOAD
2541 * ETH_VLAN_FILTER_OFFLOAD
2542 * ETH_VLAN_EXTEND_OFFLOAD
2544 * - (0) if successful.
2545 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2546 * - (-ENODEV) if *port_id* invalid.
2547 * - (-EIO) if device is removed.
2549 int rte_eth_dev_set_vlan_offload(uint16_t port_id, int offload_mask);
2552 * Read VLAN Offload configuration from an Ethernet device
2555 * The port identifier of the Ethernet device.
2557 * - (>0) if successful. Bit mask to indicate
2558 * ETH_VLAN_STRIP_OFFLOAD
2559 * ETH_VLAN_FILTER_OFFLOAD
2560 * ETH_VLAN_EXTEND_OFFLOAD
2561 * - (-ENODEV) if *port_id* invalid.
2563 int rte_eth_dev_get_vlan_offload(uint16_t port_id);
2566 * Set port based TX VLAN insertion on or off.
2569 * The port identifier of the Ethernet device.
2571 * Port based TX VLAN identifier together with user priority.
2573 * Turn on or off the port based TX VLAN insertion.
2576 * - (0) if successful.
2577 * - negative if failed.
2579 int rte_eth_dev_set_vlan_pvid(uint16_t port_id, uint16_t pvid, int on);
2581 typedef void (*buffer_tx_error_fn)(struct rte_mbuf **unsent, uint16_t count,
2585 * Structure used to buffer packets for future TX
2586 * Used by APIs rte_eth_tx_buffer and rte_eth_tx_buffer_flush
2588 struct rte_eth_dev_tx_buffer {
2589 buffer_tx_error_fn error_callback;
2590 void *error_userdata;
2591 uint16_t size; /**< Size of buffer for buffered tx */
2592 uint16_t length; /**< Number of packets in the array */
2593 struct rte_mbuf *pkts[];
2594 /**< Pending packets to be sent on explicit flush or when full */
2598 * Calculate the size of the tx buffer.
2601 * Number of stored packets.
2603 #define RTE_ETH_TX_BUFFER_SIZE(sz) \
2604 (sizeof(struct rte_eth_dev_tx_buffer) + (sz) * sizeof(struct rte_mbuf *))
2607 * Initialize default values for buffered transmitting
2610 * Tx buffer to be initialized.
2617 rte_eth_tx_buffer_init(struct rte_eth_dev_tx_buffer *buffer, uint16_t size);
2620 * Configure a callback for buffered packets which cannot be sent
2622 * Register a specific callback to be called when an attempt is made to send
2623 * all packets buffered on an ethernet port, but not all packets can
2624 * successfully be sent. The callback registered here will be called only
2625 * from calls to rte_eth_tx_buffer() and rte_eth_tx_buffer_flush() APIs.
2626 * The default callback configured for each queue by default just frees the
2627 * packets back to the calling mempool. If additional behaviour is required,
2628 * for example, to count dropped packets, or to retry transmission of packets
2629 * which cannot be sent, this function should be used to register a suitable
2630 * callback function to implement the desired behaviour.
2631 * The example callback "rte_eth_count_unsent_packet_callback()" is also
2632 * provided as reference.
2635 * The port identifier of the Ethernet device.
2637 * The function to be used as the callback.
2639 * Arbitrary parameter to be passed to the callback function
2641 * 0 on success, or -1 on error with rte_errno set appropriately
2644 rte_eth_tx_buffer_set_err_callback(struct rte_eth_dev_tx_buffer *buffer,
2645 buffer_tx_error_fn callback, void *userdata);
2648 * Callback function for silently dropping unsent buffered packets.
2650 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
2651 * adjust the default behavior when buffered packets cannot be sent. This
2652 * function drops any unsent packets silently and is used by tx buffered
2653 * operations as default behavior.
2655 * NOTE: this function should not be called directly, instead it should be used
2656 * as a callback for packet buffering.
2658 * NOTE: when configuring this function as a callback with
2659 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
2660 * should point to an uint64_t value.
2663 * The previously buffered packets which could not be sent
2665 * The number of unsent packets in the pkts array
2670 rte_eth_tx_buffer_drop_callback(struct rte_mbuf **pkts, uint16_t unsent,
2674 * Callback function for tracking unsent buffered packets.
2676 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
2677 * adjust the default behavior when buffered packets cannot be sent. This
2678 * function drops any unsent packets, but also updates a user-supplied counter
2679 * to track the overall number of packets dropped. The counter should be an
2680 * uint64_t variable.
2682 * NOTE: this function should not be called directly, instead it should be used
2683 * as a callback for packet buffering.
2685 * NOTE: when configuring this function as a callback with
2686 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
2687 * should point to an uint64_t value.
2690 * The previously buffered packets which could not be sent
2692 * The number of unsent packets in the pkts array
2694 * Pointer to an uint64_t value, which will be incremented by unsent
2697 rte_eth_tx_buffer_count_callback(struct rte_mbuf **pkts, uint16_t unsent,
2701 * Request the driver to free mbufs currently cached by the driver. The
2702 * driver will only free the mbuf if it is no longer in use. It is the
2703 * application's responsibility to ensure rte_eth_tx_buffer_flush(..) is
2707 * The port identifier of the Ethernet device.
2709 * The index of the transmit queue through which output packets must be
2711 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2712 * to rte_eth_dev_configure().
2714 * Maximum number of packets to free. Use 0 to indicate all possible packets
2715 * should be freed. Note that a packet may be using multiple mbufs.
2718 * -ENODEV: Invalid interface
2719 * -EIO: device is removed
2720 * -ENOTSUP: Driver does not support function
2722 * 0-n: Number of packets freed. More packets may still remain in ring that
2726 rte_eth_tx_done_cleanup(uint16_t port_id, uint16_t queue_id, uint32_t free_cnt);
2729 * Subtypes for IPsec offload event(@ref RTE_ETH_EVENT_IPSEC) raised by
2732 enum rte_eth_event_ipsec_subtype {
2733 RTE_ETH_EVENT_IPSEC_UNKNOWN = 0,
2734 /**< Unknown event type */
2735 RTE_ETH_EVENT_IPSEC_ESN_OVERFLOW,
2736 /**< Sequence number overflow */
2737 RTE_ETH_EVENT_IPSEC_SA_TIME_EXPIRY,
2738 /**< Soft time expiry of SA */
2739 RTE_ETH_EVENT_IPSEC_SA_BYTE_EXPIRY,
2740 /**< Soft byte expiry of SA */
2741 RTE_ETH_EVENT_IPSEC_MAX
2742 /**< Max value of this enum */
2746 * Descriptor for @ref RTE_ETH_EVENT_IPSEC event. Used by eth dev to send extra
2747 * information of the IPsec offload event.
2749 struct rte_eth_event_ipsec_desc {
2750 enum rte_eth_event_ipsec_subtype subtype;
2751 /**< Type of RTE_ETH_EVENT_IPSEC_* event */
2753 /**< Event specific metadata
2755 * For the following events, *userdata* registered
2756 * with the *rte_security_session* would be returned
2759 * - @ref RTE_ETH_EVENT_IPSEC_ESN_OVERFLOW
2760 * - @ref RTE_ETH_EVENT_IPSEC_SA_TIME_EXPIRY
2761 * - @ref RTE_ETH_EVENT_IPSEC_SA_BYTE_EXPIRY
2763 * @see struct rte_security_session_conf
2769 * The eth device event type for interrupt, and maybe others in the future.
2771 enum rte_eth_event_type {
2772 RTE_ETH_EVENT_UNKNOWN, /**< unknown event type */
2773 RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
2774 RTE_ETH_EVENT_QUEUE_STATE,
2775 /**< queue state event (enabled/disabled) */
2776 RTE_ETH_EVENT_INTR_RESET,
2777 /**< reset interrupt event, sent to VF on PF reset */
2778 RTE_ETH_EVENT_VF_MBOX, /**< message from the VF received by PF */
2779 RTE_ETH_EVENT_MACSEC, /**< MACsec offload related event */
2780 RTE_ETH_EVENT_INTR_RMV, /**< device removal event */
2781 RTE_ETH_EVENT_NEW, /**< port is probed */
2782 RTE_ETH_EVENT_DESTROY, /**< port is released */
2783 RTE_ETH_EVENT_IPSEC, /**< IPsec offload related event */
2784 RTE_ETH_EVENT_MAX /**< max value of this enum */
2787 typedef int (*rte_eth_dev_cb_fn)(uint16_t port_id,
2788 enum rte_eth_event_type event, void *cb_arg, void *ret_param);
2789 /**< user application callback to be registered for interrupts */
2792 * Register a callback function for port event.
2796 * RTE_ETH_ALL means register the event for all port ids.
2800 * User supplied callback function to be called.
2802 * Pointer to the parameters for the registered callback.
2805 * - On success, zero.
2806 * - On failure, a negative value.
2808 int rte_eth_dev_callback_register(uint16_t port_id,
2809 enum rte_eth_event_type event,
2810 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
2813 * Unregister a callback function for port event.
2817 * RTE_ETH_ALL means unregister the event for all port ids.
2821 * User supplied callback function to be called.
2823 * Pointer to the parameters for the registered callback. -1 means to
2824 * remove all for the same callback address and same event.
2827 * - On success, zero.
2828 * - On failure, a negative value.
2830 int rte_eth_dev_callback_unregister(uint16_t port_id,
2831 enum rte_eth_event_type event,
2832 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
2835 * When there is no rx packet coming in Rx Queue for a long time, we can
2836 * sleep lcore related to RX Queue for power saving, and enable rx interrupt
2837 * to be triggered when Rx packet arrives.
2839 * The rte_eth_dev_rx_intr_enable() function enables rx queue
2840 * interrupt on specific rx queue of a port.
2843 * The port identifier of the Ethernet device.
2845 * The index of the receive queue from which to retrieve input packets.
2846 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2847 * to rte_eth_dev_configure().
2849 * - (0) if successful.
2850 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
2852 * - (-ENODEV) if *port_id* invalid.
2853 * - (-EIO) if device is removed.
2855 int rte_eth_dev_rx_intr_enable(uint16_t port_id, uint16_t queue_id);
2858 * When lcore wakes up from rx interrupt indicating packet coming, disable rx
2859 * interrupt and returns to polling mode.
2861 * The rte_eth_dev_rx_intr_disable() function disables rx queue
2862 * interrupt on specific rx queue of a port.
2865 * The port identifier of the Ethernet device.
2867 * The index of the receive queue from which to retrieve input packets.
2868 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2869 * to rte_eth_dev_configure().
2871 * - (0) if successful.
2872 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
2874 * - (-ENODEV) if *port_id* invalid.
2875 * - (-EIO) if device is removed.
2877 int rte_eth_dev_rx_intr_disable(uint16_t port_id, uint16_t queue_id);
2880 * RX Interrupt control per port.
2883 * The port identifier of the Ethernet device.
2885 * Epoll instance fd which the intr vector associated to.
2886 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
2888 * The operation be performed for the vector.
2889 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
2893 * - On success, zero.
2894 * - On failure, a negative value.
2896 int rte_eth_dev_rx_intr_ctl(uint16_t port_id, int epfd, int op, void *data);
2899 * RX Interrupt control per queue.
2902 * The port identifier of the Ethernet device.
2904 * The index of the receive queue from which to retrieve input packets.
2905 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2906 * to rte_eth_dev_configure().
2908 * Epoll instance fd which the intr vector associated to.
2909 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
2911 * The operation be performed for the vector.
2912 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
2916 * - On success, zero.
2917 * - On failure, a negative value.
2919 int rte_eth_dev_rx_intr_ctl_q(uint16_t port_id, uint16_t queue_id,
2920 int epfd, int op, void *data);
2924 * @b EXPERIMENTAL: this API may change without prior notice.
2926 * Get interrupt fd per Rx queue.
2929 * The port identifier of the Ethernet device.
2931 * The index of the receive queue from which to retrieve input packets.
2932 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2933 * to rte_eth_dev_configure().
2935 * - (>=0) the interrupt fd associated to the requested Rx queue if
2941 rte_eth_dev_rx_intr_ctl_q_get_fd(uint16_t port_id, uint16_t queue_id);
2944 * Turn on the LED on the Ethernet device.
2945 * This function turns on the LED on the Ethernet device.
2948 * The port identifier of the Ethernet device.
2950 * - (0) if successful.
2951 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
2953 * - (-ENODEV) if *port_id* invalid.
2954 * - (-EIO) if device is removed.
2956 int rte_eth_led_on(uint16_t port_id);
2959 * Turn off the LED on the Ethernet device.
2960 * This function turns off the LED on the Ethernet device.
2963 * The port identifier of the Ethernet device.
2965 * - (0) if successful.
2966 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
2968 * - (-ENODEV) if *port_id* invalid.
2969 * - (-EIO) if device is removed.
2971 int rte_eth_led_off(uint16_t port_id);
2974 * Get current status of the Ethernet link flow control for Ethernet device
2977 * The port identifier of the Ethernet device.
2979 * The pointer to the structure where to store the flow control parameters.
2981 * - (0) if successful.
2982 * - (-ENOTSUP) if hardware doesn't support flow control.
2983 * - (-ENODEV) if *port_id* invalid.
2984 * - (-EIO) if device is removed.
2986 int rte_eth_dev_flow_ctrl_get(uint16_t port_id,
2987 struct rte_eth_fc_conf *fc_conf);
2990 * Configure the Ethernet link flow control for Ethernet device
2993 * The port identifier of the Ethernet device.
2995 * The pointer to the structure of the flow control parameters.
2997 * - (0) if successful.
2998 * - (-ENOTSUP) if hardware doesn't support flow control mode.
2999 * - (-ENODEV) if *port_id* invalid.
3000 * - (-EINVAL) if bad parameter
3001 * - (-EIO) if flow control setup failure or device is removed.
3003 int rte_eth_dev_flow_ctrl_set(uint16_t port_id,
3004 struct rte_eth_fc_conf *fc_conf);
3007 * Configure the Ethernet priority flow control under DCB environment
3008 * for Ethernet device.
3011 * The port identifier of the Ethernet device.
3013 * The pointer to the structure of the priority flow control parameters.
3015 * - (0) if successful.
3016 * - (-ENOTSUP) if hardware doesn't support priority flow control mode.
3017 * - (-ENODEV) if *port_id* invalid.
3018 * - (-EINVAL) if bad parameter
3019 * - (-EIO) if flow control setup failure or device is removed.
3021 int rte_eth_dev_priority_flow_ctrl_set(uint16_t port_id,
3022 struct rte_eth_pfc_conf *pfc_conf);
3025 * Add a MAC address to an internal array of addresses used to enable whitelist
3026 * filtering to accept packets only if the destination MAC address matches.
3029 * The port identifier of the Ethernet device.
3031 * The MAC address to add.
3033 * VMDq pool index to associate address with (if VMDq is enabled). If VMDq is
3034 * not enabled, this should be set to 0.
3036 * - (0) if successfully added or *mac_addr* was already added.
3037 * - (-ENOTSUP) if hardware doesn't support this feature.
3038 * - (-ENODEV) if *port* is invalid.
3039 * - (-EIO) if device is removed.
3040 * - (-ENOSPC) if no more MAC addresses can be added.
3041 * - (-EINVAL) if MAC address is invalid.
3043 int rte_eth_dev_mac_addr_add(uint16_t port_id, struct rte_ether_addr *mac_addr,
3047 * Remove a MAC address from the internal array of addresses.
3050 * The port identifier of the Ethernet device.
3052 * MAC address to remove.
3054 * - (0) if successful, or *mac_addr* didn't exist.
3055 * - (-ENOTSUP) if hardware doesn't support.
3056 * - (-ENODEV) if *port* invalid.
3057 * - (-EADDRINUSE) if attempting to remove the default MAC address
3059 int rte_eth_dev_mac_addr_remove(uint16_t port_id,
3060 struct rte_ether_addr *mac_addr);
3063 * Set the default MAC address.
3066 * The port identifier of the Ethernet device.
3068 * New default MAC address.
3070 * - (0) if successful, or *mac_addr* didn't exist.
3071 * - (-ENOTSUP) if hardware doesn't support.
3072 * - (-ENODEV) if *port* invalid.
3073 * - (-EINVAL) if MAC address is invalid.
3075 int rte_eth_dev_default_mac_addr_set(uint16_t port_id,
3076 struct rte_ether_addr *mac_addr);
3079 * Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3082 * The port identifier of the Ethernet device.
3086 * Redirection table size. The table size can be queried by
3087 * rte_eth_dev_info_get().
3089 * - (0) if successful.
3090 * - (-ENOTSUP) if hardware doesn't support.
3091 * - (-EINVAL) if bad parameter.
3092 * - (-EIO) if device is removed.
3094 int rte_eth_dev_rss_reta_update(uint16_t port_id,
3095 struct rte_eth_rss_reta_entry64 *reta_conf,
3096 uint16_t reta_size);
3099 * Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3102 * The port identifier of the Ethernet device.
3104 * RETA to query. For each requested reta entry, corresponding bit
3105 * in mask must be set.
3107 * Redirection table size. The table size can be queried by
3108 * rte_eth_dev_info_get().
3110 * - (0) if successful.
3111 * - (-ENOTSUP) if hardware doesn't support.
3112 * - (-EINVAL) if bad parameter.
3113 * - (-EIO) if device is removed.
3115 int rte_eth_dev_rss_reta_query(uint16_t port_id,
3116 struct rte_eth_rss_reta_entry64 *reta_conf,
3117 uint16_t reta_size);
3120 * Updates unicast hash table for receiving packet with the given destination
3121 * MAC address, and the packet is routed to all VFs for which the RX mode is
3122 * accept packets that match the unicast hash table.
3125 * The port identifier of the Ethernet device.
3127 * Unicast MAC address.
3129 * 1 - Set an unicast hash bit for receiving packets with the MAC address.
3130 * 0 - Clear an unicast hash bit.
3132 * - (0) if successful.
3133 * - (-ENOTSUP) if hardware doesn't support.
3134 * - (-ENODEV) if *port_id* invalid.
3135 * - (-EIO) if device is removed.
3136 * - (-EINVAL) if bad parameter.
3138 int rte_eth_dev_uc_hash_table_set(uint16_t port_id, struct rte_ether_addr *addr,
3142 * Updates all unicast hash bitmaps for receiving packet with any Unicast
3143 * Ethernet MAC addresses,the packet is routed to all VFs for which the RX
3144 * mode is accept packets that match the unicast hash table.
3147 * The port identifier of the Ethernet device.
3149 * 1 - Set all unicast hash bitmaps for receiving all the Ethernet
3151 * 0 - Clear all unicast hash bitmaps
3153 * - (0) if successful.
3154 * - (-ENOTSUP) if hardware doesn't support.
3155 * - (-ENODEV) if *port_id* invalid.
3156 * - (-EIO) if device is removed.
3157 * - (-EINVAL) if bad parameter.
3159 int rte_eth_dev_uc_all_hash_table_set(uint16_t port_id, uint8_t on);
3162 * Set a traffic mirroring rule on an Ethernet device
3165 * The port identifier of the Ethernet device.
3166 * @param mirror_conf
3167 * The pointer to the traffic mirroring structure describing the mirroring rule.
3168 * The *rte_eth_vm_mirror_conf* structure includes the type of mirroring rule,
3169 * destination pool and the value of rule if enable vlan or pool mirroring.
3172 * The index of traffic mirroring rule, we support four separated rules.
3174 * 1 - Enable a mirroring rule.
3175 * 0 - Disable a mirroring rule.
3177 * - (0) if successful.
3178 * - (-ENOTSUP) if hardware doesn't support this feature.
3179 * - (-ENODEV) if *port_id* invalid.
3180 * - (-EIO) if device is removed.
3181 * - (-EINVAL) if the mr_conf information is not correct.
3183 int rte_eth_mirror_rule_set(uint16_t port_id,
3184 struct rte_eth_mirror_conf *mirror_conf,
3189 * Reset a traffic mirroring rule on an Ethernet device.
3192 * The port identifier of the Ethernet device.
3194 * The index of traffic mirroring rule, we support four separated rules.
3196 * - (0) if successful.
3197 * - (-ENOTSUP) if hardware doesn't support this feature.
3198 * - (-ENODEV) if *port_id* invalid.
3199 * - (-EIO) if device is removed.
3200 * - (-EINVAL) if bad parameter.
3202 int rte_eth_mirror_rule_reset(uint16_t port_id,
3206 * Set the rate limitation for a queue on an Ethernet device.
3209 * The port identifier of the Ethernet device.
3213 * The tx rate in Mbps. Allocated from the total port link speed.
3215 * - (0) if successful.
3216 * - (-ENOTSUP) if hardware doesn't support this feature.
3217 * - (-ENODEV) if *port_id* invalid.
3218 * - (-EIO) if device is removed.
3219 * - (-EINVAL) if bad parameter.
3221 int rte_eth_set_queue_rate_limit(uint16_t port_id, uint16_t queue_idx,
3225 * Configuration of Receive Side Scaling hash computation of Ethernet device.
3228 * The port identifier of the Ethernet device.
3230 * The new configuration to use for RSS hash computation on the port.
3232 * - (0) if successful.
3233 * - (-ENODEV) if port identifier is invalid.
3234 * - (-EIO) if device is removed.
3235 * - (-ENOTSUP) if hardware doesn't support.
3236 * - (-EINVAL) if bad parameter.
3238 int rte_eth_dev_rss_hash_update(uint16_t port_id,
3239 struct rte_eth_rss_conf *rss_conf);
3242 * Retrieve current configuration of Receive Side Scaling hash computation
3243 * of Ethernet device.
3246 * The port identifier of the Ethernet device.
3248 * Where to store the current RSS hash configuration of the Ethernet device.
3250 * - (0) if successful.
3251 * - (-ENODEV) if port identifier is invalid.
3252 * - (-EIO) if device is removed.
3253 * - (-ENOTSUP) if hardware doesn't support RSS.
3256 rte_eth_dev_rss_hash_conf_get(uint16_t port_id,
3257 struct rte_eth_rss_conf *rss_conf);
3260 * Add UDP tunneling port for a specific type of tunnel.
3261 * The packets with this UDP port will be identified as this type of tunnel.
3262 * Before enabling any offloading function for a tunnel, users can call this API
3263 * to change or add more UDP port for the tunnel. So the offloading function
3264 * can take effect on the packets with the specific UDP port.
3267 * The port identifier of the Ethernet device.
3269 * UDP tunneling configuration.
3272 * - (0) if successful.
3273 * - (-ENODEV) if port identifier is invalid.
3274 * - (-EIO) if device is removed.
3275 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3278 rte_eth_dev_udp_tunnel_port_add(uint16_t port_id,
3279 struct rte_eth_udp_tunnel *tunnel_udp);
3282 * Delete UDP tunneling port a specific type of tunnel.
3283 * The packets with this UDP port will not be identified as this type of tunnel
3285 * Before enabling any offloading function for a tunnel, users can call this API
3286 * to delete a UDP port for the tunnel. So the offloading function will not take
3287 * effect on the packets with the specific UDP port.
3290 * The port identifier of the Ethernet device.
3292 * UDP tunneling configuration.
3295 * - (0) if successful.
3296 * - (-ENODEV) if port identifier is invalid.
3297 * - (-EIO) if device is removed.
3298 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3301 rte_eth_dev_udp_tunnel_port_delete(uint16_t port_id,
3302 struct rte_eth_udp_tunnel *tunnel_udp);
3305 * Check whether the filter type is supported on an Ethernet device.
3306 * All the supported filter types are defined in 'rte_eth_ctrl.h'.
3309 * The port identifier of the Ethernet device.
3310 * @param filter_type
3313 * - (0) if successful.
3314 * - (-ENOTSUP) if hardware doesn't support this filter type.
3315 * - (-ENODEV) if *port_id* invalid.
3316 * - (-EIO) if device is removed.
3319 int rte_eth_dev_filter_supported(uint16_t port_id,
3320 enum rte_filter_type filter_type);
3323 * Take operations to assigned filter type on an Ethernet device.
3324 * All the supported operations and filter types are defined in 'rte_eth_ctrl.h'.
3327 * The port identifier of the Ethernet device.
3328 * @param filter_type
3331 * Type of operation.
3333 * A pointer to arguments defined specifically for the operation.
3335 * - (0) if successful.
3336 * - (-ENOTSUP) if hardware doesn't support.
3337 * - (-ENODEV) if *port_id* invalid.
3338 * - (-EIO) if device is removed.
3339 * - others depends on the specific operations implementation.
3342 int rte_eth_dev_filter_ctrl(uint16_t port_id, enum rte_filter_type filter_type,
3343 enum rte_filter_op filter_op, void *arg);
3346 * Get DCB information on an Ethernet device.
3349 * The port identifier of the Ethernet device.
3353 * - (0) if successful.
3354 * - (-ENODEV) if port identifier is invalid.
3355 * - (-EIO) if device is removed.
3356 * - (-ENOTSUP) if hardware doesn't support.
3358 int rte_eth_dev_get_dcb_info(uint16_t port_id,
3359 struct rte_eth_dcb_info *dcb_info);
3361 struct rte_eth_rxtx_callback;
3364 * Add a callback to be called on packet RX on a given port and queue.
3366 * This API configures a function to be called for each burst of
3367 * packets received on a given NIC port queue. The return value is a pointer
3368 * that can be used to later remove the callback using
3369 * rte_eth_remove_rx_callback().
3371 * Multiple functions are called in the order that they are added.
3374 * The port identifier of the Ethernet device.
3376 * The queue on the Ethernet device on which the callback is to be added.
3378 * The callback function
3380 * A generic pointer parameter which will be passed to each invocation of the
3381 * callback function on this port and queue.
3385 * On success, a pointer value which can later be used to remove the callback.
3387 const struct rte_eth_rxtx_callback *
3388 rte_eth_add_rx_callback(uint16_t port_id, uint16_t queue_id,
3389 rte_rx_callback_fn fn, void *user_param);
3392 * Add a callback that must be called first on packet RX on a given port
3395 * This API configures a first function to be called for each burst of
3396 * packets received on a given NIC port queue. The return value is a pointer
3397 * that can be used to later remove the callback using
3398 * rte_eth_remove_rx_callback().
3400 * Multiple functions are called in the order that they are added.
3403 * The port identifier of the Ethernet device.
3405 * The queue on the Ethernet device on which the callback is to be added.
3407 * The callback function
3409 * A generic pointer parameter which will be passed to each invocation of the
3410 * callback function on this port and queue.
3414 * On success, a pointer value which can later be used to remove the callback.
3416 const struct rte_eth_rxtx_callback *
3417 rte_eth_add_first_rx_callback(uint16_t port_id, uint16_t queue_id,
3418 rte_rx_callback_fn fn, void *user_param);
3421 * Add a callback to be called on packet TX on a given port and queue.
3423 * This API configures a function to be called for each burst of
3424 * packets sent on a given NIC port queue. The return value is a pointer
3425 * that can be used to later remove the callback using
3426 * rte_eth_remove_tx_callback().
3428 * Multiple functions are called in the order that they are added.
3431 * The port identifier of the Ethernet device.
3433 * The queue on the Ethernet device on which the callback is to be added.
3435 * The callback function
3437 * A generic pointer parameter which will be passed to each invocation of the
3438 * callback function on this port and queue.
3442 * On success, a pointer value which can later be used to remove the callback.
3444 const struct rte_eth_rxtx_callback *
3445 rte_eth_add_tx_callback(uint16_t port_id, uint16_t queue_id,
3446 rte_tx_callback_fn fn, void *user_param);
3449 * Remove an RX packet callback from a given port and queue.
3451 * This function is used to removed callbacks that were added to a NIC port
3452 * queue using rte_eth_add_rx_callback().
3454 * Note: the callback is removed from the callback list but it isn't freed
3455 * since the it may still be in use. The memory for the callback can be
3456 * subsequently freed back by the application by calling rte_free():
3458 * - Immediately - if the port is stopped, or the user knows that no
3459 * callbacks are in flight e.g. if called from the thread doing RX/TX
3462 * - After a short delay - where the delay is sufficient to allow any
3463 * in-flight callbacks to complete.
3466 * The port identifier of the Ethernet device.
3468 * The queue on the Ethernet device from which the callback is to be removed.
3470 * User supplied callback created via rte_eth_add_rx_callback().
3473 * - 0: Success. Callback was removed.
3474 * - -ENOTSUP: Callback support is not available.
3475 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
3476 * is NULL or not found for the port/queue.
3478 int rte_eth_remove_rx_callback(uint16_t port_id, uint16_t queue_id,
3479 const struct rte_eth_rxtx_callback *user_cb);
3482 * Remove a TX packet callback from a given port and queue.
3484 * This function is used to removed callbacks that were added to a NIC port
3485 * queue using rte_eth_add_tx_callback().
3487 * Note: the callback is removed from the callback list but it isn't freed
3488 * since the it may still be in use. The memory for the callback can be
3489 * subsequently freed back by the application by calling rte_free():
3491 * - Immediately - if the port is stopped, or the user knows that no
3492 * callbacks are in flight e.g. if called from the thread doing RX/TX
3495 * - After a short delay - where the delay is sufficient to allow any
3496 * in-flight callbacks to complete.
3499 * The port identifier of the Ethernet device.
3501 * The queue on the Ethernet device from which the callback is to be removed.
3503 * User supplied callback created via rte_eth_add_tx_callback().
3506 * - 0: Success. Callback was removed.
3507 * - -ENOTSUP: Callback support is not available.
3508 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
3509 * is NULL or not found for the port/queue.
3511 int rte_eth_remove_tx_callback(uint16_t port_id, uint16_t queue_id,
3512 const struct rte_eth_rxtx_callback *user_cb);
3515 * Retrieve information about given port's RX queue.
3518 * The port identifier of the Ethernet device.
3520 * The RX queue on the Ethernet device for which information
3521 * will be retrieved.
3523 * A pointer to a structure of type *rte_eth_rxq_info_info* to be filled with
3524 * the information of the Ethernet device.
3528 * - -ENOTSUP: routine is not supported by the device PMD.
3529 * - -EINVAL: The port_id or the queue_id is out of range.
3531 int rte_eth_rx_queue_info_get(uint16_t port_id, uint16_t queue_id,
3532 struct rte_eth_rxq_info *qinfo);
3535 * Retrieve information about given port's TX queue.
3538 * The port identifier of the Ethernet device.
3540 * The TX queue on the Ethernet device for which information
3541 * will be retrieved.
3543 * A pointer to a structure of type *rte_eth_txq_info_info* to be filled with
3544 * the information of the Ethernet device.
3548 * - -ENOTSUP: routine is not supported by the device PMD.
3549 * - -EINVAL: The port_id or the queue_id is out of range.
3551 int rte_eth_tx_queue_info_get(uint16_t port_id, uint16_t queue_id,
3552 struct rte_eth_txq_info *qinfo);
3555 * Retrieve device registers and register attributes (number of registers and
3559 * The port identifier of the Ethernet device.
3561 * Pointer to rte_dev_reg_info structure to fill in. If info->data is
3562 * NULL the function fills in the width and length fields. If non-NULL
3563 * the registers are put into the buffer pointed at by the data field.
3565 * - (0) if successful.
3566 * - (-ENOTSUP) if hardware doesn't support.
3567 * - (-ENODEV) if *port_id* invalid.
3568 * - (-EIO) if device is removed.
3569 * - others depends on the specific operations implementation.
3571 int rte_eth_dev_get_reg_info(uint16_t port_id, struct rte_dev_reg_info *info);
3574 * Retrieve size of device EEPROM
3577 * The port identifier of the Ethernet device.
3579 * - (>=0) EEPROM size if successful.
3580 * - (-ENOTSUP) if hardware doesn't support.
3581 * - (-ENODEV) if *port_id* invalid.
3582 * - (-EIO) if device is removed.
3583 * - others depends on the specific operations implementation.
3585 int rte_eth_dev_get_eeprom_length(uint16_t port_id);
3588 * Retrieve EEPROM and EEPROM attribute
3591 * The port identifier of the Ethernet device.
3593 * The template includes buffer for return EEPROM data and
3594 * EEPROM attributes to be filled.
3596 * - (0) if successful.
3597 * - (-ENOTSUP) if hardware doesn't support.
3598 * - (-ENODEV) if *port_id* invalid.
3599 * - (-EIO) if device is removed.
3600 * - others depends on the specific operations implementation.
3602 int rte_eth_dev_get_eeprom(uint16_t port_id, struct rte_dev_eeprom_info *info);
3605 * Program EEPROM with provided data
3608 * The port identifier of the Ethernet device.
3610 * The template includes EEPROM data for programming and
3611 * EEPROM attributes to be filled
3613 * - (0) if successful.
3614 * - (-ENOTSUP) if hardware doesn't support.
3615 * - (-ENODEV) if *port_id* invalid.
3616 * - (-EIO) if device is removed.
3617 * - others depends on the specific operations implementation.
3619 int rte_eth_dev_set_eeprom(uint16_t port_id, struct rte_dev_eeprom_info *info);
3623 * @b EXPERIMENTAL: this API may change without prior notice.
3625 * Retrieve the type and size of plugin module EEPROM
3628 * The port identifier of the Ethernet device.
3630 * The type and size of plugin module EEPROM.
3632 * - (0) if successful.
3633 * - (-ENOTSUP) if hardware doesn't support.
3634 * - (-ENODEV) if *port_id* invalid.
3635 * - (-EIO) if device is removed.
3636 * - others depends on the specific operations implementation.
3640 rte_eth_dev_get_module_info(uint16_t port_id,
3641 struct rte_eth_dev_module_info *modinfo);
3645 * @b EXPERIMENTAL: this API may change without prior notice.
3647 * Retrieve the data of plugin module EEPROM
3650 * The port identifier of the Ethernet device.
3652 * The template includes the plugin module EEPROM attributes, and the
3653 * buffer for return plugin module EEPROM data.
3655 * - (0) if successful.
3656 * - (-ENOTSUP) if hardware doesn't support.
3657 * - (-ENODEV) if *port_id* invalid.
3658 * - (-EIO) if device is removed.
3659 * - others depends on the specific operations implementation.
3663 rte_eth_dev_get_module_eeprom(uint16_t port_id,
3664 struct rte_dev_eeprom_info *info);
3667 * Set the list of multicast addresses to filter on an Ethernet device.
3670 * The port identifier of the Ethernet device.
3671 * @param mc_addr_set
3672 * The array of multicast addresses to set. Equal to NULL when the function
3673 * is invoked to flush the set of filtered addresses.
3675 * The number of multicast addresses in the *mc_addr_set* array. Equal to 0
3676 * when the function is invoked to flush the set of filtered addresses.
3678 * - (0) if successful.
3679 * - (-ENODEV) if *port_id* invalid.
3680 * - (-EIO) if device is removed.
3681 * - (-ENOTSUP) if PMD of *port_id* doesn't support multicast filtering.
3682 * - (-ENOSPC) if *port_id* has not enough multicast filtering resources.
3684 int rte_eth_dev_set_mc_addr_list(uint16_t port_id,
3685 struct rte_ether_addr *mc_addr_set,
3686 uint32_t nb_mc_addr);
3689 * Enable IEEE1588/802.1AS timestamping for an Ethernet device.
3692 * The port identifier of the Ethernet device.
3696 * - -ENODEV: The port ID is invalid.
3697 * - -EIO: if device is removed.
3698 * - -ENOTSUP: The function is not supported by the Ethernet driver.
3700 int rte_eth_timesync_enable(uint16_t port_id);
3703 * Disable IEEE1588/802.1AS timestamping for an Ethernet device.
3706 * The port identifier of the Ethernet device.
3710 * - -ENODEV: The port ID is invalid.
3711 * - -EIO: if device is removed.
3712 * - -ENOTSUP: The function is not supported by the Ethernet driver.
3714 int rte_eth_timesync_disable(uint16_t port_id);
3717 * Read an IEEE1588/802.1AS RX timestamp from an Ethernet device.
3720 * The port identifier of the Ethernet device.
3722 * Pointer to the timestamp struct.
3724 * Device specific flags. Used to pass the RX timesync register index to
3725 * i40e. Unused in igb/ixgbe, pass 0 instead.
3729 * - -EINVAL: No timestamp is available.
3730 * - -ENODEV: The port ID is invalid.
3731 * - -EIO: if device is removed.
3732 * - -ENOTSUP: The function is not supported by the Ethernet driver.
3734 int rte_eth_timesync_read_rx_timestamp(uint16_t port_id,
3735 struct timespec *timestamp, uint32_t flags);
3738 * Read an IEEE1588/802.1AS TX timestamp from an Ethernet device.
3741 * The port identifier of the Ethernet device.
3743 * Pointer to the timestamp struct.
3747 * - -EINVAL: No timestamp is available.
3748 * - -ENODEV: The port ID is invalid.
3749 * - -EIO: if device is removed.
3750 * - -ENOTSUP: The function is not supported by the Ethernet driver.
3752 int rte_eth_timesync_read_tx_timestamp(uint16_t port_id,
3753 struct timespec *timestamp);
3756 * Adjust the timesync clock on an Ethernet device.
3758 * This is usually used in conjunction with other Ethdev timesync functions to
3759 * synchronize the device time using the IEEE1588/802.1AS protocol.
3762 * The port identifier of the Ethernet device.
3764 * The adjustment in nanoseconds.
3768 * - -ENODEV: The port ID is invalid.
3769 * - -EIO: if device is removed.
3770 * - -ENOTSUP: The function is not supported by the Ethernet driver.
3772 int rte_eth_timesync_adjust_time(uint16_t port_id, int64_t delta);
3775 * Read the time from the timesync clock on an Ethernet device.
3777 * This is usually used in conjunction with other Ethdev timesync functions to
3778 * synchronize the device time using the IEEE1588/802.1AS protocol.
3781 * The port identifier of the Ethernet device.
3783 * Pointer to the timespec struct that holds the time.
3788 int rte_eth_timesync_read_time(uint16_t port_id, struct timespec *time);
3791 * Set the time of the timesync clock on an Ethernet device.
3793 * This is usually used in conjunction with other Ethdev timesync functions to
3794 * synchronize the device time using the IEEE1588/802.1AS protocol.
3797 * The port identifier of the Ethernet device.
3799 * Pointer to the timespec struct that holds the time.
3803 * - -EINVAL: No timestamp is available.
3804 * - -ENODEV: The port ID is invalid.
3805 * - -EIO: if device is removed.
3806 * - -ENOTSUP: The function is not supported by the Ethernet driver.
3808 int rte_eth_timesync_write_time(uint16_t port_id, const struct timespec *time);
3812 * @b EXPERIMENTAL: this API may change without prior notice.
3814 * Read the current clock counter of an Ethernet device
3816 * This returns the current raw clock value of an Ethernet device. It is
3817 * a raw amount of ticks, with no given time reference.
3818 * The value returned here is from the same clock than the one
3819 * filling timestamp field of Rx packets when using hardware timestamp
3820 * offload. Therefore it can be used to compute a precise conversion of
3821 * the device clock to the real time.
3823 * E.g, a simple heuristic to derivate the frequency would be:
3824 * uint64_t start, end;
3825 * rte_eth_read_clock(port, start);
3826 * rte_delay_ms(100);
3827 * rte_eth_read_clock(port, end);
3828 * double freq = (end - start) * 10;
3830 * Compute a common reference with:
3831 * uint64_t base_time_sec = current_time();
3832 * uint64_t base_clock;
3833 * rte_eth_read_clock(port, base_clock);
3835 * Then, convert the raw mbuf timestamp with:
3836 * base_time_sec + (double)(mbuf->timestamp - base_clock) / freq;
3838 * This simple example will not provide a very good accuracy. One must
3839 * at least measure multiple times the frequency and do a regression.
3840 * To avoid deviation from the system time, the common reference can
3841 * be repeated from time to time. The integer division can also be
3842 * converted by a multiplication and a shift for better performance.
3845 * The port identifier of the Ethernet device.
3847 * Pointer to the uint64_t that holds the raw clock value.
3851 * - -ENODEV: The port ID is invalid.
3852 * - -ENOTSUP: The function is not supported by the Ethernet driver.
3856 rte_eth_read_clock(uint16_t port_id, uint64_t *clock);
3859 * Config l2 tunnel ether type of an Ethernet device for filtering specific
3860 * tunnel packets by ether type.
3863 * The port identifier of the Ethernet device.
3865 * l2 tunnel configuration.
3868 * - (0) if successful.
3869 * - (-ENODEV) if port identifier is invalid.
3870 * - (-EIO) if device is removed.
3871 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3874 rte_eth_dev_l2_tunnel_eth_type_conf(uint16_t port_id,
3875 struct rte_eth_l2_tunnel_conf *l2_tunnel);
3878 * Enable/disable l2 tunnel offload functions. Include,
3879 * 1, The ability of parsing a type of l2 tunnel of an Ethernet device.
3880 * Filtering, forwarding and offloading this type of tunnel packets depend on
3882 * 2, Stripping the l2 tunnel tag.
3883 * 3, Insertion of the l2 tunnel tag.
3884 * 4, Forwarding the packets based on the l2 tunnel tag.
3887 * The port identifier of the Ethernet device.
3889 * l2 tunnel parameters.
3891 * Indicate the offload function.
3893 * Enable or disable this function.
3896 * - (0) if successful.
3897 * - (-ENODEV) if port identifier is invalid.
3898 * - (-EIO) if device is removed.
3899 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3902 rte_eth_dev_l2_tunnel_offload_set(uint16_t port_id,
3903 struct rte_eth_l2_tunnel_conf *l2_tunnel,
3908 * Get the port id from device name. The device name should be specified
3910 * - PCIe address (Domain:Bus:Device.Function), for example- 0000:2:00.0
3911 * - SoC device name, for example- fsl-gmac0
3912 * - vdev dpdk name, for example- net_[pcap0|null0|tap0]
3915 * pci address or name of the device
3917 * pointer to port identifier of the device
3919 * - (0) if successful and port_id is filled.
3920 * - (-ENODEV or -EINVAL) on failure.
3923 rte_eth_dev_get_port_by_name(const char *name, uint16_t *port_id);
3926 * Get the device name from port id. The device name is specified as below:
3927 * - PCIe address (Domain:Bus:Device.Function), for example- 0000:02:00.0
3928 * - SoC device name, for example- fsl-gmac0
3929 * - vdev dpdk name, for example- net_[pcap0|null0|tun0|tap0]
3932 * Port identifier of the device.
3934 * Buffer of size RTE_ETH_NAME_MAX_LEN to store the name.
3936 * - (0) if successful.
3937 * - (-EINVAL) on failure.
3940 rte_eth_dev_get_name_by_port(uint16_t port_id, char *name);
3943 * Check that numbers of Rx and Tx descriptors satisfy descriptors limits from
3944 * the ethernet device information, otherwise adjust them to boundaries.
3947 * The port identifier of the Ethernet device.
3949 * A pointer to a uint16_t where the number of receive
3950 * descriptors stored.
3952 * A pointer to a uint16_t where the number of transmit
3953 * descriptors stored.
3955 * - (0) if successful.
3956 * - (-ENOTSUP, -ENODEV or -EINVAL) on failure.
3958 int rte_eth_dev_adjust_nb_rx_tx_desc(uint16_t port_id,
3959 uint16_t *nb_rx_desc,
3960 uint16_t *nb_tx_desc);
3963 * Test if a port supports specific mempool ops.
3966 * Port identifier of the Ethernet device.
3968 * The name of the pool operations to test.
3970 * - 0: best mempool ops choice for this port.
3971 * - 1: mempool ops are supported for this port.
3972 * - -ENOTSUP: mempool ops not supported for this port.
3973 * - -ENODEV: Invalid port Identifier.
3974 * - -EINVAL: Pool param is null.
3977 rte_eth_dev_pool_ops_supported(uint16_t port_id, const char *pool);
3980 * Get the security context for the Ethernet device.
3983 * Port identifier of the Ethernet device
3986 * - pointer to security context on success.
3989 rte_eth_dev_get_sec_ctx(uint16_t port_id);
3992 #include <rte_ethdev_core.h>
3996 * Retrieve a burst of input packets from a receive queue of an Ethernet
3997 * device. The retrieved packets are stored in *rte_mbuf* structures whose
3998 * pointers are supplied in the *rx_pkts* array.
4000 * The rte_eth_rx_burst() function loops, parsing the RX ring of the
4001 * receive queue, up to *nb_pkts* packets, and for each completed RX
4002 * descriptor in the ring, it performs the following operations:
4004 * - Initialize the *rte_mbuf* data structure associated with the
4005 * RX descriptor according to the information provided by the NIC into
4006 * that RX descriptor.
4008 * - Store the *rte_mbuf* data structure into the next entry of the
4011 * - Replenish the RX descriptor with a new *rte_mbuf* buffer
4012 * allocated from the memory pool associated with the receive queue at
4013 * initialization time.
4015 * When retrieving an input packet that was scattered by the controller
4016 * into multiple receive descriptors, the rte_eth_rx_burst() function
4017 * appends the associated *rte_mbuf* buffers to the first buffer of the
4020 * The rte_eth_rx_burst() function returns the number of packets
4021 * actually retrieved, which is the number of *rte_mbuf* data structures
4022 * effectively supplied into the *rx_pkts* array.
4023 * A return value equal to *nb_pkts* indicates that the RX queue contained
4024 * at least *rx_pkts* packets, and this is likely to signify that other
4025 * received packets remain in the input queue. Applications implementing
4026 * a "retrieve as much received packets as possible" policy can check this
4027 * specific case and keep invoking the rte_eth_rx_burst() function until
4028 * a value less than *nb_pkts* is returned.
4030 * This receive method has the following advantages:
4032 * - It allows a run-to-completion network stack engine to retrieve and
4033 * to immediately process received packets in a fast burst-oriented
4034 * approach, avoiding the overhead of unnecessary intermediate packet
4035 * queue/dequeue operations.
4037 * - Conversely, it also allows an asynchronous-oriented processing
4038 * method to retrieve bursts of received packets and to immediately
4039 * queue them for further parallel processing by another logical core,
4040 * for instance. However, instead of having received packets being
4041 * individually queued by the driver, this approach allows the caller
4042 * of the rte_eth_rx_burst() function to queue a burst of retrieved
4043 * packets at a time and therefore dramatically reduce the cost of
4044 * enqueue/dequeue operations per packet.
4046 * - It allows the rte_eth_rx_burst() function of the driver to take
4047 * advantage of burst-oriented hardware features (CPU cache,
4048 * prefetch instructions, and so on) to minimize the number of CPU
4049 * cycles per packet.
4051 * To summarize, the proposed receive API enables many
4052 * burst-oriented optimizations in both synchronous and asynchronous
4053 * packet processing environments with no overhead in both cases.
4055 * The rte_eth_rx_burst() function does not provide any error
4056 * notification to avoid the corresponding overhead. As a hint, the
4057 * upper-level application might check the status of the device link once
4058 * being systematically returned a 0 value for a given number of tries.
4061 * The port identifier of the Ethernet device.
4063 * The index of the receive queue from which to retrieve input packets.
4064 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
4065 * to rte_eth_dev_configure().
4067 * The address of an array of pointers to *rte_mbuf* structures that
4068 * must be large enough to store *nb_pkts* pointers in it.
4070 * The maximum number of packets to retrieve.
4072 * The number of packets actually retrieved, which is the number
4073 * of pointers to *rte_mbuf* structures effectively supplied to the
4076 static inline uint16_t
4077 rte_eth_rx_burst(uint16_t port_id, uint16_t queue_id,
4078 struct rte_mbuf **rx_pkts, const uint16_t nb_pkts)
4080 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
4083 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4084 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
4085 RTE_FUNC_PTR_OR_ERR_RET(*dev->rx_pkt_burst, 0);
4087 if (queue_id >= dev->data->nb_rx_queues) {
4088 RTE_ETHDEV_LOG(ERR, "Invalid RX queue_id=%u\n", queue_id);
4092 nb_rx = (*dev->rx_pkt_burst)(dev->data->rx_queues[queue_id],
4095 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
4096 if (unlikely(dev->post_rx_burst_cbs[queue_id] != NULL)) {
4097 struct rte_eth_rxtx_callback *cb =
4098 dev->post_rx_burst_cbs[queue_id];
4101 nb_rx = cb->fn.rx(port_id, queue_id, rx_pkts, nb_rx,
4102 nb_pkts, cb->param);
4104 } while (cb != NULL);
4112 * Get the number of used descriptors of a rx queue
4115 * The port identifier of the Ethernet device.
4117 * The queue id on the specific port.
4119 * The number of used descriptors in the specific queue, or:
4120 * (-EINVAL) if *port_id* or *queue_id* is invalid
4121 * (-ENOTSUP) if the device does not support this function
4124 rte_eth_rx_queue_count(uint16_t port_id, uint16_t queue_id)
4126 struct rte_eth_dev *dev;
4128 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -EINVAL);
4129 dev = &rte_eth_devices[port_id];
4130 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_queue_count, -ENOTSUP);
4131 if (queue_id >= dev->data->nb_rx_queues)
4134 return (int)(*dev->dev_ops->rx_queue_count)(dev, queue_id);
4138 * Check if the DD bit of the specific RX descriptor in the queue has been set
4141 * The port identifier of the Ethernet device.
4143 * The queue id on the specific port.
4145 * The offset of the descriptor ID from tail.
4147 * - (1) if the specific DD bit is set.
4148 * - (0) if the specific DD bit is not set.
4149 * - (-ENODEV) if *port_id* invalid.
4150 * - (-ENOTSUP) if the device does not support this function
4153 rte_eth_rx_descriptor_done(uint16_t port_id, uint16_t queue_id, uint16_t offset)
4155 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
4156 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
4157 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_descriptor_done, -ENOTSUP);
4158 return (*dev->dev_ops->rx_descriptor_done)( \
4159 dev->data->rx_queues[queue_id], offset);
4162 #define RTE_ETH_RX_DESC_AVAIL 0 /**< Desc available for hw. */
4163 #define RTE_ETH_RX_DESC_DONE 1 /**< Desc done, filled by hw. */
4164 #define RTE_ETH_RX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */
4167 * Check the status of a Rx descriptor in the queue
4169 * It should be called in a similar context than the Rx function:
4170 * - on a dataplane core
4171 * - not concurrently on the same queue
4173 * Since it's a dataplane function, no check is performed on port_id and
4174 * queue_id. The caller must therefore ensure that the port is enabled
4175 * and the queue is configured and running.
4177 * Note: accessing to a random descriptor in the ring may trigger cache
4178 * misses and have a performance impact.
4181 * A valid port identifier of the Ethernet device which.
4183 * A valid Rx queue identifier on this port.
4185 * The offset of the descriptor starting from tail (0 is the next
4186 * packet to be received by the driver).
4189 * - (RTE_ETH_RX_DESC_AVAIL): Descriptor is available for the hardware to
4191 * - (RTE_ETH_RX_DESC_DONE): Descriptor is done, it is filled by hw, but
4192 * not yet processed by the driver (i.e. in the receive queue).
4193 * - (RTE_ETH_RX_DESC_UNAVAIL): Descriptor is unavailable, either hold by
4194 * the driver and not yet returned to hw, or reserved by the hw.
4195 * - (-EINVAL) bad descriptor offset.
4196 * - (-ENOTSUP) if the device does not support this function.
4197 * - (-ENODEV) bad port or queue (only if compiled with debug).
4200 rte_eth_rx_descriptor_status(uint16_t port_id, uint16_t queue_id,
4203 struct rte_eth_dev *dev;
4206 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4207 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
4209 dev = &rte_eth_devices[port_id];
4210 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4211 if (queue_id >= dev->data->nb_rx_queues)
4214 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_descriptor_status, -ENOTSUP);
4215 rxq = dev->data->rx_queues[queue_id];
4217 return (*dev->dev_ops->rx_descriptor_status)(rxq, offset);
4220 #define RTE_ETH_TX_DESC_FULL 0 /**< Desc filled for hw, waiting xmit. */
4221 #define RTE_ETH_TX_DESC_DONE 1 /**< Desc done, packet is transmitted. */
4222 #define RTE_ETH_TX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */
4225 * Check the status of a Tx descriptor in the queue.
4227 * It should be called in a similar context than the Tx function:
4228 * - on a dataplane core
4229 * - not concurrently on the same queue
4231 * Since it's a dataplane function, no check is performed on port_id and
4232 * queue_id. The caller must therefore ensure that the port is enabled
4233 * and the queue is configured and running.
4235 * Note: accessing to a random descriptor in the ring may trigger cache
4236 * misses and have a performance impact.
4239 * A valid port identifier of the Ethernet device which.
4241 * A valid Tx queue identifier on this port.
4243 * The offset of the descriptor starting from tail (0 is the place where
4244 * the next packet will be send).
4247 * - (RTE_ETH_TX_DESC_FULL) Descriptor is being processed by the hw, i.e.
4248 * in the transmit queue.
4249 * - (RTE_ETH_TX_DESC_DONE) Hardware is done with this descriptor, it can
4250 * be reused by the driver.
4251 * - (RTE_ETH_TX_DESC_UNAVAIL): Descriptor is unavailable, reserved by the
4252 * driver or the hardware.
4253 * - (-EINVAL) bad descriptor offset.
4254 * - (-ENOTSUP) if the device does not support this function.
4255 * - (-ENODEV) bad port or queue (only if compiled with debug).
4257 static inline int rte_eth_tx_descriptor_status(uint16_t port_id,
4258 uint16_t queue_id, uint16_t offset)
4260 struct rte_eth_dev *dev;
4263 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4264 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
4266 dev = &rte_eth_devices[port_id];
4267 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4268 if (queue_id >= dev->data->nb_tx_queues)
4271 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->tx_descriptor_status, -ENOTSUP);
4272 txq = dev->data->tx_queues[queue_id];
4274 return (*dev->dev_ops->tx_descriptor_status)(txq, offset);
4278 * Send a burst of output packets on a transmit queue of an Ethernet device.
4280 * The rte_eth_tx_burst() function is invoked to transmit output packets
4281 * on the output queue *queue_id* of the Ethernet device designated by its
4283 * The *nb_pkts* parameter is the number of packets to send which are
4284 * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
4285 * allocated from a pool created with rte_pktmbuf_pool_create().
4286 * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
4287 * up to the number of transmit descriptors available in the TX ring of the
4289 * For each packet to send, the rte_eth_tx_burst() function performs
4290 * the following operations:
4292 * - Pick up the next available descriptor in the transmit ring.
4294 * - Free the network buffer previously sent with that descriptor, if any.
4296 * - Initialize the transmit descriptor with the information provided
4297 * in the *rte_mbuf data structure.
4299 * In the case of a segmented packet composed of a list of *rte_mbuf* buffers,
4300 * the rte_eth_tx_burst() function uses several transmit descriptors
4303 * The rte_eth_tx_burst() function returns the number of packets it
4304 * actually sent. A return value equal to *nb_pkts* means that all packets
4305 * have been sent, and this is likely to signify that other output packets
4306 * could be immediately transmitted again. Applications that implement a
4307 * "send as many packets to transmit as possible" policy can check this
4308 * specific case and keep invoking the rte_eth_tx_burst() function until
4309 * a value less than *nb_pkts* is returned.
4311 * It is the responsibility of the rte_eth_tx_burst() function to
4312 * transparently free the memory buffers of packets previously sent.
4313 * This feature is driven by the *tx_free_thresh* value supplied to the
4314 * rte_eth_dev_configure() function at device configuration time.
4315 * When the number of free TX descriptors drops below this threshold, the
4316 * rte_eth_tx_burst() function must [attempt to] free the *rte_mbuf* buffers
4317 * of those packets whose transmission was effectively completed.
4319 * If the PMD is DEV_TX_OFFLOAD_MT_LOCKFREE capable, multiple threads can
4320 * invoke this function concurrently on the same tx queue without SW lock.
4321 * @see rte_eth_dev_info_get, struct rte_eth_txconf::offloads
4323 * @see rte_eth_tx_prepare to perform some prior checks or adjustments
4327 * The port identifier of the Ethernet device.
4329 * The index of the transmit queue through which output packets must be
4331 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
4332 * to rte_eth_dev_configure().
4334 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
4335 * which contain the output packets.
4337 * The maximum number of packets to transmit.
4339 * The number of output packets actually stored in transmit descriptors of
4340 * the transmit ring. The return value can be less than the value of the
4341 * *tx_pkts* parameter when the transmit ring is full or has been filled up.
4343 static inline uint16_t
4344 rte_eth_tx_burst(uint16_t port_id, uint16_t queue_id,
4345 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
4347 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
4349 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4350 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
4351 RTE_FUNC_PTR_OR_ERR_RET(*dev->tx_pkt_burst, 0);
4353 if (queue_id >= dev->data->nb_tx_queues) {
4354 RTE_ETHDEV_LOG(ERR, "Invalid TX queue_id=%u\n", queue_id);
4359 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
4360 struct rte_eth_rxtx_callback *cb = dev->pre_tx_burst_cbs[queue_id];
4362 if (unlikely(cb != NULL)) {
4364 nb_pkts = cb->fn.tx(port_id, queue_id, tx_pkts, nb_pkts,
4367 } while (cb != NULL);
4371 return (*dev->tx_pkt_burst)(dev->data->tx_queues[queue_id], tx_pkts, nb_pkts);
4375 * Process a burst of output packets on a transmit queue of an Ethernet device.
4377 * The rte_eth_tx_prepare() function is invoked to prepare output packets to be
4378 * transmitted on the output queue *queue_id* of the Ethernet device designated
4380 * The *nb_pkts* parameter is the number of packets to be prepared which are
4381 * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
4382 * allocated from a pool created with rte_pktmbuf_pool_create().
4383 * For each packet to send, the rte_eth_tx_prepare() function performs
4384 * the following operations:
4386 * - Check if packet meets devices requirements for tx offloads.
4388 * - Check limitations about number of segments.
4390 * - Check additional requirements when debug is enabled.
4392 * - Update and/or reset required checksums when tx offload is set for packet.
4394 * Since this function can modify packet data, provided mbufs must be safely
4395 * writable (e.g. modified data cannot be in shared segment).
4397 * The rte_eth_tx_prepare() function returns the number of packets ready to be
4398 * sent. A return value equal to *nb_pkts* means that all packets are valid and
4399 * ready to be sent, otherwise stops processing on the first invalid packet and
4400 * leaves the rest packets untouched.
4402 * When this functionality is not implemented in the driver, all packets are
4403 * are returned untouched.
4406 * The port identifier of the Ethernet device.
4407 * The value must be a valid port id.
4409 * The index of the transmit queue through which output packets must be
4411 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
4412 * to rte_eth_dev_configure().
4414 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
4415 * which contain the output packets.
4417 * The maximum number of packets to process.
4419 * The number of packets correct and ready to be sent. The return value can be
4420 * less than the value of the *tx_pkts* parameter when some packet doesn't
4421 * meet devices requirements with rte_errno set appropriately:
4422 * - EINVAL: offload flags are not correctly set
4423 * - ENOTSUP: the offload feature is not supported by the hardware
4427 #ifndef RTE_ETHDEV_TX_PREPARE_NOOP
4429 static inline uint16_t
4430 rte_eth_tx_prepare(uint16_t port_id, uint16_t queue_id,
4431 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
4433 struct rte_eth_dev *dev;
4435 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4436 if (!rte_eth_dev_is_valid_port(port_id)) {
4437 RTE_ETHDEV_LOG(ERR, "Invalid TX port_id=%u\n", port_id);
4443 dev = &rte_eth_devices[port_id];
4445 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4446 if (queue_id >= dev->data->nb_tx_queues) {
4447 RTE_ETHDEV_LOG(ERR, "Invalid TX queue_id=%u\n", queue_id);
4453 if (!dev->tx_pkt_prepare)
4456 return (*dev->tx_pkt_prepare)(dev->data->tx_queues[queue_id],
4463 * Native NOOP operation for compilation targets which doesn't require any
4464 * preparations steps, and functional NOOP may introduce unnecessary performance
4467 * Generally this is not a good idea to turn it on globally and didn't should
4468 * be used if behavior of tx_preparation can change.
4471 static inline uint16_t
4472 rte_eth_tx_prepare(__rte_unused uint16_t port_id,
4473 __rte_unused uint16_t queue_id,
4474 __rte_unused struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
4482 * Send any packets queued up for transmission on a port and HW queue
4484 * This causes an explicit flush of packets previously buffered via the
4485 * rte_eth_tx_buffer() function. It returns the number of packets successfully
4486 * sent to the NIC, and calls the error callback for any unsent packets. Unless
4487 * explicitly set up otherwise, the default callback simply frees the unsent
4488 * packets back to the owning mempool.
4491 * The port identifier of the Ethernet device.
4493 * The index of the transmit queue through which output packets must be
4495 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
4496 * to rte_eth_dev_configure().
4498 * Buffer of packets to be transmit.
4500 * The number of packets successfully sent to the Ethernet device. The error
4501 * callback is called for any packets which could not be sent.
4503 static inline uint16_t
4504 rte_eth_tx_buffer_flush(uint16_t port_id, uint16_t queue_id,
4505 struct rte_eth_dev_tx_buffer *buffer)
4508 uint16_t to_send = buffer->length;
4513 sent = rte_eth_tx_burst(port_id, queue_id, buffer->pkts, to_send);
4517 /* All packets sent, or to be dealt with by callback below */
4518 if (unlikely(sent != to_send))
4519 buffer->error_callback(&buffer->pkts[sent],
4520 (uint16_t)(to_send - sent),
4521 buffer->error_userdata);
4527 * Buffer a single packet for future transmission on a port and queue
4529 * This function takes a single mbuf/packet and buffers it for later
4530 * transmission on the particular port and queue specified. Once the buffer is
4531 * full of packets, an attempt will be made to transmit all the buffered
4532 * packets. In case of error, where not all packets can be transmitted, a
4533 * callback is called with the unsent packets as a parameter. If no callback
4534 * is explicitly set up, the unsent packets are just freed back to the owning
4535 * mempool. The function returns the number of packets actually sent i.e.
4536 * 0 if no buffer flush occurred, otherwise the number of packets successfully
4540 * The port identifier of the Ethernet device.
4542 * The index of the transmit queue through which output packets must be
4544 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
4545 * to rte_eth_dev_configure().
4547 * Buffer used to collect packets to be sent.
4549 * Pointer to the packet mbuf to be sent.
4551 * 0 = packet has been buffered for later transmission
4552 * N > 0 = packet has been buffered, and the buffer was subsequently flushed,
4553 * causing N packets to be sent, and the error callback to be called for
4556 static __rte_always_inline uint16_t
4557 rte_eth_tx_buffer(uint16_t port_id, uint16_t queue_id,
4558 struct rte_eth_dev_tx_buffer *buffer, struct rte_mbuf *tx_pkt)
4560 buffer->pkts[buffer->length++] = tx_pkt;
4561 if (buffer->length < buffer->size)
4564 return rte_eth_tx_buffer_flush(port_id, queue_id, buffer);
4571 #endif /* _RTE_ETHDEV_H_ */