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 a function allowing
21 * an Ethernet Poll Mode Driver (PMD) to simultaneously register itself as
22 * an Ethernet device driver and as a PCI driver for a set of matching PCI
23 * [Ethernet] devices classes.
25 * By default, all the functions of the Ethernet Device API exported by a PMD
26 * are lock-free functions which assume to not be invoked in parallel on
27 * different logical cores to work on the same target object. For instance,
28 * the receive function of a PMD cannot be invoked in parallel on two logical
29 * cores to poll the same RX queue [of the same port]. Of course, this function
30 * can be invoked in parallel by different logical cores on different RX queues.
31 * It is the responsibility of the upper level application to enforce this rule.
33 * If needed, parallel accesses by multiple logical cores to shared queues
34 * shall be explicitly protected by dedicated inline lock-aware functions
35 * built on top of their corresponding lock-free functions of the PMD API.
37 * In all functions of the Ethernet API, the Ethernet device is
38 * designated by an integer >= 0 named the device port identifier.
40 * At the Ethernet driver level, Ethernet devices are represented by a generic
41 * data structure of type *rte_eth_dev*.
43 * Ethernet devices are dynamically registered during the PCI probing phase
44 * performed at EAL initialization time.
45 * When an Ethernet device is being probed, an *rte_eth_dev* structure and
46 * a new port identifier are allocated for that device. Then, the eth_dev_init()
47 * function supplied by the Ethernet driver matching the probed PCI
48 * device is invoked to properly initialize the device.
50 * The role of the device init function consists of resetting the hardware,
51 * checking access to Non-volatile Memory (NVM), reading the MAC address
54 * If the device init operation is successful, the correspondence between
55 * the port identifier assigned to the new device and its associated
56 * *rte_eth_dev* structure is effectively registered.
57 * Otherwise, both the *rte_eth_dev* structure and the port identifier are
60 * The functions exported by the application Ethernet API to setup a device
61 * designated by its port identifier must be invoked in the following order:
62 * - rte_eth_dev_configure()
63 * - rte_eth_tx_queue_setup()
64 * - rte_eth_rx_queue_setup()
65 * - rte_eth_dev_start()
67 * Then, the network application can invoke, in any order, the functions
68 * exported by the Ethernet API to get the MAC address of a given device, to
69 * get the speed and the status of a device physical link, to receive/transmit
70 * [burst of] packets, and so on.
72 * If the application wants to change the configuration (i.e. call
73 * rte_eth_dev_configure(), rte_eth_tx_queue_setup(), or
74 * rte_eth_rx_queue_setup()), it must call rte_eth_dev_stop() first to stop the
75 * device and then do the reconfiguration before calling rte_eth_dev_start()
76 * again. The transmit and receive functions should not be invoked when the
79 * Please note that some configuration is not stored between calls to
80 * rte_eth_dev_stop()/rte_eth_dev_start(). The following configuration will
83 * - flow control settings
84 * - receive mode configuration (promiscuous mode, hardware checksum mode,
85 * RSS/VMDQ settings etc.)
86 * - VLAN filtering configuration
87 * - MAC addresses supplied to MAC address array
88 * - flow director filtering mode (but not filtering rules)
89 * - NIC queue statistics mappings
91 * Any other configuration will not be stored and will need to be re-entered
92 * before a call to rte_eth_dev_start().
94 * Finally, a network application can close an Ethernet device by invoking the
95 * rte_eth_dev_close() function.
97 * Each function of the application Ethernet API invokes a specific function
98 * of the PMD that controls the target device designated by its port
100 * For this purpose, all device-specific functions of an Ethernet driver are
101 * supplied through a set of pointers contained in a generic structure of type
103 * The address of the *eth_dev_ops* structure is stored in the *rte_eth_dev*
104 * structure by the device init function of the Ethernet driver, which is
105 * invoked during the PCI probing phase, as explained earlier.
107 * In other words, each function of the Ethernet API simply retrieves the
108 * *rte_eth_dev* structure associated with the device port identifier and
109 * performs an indirect invocation of the corresponding driver function
110 * supplied in the *eth_dev_ops* structure of the *rte_eth_dev* structure.
112 * For performance reasons, the address of the burst-oriented RX and TX
113 * functions of the Ethernet driver are not contained in the *eth_dev_ops*
114 * structure. Instead, they are directly stored at the beginning of the
115 * *rte_eth_dev* structure to avoid an extra indirect memory access during
118 * RTE ethernet device drivers do not use interrupts for transmitting or
119 * receiving. Instead, Ethernet drivers export Poll-Mode receive and transmit
120 * functions to applications.
121 * Both receive and transmit functions are packet-burst oriented to minimize
122 * their cost per packet through the following optimizations:
124 * - Sharing among multiple packets the incompressible cost of the
125 * invocation of receive/transmit functions.
127 * - Enabling receive/transmit functions to take advantage of burst-oriented
128 * hardware features (L1 cache, prefetch instructions, NIC head/tail
129 * registers) to minimize the number of CPU cycles per packet, for instance,
130 * by avoiding useless read memory accesses to ring descriptors, or by
131 * systematically using arrays of pointers that exactly fit L1 cache line
132 * boundaries and sizes.
134 * The burst-oriented receive function does not provide any error notification,
135 * to avoid the corresponding overhead. As a hint, the upper-level application
136 * might check the status of the device link once being systematically returned
137 * a 0 value by the receive function of the driver for a given number of tries.
146 /* Use this macro to check if LRO API is supported */
147 #define RTE_ETHDEV_HAS_LRO_SUPPORT
150 #include <rte_interrupts.h>
152 #include <rte_devargs.h>
153 #include <rte_errno.h>
154 #include <rte_common.h>
155 #include <rte_config.h>
157 #include "rte_ether.h"
158 #include "rte_eth_ctrl.h"
159 #include "rte_dev_info.h"
164 * A structure used to retrieve statistics for an Ethernet port.
165 * Not all statistics fields in struct rte_eth_stats are supported
166 * by any type of network interface card (NIC). If any statistics
167 * field is not supported, its value is 0.
169 struct rte_eth_stats {
170 uint64_t ipackets; /**< Total number of successfully received packets. */
171 uint64_t opackets; /**< Total number of successfully transmitted packets.*/
172 uint64_t ibytes; /**< Total number of successfully received bytes. */
173 uint64_t obytes; /**< Total number of successfully transmitted bytes. */
175 /**< Total of RX packets dropped by the HW,
176 * because there are no available buffer (i.e. RX queues are full).
178 uint64_t ierrors; /**< Total number of erroneous received packets. */
179 uint64_t oerrors; /**< Total number of failed transmitted packets. */
180 uint64_t rx_nombuf; /**< Total number of RX mbuf allocation failures. */
181 uint64_t q_ipackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
182 /**< Total number of queue RX packets. */
183 uint64_t q_opackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
184 /**< Total number of queue TX packets. */
185 uint64_t q_ibytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
186 /**< Total number of successfully received queue bytes. */
187 uint64_t q_obytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
188 /**< Total number of successfully transmitted queue bytes. */
189 uint64_t q_errors[RTE_ETHDEV_QUEUE_STAT_CNTRS];
190 /**< Total number of queue packets received that are dropped. */
194 * Device supported speeds bitmap flags
196 #define ETH_LINK_SPEED_AUTONEG (0 << 0) /**< Autonegotiate (all speeds) */
197 #define ETH_LINK_SPEED_FIXED (1 << 0) /**< Disable autoneg (fixed speed) */
198 #define ETH_LINK_SPEED_10M_HD (1 << 1) /**< 10 Mbps half-duplex */
199 #define ETH_LINK_SPEED_10M (1 << 2) /**< 10 Mbps full-duplex */
200 #define ETH_LINK_SPEED_100M_HD (1 << 3) /**< 100 Mbps half-duplex */
201 #define ETH_LINK_SPEED_100M (1 << 4) /**< 100 Mbps full-duplex */
202 #define ETH_LINK_SPEED_1G (1 << 5) /**< 1 Gbps */
203 #define ETH_LINK_SPEED_2_5G (1 << 6) /**< 2.5 Gbps */
204 #define ETH_LINK_SPEED_5G (1 << 7) /**< 5 Gbps */
205 #define ETH_LINK_SPEED_10G (1 << 8) /**< 10 Gbps */
206 #define ETH_LINK_SPEED_20G (1 << 9) /**< 20 Gbps */
207 #define ETH_LINK_SPEED_25G (1 << 10) /**< 25 Gbps */
208 #define ETH_LINK_SPEED_40G (1 << 11) /**< 40 Gbps */
209 #define ETH_LINK_SPEED_50G (1 << 12) /**< 50 Gbps */
210 #define ETH_LINK_SPEED_56G (1 << 13) /**< 56 Gbps */
211 #define ETH_LINK_SPEED_100G (1 << 14) /**< 100 Gbps */
214 * Ethernet numeric link speeds in Mbps
216 #define ETH_SPEED_NUM_NONE 0 /**< Not defined */
217 #define ETH_SPEED_NUM_10M 10 /**< 10 Mbps */
218 #define ETH_SPEED_NUM_100M 100 /**< 100 Mbps */
219 #define ETH_SPEED_NUM_1G 1000 /**< 1 Gbps */
220 #define ETH_SPEED_NUM_2_5G 2500 /**< 2.5 Gbps */
221 #define ETH_SPEED_NUM_5G 5000 /**< 5 Gbps */
222 #define ETH_SPEED_NUM_10G 10000 /**< 10 Gbps */
223 #define ETH_SPEED_NUM_20G 20000 /**< 20 Gbps */
224 #define ETH_SPEED_NUM_25G 25000 /**< 25 Gbps */
225 #define ETH_SPEED_NUM_40G 40000 /**< 40 Gbps */
226 #define ETH_SPEED_NUM_50G 50000 /**< 50 Gbps */
227 #define ETH_SPEED_NUM_56G 56000 /**< 56 Gbps */
228 #define ETH_SPEED_NUM_100G 100000 /**< 100 Gbps */
231 * A structure used to retrieve link-level information of an Ethernet port.
234 struct rte_eth_link {
235 uint32_t link_speed; /**< ETH_SPEED_NUM_ */
236 uint16_t link_duplex : 1; /**< ETH_LINK_[HALF/FULL]_DUPLEX */
237 uint16_t link_autoneg : 1; /**< ETH_LINK_[AUTONEG/FIXED] */
238 uint16_t link_status : 1; /**< ETH_LINK_[DOWN/UP] */
239 } __attribute__((aligned(8))); /**< aligned for atomic64 read/write */
241 /* Utility constants */
242 #define ETH_LINK_HALF_DUPLEX 0 /**< Half-duplex connection (see link_duplex). */
243 #define ETH_LINK_FULL_DUPLEX 1 /**< Full-duplex connection (see link_duplex). */
244 #define ETH_LINK_DOWN 0 /**< Link is down (see link_status). */
245 #define ETH_LINK_UP 1 /**< Link is up (see link_status). */
246 #define ETH_LINK_FIXED 0 /**< No autonegotiation (see link_autoneg). */
247 #define ETH_LINK_AUTONEG 1 /**< Autonegotiated (see link_autoneg). */
250 * A structure used to configure the ring threshold registers of an RX/TX
251 * queue for an Ethernet port.
253 struct rte_eth_thresh {
254 uint8_t pthresh; /**< Ring prefetch threshold. */
255 uint8_t hthresh; /**< Ring host threshold. */
256 uint8_t wthresh; /**< Ring writeback threshold. */
260 * Simple flags are used for rte_eth_conf.rxmode.mq_mode.
262 #define ETH_MQ_RX_RSS_FLAG 0x1
263 #define ETH_MQ_RX_DCB_FLAG 0x2
264 #define ETH_MQ_RX_VMDQ_FLAG 0x4
267 * A set of values to identify what method is to be used to route
268 * packets to multiple queues.
270 enum rte_eth_rx_mq_mode {
271 /** None of DCB,RSS or VMDQ mode */
274 /** For RX side, only RSS is on */
275 ETH_MQ_RX_RSS = ETH_MQ_RX_RSS_FLAG,
276 /** For RX side,only DCB is on. */
277 ETH_MQ_RX_DCB = ETH_MQ_RX_DCB_FLAG,
278 /** Both DCB and RSS enable */
279 ETH_MQ_RX_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG,
281 /** Only VMDQ, no RSS nor DCB */
282 ETH_MQ_RX_VMDQ_ONLY = ETH_MQ_RX_VMDQ_FLAG,
283 /** RSS mode with VMDQ */
284 ETH_MQ_RX_VMDQ_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_VMDQ_FLAG,
285 /** Use VMDQ+DCB to route traffic to queues */
286 ETH_MQ_RX_VMDQ_DCB = ETH_MQ_RX_VMDQ_FLAG | ETH_MQ_RX_DCB_FLAG,
287 /** Enable both VMDQ and DCB in VMDq */
288 ETH_MQ_RX_VMDQ_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG |
293 * for rx mq mode backward compatible
295 #define ETH_RSS ETH_MQ_RX_RSS
296 #define VMDQ_DCB ETH_MQ_RX_VMDQ_DCB
297 #define ETH_DCB_RX ETH_MQ_RX_DCB
300 * A set of values to identify what method is to be used to transmit
301 * packets using multi-TCs.
303 enum rte_eth_tx_mq_mode {
304 ETH_MQ_TX_NONE = 0, /**< It is in neither DCB nor VT mode. */
305 ETH_MQ_TX_DCB, /**< For TX side,only DCB is on. */
306 ETH_MQ_TX_VMDQ_DCB, /**< For TX side,both DCB and VT is on. */
307 ETH_MQ_TX_VMDQ_ONLY, /**< Only VT on, no DCB */
311 * for tx mq mode backward compatible
313 #define ETH_DCB_NONE ETH_MQ_TX_NONE
314 #define ETH_VMDQ_DCB_TX ETH_MQ_TX_VMDQ_DCB
315 #define ETH_DCB_TX ETH_MQ_TX_DCB
318 * A structure used to configure the RX features of an Ethernet port.
320 struct rte_eth_rxmode {
321 /** The multi-queue packet distribution mode to be used, e.g. RSS. */
322 enum rte_eth_rx_mq_mode mq_mode;
323 uint32_t max_rx_pkt_len; /**< Only used if jumbo_frame enabled. */
324 uint16_t split_hdr_size; /**< hdr buf size (header_split enabled).*/
326 * Per-port Rx offloads to be set using DEV_RX_OFFLOAD_* flags.
327 * Only offloads set on rx_offload_capa field on rte_eth_dev_info
328 * structure are allowed to be set.
333 * Below bitfield API is obsolete. Application should
334 * enable per-port offloads using the offload field
337 uint16_t header_split : 1, /**< Header Split enable. */
338 hw_ip_checksum : 1, /**< IP/UDP/TCP checksum offload enable. */
339 hw_vlan_filter : 1, /**< VLAN filter enable. */
340 hw_vlan_strip : 1, /**< VLAN strip enable. */
341 hw_vlan_extend : 1, /**< Extended VLAN enable. */
342 jumbo_frame : 1, /**< Jumbo Frame Receipt enable. */
343 hw_strip_crc : 1, /**< Enable CRC stripping by hardware. */
344 enable_scatter : 1, /**< Enable scatter packets rx handler */
345 enable_lro : 1, /**< Enable LRO */
346 hw_timestamp : 1, /**< Enable HW timestamp */
347 security : 1, /**< Enable rte_security offloads */
349 * When set the offload bitfield should be ignored.
350 * Instead per-port Rx offloads should be set on offloads
352 * Per-queue offloads shuold be set on rte_eth_rxq_conf
354 * This bit is temporary till rxmode bitfield offloads API will
357 ignore_offload_bitfield : 1;
361 * VLAN types to indicate if it is for single VLAN, inner VLAN or outer VLAN.
362 * Note that single VLAN is treated the same as inner VLAN.
365 ETH_VLAN_TYPE_UNKNOWN = 0,
366 ETH_VLAN_TYPE_INNER, /**< Inner VLAN. */
367 ETH_VLAN_TYPE_OUTER, /**< Single VLAN, or outer VLAN. */
372 * A structure used to describe a vlan filter.
373 * If the bit corresponding to a VID is set, such VID is on.
375 struct rte_vlan_filter_conf {
380 * A structure used to configure the Receive Side Scaling (RSS) feature
381 * of an Ethernet port.
382 * If not NULL, the *rss_key* pointer of the *rss_conf* structure points
383 * to an array holding the RSS key to use for hashing specific header
384 * fields of received packets. The length of this array should be indicated
385 * by *rss_key_len* below. Otherwise, a default random hash key is used by
388 * The *rss_key_len* field of the *rss_conf* structure indicates the length
389 * in bytes of the array pointed by *rss_key*. To be compatible, this length
390 * will be checked in i40e only. Others assume 40 bytes to be used as before.
392 * The *rss_hf* field of the *rss_conf* structure indicates the different
393 * types of IPv4/IPv6 packets to which the RSS hashing must be applied.
394 * Supplying an *rss_hf* equal to zero disables the RSS feature.
396 struct rte_eth_rss_conf {
397 uint8_t *rss_key; /**< If not NULL, 40-byte hash key. */
398 uint8_t rss_key_len; /**< hash key length in bytes. */
399 uint64_t rss_hf; /**< Hash functions to apply - see below. */
403 * The RSS offload types are defined based on flow types which are defined
404 * in rte_eth_ctrl.h. Different NIC hardwares may support different RSS offload
405 * types. The supported flow types or RSS offload types can be queried by
406 * rte_eth_dev_info_get().
408 #define ETH_RSS_IPV4 (1ULL << RTE_ETH_FLOW_IPV4)
409 #define ETH_RSS_FRAG_IPV4 (1ULL << RTE_ETH_FLOW_FRAG_IPV4)
410 #define ETH_RSS_NONFRAG_IPV4_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_TCP)
411 #define ETH_RSS_NONFRAG_IPV4_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_UDP)
412 #define ETH_RSS_NONFRAG_IPV4_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_SCTP)
413 #define ETH_RSS_NONFRAG_IPV4_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_OTHER)
414 #define ETH_RSS_IPV6 (1ULL << RTE_ETH_FLOW_IPV6)
415 #define ETH_RSS_FRAG_IPV6 (1ULL << RTE_ETH_FLOW_FRAG_IPV6)
416 #define ETH_RSS_NONFRAG_IPV6_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_TCP)
417 #define ETH_RSS_NONFRAG_IPV6_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_UDP)
418 #define ETH_RSS_NONFRAG_IPV6_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_SCTP)
419 #define ETH_RSS_NONFRAG_IPV6_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_OTHER)
420 #define ETH_RSS_L2_PAYLOAD (1ULL << RTE_ETH_FLOW_L2_PAYLOAD)
421 #define ETH_RSS_IPV6_EX (1ULL << RTE_ETH_FLOW_IPV6_EX)
422 #define ETH_RSS_IPV6_TCP_EX (1ULL << RTE_ETH_FLOW_IPV6_TCP_EX)
423 #define ETH_RSS_IPV6_UDP_EX (1ULL << RTE_ETH_FLOW_IPV6_UDP_EX)
424 #define ETH_RSS_PORT (1ULL << RTE_ETH_FLOW_PORT)
425 #define ETH_RSS_VXLAN (1ULL << RTE_ETH_FLOW_VXLAN)
426 #define ETH_RSS_GENEVE (1ULL << RTE_ETH_FLOW_GENEVE)
427 #define ETH_RSS_NVGRE (1ULL << RTE_ETH_FLOW_NVGRE)
429 #define ETH_RSS_IP ( \
431 ETH_RSS_FRAG_IPV4 | \
432 ETH_RSS_NONFRAG_IPV4_OTHER | \
434 ETH_RSS_FRAG_IPV6 | \
435 ETH_RSS_NONFRAG_IPV6_OTHER | \
438 #define ETH_RSS_UDP ( \
439 ETH_RSS_NONFRAG_IPV4_UDP | \
440 ETH_RSS_NONFRAG_IPV6_UDP | \
443 #define ETH_RSS_TCP ( \
444 ETH_RSS_NONFRAG_IPV4_TCP | \
445 ETH_RSS_NONFRAG_IPV6_TCP | \
448 #define ETH_RSS_SCTP ( \
449 ETH_RSS_NONFRAG_IPV4_SCTP | \
450 ETH_RSS_NONFRAG_IPV6_SCTP)
452 #define ETH_RSS_TUNNEL ( \
458 /**< Mask of valid RSS hash protocols */
459 #define ETH_RSS_PROTO_MASK ( \
461 ETH_RSS_FRAG_IPV4 | \
462 ETH_RSS_NONFRAG_IPV4_TCP | \
463 ETH_RSS_NONFRAG_IPV4_UDP | \
464 ETH_RSS_NONFRAG_IPV4_SCTP | \
465 ETH_RSS_NONFRAG_IPV4_OTHER | \
467 ETH_RSS_FRAG_IPV6 | \
468 ETH_RSS_NONFRAG_IPV6_TCP | \
469 ETH_RSS_NONFRAG_IPV6_UDP | \
470 ETH_RSS_NONFRAG_IPV6_SCTP | \
471 ETH_RSS_NONFRAG_IPV6_OTHER | \
472 ETH_RSS_L2_PAYLOAD | \
474 ETH_RSS_IPV6_TCP_EX | \
475 ETH_RSS_IPV6_UDP_EX | \
482 * Definitions used for redirection table entry size.
483 * Some RSS RETA sizes may not be supported by some drivers, check the
484 * documentation or the description of relevant functions for more details.
486 #define ETH_RSS_RETA_SIZE_64 64
487 #define ETH_RSS_RETA_SIZE_128 128
488 #define ETH_RSS_RETA_SIZE_256 256
489 #define ETH_RSS_RETA_SIZE_512 512
490 #define RTE_RETA_GROUP_SIZE 64
492 /* Definitions used for VMDQ and DCB functionality */
493 #define ETH_VMDQ_MAX_VLAN_FILTERS 64 /**< Maximum nb. of VMDQ vlan filters. */
494 #define ETH_DCB_NUM_USER_PRIORITIES 8 /**< Maximum nb. of DCB priorities. */
495 #define ETH_VMDQ_DCB_NUM_QUEUES 128 /**< Maximum nb. of VMDQ DCB queues. */
496 #define ETH_DCB_NUM_QUEUES 128 /**< Maximum nb. of DCB queues. */
498 /* DCB capability defines */
499 #define ETH_DCB_PG_SUPPORT 0x00000001 /**< Priority Group(ETS) support. */
500 #define ETH_DCB_PFC_SUPPORT 0x00000002 /**< Priority Flow Control support. */
502 /* Definitions used for VLAN Offload functionality */
503 #define ETH_VLAN_STRIP_OFFLOAD 0x0001 /**< VLAN Strip On/Off */
504 #define ETH_VLAN_FILTER_OFFLOAD 0x0002 /**< VLAN Filter On/Off */
505 #define ETH_VLAN_EXTEND_OFFLOAD 0x0004 /**< VLAN Extend On/Off */
507 /* Definitions used for mask VLAN setting */
508 #define ETH_VLAN_STRIP_MASK 0x0001 /**< VLAN Strip setting mask */
509 #define ETH_VLAN_FILTER_MASK 0x0002 /**< VLAN Filter setting mask*/
510 #define ETH_VLAN_EXTEND_MASK 0x0004 /**< VLAN Extend setting mask*/
511 #define ETH_VLAN_ID_MAX 0x0FFF /**< VLAN ID is in lower 12 bits*/
513 /* Definitions used for receive MAC address */
514 #define ETH_NUM_RECEIVE_MAC_ADDR 128 /**< Maximum nb. of receive mac addr. */
516 /* Definitions used for unicast hash */
517 #define ETH_VMDQ_NUM_UC_HASH_ARRAY 128 /**< Maximum nb. of UC hash array. */
519 /* Definitions used for VMDQ pool rx mode setting */
520 #define ETH_VMDQ_ACCEPT_UNTAG 0x0001 /**< accept untagged packets. */
521 #define ETH_VMDQ_ACCEPT_HASH_MC 0x0002 /**< accept packets in multicast table . */
522 #define ETH_VMDQ_ACCEPT_HASH_UC 0x0004 /**< accept packets in unicast table. */
523 #define ETH_VMDQ_ACCEPT_BROADCAST 0x0008 /**< accept broadcast packets. */
524 #define ETH_VMDQ_ACCEPT_MULTICAST 0x0010 /**< multicast promiscuous. */
526 /** Maximum nb. of vlan per mirror rule */
527 #define ETH_MIRROR_MAX_VLANS 64
529 #define ETH_MIRROR_VIRTUAL_POOL_UP 0x01 /**< Virtual Pool uplink Mirroring. */
530 #define ETH_MIRROR_UPLINK_PORT 0x02 /**< Uplink Port Mirroring. */
531 #define ETH_MIRROR_DOWNLINK_PORT 0x04 /**< Downlink Port Mirroring. */
532 #define ETH_MIRROR_VLAN 0x08 /**< VLAN Mirroring. */
533 #define ETH_MIRROR_VIRTUAL_POOL_DOWN 0x10 /**< Virtual Pool downlink Mirroring. */
536 * A structure used to configure VLAN traffic mirror of an Ethernet port.
538 struct rte_eth_vlan_mirror {
539 uint64_t vlan_mask; /**< mask for valid VLAN ID. */
540 /** VLAN ID list for vlan mirroring. */
541 uint16_t vlan_id[ETH_MIRROR_MAX_VLANS];
545 * A structure used to configure traffic mirror of an Ethernet port.
547 struct rte_eth_mirror_conf {
548 uint8_t rule_type; /**< Mirroring rule type */
549 uint8_t dst_pool; /**< Destination pool for this mirror rule. */
550 uint64_t pool_mask; /**< Bitmap of pool for pool mirroring */
551 /** VLAN ID setting for VLAN mirroring. */
552 struct rte_eth_vlan_mirror vlan;
556 * A structure used to configure 64 entries of Redirection Table of the
557 * Receive Side Scaling (RSS) feature of an Ethernet port. To configure
558 * more than 64 entries supported by hardware, an array of this structure
561 struct rte_eth_rss_reta_entry64 {
563 /**< Mask bits indicate which entries need to be updated/queried. */
564 uint16_t reta[RTE_RETA_GROUP_SIZE];
565 /**< Group of 64 redirection table entries. */
569 * This enum indicates the possible number of traffic classes
570 * in DCB configurations
572 enum rte_eth_nb_tcs {
573 ETH_4_TCS = 4, /**< 4 TCs with DCB. */
574 ETH_8_TCS = 8 /**< 8 TCs with DCB. */
578 * This enum indicates the possible number of queue pools
579 * in VMDQ configurations.
581 enum rte_eth_nb_pools {
582 ETH_8_POOLS = 8, /**< 8 VMDq pools. */
583 ETH_16_POOLS = 16, /**< 16 VMDq pools. */
584 ETH_32_POOLS = 32, /**< 32 VMDq pools. */
585 ETH_64_POOLS = 64 /**< 64 VMDq pools. */
588 /* This structure may be extended in future. */
589 struct rte_eth_dcb_rx_conf {
590 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs */
591 /** Traffic class each UP mapped to. */
592 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
595 struct rte_eth_vmdq_dcb_tx_conf {
596 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools. */
597 /** Traffic class each UP mapped to. */
598 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
601 struct rte_eth_dcb_tx_conf {
602 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs. */
603 /** Traffic class each UP mapped to. */
604 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
607 struct rte_eth_vmdq_tx_conf {
608 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq mode, 64 pools. */
612 * A structure used to configure the VMDQ+DCB feature
613 * of an Ethernet port.
615 * Using this feature, packets are routed to a pool of queues, based
616 * on the vlan id in the vlan tag, and then to a specific queue within
617 * that pool, using the user priority vlan tag field.
619 * A default pool may be used, if desired, to route all traffic which
620 * does not match the vlan filter rules.
622 struct rte_eth_vmdq_dcb_conf {
623 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools */
624 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
625 uint8_t default_pool; /**< The default pool, if applicable */
626 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
628 uint16_t vlan_id; /**< The vlan id of the received frame */
629 uint64_t pools; /**< Bitmask of pools for packet rx */
630 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
631 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
632 /**< Selects a queue in a pool */
636 * A structure used to configure the VMDQ feature of an Ethernet port when
637 * not combined with the DCB feature.
639 * Using this feature, packets are routed to a pool of queues. By default,
640 * the pool selection is based on the MAC address, the vlan id in the
641 * vlan tag as specified in the pool_map array.
642 * Passing the ETH_VMDQ_ACCEPT_UNTAG in the rx_mode field allows pool
643 * selection using only the MAC address. MAC address to pool mapping is done
644 * using the rte_eth_dev_mac_addr_add function, with the pool parameter
645 * corresponding to the pool id.
647 * Queue selection within the selected pool will be done using RSS when
648 * it is enabled or revert to the first queue of the pool if not.
650 * A default pool may be used, if desired, to route all traffic which
651 * does not match the vlan filter rules or any pool MAC address.
653 struct rte_eth_vmdq_rx_conf {
654 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq only mode, 8 or 64 pools */
655 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
656 uint8_t default_pool; /**< The default pool, if applicable */
657 uint8_t enable_loop_back; /**< Enable VT loop back */
658 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
659 uint32_t rx_mode; /**< Flags from ETH_VMDQ_ACCEPT_* */
661 uint16_t vlan_id; /**< The vlan id of the received frame */
662 uint64_t pools; /**< Bitmask of pools for packet rx */
663 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
667 * A structure used to configure the TX features of an Ethernet port.
669 struct rte_eth_txmode {
670 enum rte_eth_tx_mq_mode mq_mode; /**< TX multi-queues mode. */
672 * Per-port Tx offloads to be set using DEV_TX_OFFLOAD_* flags.
673 * Only offloads set on tx_offload_capa field on rte_eth_dev_info
674 * structure are allowed to be set.
678 /* For i40e specifically */
681 uint8_t hw_vlan_reject_tagged : 1,
682 /**< If set, reject sending out tagged pkts */
683 hw_vlan_reject_untagged : 1,
684 /**< If set, reject sending out untagged pkts */
685 hw_vlan_insert_pvid : 1;
686 /**< If set, enable port based VLAN insertion */
690 * A structure used to configure an RX ring of an Ethernet port.
692 struct rte_eth_rxconf {
693 struct rte_eth_thresh rx_thresh; /**< RX ring threshold registers. */
694 uint16_t rx_free_thresh; /**< Drives the freeing of RX descriptors. */
695 uint8_t rx_drop_en; /**< Drop packets if no descriptors are available. */
696 uint8_t rx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
698 * Per-queue Rx offloads to be set using DEV_RX_OFFLOAD_* flags.
699 * Only offloads set on rx_queue_offload_capa or rx_offload_capa
700 * fields on rte_eth_dev_info structure are allowed to be set.
705 #define ETH_TXQ_FLAGS_NOMULTSEGS 0x0001 /**< nb_segs=1 for all mbufs */
706 #define ETH_TXQ_FLAGS_NOREFCOUNT 0x0002 /**< refcnt can be ignored */
707 #define ETH_TXQ_FLAGS_NOMULTMEMP 0x0004 /**< all bufs come from same mempool */
708 #define ETH_TXQ_FLAGS_NOVLANOFFL 0x0100 /**< disable VLAN offload */
709 #define ETH_TXQ_FLAGS_NOXSUMSCTP 0x0200 /**< disable SCTP checksum offload */
710 #define ETH_TXQ_FLAGS_NOXSUMUDP 0x0400 /**< disable UDP checksum offload */
711 #define ETH_TXQ_FLAGS_NOXSUMTCP 0x0800 /**< disable TCP checksum offload */
712 #define ETH_TXQ_FLAGS_NOOFFLOADS \
713 (ETH_TXQ_FLAGS_NOVLANOFFL | ETH_TXQ_FLAGS_NOXSUMSCTP | \
714 ETH_TXQ_FLAGS_NOXSUMUDP | ETH_TXQ_FLAGS_NOXSUMTCP)
715 #define ETH_TXQ_FLAGS_NOXSUMS \
716 (ETH_TXQ_FLAGS_NOXSUMSCTP | ETH_TXQ_FLAGS_NOXSUMUDP | \
717 ETH_TXQ_FLAGS_NOXSUMTCP)
719 * When set the txq_flags should be ignored,
720 * instead per-queue Tx offloads will be set on offloads field
721 * located on rte_eth_txq_conf struct.
722 * This flag is temporary till the rte_eth_txq_conf.txq_flags
723 * API will be deprecated.
725 #define ETH_TXQ_FLAGS_IGNORE 0x8000
728 * A structure used to configure a TX ring of an Ethernet port.
730 struct rte_eth_txconf {
731 struct rte_eth_thresh tx_thresh; /**< TX ring threshold registers. */
732 uint16_t tx_rs_thresh; /**< Drives the setting of RS bit on TXDs. */
733 uint16_t tx_free_thresh; /**< Start freeing TX buffers if there are
734 less free descriptors than this value. */
736 uint32_t txq_flags; /**< Set flags for the Tx queue */
737 uint8_t tx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
739 * Per-queue Tx offloads to be set using DEV_TX_OFFLOAD_* flags.
740 * Only offloads set on tx_queue_offload_capa or tx_offload_capa
741 * fields on rte_eth_dev_info structure are allowed to be set.
747 * A structure contains information about HW descriptor ring limitations.
749 struct rte_eth_desc_lim {
750 uint16_t nb_max; /**< Max allowed number of descriptors. */
751 uint16_t nb_min; /**< Min allowed number of descriptors. */
752 uint16_t nb_align; /**< Number of descriptors should be aligned to. */
755 * Max allowed number of segments per whole packet.
757 * - For TSO packet this is the total number of data descriptors allowed
760 * @see nb_mtu_seg_max
765 * Max number of segments per one MTU.
767 * - For non-TSO packet, this is the maximum allowed number of segments
768 * in a single transmit packet.
770 * - For TSO packet each segment within the TSO may span up to this
775 uint16_t nb_mtu_seg_max;
779 * This enum indicates the flow control mode
781 enum rte_eth_fc_mode {
782 RTE_FC_NONE = 0, /**< Disable flow control. */
783 RTE_FC_RX_PAUSE, /**< RX pause frame, enable flowctrl on TX side. */
784 RTE_FC_TX_PAUSE, /**< TX pause frame, enable flowctrl on RX side. */
785 RTE_FC_FULL /**< Enable flow control on both side. */
789 * A structure used to configure Ethernet flow control parameter.
790 * These parameters will be configured into the register of the NIC.
791 * Please refer to the corresponding data sheet for proper value.
793 struct rte_eth_fc_conf {
794 uint32_t high_water; /**< High threshold value to trigger XOFF */
795 uint32_t low_water; /**< Low threshold value to trigger XON */
796 uint16_t pause_time; /**< Pause quota in the Pause frame */
797 uint16_t send_xon; /**< Is XON frame need be sent */
798 enum rte_eth_fc_mode mode; /**< Link flow control mode */
799 uint8_t mac_ctrl_frame_fwd; /**< Forward MAC control frames */
800 uint8_t autoneg; /**< Use Pause autoneg */
804 * A structure used to configure Ethernet priority flow control parameter.
805 * These parameters will be configured into the register of the NIC.
806 * Please refer to the corresponding data sheet for proper value.
808 struct rte_eth_pfc_conf {
809 struct rte_eth_fc_conf fc; /**< General flow control parameter. */
810 uint8_t priority; /**< VLAN User Priority. */
814 * Memory space that can be configured to store Flow Director filters
815 * in the board memory.
817 enum rte_fdir_pballoc_type {
818 RTE_FDIR_PBALLOC_64K = 0, /**< 64k. */
819 RTE_FDIR_PBALLOC_128K, /**< 128k. */
820 RTE_FDIR_PBALLOC_256K, /**< 256k. */
824 * Select report mode of FDIR hash information in RX descriptors.
826 enum rte_fdir_status_mode {
827 RTE_FDIR_NO_REPORT_STATUS = 0, /**< Never report FDIR hash. */
828 RTE_FDIR_REPORT_STATUS, /**< Only report FDIR hash for matching pkts. */
829 RTE_FDIR_REPORT_STATUS_ALWAYS, /**< Always report FDIR hash. */
833 * A structure used to configure the Flow Director (FDIR) feature
834 * of an Ethernet port.
836 * If mode is RTE_FDIR_DISABLE, the pballoc value is ignored.
838 struct rte_fdir_conf {
839 enum rte_fdir_mode mode; /**< Flow Director mode. */
840 enum rte_fdir_pballoc_type pballoc; /**< Space for FDIR filters. */
841 enum rte_fdir_status_mode status; /**< How to report FDIR hash. */
842 /** RX queue of packets matching a "drop" filter in perfect mode. */
844 struct rte_eth_fdir_masks mask;
845 struct rte_eth_fdir_flex_conf flex_conf;
846 /**< Flex payload configuration. */
850 * UDP tunneling configuration.
851 * Used to config the UDP port for a type of tunnel.
852 * NICs need the UDP port to identify the tunnel type.
853 * Normally a type of tunnel has a default UDP port, this structure can be used
854 * in case if the users want to change or support more UDP port.
856 struct rte_eth_udp_tunnel {
857 uint16_t udp_port; /**< UDP port used for the tunnel. */
858 uint8_t prot_type; /**< Tunnel type. Defined in rte_eth_tunnel_type. */
862 * A structure used to enable/disable specific device interrupts.
864 struct rte_intr_conf {
865 /** enable/disable lsc interrupt. 0 (default) - disable, 1 enable */
867 /** enable/disable rxq interrupt. 0 (default) - disable, 1 enable */
869 /** enable/disable rmv interrupt. 0 (default) - disable, 1 enable */
874 * A structure used to configure an Ethernet port.
875 * Depending upon the RX multi-queue mode, extra advanced
876 * configuration settings may be needed.
878 struct rte_eth_conf {
879 uint32_t link_speeds; /**< bitmap of ETH_LINK_SPEED_XXX of speeds to be
880 used. ETH_LINK_SPEED_FIXED disables link
881 autonegotiation, and a unique speed shall be
882 set. Otherwise, the bitmap defines the set of
883 speeds to be advertised. If the special value
884 ETH_LINK_SPEED_AUTONEG (0) is used, all speeds
885 supported are advertised. */
886 struct rte_eth_rxmode rxmode; /**< Port RX configuration. */
887 struct rte_eth_txmode txmode; /**< Port TX configuration. */
888 uint32_t lpbk_mode; /**< Loopback operation mode. By default the value
889 is 0, meaning the loopback mode is disabled.
890 Read the datasheet of given ethernet controller
891 for details. The possible values of this field
892 are defined in implementation of each driver. */
894 struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
895 struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
896 /**< Port vmdq+dcb configuration. */
897 struct rte_eth_dcb_rx_conf dcb_rx_conf;
898 /**< Port dcb RX configuration. */
899 struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
900 /**< Port vmdq RX configuration. */
901 } rx_adv_conf; /**< Port RX filtering configuration. */
903 struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
904 /**< Port vmdq+dcb TX configuration. */
905 struct rte_eth_dcb_tx_conf dcb_tx_conf;
906 /**< Port dcb TX configuration. */
907 struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
908 /**< Port vmdq TX configuration. */
909 } tx_adv_conf; /**< Port TX DCB configuration (union). */
910 /** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
911 is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
912 uint32_t dcb_capability_en;
913 struct rte_fdir_conf fdir_conf; /**< FDIR configuration. */
914 struct rte_intr_conf intr_conf; /**< Interrupt mode configuration. */
918 * A structure used to retrieve the contextual information of
919 * an Ethernet device, such as the controlling driver of the device,
920 * its PCI context, etc...
924 * RX offload capabilities of a device.
926 #define DEV_RX_OFFLOAD_VLAN_STRIP 0x00000001
927 #define DEV_RX_OFFLOAD_IPV4_CKSUM 0x00000002
928 #define DEV_RX_OFFLOAD_UDP_CKSUM 0x00000004
929 #define DEV_RX_OFFLOAD_TCP_CKSUM 0x00000008
930 #define DEV_RX_OFFLOAD_TCP_LRO 0x00000010
931 #define DEV_RX_OFFLOAD_QINQ_STRIP 0x00000020
932 #define DEV_RX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000040
933 #define DEV_RX_OFFLOAD_MACSEC_STRIP 0x00000080
934 #define DEV_RX_OFFLOAD_HEADER_SPLIT 0x00000100
935 #define DEV_RX_OFFLOAD_VLAN_FILTER 0x00000200
936 #define DEV_RX_OFFLOAD_VLAN_EXTEND 0x00000400
937 #define DEV_RX_OFFLOAD_JUMBO_FRAME 0x00000800
938 #define DEV_RX_OFFLOAD_CRC_STRIP 0x00001000
939 #define DEV_RX_OFFLOAD_SCATTER 0x00002000
940 #define DEV_RX_OFFLOAD_TIMESTAMP 0x00004000
941 #define DEV_RX_OFFLOAD_SECURITY 0x00008000
942 #define DEV_RX_OFFLOAD_CHECKSUM (DEV_RX_OFFLOAD_IPV4_CKSUM | \
943 DEV_RX_OFFLOAD_UDP_CKSUM | \
944 DEV_RX_OFFLOAD_TCP_CKSUM)
945 #define DEV_RX_OFFLOAD_VLAN (DEV_RX_OFFLOAD_VLAN_STRIP | \
946 DEV_RX_OFFLOAD_VLAN_FILTER | \
947 DEV_RX_OFFLOAD_VLAN_EXTEND)
950 * TX offload capabilities of a device.
952 #define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001
953 #define DEV_TX_OFFLOAD_IPV4_CKSUM 0x00000002
954 #define DEV_TX_OFFLOAD_UDP_CKSUM 0x00000004
955 #define DEV_TX_OFFLOAD_TCP_CKSUM 0x00000008
956 #define DEV_TX_OFFLOAD_SCTP_CKSUM 0x00000010
957 #define DEV_TX_OFFLOAD_TCP_TSO 0x00000020
958 #define DEV_TX_OFFLOAD_UDP_TSO 0x00000040
959 #define DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000080 /**< Used for tunneling packet. */
960 #define DEV_TX_OFFLOAD_QINQ_INSERT 0x00000100
961 #define DEV_TX_OFFLOAD_VXLAN_TNL_TSO 0x00000200 /**< Used for tunneling packet. */
962 #define DEV_TX_OFFLOAD_GRE_TNL_TSO 0x00000400 /**< Used for tunneling packet. */
963 #define DEV_TX_OFFLOAD_IPIP_TNL_TSO 0x00000800 /**< Used for tunneling packet. */
964 #define DEV_TX_OFFLOAD_GENEVE_TNL_TSO 0x00001000 /**< Used for tunneling packet. */
965 #define DEV_TX_OFFLOAD_MACSEC_INSERT 0x00002000
966 #define DEV_TX_OFFLOAD_MT_LOCKFREE 0x00004000
967 /**< Multiple threads can invoke rte_eth_tx_burst() concurrently on the same
968 * tx queue without SW lock.
970 #define DEV_TX_OFFLOAD_MULTI_SEGS 0x00008000
971 /**< Device supports multi segment send. */
972 #define DEV_TX_OFFLOAD_MBUF_FAST_FREE 0x00010000
973 /**< Device supports optimization for fast release of mbufs.
974 * When set application must guarantee that per-queue all mbufs comes from
975 * the same mempool and has refcnt = 1.
977 #define DEV_TX_OFFLOAD_SECURITY 0x00020000
979 struct rte_pci_device;
982 * Ethernet device information
984 struct rte_eth_dev_info {
985 struct rte_pci_device *pci_dev; /**< Device PCI information. */
986 const char *driver_name; /**< Device Driver name. */
987 unsigned int if_index; /**< Index to bound host interface, or 0 if none.
988 Use if_indextoname() to translate into an interface name. */
989 uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
990 uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
991 uint16_t max_rx_queues; /**< Maximum number of RX queues. */
992 uint16_t max_tx_queues; /**< Maximum number of TX queues. */
993 uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
994 uint32_t max_hash_mac_addrs;
995 /** Maximum number of hash MAC addresses for MTA and UTA. */
996 uint16_t max_vfs; /**< Maximum number of VFs. */
997 uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
998 uint64_t rx_offload_capa;
999 /**< Device per port RX offload capabilities. */
1000 uint64_t tx_offload_capa;
1001 /**< Device per port TX offload capabilities. */
1002 uint64_t rx_queue_offload_capa;
1003 /**< Device per queue RX offload capabilities. */
1004 uint64_t tx_queue_offload_capa;
1005 /**< Device per queue TX offload capabilities. */
1007 /**< Device redirection table size, the total number of entries. */
1008 uint8_t hash_key_size; /**< Hash key size in bytes */
1009 /** Bit mask of RSS offloads, the bit offset also means flow type */
1010 uint64_t flow_type_rss_offloads;
1011 struct rte_eth_rxconf default_rxconf; /**< Default RX configuration */
1012 struct rte_eth_txconf default_txconf; /**< Default TX configuration */
1013 uint16_t vmdq_queue_base; /**< First queue ID for VMDQ pools. */
1014 uint16_t vmdq_queue_num; /**< Queue number for VMDQ pools. */
1015 uint16_t vmdq_pool_base; /**< First ID of VMDQ pools. */
1016 struct rte_eth_desc_lim rx_desc_lim; /**< RX descriptors limits */
1017 struct rte_eth_desc_lim tx_desc_lim; /**< TX descriptors limits */
1018 uint32_t speed_capa; /**< Supported speeds bitmap (ETH_LINK_SPEED_). */
1019 /** Configured number of rx/tx queues */
1020 uint16_t nb_rx_queues; /**< Number of RX queues. */
1021 uint16_t nb_tx_queues; /**< Number of TX queues. */
1025 * Ethernet device RX queue information structure.
1026 * Used to retieve information about configured queue.
1028 struct rte_eth_rxq_info {
1029 struct rte_mempool *mp; /**< mempool used by that queue. */
1030 struct rte_eth_rxconf conf; /**< queue config parameters. */
1031 uint8_t scattered_rx; /**< scattered packets RX supported. */
1032 uint16_t nb_desc; /**< configured number of RXDs. */
1033 } __rte_cache_min_aligned;
1036 * Ethernet device TX queue information structure.
1037 * Used to retrieve information about configured queue.
1039 struct rte_eth_txq_info {
1040 struct rte_eth_txconf conf; /**< queue config parameters. */
1041 uint16_t nb_desc; /**< configured number of TXDs. */
1042 } __rte_cache_min_aligned;
1044 /** Maximum name length for extended statistics counters */
1045 #define RTE_ETH_XSTATS_NAME_SIZE 64
1048 * An Ethernet device extended statistic structure
1050 * This structure is used by rte_eth_xstats_get() to provide
1051 * statistics that are not provided in the generic *rte_eth_stats*
1053 * It maps a name id, corresponding to an index in the array returned
1054 * by rte_eth_xstats_get_names(), to a statistic value.
1056 struct rte_eth_xstat {
1057 uint64_t id; /**< The index in xstats name array. */
1058 uint64_t value; /**< The statistic counter value. */
1062 * A name element for extended statistics.
1064 * An array of this structure is returned by rte_eth_xstats_get_names().
1065 * It lists the names of extended statistics for a PMD. The *rte_eth_xstat*
1066 * structure references these names by their array index.
1068 struct rte_eth_xstat_name {
1069 char name[RTE_ETH_XSTATS_NAME_SIZE]; /**< The statistic name. */
1072 #define ETH_DCB_NUM_TCS 8
1073 #define ETH_MAX_VMDQ_POOL 64
1076 * A structure used to get the information of queue and
1077 * TC mapping on both TX and RX paths.
1079 struct rte_eth_dcb_tc_queue_mapping {
1080 /** rx queues assigned to tc per Pool */
1084 } tc_rxq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
1085 /** rx queues assigned to tc per Pool */
1089 } tc_txq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
1093 * A structure used to get the information of DCB.
1094 * It includes TC UP mapping and queue TC mapping.
1096 struct rte_eth_dcb_info {
1097 uint8_t nb_tcs; /**< number of TCs */
1098 uint8_t prio_tc[ETH_DCB_NUM_USER_PRIORITIES]; /**< Priority to tc */
1099 uint8_t tc_bws[ETH_DCB_NUM_TCS]; /**< TX BW percentage for each TC */
1100 /** rx queues assigned to tc */
1101 struct rte_eth_dcb_tc_queue_mapping tc_queue;
1105 * RX/TX queue states
1107 #define RTE_ETH_QUEUE_STATE_STOPPED 0
1108 #define RTE_ETH_QUEUE_STATE_STARTED 1
1112 #define RTE_ETH_ALL RTE_MAX_ETHPORTS
1114 struct rte_eth_dev_callback;
1115 /** @internal Structure to keep track of registered callbacks */
1116 TAILQ_HEAD(rte_eth_dev_cb_list, rte_eth_dev_callback);
1118 /* Macros to check for valid port */
1119 #define RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, retval) do { \
1120 if (!rte_eth_dev_is_valid_port(port_id)) { \
1121 RTE_PMD_DEBUG_TRACE("Invalid port_id=%d\n", port_id); \
1126 #define RTE_ETH_VALID_PORTID_OR_RET(port_id) do { \
1127 if (!rte_eth_dev_is_valid_port(port_id)) { \
1128 RTE_PMD_DEBUG_TRACE("Invalid port_id=%d\n", port_id); \
1134 * l2 tunnel configuration.
1137 /**< l2 tunnel enable mask */
1138 #define ETH_L2_TUNNEL_ENABLE_MASK 0x00000001
1139 /**< l2 tunnel insertion mask */
1140 #define ETH_L2_TUNNEL_INSERTION_MASK 0x00000002
1141 /**< l2 tunnel stripping mask */
1142 #define ETH_L2_TUNNEL_STRIPPING_MASK 0x00000004
1143 /**< l2 tunnel forwarding mask */
1144 #define ETH_L2_TUNNEL_FORWARDING_MASK 0x00000008
1147 * Definitions of all functions exported by an Ethernet driver through the
1148 * the generic structure of type *eth_dev_ops* supplied in the *rte_eth_dev*
1149 * structure associated with an Ethernet device.
1152 typedef int (*eth_dev_configure_t)(struct rte_eth_dev *dev);
1153 /**< @internal Ethernet device configuration. */
1155 typedef int (*eth_dev_start_t)(struct rte_eth_dev *dev);
1156 /**< @internal Function used to start a configured Ethernet device. */
1158 typedef void (*eth_dev_stop_t)(struct rte_eth_dev *dev);
1159 /**< @internal Function used to stop a configured Ethernet device. */
1161 typedef int (*eth_dev_set_link_up_t)(struct rte_eth_dev *dev);
1162 /**< @internal Function used to link up a configured Ethernet device. */
1164 typedef int (*eth_dev_set_link_down_t)(struct rte_eth_dev *dev);
1165 /**< @internal Function used to link down a configured Ethernet device. */
1167 typedef void (*eth_dev_close_t)(struct rte_eth_dev *dev);
1168 /**< @internal Function used to close a configured Ethernet device. */
1170 typedef int (*eth_dev_reset_t)(struct rte_eth_dev *dev);
1171 /** <@internal Function used to reset a configured Ethernet device. */
1173 typedef void (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev);
1174 /**< @internal Function used to enable the RX promiscuous mode of an Ethernet device. */
1176 typedef void (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev);
1177 /**< @internal Function used to disable the RX promiscuous mode of an Ethernet device. */
1179 typedef void (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
1180 /**< @internal Enable the receipt of all multicast packets by an Ethernet device. */
1182 typedef void (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
1183 /**< @internal Disable the receipt of all multicast packets by an Ethernet device. */
1185 typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
1186 int wait_to_complete);
1187 /**< @internal Get link speed, duplex mode and state (up/down) of an Ethernet device. */
1189 typedef int (*eth_stats_get_t)(struct rte_eth_dev *dev,
1190 struct rte_eth_stats *igb_stats);
1191 /**< @internal Get global I/O statistics of an Ethernet device. */
1193 typedef void (*eth_stats_reset_t)(struct rte_eth_dev *dev);
1194 /**< @internal Reset global I/O statistics of an Ethernet device to 0. */
1196 typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev,
1197 struct rte_eth_xstat *stats, unsigned n);
1198 /**< @internal Get extended stats of an Ethernet device. */
1200 typedef int (*eth_xstats_get_by_id_t)(struct rte_eth_dev *dev,
1201 const uint64_t *ids,
1204 /**< @internal Get extended stats of an Ethernet device. */
1206 typedef void (*eth_xstats_reset_t)(struct rte_eth_dev *dev);
1207 /**< @internal Reset extended stats of an Ethernet device. */
1209 typedef int (*eth_xstats_get_names_t)(struct rte_eth_dev *dev,
1210 struct rte_eth_xstat_name *xstats_names, unsigned size);
1211 /**< @internal Get names of extended stats of an Ethernet device. */
1213 typedef int (*eth_xstats_get_names_by_id_t)(struct rte_eth_dev *dev,
1214 struct rte_eth_xstat_name *xstats_names, const uint64_t *ids,
1216 /**< @internal Get names of extended stats of an Ethernet device. */
1218 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
1222 /**< @internal Set a queue statistics mapping for a tx/rx queue of an Ethernet device. */
1224 typedef void (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
1225 struct rte_eth_dev_info *dev_info);
1226 /**< @internal Get specific informations of an Ethernet device. */
1228 typedef const uint32_t *(*eth_dev_supported_ptypes_get_t)(struct rte_eth_dev *dev);
1229 /**< @internal Get supported ptypes of an Ethernet device. */
1231 typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
1233 /**< @internal Start rx and tx of a queue of an Ethernet device. */
1235 typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
1237 /**< @internal Stop rx and tx of a queue of an Ethernet device. */
1239 typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
1240 uint16_t rx_queue_id,
1241 uint16_t nb_rx_desc,
1242 unsigned int socket_id,
1243 const struct rte_eth_rxconf *rx_conf,
1244 struct rte_mempool *mb_pool);
1245 /**< @internal Set up a receive queue of an Ethernet device. */
1247 typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
1248 uint16_t tx_queue_id,
1249 uint16_t nb_tx_desc,
1250 unsigned int socket_id,
1251 const struct rte_eth_txconf *tx_conf);
1252 /**< @internal Setup a transmit queue of an Ethernet device. */
1254 typedef int (*eth_rx_enable_intr_t)(struct rte_eth_dev *dev,
1255 uint16_t rx_queue_id);
1256 /**< @internal Enable interrupt of a receive queue of an Ethernet device. */
1258 typedef int (*eth_rx_disable_intr_t)(struct rte_eth_dev *dev,
1259 uint16_t rx_queue_id);
1260 /**< @internal Disable interrupt of a receive queue of an Ethernet device. */
1262 typedef void (*eth_queue_release_t)(void *queue);
1263 /**< @internal Release memory resources allocated by given RX/TX queue. */
1265 typedef uint32_t (*eth_rx_queue_count_t)(struct rte_eth_dev *dev,
1266 uint16_t rx_queue_id);
1267 /**< @internal Get number of used descriptors on a receive queue. */
1269 typedef int (*eth_rx_descriptor_done_t)(void *rxq, uint16_t offset);
1270 /**< @internal Check DD bit of specific RX descriptor */
1272 typedef int (*eth_rx_descriptor_status_t)(void *rxq, uint16_t offset);
1273 /**< @internal Check the status of a Rx descriptor */
1275 typedef int (*eth_tx_descriptor_status_t)(void *txq, uint16_t offset);
1276 /**< @internal Check the status of a Tx descriptor */
1278 typedef int (*eth_fw_version_get_t)(struct rte_eth_dev *dev,
1279 char *fw_version, size_t fw_size);
1280 /**< @internal Get firmware information of an Ethernet device. */
1282 typedef int (*eth_tx_done_cleanup_t)(void *txq, uint32_t free_cnt);
1283 /**< @internal Force mbufs to be from TX ring. */
1285 typedef void (*eth_rxq_info_get_t)(struct rte_eth_dev *dev,
1286 uint16_t rx_queue_id, struct rte_eth_rxq_info *qinfo);
1288 typedef void (*eth_txq_info_get_t)(struct rte_eth_dev *dev,
1289 uint16_t tx_queue_id, struct rte_eth_txq_info *qinfo);
1291 typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);
1292 /**< @internal Set MTU. */
1294 typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
1297 /**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */
1299 typedef int (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
1300 enum rte_vlan_type type, uint16_t tpid);
1301 /**< @internal set the outer/inner VLAN-TPID by an Ethernet device. */
1303 typedef int (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
1304 /**< @internal set VLAN offload function by an Ethernet device. */
1306 typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
1309 /**< @internal set port based TX VLAN insertion by an Ethernet device. */
1311 typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
1312 uint16_t rx_queue_id,
1314 /**< @internal VLAN stripping enable/disable by an queue of Ethernet device. */
1316 typedef uint16_t (*eth_rx_burst_t)(void *rxq,
1317 struct rte_mbuf **rx_pkts,
1319 /**< @internal Retrieve input packets from a receive queue of an Ethernet device. */
1321 typedef uint16_t (*eth_tx_burst_t)(void *txq,
1322 struct rte_mbuf **tx_pkts,
1324 /**< @internal Send output packets on a transmit queue of an Ethernet device. */
1326 typedef uint16_t (*eth_tx_prep_t)(void *txq,
1327 struct rte_mbuf **tx_pkts,
1329 /**< @internal Prepare output packets on a transmit queue of an Ethernet device. */
1331 typedef int (*flow_ctrl_get_t)(struct rte_eth_dev *dev,
1332 struct rte_eth_fc_conf *fc_conf);
1333 /**< @internal Get current flow control parameter on an Ethernet device */
1335 typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
1336 struct rte_eth_fc_conf *fc_conf);
1337 /**< @internal Setup flow control parameter on an Ethernet device */
1339 typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
1340 struct rte_eth_pfc_conf *pfc_conf);
1341 /**< @internal Setup priority flow control parameter on an Ethernet device */
1343 typedef int (*reta_update_t)(struct rte_eth_dev *dev,
1344 struct rte_eth_rss_reta_entry64 *reta_conf,
1345 uint16_t reta_size);
1346 /**< @internal Update RSS redirection table on an Ethernet device */
1348 typedef int (*reta_query_t)(struct rte_eth_dev *dev,
1349 struct rte_eth_rss_reta_entry64 *reta_conf,
1350 uint16_t reta_size);
1351 /**< @internal Query RSS redirection table on an Ethernet device */
1353 typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
1354 struct rte_eth_rss_conf *rss_conf);
1355 /**< @internal Update RSS hash configuration of an Ethernet device */
1357 typedef int (*rss_hash_conf_get_t)(struct rte_eth_dev *dev,
1358 struct rte_eth_rss_conf *rss_conf);
1359 /**< @internal Get current RSS hash configuration of an Ethernet device */
1361 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
1362 /**< @internal Turn on SW controllable LED on an Ethernet device */
1364 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
1365 /**< @internal Turn off SW controllable LED on an Ethernet device */
1367 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
1368 /**< @internal Remove MAC address from receive address register */
1370 typedef int (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
1371 struct ether_addr *mac_addr,
1374 /**< @internal Set a MAC address into Receive Address Address Register */
1376 typedef void (*eth_mac_addr_set_t)(struct rte_eth_dev *dev,
1377 struct ether_addr *mac_addr);
1378 /**< @internal Set a MAC address into Receive Address Address Register */
1380 typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
1381 struct ether_addr *mac_addr,
1383 /**< @internal Set a Unicast Hash bitmap */
1385 typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
1387 /**< @internal Set all Unicast Hash bitmap */
1389 typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
1392 /**< @internal Set queue TX rate */
1394 typedef int (*eth_mirror_rule_set_t)(struct rte_eth_dev *dev,
1395 struct rte_eth_mirror_conf *mirror_conf,
1398 /**< @internal Add a traffic mirroring rule on an Ethernet device */
1400 typedef int (*eth_mirror_rule_reset_t)(struct rte_eth_dev *dev,
1402 /**< @internal Remove a traffic mirroring rule on an Ethernet device */
1404 typedef int (*eth_udp_tunnel_port_add_t)(struct rte_eth_dev *dev,
1405 struct rte_eth_udp_tunnel *tunnel_udp);
1406 /**< @internal Add tunneling UDP port */
1408 typedef int (*eth_udp_tunnel_port_del_t)(struct rte_eth_dev *dev,
1409 struct rte_eth_udp_tunnel *tunnel_udp);
1410 /**< @internal Delete tunneling UDP port */
1412 typedef int (*eth_set_mc_addr_list_t)(struct rte_eth_dev *dev,
1413 struct ether_addr *mc_addr_set,
1414 uint32_t nb_mc_addr);
1415 /**< @internal set the list of multicast addresses on an Ethernet device */
1417 typedef int (*eth_timesync_enable_t)(struct rte_eth_dev *dev);
1418 /**< @internal Function used to enable IEEE1588/802.1AS timestamping. */
1420 typedef int (*eth_timesync_disable_t)(struct rte_eth_dev *dev);
1421 /**< @internal Function used to disable IEEE1588/802.1AS timestamping. */
1423 typedef int (*eth_timesync_read_rx_timestamp_t)(struct rte_eth_dev *dev,
1424 struct timespec *timestamp,
1426 /**< @internal Function used to read an RX IEEE1588/802.1AS timestamp. */
1428 typedef int (*eth_timesync_read_tx_timestamp_t)(struct rte_eth_dev *dev,
1429 struct timespec *timestamp);
1430 /**< @internal Function used to read a TX IEEE1588/802.1AS timestamp. */
1432 typedef int (*eth_timesync_adjust_time)(struct rte_eth_dev *dev, int64_t);
1433 /**< @internal Function used to adjust the device clock */
1435 typedef int (*eth_timesync_read_time)(struct rte_eth_dev *dev,
1436 struct timespec *timestamp);
1437 /**< @internal Function used to get time from the device clock. */
1439 typedef int (*eth_timesync_write_time)(struct rte_eth_dev *dev,
1440 const struct timespec *timestamp);
1441 /**< @internal Function used to get time from the device clock */
1443 typedef int (*eth_get_reg_t)(struct rte_eth_dev *dev,
1444 struct rte_dev_reg_info *info);
1445 /**< @internal Retrieve registers */
1447 typedef int (*eth_get_eeprom_length_t)(struct rte_eth_dev *dev);
1448 /**< @internal Retrieve eeprom size */
1450 typedef int (*eth_get_eeprom_t)(struct rte_eth_dev *dev,
1451 struct rte_dev_eeprom_info *info);
1452 /**< @internal Retrieve eeprom data */
1454 typedef int (*eth_set_eeprom_t)(struct rte_eth_dev *dev,
1455 struct rte_dev_eeprom_info *info);
1456 /**< @internal Program eeprom data */
1458 typedef int (*eth_l2_tunnel_eth_type_conf_t)
1459 (struct rte_eth_dev *dev, struct rte_eth_l2_tunnel_conf *l2_tunnel);
1460 /**< @internal config l2 tunnel ether type */
1462 typedef int (*eth_l2_tunnel_offload_set_t)
1463 (struct rte_eth_dev *dev,
1464 struct rte_eth_l2_tunnel_conf *l2_tunnel,
1467 /**< @internal enable/disable the l2 tunnel offload functions */
1470 typedef int (*eth_filter_ctrl_t)(struct rte_eth_dev *dev,
1471 enum rte_filter_type filter_type,
1472 enum rte_filter_op filter_op,
1474 /**< @internal Take operations to assigned filter type on an Ethernet device */
1476 typedef int (*eth_tm_ops_get_t)(struct rte_eth_dev *dev, void *ops);
1477 /**< @internal Get Traffic Management (TM) operations on an Ethernet device */
1479 typedef int (*eth_mtr_ops_get_t)(struct rte_eth_dev *dev, void *ops);
1480 /**< @internal Get Trafffic Metering and Policing (MTR) operations */
1482 typedef int (*eth_get_dcb_info)(struct rte_eth_dev *dev,
1483 struct rte_eth_dcb_info *dcb_info);
1484 /**< @internal Get dcb information on an Ethernet device */
1486 typedef int (*eth_pool_ops_supported_t)(struct rte_eth_dev *dev,
1488 /**< @internal Test if a port supports specific mempool ops */
1491 * @internal A structure containing the functions exported by an Ethernet driver.
1493 struct eth_dev_ops {
1494 eth_dev_configure_t dev_configure; /**< Configure device. */
1495 eth_dev_start_t dev_start; /**< Start device. */
1496 eth_dev_stop_t dev_stop; /**< Stop device. */
1497 eth_dev_set_link_up_t dev_set_link_up; /**< Device link up. */
1498 eth_dev_set_link_down_t dev_set_link_down; /**< Device link down. */
1499 eth_dev_close_t dev_close; /**< Close device. */
1500 eth_dev_reset_t dev_reset; /**< Reset device. */
1501 eth_link_update_t link_update; /**< Get device link state. */
1503 eth_promiscuous_enable_t promiscuous_enable; /**< Promiscuous ON. */
1504 eth_promiscuous_disable_t promiscuous_disable;/**< Promiscuous OFF. */
1505 eth_allmulticast_enable_t allmulticast_enable;/**< RX multicast ON. */
1506 eth_allmulticast_disable_t allmulticast_disable;/**< RX multicast OFF. */
1507 eth_mac_addr_remove_t mac_addr_remove; /**< Remove MAC address. */
1508 eth_mac_addr_add_t mac_addr_add; /**< Add a MAC address. */
1509 eth_mac_addr_set_t mac_addr_set; /**< Set a MAC address. */
1510 eth_set_mc_addr_list_t set_mc_addr_list; /**< set list of mcast addrs. */
1511 mtu_set_t mtu_set; /**< Set MTU. */
1513 eth_stats_get_t stats_get; /**< Get generic device statistics. */
1514 eth_stats_reset_t stats_reset; /**< Reset generic device statistics. */
1515 eth_xstats_get_t xstats_get; /**< Get extended device statistics. */
1516 eth_xstats_reset_t xstats_reset; /**< Reset extended device statistics. */
1517 eth_xstats_get_names_t xstats_get_names;
1518 /**< Get names of extended statistics. */
1519 eth_queue_stats_mapping_set_t queue_stats_mapping_set;
1520 /**< Configure per queue stat counter mapping. */
1522 eth_dev_infos_get_t dev_infos_get; /**< Get device info. */
1523 eth_rxq_info_get_t rxq_info_get; /**< retrieve RX queue information. */
1524 eth_txq_info_get_t txq_info_get; /**< retrieve TX queue information. */
1525 eth_fw_version_get_t fw_version_get; /**< Get firmware version. */
1526 eth_dev_supported_ptypes_get_t dev_supported_ptypes_get;
1527 /**< Get packet types supported and identified by device. */
1529 vlan_filter_set_t vlan_filter_set; /**< Filter VLAN Setup. */
1530 vlan_tpid_set_t vlan_tpid_set; /**< Outer/Inner VLAN TPID Setup. */
1531 vlan_strip_queue_set_t vlan_strip_queue_set; /**< VLAN Stripping on queue. */
1532 vlan_offload_set_t vlan_offload_set; /**< Set VLAN Offload. */
1533 vlan_pvid_set_t vlan_pvid_set; /**< Set port based TX VLAN insertion. */
1535 eth_queue_start_t rx_queue_start;/**< Start RX for a queue. */
1536 eth_queue_stop_t rx_queue_stop; /**< Stop RX for a queue. */
1537 eth_queue_start_t tx_queue_start;/**< Start TX for a queue. */
1538 eth_queue_stop_t tx_queue_stop; /**< Stop TX for a queue. */
1539 eth_rx_queue_setup_t rx_queue_setup;/**< Set up device RX queue. */
1540 eth_queue_release_t rx_queue_release; /**< Release RX queue. */
1541 eth_rx_queue_count_t rx_queue_count;
1542 /**< Get the number of used RX descriptors. */
1543 eth_rx_descriptor_done_t rx_descriptor_done; /**< Check rxd DD bit. */
1544 eth_rx_descriptor_status_t rx_descriptor_status;
1545 /**< Check the status of a Rx descriptor. */
1546 eth_tx_descriptor_status_t tx_descriptor_status;
1547 /**< Check the status of a Tx descriptor. */
1548 eth_rx_enable_intr_t rx_queue_intr_enable; /**< Enable Rx queue interrupt. */
1549 eth_rx_disable_intr_t rx_queue_intr_disable; /**< Disable Rx queue interrupt. */
1550 eth_tx_queue_setup_t tx_queue_setup;/**< Set up device TX queue. */
1551 eth_queue_release_t tx_queue_release; /**< Release TX queue. */
1552 eth_tx_done_cleanup_t tx_done_cleanup;/**< Free tx ring mbufs */
1554 eth_dev_led_on_t dev_led_on; /**< Turn on LED. */
1555 eth_dev_led_off_t dev_led_off; /**< Turn off LED. */
1557 flow_ctrl_get_t flow_ctrl_get; /**< Get flow control. */
1558 flow_ctrl_set_t flow_ctrl_set; /**< Setup flow control. */
1559 priority_flow_ctrl_set_t priority_flow_ctrl_set; /**< Setup priority flow control. */
1561 eth_uc_hash_table_set_t uc_hash_table_set; /**< Set Unicast Table Array. */
1562 eth_uc_all_hash_table_set_t uc_all_hash_table_set; /**< Set Unicast hash bitmap. */
1564 eth_mirror_rule_set_t mirror_rule_set; /**< Add a traffic mirror rule. */
1565 eth_mirror_rule_reset_t mirror_rule_reset; /**< reset a traffic mirror rule. */
1567 eth_udp_tunnel_port_add_t udp_tunnel_port_add; /** Add UDP tunnel port. */
1568 eth_udp_tunnel_port_del_t udp_tunnel_port_del; /** Del UDP tunnel port. */
1569 eth_l2_tunnel_eth_type_conf_t l2_tunnel_eth_type_conf;
1570 /** Config ether type of l2 tunnel. */
1571 eth_l2_tunnel_offload_set_t l2_tunnel_offload_set;
1572 /** Enable/disable l2 tunnel offload functions. */
1574 eth_set_queue_rate_limit_t set_queue_rate_limit; /**< Set queue rate limit. */
1576 rss_hash_update_t rss_hash_update; /** Configure RSS hash protocols. */
1577 rss_hash_conf_get_t rss_hash_conf_get; /** Get current RSS hash configuration. */
1578 reta_update_t reta_update; /** Update redirection table. */
1579 reta_query_t reta_query; /** Query redirection table. */
1581 eth_get_reg_t get_reg; /**< Get registers. */
1582 eth_get_eeprom_length_t get_eeprom_length; /**< Get eeprom length. */
1583 eth_get_eeprom_t get_eeprom; /**< Get eeprom data. */
1584 eth_set_eeprom_t set_eeprom; /**< Set eeprom. */
1587 eth_filter_ctrl_t filter_ctrl; /**< common filter control. */
1589 eth_get_dcb_info get_dcb_info; /** Get DCB information. */
1591 eth_timesync_enable_t timesync_enable;
1592 /** Turn IEEE1588/802.1AS timestamping on. */
1593 eth_timesync_disable_t timesync_disable;
1594 /** Turn IEEE1588/802.1AS timestamping off. */
1595 eth_timesync_read_rx_timestamp_t timesync_read_rx_timestamp;
1596 /** Read the IEEE1588/802.1AS RX timestamp. */
1597 eth_timesync_read_tx_timestamp_t timesync_read_tx_timestamp;
1598 /** Read the IEEE1588/802.1AS TX timestamp. */
1599 eth_timesync_adjust_time timesync_adjust_time; /** Adjust the device clock. */
1600 eth_timesync_read_time timesync_read_time; /** Get the device clock time. */
1601 eth_timesync_write_time timesync_write_time; /** Set the device clock time. */
1603 eth_xstats_get_by_id_t xstats_get_by_id;
1604 /**< Get extended device statistic values by ID. */
1605 eth_xstats_get_names_by_id_t xstats_get_names_by_id;
1606 /**< Get name of extended device statistics by ID. */
1608 eth_tm_ops_get_t tm_ops_get;
1609 /**< Get Traffic Management (TM) operations. */
1611 eth_mtr_ops_get_t mtr_ops_get;
1612 /**< Get Traffic Metering and Policing (MTR) operations. */
1614 eth_pool_ops_supported_t pool_ops_supported;
1615 /**< Test if a port supports specific mempool ops */
1619 * Function type used for RX packet processing packet callbacks.
1621 * The callback function is called on RX with a burst of packets that have
1622 * been received on the given port and queue.
1625 * The Ethernet port on which RX is being performed.
1627 * The queue on the Ethernet port which is being used to receive the packets.
1629 * The burst of packets that have just been received.
1631 * The number of packets in the burst pointed to by "pkts".
1633 * The max number of packets that can be stored in the "pkts" array.
1635 * The arbitrary user parameter passed in by the application when the callback
1636 * was originally configured.
1638 * The number of packets returned to the user.
1640 typedef uint16_t (*rte_rx_callback_fn)(uint16_t port, uint16_t queue,
1641 struct rte_mbuf *pkts[], uint16_t nb_pkts, uint16_t max_pkts,
1645 * Function type used for TX packet processing packet callbacks.
1647 * The callback function is called on TX with a burst of packets immediately
1648 * before the packets are put onto the hardware queue for transmission.
1651 * The Ethernet port on which TX is being performed.
1653 * The queue on the Ethernet port which is being used to transmit the packets.
1655 * The burst of packets that are about to be transmitted.
1657 * The number of packets in the burst pointed to by "pkts".
1659 * The arbitrary user parameter passed in by the application when the callback
1660 * was originally configured.
1662 * The number of packets to be written to the NIC.
1664 typedef uint16_t (*rte_tx_callback_fn)(uint16_t port, uint16_t queue,
1665 struct rte_mbuf *pkts[], uint16_t nb_pkts, void *user_param);
1669 * Structure used to hold information about the callbacks to be called for a
1670 * queue on RX and TX.
1672 struct rte_eth_rxtx_callback {
1673 struct rte_eth_rxtx_callback *next;
1675 rte_rx_callback_fn rx;
1676 rte_tx_callback_fn tx;
1682 * A set of values to describe the possible states of an eth device.
1684 enum rte_eth_dev_state {
1685 RTE_ETH_DEV_UNUSED = 0,
1686 RTE_ETH_DEV_ATTACHED,
1687 RTE_ETH_DEV_DEFERRED,
1692 * The generic data structure associated with each ethernet device.
1694 * Pointers to burst-oriented packet receive and transmit functions are
1695 * located at the beginning of the structure, along with the pointer to
1696 * where all the data elements for the particular device are stored in shared
1697 * memory. This split allows the function pointer and driver data to be per-
1698 * process, while the actual configuration data for the device is shared.
1700 struct rte_eth_dev {
1701 eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
1702 eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
1703 eth_tx_prep_t tx_pkt_prepare; /**< Pointer to PMD transmit prepare function. */
1704 struct rte_eth_dev_data *data; /**< Pointer to device data */
1705 const struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
1706 struct rte_device *device; /**< Backing device */
1707 struct rte_intr_handle *intr_handle; /**< Device interrupt handle */
1708 /** User application callbacks for NIC interrupts */
1709 struct rte_eth_dev_cb_list link_intr_cbs;
1711 * User-supplied functions called from rx_burst to post-process
1712 * received packets before passing them to the user
1714 struct rte_eth_rxtx_callback *post_rx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
1716 * User-supplied functions called from tx_burst to pre-process
1717 * received packets before passing them to the driver for transmission.
1719 struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
1720 enum rte_eth_dev_state state; /**< Flag indicating the port state */
1721 void *security_ctx; /**< Context for security ops */
1722 } __rte_cache_aligned;
1725 rte_eth_dev_get_sec_ctx(uint8_t port_id);
1727 struct rte_eth_dev_sriov {
1728 uint8_t active; /**< SRIOV is active with 16, 32 or 64 pools */
1729 uint8_t nb_q_per_pool; /**< rx queue number per pool */
1730 uint16_t def_vmdq_idx; /**< Default pool num used for PF */
1731 uint16_t def_pool_q_idx; /**< Default pool queue start reg index */
1733 #define RTE_ETH_DEV_SRIOV(dev) ((dev)->data->sriov)
1735 #define RTE_ETH_NAME_MAX_LEN RTE_DEV_NAME_MAX_LEN
1739 * The data part, with no function pointers, associated with each ethernet device.
1741 * This structure is safe to place in shared memory to be common among different
1742 * processes in a multi-process configuration.
1744 struct rte_eth_dev_data {
1745 char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
1747 void **rx_queues; /**< Array of pointers to RX queues. */
1748 void **tx_queues; /**< Array of pointers to TX queues. */
1749 uint16_t nb_rx_queues; /**< Number of RX queues. */
1750 uint16_t nb_tx_queues; /**< Number of TX queues. */
1752 struct rte_eth_dev_sriov sriov; /**< SRIOV data */
1754 void *dev_private; /**< PMD-specific private data */
1756 struct rte_eth_link dev_link;
1757 /**< Link-level information & status */
1759 struct rte_eth_conf dev_conf; /**< Configuration applied to device. */
1760 uint16_t mtu; /**< Maximum Transmission Unit. */
1762 uint32_t min_rx_buf_size;
1763 /**< Common rx buffer size handled by all queues */
1765 uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
1766 struct ether_addr* mac_addrs;/**< Device Ethernet Link address. */
1767 uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
1768 /** bitmap array of associating Ethernet MAC addresses to pools */
1769 struct ether_addr* hash_mac_addrs;
1770 /** Device Ethernet MAC addresses of hash filtering. */
1771 uint16_t port_id; /**< Device [external] port identifier. */
1773 uint8_t promiscuous : 1, /**< RX promiscuous mode ON(1) / OFF(0). */
1774 scattered_rx : 1, /**< RX of scattered packets is ON(1) / OFF(0) */
1775 all_multicast : 1, /**< RX all multicast mode ON(1) / OFF(0). */
1776 dev_started : 1, /**< Device state: STARTED(1) / STOPPED(0). */
1777 lro : 1; /**< RX LRO is ON(1) / OFF(0) */
1778 uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT];
1779 /** Queues state: STARTED(1) / STOPPED(0) */
1780 uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
1781 /** Queues state: STARTED(1) / STOPPED(0) */
1782 uint32_t dev_flags; /**< Capabilities */
1783 enum rte_kernel_driver kdrv; /**< Kernel driver passthrough */
1784 int numa_node; /**< NUMA node connection */
1785 struct rte_vlan_filter_conf vlan_filter_conf;
1786 /**< VLAN filter configuration. */
1789 /** Device supports link state interrupt */
1790 #define RTE_ETH_DEV_INTR_LSC 0x0002
1791 /** Device is a bonded slave */
1792 #define RTE_ETH_DEV_BONDED_SLAVE 0x0004
1793 /** Device supports device removal interrupt */
1794 #define RTE_ETH_DEV_INTR_RMV 0x0008
1798 * The pool of *rte_eth_dev* structures. The size of the pool
1799 * is configured at compile-time in the <rte_ethdev.c> file.
1801 extern struct rte_eth_dev rte_eth_devices[];
1804 * Iterates over valid ethdev ports.
1807 * The id of the next possible valid port.
1809 * Next valid port id, RTE_MAX_ETHPORTS if there is none.
1811 uint16_t rte_eth_find_next(uint16_t port_id);
1814 * Macro to iterate over all enabled ethdev ports.
1816 #define RTE_ETH_FOREACH_DEV(p) \
1817 for (p = rte_eth_find_next(0); \
1818 (unsigned int)p < (unsigned int)RTE_MAX_ETHPORTS; \
1819 p = rte_eth_find_next(p + 1))
1823 * Get the total number of Ethernet devices that have been successfully
1824 * initialized by the matching Ethernet driver during the PCI probing phase
1825 * and that are available for applications to use. These devices must be
1826 * accessed by using the ``RTE_ETH_FOREACH_DEV()`` macro to deal with
1827 * non-contiguous ranges of devices.
1828 * These non-contiguous ranges can be created by calls to hotplug functions or
1832 * - The total number of usable Ethernet devices.
1834 uint16_t rte_eth_dev_count(void);
1838 * Returns a ethdev slot specified by the unique identifier name.
1841 * The pointer to the Unique identifier name for each Ethernet device
1843 * - The pointer to the ethdev slot, on success. NULL on error
1845 struct rte_eth_dev *rte_eth_dev_allocated(const char *name);
1849 * Allocates a new ethdev slot for an ethernet device and returns the pointer
1850 * to that slot for the driver to use.
1852 * @param name Unique identifier name for each Ethernet device
1853 * @param type Device type of this Ethernet device
1855 * - Slot in the rte_dev_devices array for a new device;
1857 struct rte_eth_dev *rte_eth_dev_allocate(const char *name);
1861 * Attach to the ethdev already initialized by the primary
1864 * @param name Ethernet device's name.
1866 * - Success: Slot in the rte_dev_devices array for attached
1868 * - Error: Null pointer.
1870 struct rte_eth_dev *rte_eth_dev_attach_secondary(const char *name);
1874 * Release the specified ethdev port.
1877 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure.
1879 * - 0 on success, negative on error
1881 int rte_eth_dev_release_port(struct rte_eth_dev *eth_dev);
1884 * Attach a new Ethernet device specified by arguments.
1887 * A pointer to a strings array describing the new device
1888 * to be attached. The strings should be a pci address like
1889 * '0000:01:00.0' or virtual device name like 'net_pcap0'.
1891 * A pointer to a port identifier actually attached.
1893 * 0 on success and port_id is filled, negative on error
1895 int rte_eth_dev_attach(const char *devargs, uint16_t *port_id);
1898 * Detach a Ethernet device specified by port identifier.
1899 * This function must be called when the device is in the
1903 * The port identifier of the device to detach.
1905 * A pointer to a buffer that will be filled with the device name.
1906 * This buffer must be at least RTE_DEV_NAME_MAX_LEN long.
1908 * 0 on success and devname is filled, negative on error
1910 int rte_eth_dev_detach(uint16_t port_id, char *devname);
1913 * Convert a numerical speed in Mbps to a bitmap flag that can be used in
1914 * the bitmap link_speeds of the struct rte_eth_conf
1917 * Numerical speed value in Mbps
1919 * ETH_LINK_[HALF/FULL]_DUPLEX (only for 10/100M speeds)
1921 * 0 if the speed cannot be mapped
1923 uint32_t rte_eth_speed_bitflag(uint32_t speed, int duplex);
1926 * Configure an Ethernet device.
1927 * This function must be invoked first before any other function in the
1928 * Ethernet API. This function can also be re-invoked when a device is in the
1932 * The port identifier of the Ethernet device to configure.
1933 * @param nb_rx_queue
1934 * The number of receive queues to set up for the Ethernet device.
1935 * @param nb_tx_queue
1936 * The number of transmit queues to set up for the Ethernet device.
1938 * The pointer to the configuration data to be used for the Ethernet device.
1939 * The *rte_eth_conf* structure includes:
1940 * - the hardware offload features to activate, with dedicated fields for
1941 * each statically configurable offload hardware feature provided by
1942 * Ethernet devices, such as IP checksum or VLAN tag stripping for
1944 * The Rx offload bitfield API is obsolete and will be deprecated.
1945 * Applications should set the ignore_bitfield_offloads bit on *rxmode*
1946 * structure and use offloads field to set per-port offloads instead.
1947 * - the Receive Side Scaling (RSS) configuration when using multiple RX
1950 * Embedding all configuration information in a single data structure
1951 * is the more flexible method that allows the addition of new features
1952 * without changing the syntax of the API.
1954 * - 0: Success, device configured.
1955 * - <0: Error code returned by the driver configuration function.
1957 int rte_eth_dev_configure(uint16_t port_id, uint16_t nb_rx_queue,
1958 uint16_t nb_tx_queue, const struct rte_eth_conf *eth_conf);
1962 * Release device queues and clear its configuration to force the user
1963 * application to reconfigure it. It is for internal use only.
1966 * Pointer to struct rte_eth_dev.
1971 void _rte_eth_dev_reset(struct rte_eth_dev *dev);
1974 * Allocate and set up a receive queue for an Ethernet device.
1976 * The function allocates a contiguous block of memory for *nb_rx_desc*
1977 * receive descriptors from a memory zone associated with *socket_id*
1978 * and initializes each receive descriptor with a network buffer allocated
1979 * from the memory pool *mb_pool*.
1982 * The port identifier of the Ethernet device.
1983 * @param rx_queue_id
1984 * The index of the receive queue to set up.
1985 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1986 * to rte_eth_dev_configure().
1988 * The number of receive descriptors to allocate for the receive ring.
1990 * The *socket_id* argument is the socket identifier in case of NUMA.
1991 * The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1992 * the DMA memory allocated for the receive descriptors of the ring.
1994 * The pointer to the configuration data to be used for the receive queue.
1995 * NULL value is allowed, in which case default RX configuration
1997 * The *rx_conf* structure contains an *rx_thresh* structure with the values
1998 * of the Prefetch, Host, and Write-Back threshold registers of the receive
2000 * In addition it contains the hardware offloads features to activate using
2001 * the DEV_RX_OFFLOAD_* flags.
2003 * The pointer to the memory pool from which to allocate *rte_mbuf* network
2004 * memory buffers to populate each descriptor of the receive ring.
2006 * - 0: Success, receive queue correctly set up.
2007 * - -EINVAL: The size of network buffers which can be allocated from the
2008 * memory pool does not fit the various buffer sizes allowed by the
2009 * device controller.
2010 * - -ENOMEM: Unable to allocate the receive ring descriptors or to
2011 * allocate network memory buffers from the memory pool when
2012 * initializing receive descriptors.
2014 int rte_eth_rx_queue_setup(uint16_t port_id, uint16_t rx_queue_id,
2015 uint16_t nb_rx_desc, unsigned int socket_id,
2016 const struct rte_eth_rxconf *rx_conf,
2017 struct rte_mempool *mb_pool);
2020 * Allocate and set up a transmit queue for an Ethernet device.
2023 * The port identifier of the Ethernet device.
2024 * @param tx_queue_id
2025 * The index of the transmit queue to set up.
2026 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2027 * to rte_eth_dev_configure().
2029 * The number of transmit descriptors to allocate for the transmit ring.
2031 * The *socket_id* argument is the socket identifier in case of NUMA.
2032 * Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
2033 * the DMA memory allocated for the transmit descriptors of the ring.
2035 * The pointer to the configuration data to be used for the transmit queue.
2036 * NULL value is allowed, in which case default TX configuration
2038 * The *tx_conf* structure contains the following data:
2039 * - The *tx_thresh* structure with the values of the Prefetch, Host, and
2040 * Write-Back threshold registers of the transmit ring.
2041 * When setting Write-Back threshold to the value greater then zero,
2042 * *tx_rs_thresh* value should be explicitly set to one.
2043 * - The *tx_free_thresh* value indicates the [minimum] number of network
2044 * buffers that must be pending in the transmit ring to trigger their
2045 * [implicit] freeing by the driver transmit function.
2046 * - The *tx_rs_thresh* value indicates the [minimum] number of transmit
2047 * descriptors that must be pending in the transmit ring before setting the
2048 * RS bit on a descriptor by the driver transmit function.
2049 * The *tx_rs_thresh* value should be less or equal then
2050 * *tx_free_thresh* value, and both of them should be less then
2052 * - The *txq_flags* member contains flags to pass to the TX queue setup
2053 * function to configure the behavior of the TX queue. This should be set
2054 * to 0 if no special configuration is required.
2055 * This API is obsolete and will be deprecated. Applications
2056 * should set it to ETH_TXQ_FLAGS_IGNORE and use
2057 * the offloads field below.
2058 * - The *offloads* member contains Tx offloads to be enabled.
2059 * Offloads which are not set cannot be used on the datapath.
2061 * Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces
2062 * the transmit function to use default values.
2064 * - 0: Success, the transmit queue is correctly set up.
2065 * - -ENOMEM: Unable to allocate the transmit ring descriptors.
2067 int rte_eth_tx_queue_setup(uint16_t port_id, uint16_t tx_queue_id,
2068 uint16_t nb_tx_desc, unsigned int socket_id,
2069 const struct rte_eth_txconf *tx_conf);
2072 * Return the NUMA socket to which an Ethernet device is connected
2075 * The port identifier of the Ethernet device
2077 * The NUMA socket id to which the Ethernet device is connected or
2078 * a default of zero if the socket could not be determined.
2079 * -1 is returned is the port_id value is out of range.
2081 int rte_eth_dev_socket_id(uint16_t port_id);
2084 * Check if port_id of device is attached
2087 * The port identifier of the Ethernet device
2089 * - 0 if port is out of range or not attached
2090 * - 1 if device is attached
2092 int rte_eth_dev_is_valid_port(uint16_t port_id);
2095 * Start specified RX queue of a port. It is used when rx_deferred_start
2096 * flag of the specified queue is true.
2099 * The port identifier of the Ethernet device
2100 * @param rx_queue_id
2101 * The index of the rx queue to update the ring.
2102 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2103 * to rte_eth_dev_configure().
2105 * - 0: Success, the receive queue is started.
2106 * - -EINVAL: The port_id or the queue_id out of range.
2107 * - -ENOTSUP: The function not supported in PMD driver.
2109 int rte_eth_dev_rx_queue_start(uint16_t port_id, uint16_t rx_queue_id);
2112 * Stop specified RX queue of a port
2115 * The port identifier of the Ethernet device
2116 * @param rx_queue_id
2117 * The index of the rx queue to update the ring.
2118 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2119 * to rte_eth_dev_configure().
2121 * - 0: Success, the receive queue is stopped.
2122 * - -EINVAL: The port_id or the queue_id out of range.
2123 * - -ENOTSUP: The function not supported in PMD driver.
2125 int rte_eth_dev_rx_queue_stop(uint16_t port_id, uint16_t rx_queue_id);
2128 * Start TX for specified queue of a port. It is used when tx_deferred_start
2129 * flag of the specified queue is true.
2132 * The port identifier of the Ethernet device
2133 * @param tx_queue_id
2134 * The index of the tx queue to update the ring.
2135 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2136 * to rte_eth_dev_configure().
2138 * - 0: Success, the transmit queue is started.
2139 * - -EINVAL: The port_id or the queue_id out of range.
2140 * - -ENOTSUP: The function not supported in PMD driver.
2142 int rte_eth_dev_tx_queue_start(uint16_t port_id, uint16_t tx_queue_id);
2145 * Stop specified TX queue of a port
2148 * The port identifier of the Ethernet device
2149 * @param tx_queue_id
2150 * The index of the tx queue to update the ring.
2151 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2152 * to rte_eth_dev_configure().
2154 * - 0: Success, the transmit queue is stopped.
2155 * - -EINVAL: The port_id or the queue_id out of range.
2156 * - -ENOTSUP: The function not supported in PMD driver.
2158 int rte_eth_dev_tx_queue_stop(uint16_t port_id, uint16_t tx_queue_id);
2163 * Start an Ethernet device.
2165 * The device start step is the last one and consists of setting the configured
2166 * offload features and in starting the transmit and the receive units of the
2168 * On success, all basic functions exported by the Ethernet API (link status,
2169 * receive/transmit, and so on) can be invoked.
2172 * The port identifier of the Ethernet device.
2174 * - 0: Success, Ethernet device started.
2175 * - <0: Error code of the driver device start function.
2177 int rte_eth_dev_start(uint16_t port_id);
2180 * Stop an Ethernet device. The device can be restarted with a call to
2181 * rte_eth_dev_start()
2184 * The port identifier of the Ethernet device.
2186 void rte_eth_dev_stop(uint16_t port_id);
2190 * Link up an Ethernet device.
2192 * Set device link up will re-enable the device rx/tx
2193 * functionality after it is previously set device linked down.
2196 * The port identifier of the Ethernet device.
2198 * - 0: Success, Ethernet device linked up.
2199 * - <0: Error code of the driver device link up function.
2201 int rte_eth_dev_set_link_up(uint16_t port_id);
2204 * Link down an Ethernet device.
2205 * The device rx/tx functionality will be disabled if success,
2206 * and it can be re-enabled with a call to
2207 * rte_eth_dev_set_link_up()
2210 * The port identifier of the Ethernet device.
2212 int rte_eth_dev_set_link_down(uint16_t port_id);
2215 * Close a stopped Ethernet device. The device cannot be restarted!
2216 * The function frees all resources except for needed by the
2217 * closed state. To free these resources, call rte_eth_dev_detach().
2220 * The port identifier of the Ethernet device.
2222 void rte_eth_dev_close(uint16_t port_id);
2225 * Reset a Ethernet device and keep its port id.
2227 * When a port has to be reset passively, the DPDK application can invoke
2228 * this function. For example when a PF is reset, all its VFs should also
2229 * be reset. Normally a DPDK application can invoke this function when
2230 * RTE_ETH_EVENT_INTR_RESET event is detected, but can also use it to start
2231 * a port reset in other circumstances.
2233 * When this function is called, it first stops the port and then calls the
2234 * PMD specific dev_uninit( ) and dev_init( ) to return the port to initial
2235 * state, in which no Tx and Rx queues are setup, as if the port has been
2236 * reset and not started. The port keeps the port id it had before the
2239 * After calling rte_eth_dev_reset( ), the application should use
2240 * rte_eth_dev_configure( ), rte_eth_rx_queue_setup( ),
2241 * rte_eth_tx_queue_setup( ), and rte_eth_dev_start( )
2242 * to reconfigure the device as appropriate.
2244 * Note: To avoid unexpected behavior, the application should stop calling
2245 * Tx and Rx functions before calling rte_eth_dev_reset( ). For thread
2246 * safety, all these controlling functions should be called from the same
2250 * The port identifier of the Ethernet device.
2253 * - (0) if successful.
2254 * - (-EINVAL) if port identifier is invalid.
2255 * - (-ENOTSUP) if hardware doesn't support this function.
2256 * - (-EPERM) if not ran from the primary process.
2257 * - (-EIO) if re-initialisation failed.
2258 * - (-ENOMEM) if the reset failed due to OOM.
2259 * - (-EAGAIN) if the reset temporarily failed and should be retried later.
2261 int rte_eth_dev_reset(uint16_t port_id);
2264 * Enable receipt in promiscuous mode for an Ethernet device.
2267 * The port identifier of the Ethernet device.
2269 void rte_eth_promiscuous_enable(uint16_t port_id);
2272 * Disable receipt in promiscuous mode for an Ethernet device.
2275 * The port identifier of the Ethernet device.
2277 void rte_eth_promiscuous_disable(uint16_t port_id);
2280 * Return the value of promiscuous mode for an Ethernet device.
2283 * The port identifier of the Ethernet device.
2285 * - (1) if promiscuous is enabled
2286 * - (0) if promiscuous is disabled.
2289 int rte_eth_promiscuous_get(uint16_t port_id);
2292 * Enable the receipt of any multicast frame by an Ethernet device.
2295 * The port identifier of the Ethernet device.
2297 void rte_eth_allmulticast_enable(uint16_t port_id);
2300 * Disable the receipt of all multicast frames by an Ethernet device.
2303 * The port identifier of the Ethernet device.
2305 void rte_eth_allmulticast_disable(uint16_t port_id);
2308 * Return the value of allmulticast mode for an Ethernet device.
2311 * The port identifier of the Ethernet device.
2313 * - (1) if allmulticast is enabled
2314 * - (0) if allmulticast is disabled.
2317 int rte_eth_allmulticast_get(uint16_t port_id);
2320 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2321 * or FULL-DUPLEX) of the physical link of an Ethernet device. It might need
2322 * to wait up to 9 seconds in it.
2325 * The port identifier of the Ethernet device.
2327 * A pointer to an *rte_eth_link* structure to be filled with
2328 * the status, the speed and the mode of the Ethernet device link.
2330 void rte_eth_link_get(uint16_t port_id, struct rte_eth_link *link);
2333 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2334 * or FULL-DUPLEX) of the physical link of an Ethernet device. It is a no-wait
2335 * version of rte_eth_link_get().
2338 * The port identifier of the Ethernet device.
2340 * A pointer to an *rte_eth_link* structure to be filled with
2341 * the status, the speed and the mode of the Ethernet device link.
2343 void rte_eth_link_get_nowait(uint16_t port_id, struct rte_eth_link *link);
2346 * Retrieve the general I/O statistics of an Ethernet device.
2349 * The port identifier of the Ethernet device.
2351 * A pointer to a structure of type *rte_eth_stats* to be filled with
2352 * the values of device counters for the following set of statistics:
2353 * - *ipackets* with the total of successfully received packets.
2354 * - *opackets* with the total of successfully transmitted packets.
2355 * - *ibytes* with the total of successfully received bytes.
2356 * - *obytes* with the total of successfully transmitted bytes.
2357 * - *ierrors* with the total of erroneous received packets.
2358 * - *oerrors* with the total of failed transmitted packets.
2360 * Zero if successful. Non-zero otherwise.
2362 int rte_eth_stats_get(uint16_t port_id, struct rte_eth_stats *stats);
2365 * Reset the general I/O statistics of an Ethernet device.
2368 * The port identifier of the Ethernet device.
2370 * - (0) if device notified to reset stats.
2371 * - (-ENOTSUP) if hardware doesn't support.
2372 * - (-ENODEV) if *port_id* invalid.
2374 int rte_eth_stats_reset(uint16_t port_id);
2377 * Retrieve names of extended statistics of an Ethernet device.
2380 * The port identifier of the Ethernet device.
2381 * @param xstats_names
2382 * An rte_eth_xstat_name array of at least *size* elements to
2383 * be filled. If set to NULL, the function returns the required number
2386 * The size of the xstats_names array (number of elements).
2388 * - A positive value lower or equal to size: success. The return value
2389 * is the number of entries filled in the stats table.
2390 * - A positive value higher than size: error, the given statistics table
2391 * is too small. The return value corresponds to the size that should
2392 * be given to succeed. The entries in the table are not valid and
2393 * shall not be used by the caller.
2394 * - A negative value on error (invalid port id).
2396 int rte_eth_xstats_get_names(uint16_t port_id,
2397 struct rte_eth_xstat_name *xstats_names,
2401 * Retrieve extended statistics of an Ethernet device.
2404 * The port identifier of the Ethernet device.
2406 * A pointer to a table of structure of type *rte_eth_xstat*
2407 * to be filled with device statistics ids and values: id is the
2408 * index of the name string in xstats_names (see rte_eth_xstats_get_names()),
2409 * and value is the statistic counter.
2410 * This parameter can be set to NULL if n is 0.
2412 * The size of the xstats array (number of elements).
2414 * - A positive value lower or equal to n: success. The return value
2415 * is the number of entries filled in the stats table.
2416 * - A positive value higher than n: error, the given statistics table
2417 * is too small. The return value corresponds to the size that should
2418 * be given to succeed. The entries in the table are not valid and
2419 * shall not be used by the caller.
2420 * - A negative value on error (invalid port id).
2422 int rte_eth_xstats_get(uint16_t port_id, struct rte_eth_xstat *xstats,
2426 * Retrieve names of extended statistics of an Ethernet device.
2429 * The port identifier of the Ethernet device.
2430 * @param xstats_names
2431 * An rte_eth_xstat_name array of at least *size* elements to
2432 * be filled. If set to NULL, the function returns the required number
2435 * IDs array given by app to retrieve specific statistics
2437 * The size of the xstats_names array (number of elements).
2439 * - A positive value lower or equal to size: success. The return value
2440 * is the number of entries filled in the stats table.
2441 * - A positive value higher than size: error, the given statistics table
2442 * is too small. The return value corresponds to the size that should
2443 * be given to succeed. The entries in the table are not valid and
2444 * shall not be used by the caller.
2445 * - A negative value on error (invalid port id).
2448 rte_eth_xstats_get_names_by_id(uint16_t port_id,
2449 struct rte_eth_xstat_name *xstats_names, unsigned int size,
2453 * Retrieve extended statistics of an Ethernet device.
2456 * The port identifier of the Ethernet device.
2458 * A pointer to an ids array passed by application. This tells which
2459 * statistics values function should retrieve. This parameter
2460 * can be set to NULL if size is 0. In this case function will retrieve
2461 * all avalible statistics.
2463 * A pointer to a table to be filled with device statistics values.
2465 * The size of the ids array (number of elements).
2467 * - A positive value lower or equal to size: success. The return value
2468 * is the number of entries filled in the stats table.
2469 * - A positive value higher than size: error, the given statistics table
2470 * is too small. The return value corresponds to the size that should
2471 * be given to succeed. The entries in the table are not valid and
2472 * shall not be used by the caller.
2473 * - A negative value on error (invalid port id).
2475 int rte_eth_xstats_get_by_id(uint16_t port_id, const uint64_t *ids,
2476 uint64_t *values, unsigned int size);
2479 * Gets the ID of a statistic from its name.
2481 * This function searches for the statistics using string compares, and
2482 * as such should not be used on the fast-path. For fast-path retrieval of
2483 * specific statistics, store the ID as provided in *id* from this function,
2484 * and pass the ID to rte_eth_xstats_get()
2486 * @param port_id The port to look up statistics from
2487 * @param xstat_name The name of the statistic to return
2488 * @param[out] id A pointer to an app-supplied uint64_t which should be
2489 * set to the ID of the stat if the stat exists.
2492 * -ENODEV for invalid port_id,
2493 * -EINVAL if the xstat_name doesn't exist in port_id
2495 int rte_eth_xstats_get_id_by_name(uint16_t port_id, const char *xstat_name,
2499 * Reset extended statistics of an Ethernet device.
2502 * The port identifier of the Ethernet device.
2504 void rte_eth_xstats_reset(uint16_t port_id);
2507 * Set a mapping for the specified transmit queue to the specified per-queue
2508 * statistics counter.
2511 * The port identifier of the Ethernet device.
2512 * @param tx_queue_id
2513 * The index of the transmit queue for which a queue stats mapping is required.
2514 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2515 * to rte_eth_dev_configure().
2517 * The per-queue packet statistics functionality number that the transmit
2518 * queue is to be assigned.
2519 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2521 * Zero if successful. Non-zero otherwise.
2523 int rte_eth_dev_set_tx_queue_stats_mapping(uint16_t port_id,
2524 uint16_t tx_queue_id, uint8_t stat_idx);
2527 * Set a mapping for the specified receive queue to the specified per-queue
2528 * statistics counter.
2531 * The port identifier of the Ethernet device.
2532 * @param rx_queue_id
2533 * The index of the receive queue for which a queue stats mapping is required.
2534 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2535 * to rte_eth_dev_configure().
2537 * The per-queue packet statistics functionality number that the receive
2538 * queue is to be assigned.
2539 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2541 * Zero if successful. Non-zero otherwise.
2543 int rte_eth_dev_set_rx_queue_stats_mapping(uint16_t port_id,
2544 uint16_t rx_queue_id,
2548 * Retrieve the Ethernet address of an Ethernet device.
2551 * The port identifier of the Ethernet device.
2553 * A pointer to a structure of type *ether_addr* to be filled with
2554 * the Ethernet address of the Ethernet device.
2556 void rte_eth_macaddr_get(uint16_t port_id, struct ether_addr *mac_addr);
2559 * Retrieve the contextual information of an Ethernet device.
2562 * The port identifier of the Ethernet device.
2564 * A pointer to a structure of type *rte_eth_dev_info* to be filled with
2565 * the contextual information of the Ethernet device.
2567 void rte_eth_dev_info_get(uint16_t port_id, struct rte_eth_dev_info *dev_info);
2570 * Retrieve the firmware version of a device.
2573 * The port identifier of the device.
2575 * A pointer to a string array storing the firmware version of a device,
2576 * the string includes terminating null. This pointer is allocated by caller.
2578 * The size of the string array pointed by fw_version, which should be
2579 * large enough to store firmware version of the device.
2581 * - (0) if successful.
2582 * - (-ENOTSUP) if operation is not supported.
2583 * - (-ENODEV) if *port_id* invalid.
2584 * - (>0) if *fw_size* is not enough to store firmware version, return
2585 * the size of the non truncated string.
2587 int rte_eth_dev_fw_version_get(uint16_t port_id,
2588 char *fw_version, size_t fw_size);
2591 * Retrieve the supported packet types of an Ethernet device.
2593 * When a packet type is announced as supported, it *must* be recognized by
2594 * the PMD. For instance, if RTE_PTYPE_L2_ETHER, RTE_PTYPE_L2_ETHER_VLAN
2595 * and RTE_PTYPE_L3_IPV4 are announced, the PMD must return the following
2596 * packet types for these packets:
2597 * - Ether/IPv4 -> RTE_PTYPE_L2_ETHER | RTE_PTYPE_L3_IPV4
2598 * - Ether/Vlan/IPv4 -> RTE_PTYPE_L2_ETHER_VLAN | RTE_PTYPE_L3_IPV4
2599 * - Ether/[anything else] -> RTE_PTYPE_L2_ETHER
2600 * - Ether/Vlan/[anything else] -> RTE_PTYPE_L2_ETHER_VLAN
2602 * When a packet is received by a PMD, the most precise type must be
2603 * returned among the ones supported. However a PMD is allowed to set
2604 * packet type that is not in the supported list, at the condition that it
2605 * is more precise. Therefore, a PMD announcing no supported packet types
2606 * can still set a matching packet type in a received packet.
2609 * Better to invoke this API after the device is already started or rx burst
2610 * function is decided, to obtain correct supported ptypes.
2612 * if a given PMD does not report what ptypes it supports, then the supported
2613 * ptype count is reported as 0.
2615 * The port identifier of the Ethernet device.
2617 * A hint of what kind of packet type which the caller is interested in.
2619 * An array pointer to store adequate packet types, allocated by caller.
2621 * Size of the array pointed by param ptypes.
2623 * - (>=0) Number of supported ptypes. If the number of types exceeds num,
2624 * only num entries will be filled into the ptypes array, but the full
2625 * count of supported ptypes will be returned.
2626 * - (-ENODEV) if *port_id* invalid.
2628 int rte_eth_dev_get_supported_ptypes(uint16_t port_id, uint32_t ptype_mask,
2629 uint32_t *ptypes, int num);
2632 * Retrieve the MTU of an Ethernet device.
2635 * The port identifier of the Ethernet device.
2637 * A pointer to a uint16_t where the retrieved MTU is to be stored.
2639 * - (0) if successful.
2640 * - (-ENODEV) if *port_id* invalid.
2642 int rte_eth_dev_get_mtu(uint16_t port_id, uint16_t *mtu);
2645 * Change the MTU of an Ethernet device.
2648 * The port identifier of the Ethernet device.
2650 * A uint16_t for the MTU to be applied.
2652 * - (0) if successful.
2653 * - (-ENOTSUP) if operation is not supported.
2654 * - (-ENODEV) if *port_id* invalid.
2655 * - (-EINVAL) if *mtu* invalid.
2656 * - (-EBUSY) if operation is not allowed when the port is running
2658 int rte_eth_dev_set_mtu(uint16_t port_id, uint16_t mtu);
2661 * Enable/Disable hardware filtering by an Ethernet device of received
2662 * VLAN packets tagged with a given VLAN Tag Identifier.
2665 * The port identifier of the Ethernet device.
2667 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
2669 * If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*.
2670 * Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*.
2672 * - (0) if successful.
2673 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2674 * - (-ENODEV) if *port_id* invalid.
2675 * - (-ENOSYS) if VLAN filtering on *port_id* disabled.
2676 * - (-EINVAL) if *vlan_id* > 4095.
2678 int rte_eth_dev_vlan_filter(uint16_t port_id, uint16_t vlan_id, int on);
2681 * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
2682 * 82599/X540/X550 can support VLAN stripping at the rx queue level
2685 * The port identifier of the Ethernet device.
2686 * @param rx_queue_id
2687 * The index of the receive queue for which a queue stats mapping is required.
2688 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2689 * to rte_eth_dev_configure().
2691 * If 1, Enable VLAN Stripping of the receive queue of the Ethernet port.
2692 * If 0, Disable VLAN Stripping of the receive queue of the Ethernet port.
2694 * - (0) if successful.
2695 * - (-ENOSUP) if hardware-assisted VLAN stripping not configured.
2696 * - (-ENODEV) if *port_id* invalid.
2697 * - (-EINVAL) if *rx_queue_id* invalid.
2699 int rte_eth_dev_set_vlan_strip_on_queue(uint16_t port_id, uint16_t rx_queue_id,
2703 * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
2704 * the VLAN Header. This is a register setup available on some Intel NIC, not
2705 * but all, please check the data sheet for availability.
2708 * The port identifier of the Ethernet device.
2712 * The Tag Protocol ID
2714 * - (0) if successful.
2715 * - (-ENOSUP) if hardware-assisted VLAN TPID setup is not supported.
2716 * - (-ENODEV) if *port_id* invalid.
2718 int rte_eth_dev_set_vlan_ether_type(uint16_t port_id,
2719 enum rte_vlan_type vlan_type,
2723 * Set VLAN offload configuration on an Ethernet device
2724 * Enable/Disable Extended VLAN by an Ethernet device, This is a register setup
2725 * available on some Intel NIC, not but all, please check the data sheet for
2727 * Enable/Disable VLAN Strip can be done on rx queue for certain NIC, but here
2728 * the configuration is applied on the port level.
2731 * The port identifier of the Ethernet device.
2732 * @param offload_mask
2733 * The VLAN Offload bit mask can be mixed use with "OR"
2734 * ETH_VLAN_STRIP_OFFLOAD
2735 * ETH_VLAN_FILTER_OFFLOAD
2736 * ETH_VLAN_EXTEND_OFFLOAD
2738 * - (0) if successful.
2739 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2740 * - (-ENODEV) if *port_id* invalid.
2742 int rte_eth_dev_set_vlan_offload(uint16_t port_id, int offload_mask);
2745 * Read VLAN Offload configuration from an Ethernet device
2748 * The port identifier of the Ethernet device.
2750 * - (>0) if successful. Bit mask to indicate
2751 * ETH_VLAN_STRIP_OFFLOAD
2752 * ETH_VLAN_FILTER_OFFLOAD
2753 * ETH_VLAN_EXTEND_OFFLOAD
2754 * - (-ENODEV) if *port_id* invalid.
2756 int rte_eth_dev_get_vlan_offload(uint16_t port_id);
2759 * Set port based TX VLAN insertion on or off.
2762 * The port identifier of the Ethernet device.
2764 * Port based TX VLAN identifier together with user priority.
2766 * Turn on or off the port based TX VLAN insertion.
2769 * - (0) if successful.
2770 * - negative if failed.
2772 int rte_eth_dev_set_vlan_pvid(uint16_t port_id, uint16_t pvid, int on);
2776 * Retrieve a burst of input packets from a receive queue of an Ethernet
2777 * device. The retrieved packets are stored in *rte_mbuf* structures whose
2778 * pointers are supplied in the *rx_pkts* array.
2780 * The rte_eth_rx_burst() function loops, parsing the RX ring of the
2781 * receive queue, up to *nb_pkts* packets, and for each completed RX
2782 * descriptor in the ring, it performs the following operations:
2784 * - Initialize the *rte_mbuf* data structure associated with the
2785 * RX descriptor according to the information provided by the NIC into
2786 * that RX descriptor.
2788 * - Store the *rte_mbuf* data structure into the next entry of the
2791 * - Replenish the RX descriptor with a new *rte_mbuf* buffer
2792 * allocated from the memory pool associated with the receive queue at
2793 * initialization time.
2795 * When retrieving an input packet that was scattered by the controller
2796 * into multiple receive descriptors, the rte_eth_rx_burst() function
2797 * appends the associated *rte_mbuf* buffers to the first buffer of the
2800 * The rte_eth_rx_burst() function returns the number of packets
2801 * actually retrieved, which is the number of *rte_mbuf* data structures
2802 * effectively supplied into the *rx_pkts* array.
2803 * A return value equal to *nb_pkts* indicates that the RX queue contained
2804 * at least *rx_pkts* packets, and this is likely to signify that other
2805 * received packets remain in the input queue. Applications implementing
2806 * a "retrieve as much received packets as possible" policy can check this
2807 * specific case and keep invoking the rte_eth_rx_burst() function until
2808 * a value less than *nb_pkts* is returned.
2810 * This receive method has the following advantages:
2812 * - It allows a run-to-completion network stack engine to retrieve and
2813 * to immediately process received packets in a fast burst-oriented
2814 * approach, avoiding the overhead of unnecessary intermediate packet
2815 * queue/dequeue operations.
2817 * - Conversely, it also allows an asynchronous-oriented processing
2818 * method to retrieve bursts of received packets and to immediately
2819 * queue them for further parallel processing by another logical core,
2820 * for instance. However, instead of having received packets being
2821 * individually queued by the driver, this approach allows the caller
2822 * of the rte_eth_rx_burst() function to queue a burst of retrieved
2823 * packets at a time and therefore dramatically reduce the cost of
2824 * enqueue/dequeue operations per packet.
2826 * - It allows the rte_eth_rx_burst() function of the driver to take
2827 * advantage of burst-oriented hardware features (CPU cache,
2828 * prefetch instructions, and so on) to minimize the number of CPU
2829 * cycles per packet.
2831 * To summarize, the proposed receive API enables many
2832 * burst-oriented optimizations in both synchronous and asynchronous
2833 * packet processing environments with no overhead in both cases.
2835 * The rte_eth_rx_burst() function does not provide any error
2836 * notification to avoid the corresponding overhead. As a hint, the
2837 * upper-level application might check the status of the device link once
2838 * being systematically returned a 0 value for a given number of tries.
2841 * The port identifier of the Ethernet device.
2843 * The index of the receive queue from which to retrieve input packets.
2844 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2845 * to rte_eth_dev_configure().
2847 * The address of an array of pointers to *rte_mbuf* structures that
2848 * must be large enough to store *nb_pkts* pointers in it.
2850 * The maximum number of packets to retrieve.
2852 * The number of packets actually retrieved, which is the number
2853 * of pointers to *rte_mbuf* structures effectively supplied to the
2856 static inline uint16_t
2857 rte_eth_rx_burst(uint16_t port_id, uint16_t queue_id,
2858 struct rte_mbuf **rx_pkts, const uint16_t nb_pkts)
2860 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2862 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2863 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
2864 RTE_FUNC_PTR_OR_ERR_RET(*dev->rx_pkt_burst, 0);
2866 if (queue_id >= dev->data->nb_rx_queues) {
2867 RTE_PMD_DEBUG_TRACE("Invalid RX queue_id=%d\n", queue_id);
2871 int16_t nb_rx = (*dev->rx_pkt_burst)(dev->data->rx_queues[queue_id],
2874 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
2875 struct rte_eth_rxtx_callback *cb = dev->post_rx_burst_cbs[queue_id];
2877 if (unlikely(cb != NULL)) {
2879 nb_rx = cb->fn.rx(port_id, queue_id, rx_pkts, nb_rx,
2880 nb_pkts, cb->param);
2882 } while (cb != NULL);
2890 * Get the number of used descriptors of a rx queue
2893 * The port identifier of the Ethernet device.
2895 * The queue id on the specific port.
2897 * The number of used descriptors in the specific queue, or:
2898 * (-EINVAL) if *port_id* or *queue_id* is invalid
2899 * (-ENOTSUP) if the device does not support this function
2902 rte_eth_rx_queue_count(uint16_t port_id, uint16_t queue_id)
2904 struct rte_eth_dev *dev;
2906 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -EINVAL);
2907 dev = &rte_eth_devices[port_id];
2908 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_queue_count, -ENOTSUP);
2909 if (queue_id >= dev->data->nb_rx_queues)
2912 return (*dev->dev_ops->rx_queue_count)(dev, queue_id);
2916 * Check if the DD bit of the specific RX descriptor in the queue has been set
2919 * The port identifier of the Ethernet device.
2921 * The queue id on the specific port.
2923 * The offset of the descriptor ID from tail.
2925 * - (1) if the specific DD bit is set.
2926 * - (0) if the specific DD bit is not set.
2927 * - (-ENODEV) if *port_id* invalid.
2928 * - (-ENOTSUP) if the device does not support this function
2931 rte_eth_rx_descriptor_done(uint16_t port_id, uint16_t queue_id, uint16_t offset)
2933 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2934 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
2935 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_descriptor_done, -ENOTSUP);
2936 return (*dev->dev_ops->rx_descriptor_done)( \
2937 dev->data->rx_queues[queue_id], offset);
2940 #define RTE_ETH_RX_DESC_AVAIL 0 /**< Desc available for hw. */
2941 #define RTE_ETH_RX_DESC_DONE 1 /**< Desc done, filled by hw. */
2942 #define RTE_ETH_RX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */
2945 * Check the status of a Rx descriptor in the queue
2947 * It should be called in a similar context than the Rx function:
2948 * - on a dataplane core
2949 * - not concurrently on the same queue
2951 * Since it's a dataplane function, no check is performed on port_id and
2952 * queue_id. The caller must therefore ensure that the port is enabled
2953 * and the queue is configured and running.
2955 * Note: accessing to a random descriptor in the ring may trigger cache
2956 * misses and have a performance impact.
2959 * A valid port identifier of the Ethernet device which.
2961 * A valid Rx queue identifier on this port.
2963 * The offset of the descriptor starting from tail (0 is the next
2964 * packet to be received by the driver).
2967 * - (RTE_ETH_RX_DESC_AVAIL): Descriptor is available for the hardware to
2969 * - (RTE_ETH_RX_DESC_DONE): Descriptor is done, it is filled by hw, but
2970 * not yet processed by the driver (i.e. in the receive queue).
2971 * - (RTE_ETH_RX_DESC_UNAVAIL): Descriptor is unavailable, either hold by
2972 * the driver and not yet returned to hw, or reserved by the hw.
2973 * - (-EINVAL) bad descriptor offset.
2974 * - (-ENOTSUP) if the device does not support this function.
2975 * - (-ENODEV) bad port or queue (only if compiled with debug).
2978 rte_eth_rx_descriptor_status(uint16_t port_id, uint16_t queue_id,
2981 struct rte_eth_dev *dev;
2984 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2985 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
2987 dev = &rte_eth_devices[port_id];
2988 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2989 if (queue_id >= dev->data->nb_rx_queues)
2992 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_descriptor_status, -ENOTSUP);
2993 rxq = dev->data->rx_queues[queue_id];
2995 return (*dev->dev_ops->rx_descriptor_status)(rxq, offset);
2998 #define RTE_ETH_TX_DESC_FULL 0 /**< Desc filled for hw, waiting xmit. */
2999 #define RTE_ETH_TX_DESC_DONE 1 /**< Desc done, packet is transmitted. */
3000 #define RTE_ETH_TX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */
3003 * Check the status of a Tx descriptor in the queue.
3005 * It should be called in a similar context than the Tx function:
3006 * - on a dataplane core
3007 * - not concurrently on the same queue
3009 * Since it's a dataplane function, no check is performed on port_id and
3010 * queue_id. The caller must therefore ensure that the port is enabled
3011 * and the queue is configured and running.
3013 * Note: accessing to a random descriptor in the ring may trigger cache
3014 * misses and have a performance impact.
3017 * A valid port identifier of the Ethernet device which.
3019 * A valid Tx queue identifier on this port.
3021 * The offset of the descriptor starting from tail (0 is the place where
3022 * the next packet will be send).
3025 * - (RTE_ETH_TX_DESC_FULL) Descriptor is being processed by the hw, i.e.
3026 * in the transmit queue.
3027 * - (RTE_ETH_TX_DESC_DONE) Hardware is done with this descriptor, it can
3028 * be reused by the driver.
3029 * - (RTE_ETH_TX_DESC_UNAVAIL): Descriptor is unavailable, reserved by the
3030 * driver or the hardware.
3031 * - (-EINVAL) bad descriptor offset.
3032 * - (-ENOTSUP) if the device does not support this function.
3033 * - (-ENODEV) bad port or queue (only if compiled with debug).
3035 static inline int rte_eth_tx_descriptor_status(uint16_t port_id,
3036 uint16_t queue_id, uint16_t offset)
3038 struct rte_eth_dev *dev;
3041 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3042 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
3044 dev = &rte_eth_devices[port_id];
3045 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3046 if (queue_id >= dev->data->nb_tx_queues)
3049 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->tx_descriptor_status, -ENOTSUP);
3050 txq = dev->data->tx_queues[queue_id];
3052 return (*dev->dev_ops->tx_descriptor_status)(txq, offset);
3056 * Send a burst of output packets on a transmit queue of an Ethernet device.
3058 * The rte_eth_tx_burst() function is invoked to transmit output packets
3059 * on the output queue *queue_id* of the Ethernet device designated by its
3061 * The *nb_pkts* parameter is the number of packets to send which are
3062 * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
3063 * allocated from a pool created with rte_pktmbuf_pool_create().
3064 * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
3065 * up to the number of transmit descriptors available in the TX ring of the
3067 * For each packet to send, the rte_eth_tx_burst() function performs
3068 * the following operations:
3070 * - Pick up the next available descriptor in the transmit ring.
3072 * - Free the network buffer previously sent with that descriptor, if any.
3074 * - Initialize the transmit descriptor with the information provided
3075 * in the *rte_mbuf data structure.
3077 * In the case of a segmented packet composed of a list of *rte_mbuf* buffers,
3078 * the rte_eth_tx_burst() function uses several transmit descriptors
3081 * The rte_eth_tx_burst() function returns the number of packets it
3082 * actually sent. A return value equal to *nb_pkts* means that all packets
3083 * have been sent, and this is likely to signify that other output packets
3084 * could be immediately transmitted again. Applications that implement a
3085 * "send as many packets to transmit as possible" policy can check this
3086 * specific case and keep invoking the rte_eth_tx_burst() function until
3087 * a value less than *nb_pkts* is returned.
3089 * It is the responsibility of the rte_eth_tx_burst() function to
3090 * transparently free the memory buffers of packets previously sent.
3091 * This feature is driven by the *tx_free_thresh* value supplied to the
3092 * rte_eth_dev_configure() function at device configuration time.
3093 * When the number of free TX descriptors drops below this threshold, the
3094 * rte_eth_tx_burst() function must [attempt to] free the *rte_mbuf* buffers
3095 * of those packets whose transmission was effectively completed.
3097 * If the PMD is DEV_TX_OFFLOAD_MT_LOCKFREE capable, multiple threads can
3098 * invoke this function concurrently on the same tx queue without SW lock.
3099 * @see rte_eth_dev_info_get, struct rte_eth_txconf::txq_flags
3102 * The port identifier of the Ethernet device.
3104 * The index of the transmit queue through which output packets must be
3106 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3107 * to rte_eth_dev_configure().
3109 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
3110 * which contain the output packets.
3112 * The maximum number of packets to transmit.
3114 * The number of output packets actually stored in transmit descriptors of
3115 * the transmit ring. The return value can be less than the value of the
3116 * *tx_pkts* parameter when the transmit ring is full or has been filled up.
3118 static inline uint16_t
3119 rte_eth_tx_burst(uint16_t port_id, uint16_t queue_id,
3120 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
3122 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
3124 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3125 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
3126 RTE_FUNC_PTR_OR_ERR_RET(*dev->tx_pkt_burst, 0);
3128 if (queue_id >= dev->data->nb_tx_queues) {
3129 RTE_PMD_DEBUG_TRACE("Invalid TX queue_id=%d\n", queue_id);
3134 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
3135 struct rte_eth_rxtx_callback *cb = dev->pre_tx_burst_cbs[queue_id];
3137 if (unlikely(cb != NULL)) {
3139 nb_pkts = cb->fn.tx(port_id, queue_id, tx_pkts, nb_pkts,
3142 } while (cb != NULL);
3146 return (*dev->tx_pkt_burst)(dev->data->tx_queues[queue_id], tx_pkts, nb_pkts);
3151 * @b EXPERIMENTAL: this API may change without prior notice
3153 * Process a burst of output packets on a transmit queue of an Ethernet device.
3155 * The rte_eth_tx_prepare() function is invoked to prepare output packets to be
3156 * transmitted on the output queue *queue_id* of the Ethernet device designated
3158 * The *nb_pkts* parameter is the number of packets to be prepared which are
3159 * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
3160 * allocated from a pool created with rte_pktmbuf_pool_create().
3161 * For each packet to send, the rte_eth_tx_prepare() function performs
3162 * the following operations:
3164 * - Check if packet meets devices requirements for tx offloads.
3166 * - Check limitations about number of segments.
3168 * - Check additional requirements when debug is enabled.
3170 * - Update and/or reset required checksums when tx offload is set for packet.
3172 * Since this function can modify packet data, provided mbufs must be safely
3173 * writable (e.g. modified data cannot be in shared segment).
3175 * The rte_eth_tx_prepare() function returns the number of packets ready to be
3176 * sent. A return value equal to *nb_pkts* means that all packets are valid and
3177 * ready to be sent, otherwise stops processing on the first invalid packet and
3178 * leaves the rest packets untouched.
3180 * When this functionality is not implemented in the driver, all packets are
3181 * are returned untouched.
3184 * The port identifier of the Ethernet device.
3185 * The value must be a valid port id.
3187 * The index of the transmit queue through which output packets must be
3189 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3190 * to rte_eth_dev_configure().
3192 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
3193 * which contain the output packets.
3195 * The maximum number of packets to process.
3197 * The number of packets correct and ready to be sent. The return value can be
3198 * less than the value of the *tx_pkts* parameter when some packet doesn't
3199 * meet devices requirements with rte_errno set appropriately:
3200 * - -EINVAL: offload flags are not correctly set
3201 * - -ENOTSUP: the offload feature is not supported by the hardware
3205 #ifndef RTE_ETHDEV_TX_PREPARE_NOOP
3207 static inline uint16_t
3208 rte_eth_tx_prepare(uint16_t port_id, uint16_t queue_id,
3209 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
3211 struct rte_eth_dev *dev;
3213 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3214 if (!rte_eth_dev_is_valid_port(port_id)) {
3215 RTE_PMD_DEBUG_TRACE("Invalid TX port_id=%d\n", port_id);
3216 rte_errno = -EINVAL;
3221 dev = &rte_eth_devices[port_id];
3223 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3224 if (queue_id >= dev->data->nb_tx_queues) {
3225 RTE_PMD_DEBUG_TRACE("Invalid TX queue_id=%d\n", queue_id);
3226 rte_errno = -EINVAL;
3231 if (!dev->tx_pkt_prepare)
3234 return (*dev->tx_pkt_prepare)(dev->data->tx_queues[queue_id],
3241 * Native NOOP operation for compilation targets which doesn't require any
3242 * preparations steps, and functional NOOP may introduce unnecessary performance
3245 * Generally this is not a good idea to turn it on globally and didn't should
3246 * be used if behavior of tx_preparation can change.
3249 static inline uint16_t
3250 rte_eth_tx_prepare(__rte_unused uint16_t port_id,
3251 __rte_unused uint16_t queue_id,
3252 __rte_unused struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
3259 typedef void (*buffer_tx_error_fn)(struct rte_mbuf **unsent, uint16_t count,
3263 * Structure used to buffer packets for future TX
3264 * Used by APIs rte_eth_tx_buffer and rte_eth_tx_buffer_flush
3266 struct rte_eth_dev_tx_buffer {
3267 buffer_tx_error_fn error_callback;
3268 void *error_userdata;
3269 uint16_t size; /**< Size of buffer for buffered tx */
3270 uint16_t length; /**< Number of packets in the array */
3271 struct rte_mbuf *pkts[];
3272 /**< Pending packets to be sent on explicit flush or when full */
3276 * Calculate the size of the tx buffer.
3279 * Number of stored packets.
3281 #define RTE_ETH_TX_BUFFER_SIZE(sz) \
3282 (sizeof(struct rte_eth_dev_tx_buffer) + (sz) * sizeof(struct rte_mbuf *))
3285 * Initialize default values for buffered transmitting
3288 * Tx buffer to be initialized.
3295 rte_eth_tx_buffer_init(struct rte_eth_dev_tx_buffer *buffer, uint16_t size);
3298 * Send any packets queued up for transmission on a port and HW queue
3300 * This causes an explicit flush of packets previously buffered via the
3301 * rte_eth_tx_buffer() function. It returns the number of packets successfully
3302 * sent to the NIC, and calls the error callback for any unsent packets. Unless
3303 * explicitly set up otherwise, the default callback simply frees the unsent
3304 * packets back to the owning mempool.
3307 * The port identifier of the Ethernet device.
3309 * The index of the transmit queue through which output packets must be
3311 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3312 * to rte_eth_dev_configure().
3314 * Buffer of packets to be transmit.
3316 * The number of packets successfully sent to the Ethernet device. The error
3317 * callback is called for any packets which could not be sent.
3319 static inline uint16_t
3320 rte_eth_tx_buffer_flush(uint16_t port_id, uint16_t queue_id,
3321 struct rte_eth_dev_tx_buffer *buffer)
3324 uint16_t to_send = buffer->length;
3329 sent = rte_eth_tx_burst(port_id, queue_id, buffer->pkts, to_send);
3333 /* All packets sent, or to be dealt with by callback below */
3334 if (unlikely(sent != to_send))
3335 buffer->error_callback(&buffer->pkts[sent], to_send - sent,
3336 buffer->error_userdata);
3342 * Buffer a single packet for future transmission on a port and queue
3344 * This function takes a single mbuf/packet and buffers it for later
3345 * transmission on the particular port and queue specified. Once the buffer is
3346 * full of packets, an attempt will be made to transmit all the buffered
3347 * packets. In case of error, where not all packets can be transmitted, a
3348 * callback is called with the unsent packets as a parameter. If no callback
3349 * is explicitly set up, the unsent packets are just freed back to the owning
3350 * mempool. The function returns the number of packets actually sent i.e.
3351 * 0 if no buffer flush occurred, otherwise the number of packets successfully
3355 * The port identifier of the Ethernet device.
3357 * The index of the transmit queue through which output packets must be
3359 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3360 * to rte_eth_dev_configure().
3362 * Buffer used to collect packets to be sent.
3364 * Pointer to the packet mbuf to be sent.
3366 * 0 = packet has been buffered for later transmission
3367 * N > 0 = packet has been buffered, and the buffer was subsequently flushed,
3368 * causing N packets to be sent, and the error callback to be called for
3371 static __rte_always_inline uint16_t
3372 rte_eth_tx_buffer(uint16_t port_id, uint16_t queue_id,
3373 struct rte_eth_dev_tx_buffer *buffer, struct rte_mbuf *tx_pkt)
3375 buffer->pkts[buffer->length++] = tx_pkt;
3376 if (buffer->length < buffer->size)
3379 return rte_eth_tx_buffer_flush(port_id, queue_id, buffer);
3383 * Configure a callback for buffered packets which cannot be sent
3385 * Register a specific callback to be called when an attempt is made to send
3386 * all packets buffered on an ethernet port, but not all packets can
3387 * successfully be sent. The callback registered here will be called only
3388 * from calls to rte_eth_tx_buffer() and rte_eth_tx_buffer_flush() APIs.
3389 * The default callback configured for each queue by default just frees the
3390 * packets back to the calling mempool. If additional behaviour is required,
3391 * for example, to count dropped packets, or to retry transmission of packets
3392 * which cannot be sent, this function should be used to register a suitable
3393 * callback function to implement the desired behaviour.
3394 * The example callback "rte_eth_count_unsent_packet_callback()" is also
3395 * provided as reference.
3398 * The port identifier of the Ethernet device.
3400 * The function to be used as the callback.
3402 * Arbitrary parameter to be passed to the callback function
3404 * 0 on success, or -1 on error with rte_errno set appropriately
3407 rte_eth_tx_buffer_set_err_callback(struct rte_eth_dev_tx_buffer *buffer,
3408 buffer_tx_error_fn callback, void *userdata);
3411 * Callback function for silently dropping unsent buffered packets.
3413 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
3414 * adjust the default behavior when buffered packets cannot be sent. This
3415 * function drops any unsent packets silently and is used by tx buffered
3416 * operations as default behavior.
3418 * NOTE: this function should not be called directly, instead it should be used
3419 * as a callback for packet buffering.
3421 * NOTE: when configuring this function as a callback with
3422 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
3423 * should point to an uint64_t value.
3426 * The previously buffered packets which could not be sent
3428 * The number of unsent packets in the pkts array
3433 rte_eth_tx_buffer_drop_callback(struct rte_mbuf **pkts, uint16_t unsent,
3437 * Callback function for tracking unsent buffered packets.
3439 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
3440 * adjust the default behavior when buffered packets cannot be sent. This
3441 * function drops any unsent packets, but also updates a user-supplied counter
3442 * to track the overall number of packets dropped. The counter should be an
3443 * uint64_t variable.
3445 * NOTE: this function should not be called directly, instead it should be used
3446 * as a callback for packet buffering.
3448 * NOTE: when configuring this function as a callback with
3449 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
3450 * should point to an uint64_t value.
3453 * The previously buffered packets which could not be sent
3455 * The number of unsent packets in the pkts array
3457 * Pointer to an uint64_t value, which will be incremented by unsent
3460 rte_eth_tx_buffer_count_callback(struct rte_mbuf **pkts, uint16_t unsent,
3464 * Request the driver to free mbufs currently cached by the driver. The
3465 * driver will only free the mbuf if it is no longer in use. It is the
3466 * application's responsibity to ensure rte_eth_tx_buffer_flush(..) is
3470 * The port identifier of the Ethernet device.
3472 * The index of the transmit queue through which output packets must be
3474 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3475 * to rte_eth_dev_configure().
3477 * Maximum number of packets to free. Use 0 to indicate all possible packets
3478 * should be freed. Note that a packet may be using multiple mbufs.
3481 * -ENODEV: Invalid interface
3482 * -ENOTSUP: Driver does not support function
3484 * 0-n: Number of packets freed. More packets may still remain in ring that
3488 rte_eth_tx_done_cleanup(uint16_t port_id, uint16_t queue_id, uint32_t free_cnt);
3491 * The eth device event type for interrupt, and maybe others in the future.
3493 enum rte_eth_event_type {
3494 RTE_ETH_EVENT_UNKNOWN, /**< unknown event type */
3495 RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
3496 RTE_ETH_EVENT_QUEUE_STATE,
3497 /**< queue state event (enabled/disabled) */
3498 RTE_ETH_EVENT_INTR_RESET,
3499 /**< reset interrupt event, sent to VF on PF reset */
3500 RTE_ETH_EVENT_VF_MBOX, /**< message from the VF received by PF */
3501 RTE_ETH_EVENT_MACSEC, /**< MACsec offload related event */
3502 RTE_ETH_EVENT_INTR_RMV, /**< device removal event */
3503 RTE_ETH_EVENT_NEW, /**< port is probed */
3504 RTE_ETH_EVENT_DESTROY, /**< port is released */
3505 RTE_ETH_EVENT_MAX /**< max value of this enum */
3508 typedef int (*rte_eth_dev_cb_fn)(uint16_t port_id,
3509 enum rte_eth_event_type event, void *cb_arg, void *ret_param);
3510 /**< user application callback to be registered for interrupts */
3515 * Register a callback function for port event.
3519 * RTE_ETH_ALL means register the event for all port ids.
3523 * User supplied callback function to be called.
3525 * Pointer to the parameters for the registered callback.
3528 * - On success, zero.
3529 * - On failure, a negative value.
3531 int rte_eth_dev_callback_register(uint16_t port_id,
3532 enum rte_eth_event_type event,
3533 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
3536 * Unregister a callback function for port event.
3540 * RTE_ETH_ALL means unregister the event for all port ids.
3544 * User supplied callback function to be called.
3546 * Pointer to the parameters for the registered callback. -1 means to
3547 * remove all for the same callback address and same event.
3550 * - On success, zero.
3551 * - On failure, a negative value.
3553 int rte_eth_dev_callback_unregister(uint16_t port_id,
3554 enum rte_eth_event_type event,
3555 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
3558 * @internal Executes all the user application registered callbacks for
3559 * the specific device. It is for DPDK internal user only. User
3560 * application should not call it directly.
3563 * Pointer to struct rte_eth_dev.
3565 * Eth device interrupt event type.
3567 * To pass data back to user application.
3568 * This allows the user application to decide if a particular function
3569 * is permitted or not.
3574 int _rte_eth_dev_callback_process(struct rte_eth_dev *dev,
3575 enum rte_eth_event_type event, void *ret_param);
3578 * When there is no rx packet coming in Rx Queue for a long time, we can
3579 * sleep lcore related to RX Queue for power saving, and enable rx interrupt
3580 * to be triggered when Rx packet arrives.
3582 * The rte_eth_dev_rx_intr_enable() function enables rx queue
3583 * interrupt on specific rx queue of a port.
3586 * The port identifier of the Ethernet device.
3588 * The index of the receive queue from which to retrieve input packets.
3589 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3590 * to rte_eth_dev_configure().
3592 * - (0) if successful.
3593 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3595 * - (-ENODEV) if *port_id* invalid.
3597 int rte_eth_dev_rx_intr_enable(uint16_t port_id, uint16_t queue_id);
3600 * When lcore wakes up from rx interrupt indicating packet coming, disable rx
3601 * interrupt and returns to polling mode.
3603 * The rte_eth_dev_rx_intr_disable() function disables rx queue
3604 * interrupt on specific rx queue of a port.
3607 * The port identifier of the Ethernet device.
3609 * The index of the receive queue from which to retrieve input packets.
3610 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3611 * to rte_eth_dev_configure().
3613 * - (0) if successful.
3614 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3616 * - (-ENODEV) if *port_id* invalid.
3618 int rte_eth_dev_rx_intr_disable(uint16_t port_id, uint16_t queue_id);
3621 * RX Interrupt control per port.
3624 * The port identifier of the Ethernet device.
3626 * Epoll instance fd which the intr vector associated to.
3627 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
3629 * The operation be performed for the vector.
3630 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
3634 * - On success, zero.
3635 * - On failure, a negative value.
3637 int rte_eth_dev_rx_intr_ctl(uint16_t port_id, int epfd, int op, void *data);
3640 * RX Interrupt control per queue.
3643 * The port identifier of the Ethernet device.
3645 * The index of the receive queue from which to retrieve input packets.
3646 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3647 * to rte_eth_dev_configure().
3649 * Epoll instance fd which the intr vector associated to.
3650 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
3652 * The operation be performed for the vector.
3653 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
3657 * - On success, zero.
3658 * - On failure, a negative value.
3660 int rte_eth_dev_rx_intr_ctl_q(uint16_t port_id, uint16_t queue_id,
3661 int epfd, int op, void *data);
3664 * Turn on the LED on the Ethernet device.
3665 * This function turns on the LED on the Ethernet device.
3668 * The port identifier of the Ethernet device.
3670 * - (0) if successful.
3671 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3673 * - (-ENODEV) if *port_id* invalid.
3675 int rte_eth_led_on(uint16_t port_id);
3678 * Turn off the LED on the Ethernet device.
3679 * This function turns off the LED on the Ethernet device.
3682 * The port identifier of the Ethernet device.
3684 * - (0) if successful.
3685 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3687 * - (-ENODEV) if *port_id* invalid.
3689 int rte_eth_led_off(uint16_t port_id);
3692 * Get current status of the Ethernet link flow control for Ethernet device
3695 * The port identifier of the Ethernet device.
3697 * The pointer to the structure where to store the flow control parameters.
3699 * - (0) if successful.
3700 * - (-ENOTSUP) if hardware doesn't support flow control.
3701 * - (-ENODEV) if *port_id* invalid.
3703 int rte_eth_dev_flow_ctrl_get(uint16_t port_id,
3704 struct rte_eth_fc_conf *fc_conf);
3707 * Configure the Ethernet link flow control for Ethernet device
3710 * The port identifier of the Ethernet device.
3712 * The pointer to the structure of the flow control parameters.
3714 * - (0) if successful.
3715 * - (-ENOTSUP) if hardware doesn't support flow control mode.
3716 * - (-ENODEV) if *port_id* invalid.
3717 * - (-EINVAL) if bad parameter
3718 * - (-EIO) if flow control setup failure
3720 int rte_eth_dev_flow_ctrl_set(uint16_t port_id,
3721 struct rte_eth_fc_conf *fc_conf);
3724 * Configure the Ethernet priority flow control under DCB environment
3725 * for Ethernet device.
3728 * The port identifier of the Ethernet device.
3730 * The pointer to the structure of the priority flow control parameters.
3732 * - (0) if successful.
3733 * - (-ENOTSUP) if hardware doesn't support priority flow control mode.
3734 * - (-ENODEV) if *port_id* invalid.
3735 * - (-EINVAL) if bad parameter
3736 * - (-EIO) if flow control setup failure
3738 int rte_eth_dev_priority_flow_ctrl_set(uint16_t port_id,
3739 struct rte_eth_pfc_conf *pfc_conf);
3742 * Add a MAC address to an internal array of addresses used to enable whitelist
3743 * filtering to accept packets only if the destination MAC address matches.
3746 * The port identifier of the Ethernet device.
3748 * The MAC address to add.
3750 * VMDq pool index to associate address with (if VMDq is enabled). If VMDq is
3751 * not enabled, this should be set to 0.
3753 * - (0) if successfully added or *mac_addr" was already added.
3754 * - (-ENOTSUP) if hardware doesn't support this feature.
3755 * - (-ENODEV) if *port* is invalid.
3756 * - (-ENOSPC) if no more MAC addresses can be added.
3757 * - (-EINVAL) if MAC address is invalid.
3759 int rte_eth_dev_mac_addr_add(uint16_t port, struct ether_addr *mac_addr,
3763 * Remove a MAC address from the internal array of addresses.
3766 * The port identifier of the Ethernet device.
3768 * MAC address to remove.
3770 * - (0) if successful, or *mac_addr* didn't exist.
3771 * - (-ENOTSUP) if hardware doesn't support.
3772 * - (-ENODEV) if *port* invalid.
3773 * - (-EADDRINUSE) if attempting to remove the default MAC address
3775 int rte_eth_dev_mac_addr_remove(uint16_t port, struct ether_addr *mac_addr);
3778 * Set the default MAC address.
3781 * The port identifier of the Ethernet device.
3783 * New default MAC address.
3785 * - (0) if successful, or *mac_addr* didn't exist.
3786 * - (-ENOTSUP) if hardware doesn't support.
3787 * - (-ENODEV) if *port* invalid.
3788 * - (-EINVAL) if MAC address is invalid.
3790 int rte_eth_dev_default_mac_addr_set(uint16_t port,
3791 struct ether_addr *mac_addr);
3794 * Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3797 * The port identifier of the Ethernet device.
3801 * Redirection table size. The table size can be queried by
3802 * rte_eth_dev_info_get().
3804 * - (0) if successful.
3805 * - (-ENOTSUP) if hardware doesn't support.
3806 * - (-EINVAL) if bad parameter.
3808 int rte_eth_dev_rss_reta_update(uint16_t port,
3809 struct rte_eth_rss_reta_entry64 *reta_conf,
3810 uint16_t reta_size);
3813 * Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3816 * The port identifier of the Ethernet device.
3820 * Redirection table size. The table size can be queried by
3821 * rte_eth_dev_info_get().
3823 * - (0) if successful.
3824 * - (-ENOTSUP) if hardware doesn't support.
3825 * - (-EINVAL) if bad parameter.
3827 int rte_eth_dev_rss_reta_query(uint16_t port,
3828 struct rte_eth_rss_reta_entry64 *reta_conf,
3829 uint16_t reta_size);
3832 * Updates unicast hash table for receiving packet with the given destination
3833 * MAC address, and the packet is routed to all VFs for which the RX mode is
3834 * accept packets that match the unicast hash table.
3837 * The port identifier of the Ethernet device.
3839 * Unicast MAC address.
3841 * 1 - Set an unicast hash bit for receiving packets with the MAC address.
3842 * 0 - Clear an unicast hash bit.
3844 * - (0) if successful.
3845 * - (-ENOTSUP) if hardware doesn't support.
3846 * - (-ENODEV) if *port_id* invalid.
3847 * - (-EINVAL) if bad parameter.
3849 int rte_eth_dev_uc_hash_table_set(uint16_t port, struct ether_addr *addr,
3853 * Updates all unicast hash bitmaps for receiving packet with any Unicast
3854 * Ethernet MAC addresses,the packet is routed to all VFs for which the RX
3855 * mode is accept packets that match the unicast hash table.
3858 * The port identifier of the Ethernet device.
3860 * 1 - Set all unicast hash bitmaps for receiving all the Ethernet
3862 * 0 - Clear all unicast hash bitmaps
3864 * - (0) if successful.
3865 * - (-ENOTSUP) if hardware doesn't support.
3866 * - (-ENODEV) if *port_id* invalid.
3867 * - (-EINVAL) if bad parameter.
3869 int rte_eth_dev_uc_all_hash_table_set(uint16_t port, uint8_t on);
3872 * Set a traffic mirroring rule on an Ethernet device
3875 * The port identifier of the Ethernet device.
3876 * @param mirror_conf
3877 * The pointer to the traffic mirroring structure describing the mirroring rule.
3878 * The *rte_eth_vm_mirror_conf* structure includes the type of mirroring rule,
3879 * destination pool and the value of rule if enable vlan or pool mirroring.
3882 * The index of traffic mirroring rule, we support four separated rules.
3884 * 1 - Enable a mirroring rule.
3885 * 0 - Disable a mirroring rule.
3887 * - (0) if successful.
3888 * - (-ENOTSUP) if hardware doesn't support this feature.
3889 * - (-ENODEV) if *port_id* invalid.
3890 * - (-EINVAL) if the mr_conf information is not correct.
3892 int rte_eth_mirror_rule_set(uint16_t port_id,
3893 struct rte_eth_mirror_conf *mirror_conf,
3898 * Reset a traffic mirroring rule on an Ethernet device.
3901 * The port identifier of the Ethernet device.
3903 * The index of traffic mirroring rule, we support four separated rules.
3905 * - (0) if successful.
3906 * - (-ENOTSUP) if hardware doesn't support this feature.
3907 * - (-ENODEV) if *port_id* invalid.
3908 * - (-EINVAL) if bad parameter.
3910 int rte_eth_mirror_rule_reset(uint16_t port_id,
3914 * Set the rate limitation for a queue on an Ethernet device.
3917 * The port identifier of the Ethernet device.
3921 * The tx rate in Mbps. Allocated from the total port link speed.
3923 * - (0) if successful.
3924 * - (-ENOTSUP) if hardware doesn't support this feature.
3925 * - (-ENODEV) if *port_id* invalid.
3926 * - (-EINVAL) if bad parameter.
3928 int rte_eth_set_queue_rate_limit(uint16_t port_id, uint16_t queue_idx,
3932 * Configuration of Receive Side Scaling hash computation of Ethernet device.
3935 * The port identifier of the Ethernet device.
3937 * The new configuration to use for RSS hash computation on the port.
3939 * - (0) if successful.
3940 * - (-ENODEV) if port identifier is invalid.
3941 * - (-ENOTSUP) if hardware doesn't support.
3942 * - (-EINVAL) if bad parameter.
3944 int rte_eth_dev_rss_hash_update(uint16_t port_id,
3945 struct rte_eth_rss_conf *rss_conf);
3948 * Retrieve current configuration of Receive Side Scaling hash computation
3949 * of Ethernet device.
3952 * The port identifier of the Ethernet device.
3954 * Where to store the current RSS hash configuration of the Ethernet device.
3956 * - (0) if successful.
3957 * - (-ENODEV) if port identifier is invalid.
3958 * - (-ENOTSUP) if hardware doesn't support RSS.
3961 rte_eth_dev_rss_hash_conf_get(uint16_t port_id,
3962 struct rte_eth_rss_conf *rss_conf);
3965 * Add UDP tunneling port for a specific type of tunnel.
3966 * The packets with this UDP port will be identified as this type of tunnel.
3967 * Before enabling any offloading function for a tunnel, users can call this API
3968 * to change or add more UDP port for the tunnel. So the offloading function
3969 * can take effect on the packets with the specific UDP port.
3972 * The port identifier of the Ethernet device.
3974 * UDP tunneling configuration.
3977 * - (0) if successful.
3978 * - (-ENODEV) if port identifier is invalid.
3979 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3982 rte_eth_dev_udp_tunnel_port_add(uint16_t port_id,
3983 struct rte_eth_udp_tunnel *tunnel_udp);
3986 * Delete UDP tunneling port a specific type of tunnel.
3987 * The packets with this UDP port will not be identified as this type of tunnel
3989 * Before enabling any offloading function for a tunnel, users can call this API
3990 * to delete a UDP port for the tunnel. So the offloading function will not take
3991 * effect on the packets with the specific UDP port.
3994 * The port identifier of the Ethernet device.
3996 * UDP tunneling configuration.
3999 * - (0) if successful.
4000 * - (-ENODEV) if port identifier is invalid.
4001 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4004 rte_eth_dev_udp_tunnel_port_delete(uint16_t port_id,
4005 struct rte_eth_udp_tunnel *tunnel_udp);
4008 * Check whether the filter type is supported on an Ethernet device.
4009 * All the supported filter types are defined in 'rte_eth_ctrl.h'.
4012 * The port identifier of the Ethernet device.
4013 * @param filter_type
4016 * - (0) if successful.
4017 * - (-ENOTSUP) if hardware doesn't support this filter type.
4018 * - (-ENODEV) if *port_id* invalid.
4020 int rte_eth_dev_filter_supported(uint16_t port_id,
4021 enum rte_filter_type filter_type);
4024 * Take operations to assigned filter type on an Ethernet device.
4025 * All the supported operations and filter types are defined in 'rte_eth_ctrl.h'.
4028 * The port identifier of the Ethernet device.
4029 * @param filter_type
4032 * Type of operation.
4034 * A pointer to arguments defined specifically for the operation.
4036 * - (0) if successful.
4037 * - (-ENOTSUP) if hardware doesn't support.
4038 * - (-ENODEV) if *port_id* invalid.
4039 * - others depends on the specific operations implementation.
4041 int rte_eth_dev_filter_ctrl(uint16_t port_id, enum rte_filter_type filter_type,
4042 enum rte_filter_op filter_op, void *arg);
4045 * Get DCB information on an Ethernet device.
4048 * The port identifier of the Ethernet device.
4052 * - (0) if successful.
4053 * - (-ENODEV) if port identifier is invalid.
4054 * - (-ENOTSUP) if hardware doesn't support.
4056 int rte_eth_dev_get_dcb_info(uint16_t port_id,
4057 struct rte_eth_dcb_info *dcb_info);
4060 * Add a callback to be called on packet RX on a given port and queue.
4062 * This API configures a function to be called for each burst of
4063 * packets received on a given NIC port queue. The return value is a pointer
4064 * that can be used to later remove the callback using
4065 * rte_eth_remove_rx_callback().
4067 * Multiple functions are called in the order that they are added.
4070 * The port identifier of the Ethernet device.
4072 * The queue on the Ethernet device on which the callback is to be added.
4074 * The callback function
4076 * A generic pointer parameter which will be passed to each invocation of the
4077 * callback function on this port and queue.
4081 * On success, a pointer value which can later be used to remove the callback.
4083 void *rte_eth_add_rx_callback(uint16_t port_id, uint16_t queue_id,
4084 rte_rx_callback_fn fn, void *user_param);
4087 * Add a callback that must be called first on packet RX on a given port
4090 * This API configures a first function to be called for each burst of
4091 * packets received on a given NIC port queue. The return value is a pointer
4092 * that can be used to later remove the callback using
4093 * rte_eth_remove_rx_callback().
4095 * Multiple functions are called in the order that they are added.
4098 * The port identifier of the Ethernet device.
4100 * The queue on the Ethernet device on which the callback is to be added.
4102 * The callback function
4104 * A generic pointer parameter which will be passed to each invocation of the
4105 * callback function on this port and queue.
4109 * On success, a pointer value which can later be used to remove the callback.
4111 void *rte_eth_add_first_rx_callback(uint16_t port_id, uint16_t queue_id,
4112 rte_rx_callback_fn fn, void *user_param);
4115 * Add a callback to be called on packet TX on a given port and queue.
4117 * This API configures a function to be called for each burst of
4118 * packets sent on a given NIC port queue. The return value is a pointer
4119 * that can be used to later remove the callback using
4120 * rte_eth_remove_tx_callback().
4122 * Multiple functions are called in the order that they are added.
4125 * The port identifier of the Ethernet device.
4127 * The queue on the Ethernet device on which the callback is to be added.
4129 * The callback function
4131 * A generic pointer parameter which will be passed to each invocation of the
4132 * callback function on this port and queue.
4136 * On success, a pointer value which can later be used to remove the callback.
4138 void *rte_eth_add_tx_callback(uint16_t port_id, uint16_t queue_id,
4139 rte_tx_callback_fn fn, void *user_param);
4142 * Remove an RX packet callback from a given port and queue.
4144 * This function is used to removed callbacks that were added to a NIC port
4145 * queue using rte_eth_add_rx_callback().
4147 * Note: the callback is removed from the callback list but it isn't freed
4148 * since the it may still be in use. The memory for the callback can be
4149 * subsequently freed back by the application by calling rte_free():
4151 * - Immediately - if the port is stopped, or the user knows that no
4152 * callbacks are in flight e.g. if called from the thread doing RX/TX
4155 * - After a short delay - where the delay is sufficient to allow any
4156 * in-flight callbacks to complete.
4159 * The port identifier of the Ethernet device.
4161 * The queue on the Ethernet device from which the callback is to be removed.
4163 * User supplied callback created via rte_eth_add_rx_callback().
4166 * - 0: Success. Callback was removed.
4167 * - -ENOTSUP: Callback support is not available.
4168 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
4169 * is NULL or not found for the port/queue.
4171 int rte_eth_remove_rx_callback(uint16_t port_id, uint16_t queue_id,
4172 struct rte_eth_rxtx_callback *user_cb);
4175 * Remove a TX packet callback from a given port and queue.
4177 * This function is used to removed callbacks that were added to a NIC port
4178 * queue using rte_eth_add_tx_callback().
4180 * Note: the callback is removed from the callback list but it isn't freed
4181 * since the it may still be in use. The memory for the callback can be
4182 * subsequently freed back by the application by calling rte_free():
4184 * - Immediately - if the port is stopped, or the user knows that no
4185 * callbacks are in flight e.g. if called from the thread doing RX/TX
4188 * - After a short delay - where the delay is sufficient to allow any
4189 * in-flight callbacks to complete.
4192 * The port identifier of the Ethernet device.
4194 * The queue on the Ethernet device from which the callback is to be removed.
4196 * User supplied callback created via rte_eth_add_tx_callback().
4199 * - 0: Success. Callback was removed.
4200 * - -ENOTSUP: Callback support is not available.
4201 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
4202 * is NULL or not found for the port/queue.
4204 int rte_eth_remove_tx_callback(uint16_t port_id, uint16_t queue_id,
4205 struct rte_eth_rxtx_callback *user_cb);
4208 * Retrieve information about given port's RX queue.
4211 * The port identifier of the Ethernet device.
4213 * The RX queue on the Ethernet device for which information
4214 * will be retrieved.
4216 * A pointer to a structure of type *rte_eth_rxq_info_info* to be filled with
4217 * the information of the Ethernet device.
4221 * - -ENOTSUP: routine is not supported by the device PMD.
4222 * - -EINVAL: The port_id or the queue_id is out of range.
4224 int rte_eth_rx_queue_info_get(uint16_t port_id, uint16_t queue_id,
4225 struct rte_eth_rxq_info *qinfo);
4228 * Retrieve information about given port's TX queue.
4231 * The port identifier of the Ethernet device.
4233 * The TX queue on the Ethernet device for which information
4234 * will be retrieved.
4236 * A pointer to a structure of type *rte_eth_txq_info_info* to be filled with
4237 * the information of the Ethernet device.
4241 * - -ENOTSUP: routine is not supported by the device PMD.
4242 * - -EINVAL: The port_id or the queue_id is out of range.
4244 int rte_eth_tx_queue_info_get(uint16_t port_id, uint16_t queue_id,
4245 struct rte_eth_txq_info *qinfo);
4248 * Retrieve device registers and register attributes (number of registers and
4252 * The port identifier of the Ethernet device.
4254 * Pointer to rte_dev_reg_info structure to fill in. If info->data is
4255 * NULL the function fills in the width and length fields. If non-NULL
4256 * the registers are put into the buffer pointed at by the data field.
4258 * - (0) if successful.
4259 * - (-ENOTSUP) if hardware doesn't support.
4260 * - (-ENODEV) if *port_id* invalid.
4261 * - others depends on the specific operations implementation.
4263 int rte_eth_dev_get_reg_info(uint16_t port_id, struct rte_dev_reg_info *info);
4266 * Retrieve size of device EEPROM
4269 * The port identifier of the Ethernet device.
4271 * - (>=0) EEPROM size if successful.
4272 * - (-ENOTSUP) if hardware doesn't support.
4273 * - (-ENODEV) if *port_id* invalid.
4274 * - others depends on the specific operations implementation.
4276 int rte_eth_dev_get_eeprom_length(uint16_t port_id);
4279 * Retrieve EEPROM and EEPROM attribute
4282 * The port identifier of the Ethernet device.
4284 * The template includes buffer for return EEPROM data and
4285 * EEPROM attributes to be filled.
4287 * - (0) if successful.
4288 * - (-ENOTSUP) if hardware doesn't support.
4289 * - (-ENODEV) if *port_id* invalid.
4290 * - others depends on the specific operations implementation.
4292 int rte_eth_dev_get_eeprom(uint16_t port_id, struct rte_dev_eeprom_info *info);
4295 * Program EEPROM with provided data
4298 * The port identifier of the Ethernet device.
4300 * The template includes EEPROM data for programming and
4301 * EEPROM attributes to be filled
4303 * - (0) if successful.
4304 * - (-ENOTSUP) if hardware doesn't support.
4305 * - (-ENODEV) if *port_id* invalid.
4306 * - others depends on the specific operations implementation.
4308 int rte_eth_dev_set_eeprom(uint16_t port_id, struct rte_dev_eeprom_info *info);
4311 * Set the list of multicast addresses to filter on an Ethernet device.
4314 * The port identifier of the Ethernet device.
4315 * @param mc_addr_set
4316 * The array of multicast addresses to set. Equal to NULL when the function
4317 * is invoked to flush the set of filtered addresses.
4319 * The number of multicast addresses in the *mc_addr_set* array. Equal to 0
4320 * when the function is invoked to flush the set of filtered addresses.
4322 * - (0) if successful.
4323 * - (-ENODEV) if *port_id* invalid.
4324 * - (-ENOTSUP) if PMD of *port_id* doesn't support multicast filtering.
4325 * - (-ENOSPC) if *port_id* has not enough multicast filtering resources.
4327 int rte_eth_dev_set_mc_addr_list(uint16_t port_id,
4328 struct ether_addr *mc_addr_set,
4329 uint32_t nb_mc_addr);
4332 * Enable IEEE1588/802.1AS timestamping for an Ethernet device.
4335 * The port identifier of the Ethernet device.
4339 * - -ENODEV: The port ID is invalid.
4340 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4342 int rte_eth_timesync_enable(uint16_t port_id);
4345 * Disable IEEE1588/802.1AS timestamping for an Ethernet device.
4348 * The port identifier of the Ethernet device.
4352 * - -ENODEV: The port ID is invalid.
4353 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4355 int rte_eth_timesync_disable(uint16_t port_id);
4358 * Read an IEEE1588/802.1AS RX timestamp from an Ethernet device.
4361 * The port identifier of the Ethernet device.
4363 * Pointer to the timestamp struct.
4365 * Device specific flags. Used to pass the RX timesync register index to
4366 * i40e. Unused in igb/ixgbe, pass 0 instead.
4370 * - -EINVAL: No timestamp is available.
4371 * - -ENODEV: The port ID is invalid.
4372 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4374 int rte_eth_timesync_read_rx_timestamp(uint16_t port_id,
4375 struct timespec *timestamp, uint32_t flags);
4378 * Read an IEEE1588/802.1AS TX timestamp from an Ethernet device.
4381 * The port identifier of the Ethernet device.
4383 * Pointer to the timestamp struct.
4387 * - -EINVAL: No timestamp is available.
4388 * - -ENODEV: The port ID is invalid.
4389 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4391 int rte_eth_timesync_read_tx_timestamp(uint16_t port_id,
4392 struct timespec *timestamp);
4395 * Adjust the timesync clock on an Ethernet device.
4397 * This is usually used in conjunction with other Ethdev timesync functions to
4398 * synchronize the device time using the IEEE1588/802.1AS protocol.
4401 * The port identifier of the Ethernet device.
4403 * The adjustment in nanoseconds.
4407 * - -ENODEV: The port ID is invalid.
4408 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4410 int rte_eth_timesync_adjust_time(uint16_t port_id, int64_t delta);
4413 * Read the time from the timesync clock on an Ethernet device.
4415 * This is usually used in conjunction with other Ethdev timesync functions to
4416 * synchronize the device time using the IEEE1588/802.1AS protocol.
4419 * The port identifier of the Ethernet device.
4421 * Pointer to the timespec struct that holds the time.
4426 int rte_eth_timesync_read_time(uint16_t port_id, struct timespec *time);
4429 * Set the time of the timesync clock on an Ethernet device.
4431 * This is usually used in conjunction with other Ethdev timesync functions to
4432 * synchronize the device time using the IEEE1588/802.1AS protocol.
4435 * The port identifier of the Ethernet device.
4437 * Pointer to the timespec struct that holds the time.
4441 * - -EINVAL: No timestamp is available.
4442 * - -ENODEV: The port ID is invalid.
4443 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4445 int rte_eth_timesync_write_time(uint16_t port_id, const struct timespec *time);
4448 * Create memzone for HW rings.
4449 * malloc can't be used as the physical address is needed.
4450 * If the memzone is already created, then this function returns a ptr
4454 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
4456 * The name of the memory zone
4458 * The index of the queue to add to name
4460 * The sizeof of the memory area
4462 * Alignment for resulting memzone. Must be a power of 2.
4464 * The *socket_id* argument is the socket identifier in case of NUMA.
4466 const struct rte_memzone *
4467 rte_eth_dma_zone_reserve(const struct rte_eth_dev *eth_dev, const char *name,
4468 uint16_t queue_id, size_t size,
4469 unsigned align, int socket_id);
4472 * Config l2 tunnel ether type of an Ethernet device for filtering specific
4473 * tunnel packets by ether type.
4476 * The port identifier of the Ethernet device.
4478 * l2 tunnel configuration.
4481 * - (0) if successful.
4482 * - (-ENODEV) if port identifier is invalid.
4483 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4486 rte_eth_dev_l2_tunnel_eth_type_conf(uint16_t port_id,
4487 struct rte_eth_l2_tunnel_conf *l2_tunnel);
4490 * Enable/disable l2 tunnel offload functions. Include,
4491 * 1, The ability of parsing a type of l2 tunnel of an Ethernet device.
4492 * Filtering, forwarding and offloading this type of tunnel packets depend on
4494 * 2, Stripping the l2 tunnel tag.
4495 * 3, Insertion of the l2 tunnel tag.
4496 * 4, Forwarding the packets based on the l2 tunnel tag.
4499 * The port identifier of the Ethernet device.
4501 * l2 tunnel parameters.
4503 * Indicate the offload function.
4505 * Enable or disable this function.
4508 * - (0) if successful.
4509 * - (-ENODEV) if port identifier is invalid.
4510 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4513 rte_eth_dev_l2_tunnel_offload_set(uint16_t port_id,
4514 struct rte_eth_l2_tunnel_conf *l2_tunnel,
4519 * Get the port id from pci address or device name
4520 * Ex: 0000:2:00.0 or vdev name net_pcap0
4523 * pci address or name of the device
4525 * pointer to port identifier of the device
4527 * - (0) if successful and port_id is filled.
4528 * - (-ENODEV or -EINVAL) on failure.
4531 rte_eth_dev_get_port_by_name(const char *name, uint16_t *port_id);
4534 * Get the device name from port id
4537 * pointer to port identifier of the device
4539 * pci address or name of the device
4541 * - (0) if successful.
4542 * - (-EINVAL) on failure.
4545 rte_eth_dev_get_name_by_port(uint16_t port_id, char *name);
4548 * Check that numbers of Rx and Tx descriptors satisfy descriptors limits from
4549 * the ethernet device information, otherwise adjust them to boundaries.
4552 * The port identifier of the Ethernet device.
4554 * A pointer to a uint16_t where the number of receive
4555 * descriptors stored.
4557 * A pointer to a uint16_t where the number of transmit
4558 * descriptors stored.
4560 * - (0) if successful.
4561 * - (-ENOTSUP, -ENODEV or -EINVAL) on failure.
4563 int rte_eth_dev_adjust_nb_rx_tx_desc(uint16_t port_id,
4564 uint16_t *nb_rx_desc,
4565 uint16_t *nb_tx_desc);
4569 * Test if a port supports specific mempool ops.
4572 * Port identifier of the Ethernet device.
4574 * The name of the pool operations to test.
4576 * - 0: best mempool ops choice for this port.
4577 * - 1: mempool ops are supported for this port.
4578 * - -ENOTSUP: mempool ops not supported for this port.
4579 * - -ENODEV: Invalid port Identifier.
4580 * - -EINVAL: Pool param is null.
4583 rte_eth_dev_pool_ops_supported(uint16_t port_id, const char *pool);
4589 #endif /* _RTE_ETHDEV_H_ */