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 * If new Rx offload capabilities are defined, they also must be
951 * mentioned in rte_rx_offload_names in rte_ethdev.c file.
955 * TX offload capabilities of a device.
957 #define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001
958 #define DEV_TX_OFFLOAD_IPV4_CKSUM 0x00000002
959 #define DEV_TX_OFFLOAD_UDP_CKSUM 0x00000004
960 #define DEV_TX_OFFLOAD_TCP_CKSUM 0x00000008
961 #define DEV_TX_OFFLOAD_SCTP_CKSUM 0x00000010
962 #define DEV_TX_OFFLOAD_TCP_TSO 0x00000020
963 #define DEV_TX_OFFLOAD_UDP_TSO 0x00000040
964 #define DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000080 /**< Used for tunneling packet. */
965 #define DEV_TX_OFFLOAD_QINQ_INSERT 0x00000100
966 #define DEV_TX_OFFLOAD_VXLAN_TNL_TSO 0x00000200 /**< Used for tunneling packet. */
967 #define DEV_TX_OFFLOAD_GRE_TNL_TSO 0x00000400 /**< Used for tunneling packet. */
968 #define DEV_TX_OFFLOAD_IPIP_TNL_TSO 0x00000800 /**< Used for tunneling packet. */
969 #define DEV_TX_OFFLOAD_GENEVE_TNL_TSO 0x00001000 /**< Used for tunneling packet. */
970 #define DEV_TX_OFFLOAD_MACSEC_INSERT 0x00002000
971 #define DEV_TX_OFFLOAD_MT_LOCKFREE 0x00004000
972 /**< Multiple threads can invoke rte_eth_tx_burst() concurrently on the same
973 * tx queue without SW lock.
975 #define DEV_TX_OFFLOAD_MULTI_SEGS 0x00008000
976 /**< Device supports multi segment send. */
977 #define DEV_TX_OFFLOAD_MBUF_FAST_FREE 0x00010000
978 /**< Device supports optimization for fast release of mbufs.
979 * When set application must guarantee that per-queue all mbufs comes from
980 * the same mempool and has refcnt = 1.
982 #define DEV_TX_OFFLOAD_SECURITY 0x00020000
985 * If new Tx offload capabilities are defined, they also must be
986 * mentioned in rte_tx_offload_names in rte_ethdev.c file.
989 struct rte_pci_device;
992 * Ethernet device information
994 struct rte_eth_dev_info {
995 struct rte_pci_device *pci_dev; /**< Device PCI information. */
996 const char *driver_name; /**< Device Driver name. */
997 unsigned int if_index; /**< Index to bound host interface, or 0 if none.
998 Use if_indextoname() to translate into an interface name. */
999 uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
1000 uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
1001 uint16_t max_rx_queues; /**< Maximum number of RX queues. */
1002 uint16_t max_tx_queues; /**< Maximum number of TX queues. */
1003 uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
1004 uint32_t max_hash_mac_addrs;
1005 /** Maximum number of hash MAC addresses for MTA and UTA. */
1006 uint16_t max_vfs; /**< Maximum number of VFs. */
1007 uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
1008 uint64_t rx_offload_capa;
1009 /**< Device per port RX offload capabilities. */
1010 uint64_t tx_offload_capa;
1011 /**< Device per port TX offload capabilities. */
1012 uint64_t rx_queue_offload_capa;
1013 /**< Device per queue RX offload capabilities. */
1014 uint64_t tx_queue_offload_capa;
1015 /**< Device per queue TX offload capabilities. */
1017 /**< Device redirection table size, the total number of entries. */
1018 uint8_t hash_key_size; /**< Hash key size in bytes */
1019 /** Bit mask of RSS offloads, the bit offset also means flow type */
1020 uint64_t flow_type_rss_offloads;
1021 struct rte_eth_rxconf default_rxconf; /**< Default RX configuration */
1022 struct rte_eth_txconf default_txconf; /**< Default TX configuration */
1023 uint16_t vmdq_queue_base; /**< First queue ID for VMDQ pools. */
1024 uint16_t vmdq_queue_num; /**< Queue number for VMDQ pools. */
1025 uint16_t vmdq_pool_base; /**< First ID of VMDQ pools. */
1026 struct rte_eth_desc_lim rx_desc_lim; /**< RX descriptors limits */
1027 struct rte_eth_desc_lim tx_desc_lim; /**< TX descriptors limits */
1028 uint32_t speed_capa; /**< Supported speeds bitmap (ETH_LINK_SPEED_). */
1029 /** Configured number of rx/tx queues */
1030 uint16_t nb_rx_queues; /**< Number of RX queues. */
1031 uint16_t nb_tx_queues; /**< Number of TX queues. */
1035 * Ethernet device RX queue information structure.
1036 * Used to retieve information about configured queue.
1038 struct rte_eth_rxq_info {
1039 struct rte_mempool *mp; /**< mempool used by that queue. */
1040 struct rte_eth_rxconf conf; /**< queue config parameters. */
1041 uint8_t scattered_rx; /**< scattered packets RX supported. */
1042 uint16_t nb_desc; /**< configured number of RXDs. */
1043 } __rte_cache_min_aligned;
1046 * Ethernet device TX queue information structure.
1047 * Used to retrieve information about configured queue.
1049 struct rte_eth_txq_info {
1050 struct rte_eth_txconf conf; /**< queue config parameters. */
1051 uint16_t nb_desc; /**< configured number of TXDs. */
1052 } __rte_cache_min_aligned;
1054 /** Maximum name length for extended statistics counters */
1055 #define RTE_ETH_XSTATS_NAME_SIZE 64
1058 * An Ethernet device extended statistic structure
1060 * This structure is used by rte_eth_xstats_get() to provide
1061 * statistics that are not provided in the generic *rte_eth_stats*
1063 * It maps a name id, corresponding to an index in the array returned
1064 * by rte_eth_xstats_get_names(), to a statistic value.
1066 struct rte_eth_xstat {
1067 uint64_t id; /**< The index in xstats name array. */
1068 uint64_t value; /**< The statistic counter value. */
1072 * A name element for extended statistics.
1074 * An array of this structure is returned by rte_eth_xstats_get_names().
1075 * It lists the names of extended statistics for a PMD. The *rte_eth_xstat*
1076 * structure references these names by their array index.
1078 struct rte_eth_xstat_name {
1079 char name[RTE_ETH_XSTATS_NAME_SIZE]; /**< The statistic name. */
1082 #define ETH_DCB_NUM_TCS 8
1083 #define ETH_MAX_VMDQ_POOL 64
1086 * A structure used to get the information of queue and
1087 * TC mapping on both TX and RX paths.
1089 struct rte_eth_dcb_tc_queue_mapping {
1090 /** rx queues assigned to tc per Pool */
1094 } tc_rxq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
1095 /** rx queues assigned to tc per Pool */
1099 } tc_txq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
1103 * A structure used to get the information of DCB.
1104 * It includes TC UP mapping and queue TC mapping.
1106 struct rte_eth_dcb_info {
1107 uint8_t nb_tcs; /**< number of TCs */
1108 uint8_t prio_tc[ETH_DCB_NUM_USER_PRIORITIES]; /**< Priority to tc */
1109 uint8_t tc_bws[ETH_DCB_NUM_TCS]; /**< TX BW percentage for each TC */
1110 /** rx queues assigned to tc */
1111 struct rte_eth_dcb_tc_queue_mapping tc_queue;
1115 * RX/TX queue states
1117 #define RTE_ETH_QUEUE_STATE_STOPPED 0
1118 #define RTE_ETH_QUEUE_STATE_STARTED 1
1122 #define RTE_ETH_ALL RTE_MAX_ETHPORTS
1124 struct rte_eth_dev_callback;
1125 /** @internal Structure to keep track of registered callbacks */
1126 TAILQ_HEAD(rte_eth_dev_cb_list, rte_eth_dev_callback);
1128 /* Macros to check for valid port */
1129 #define RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, retval) do { \
1130 if (!rte_eth_dev_is_valid_port(port_id)) { \
1131 RTE_PMD_DEBUG_TRACE("Invalid port_id=%d\n", port_id); \
1136 #define RTE_ETH_VALID_PORTID_OR_RET(port_id) do { \
1137 if (!rte_eth_dev_is_valid_port(port_id)) { \
1138 RTE_PMD_DEBUG_TRACE("Invalid port_id=%d\n", port_id); \
1144 * l2 tunnel configuration.
1147 /**< l2 tunnel enable mask */
1148 #define ETH_L2_TUNNEL_ENABLE_MASK 0x00000001
1149 /**< l2 tunnel insertion mask */
1150 #define ETH_L2_TUNNEL_INSERTION_MASK 0x00000002
1151 /**< l2 tunnel stripping mask */
1152 #define ETH_L2_TUNNEL_STRIPPING_MASK 0x00000004
1153 /**< l2 tunnel forwarding mask */
1154 #define ETH_L2_TUNNEL_FORWARDING_MASK 0x00000008
1157 * Definitions of all functions exported by an Ethernet driver through the
1158 * the generic structure of type *eth_dev_ops* supplied in the *rte_eth_dev*
1159 * structure associated with an Ethernet device.
1162 typedef int (*eth_dev_configure_t)(struct rte_eth_dev *dev);
1163 /**< @internal Ethernet device configuration. */
1165 typedef int (*eth_dev_start_t)(struct rte_eth_dev *dev);
1166 /**< @internal Function used to start a configured Ethernet device. */
1168 typedef void (*eth_dev_stop_t)(struct rte_eth_dev *dev);
1169 /**< @internal Function used to stop a configured Ethernet device. */
1171 typedef int (*eth_dev_set_link_up_t)(struct rte_eth_dev *dev);
1172 /**< @internal Function used to link up a configured Ethernet device. */
1174 typedef int (*eth_dev_set_link_down_t)(struct rte_eth_dev *dev);
1175 /**< @internal Function used to link down a configured Ethernet device. */
1177 typedef void (*eth_dev_close_t)(struct rte_eth_dev *dev);
1178 /**< @internal Function used to close a configured Ethernet device. */
1180 typedef int (*eth_dev_reset_t)(struct rte_eth_dev *dev);
1181 /** <@internal Function used to reset a configured Ethernet device. */
1183 typedef int (*eth_is_removed_t)(struct rte_eth_dev *dev);
1184 /**< @internal Function used to detect an Ethernet device removal. */
1186 typedef void (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev);
1187 /**< @internal Function used to enable the RX promiscuous mode of an Ethernet device. */
1189 typedef void (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev);
1190 /**< @internal Function used to disable the RX promiscuous mode of an Ethernet device. */
1192 typedef void (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
1193 /**< @internal Enable the receipt of all multicast packets by an Ethernet device. */
1195 typedef void (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
1196 /**< @internal Disable the receipt of all multicast packets by an Ethernet device. */
1198 typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
1199 int wait_to_complete);
1200 /**< @internal Get link speed, duplex mode and state (up/down) of an Ethernet device. */
1202 typedef int (*eth_stats_get_t)(struct rte_eth_dev *dev,
1203 struct rte_eth_stats *igb_stats);
1204 /**< @internal Get global I/O statistics of an Ethernet device. */
1206 typedef void (*eth_stats_reset_t)(struct rte_eth_dev *dev);
1207 /**< @internal Reset global I/O statistics of an Ethernet device to 0. */
1209 typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev,
1210 struct rte_eth_xstat *stats, unsigned n);
1211 /**< @internal Get extended stats of an Ethernet device. */
1213 typedef int (*eth_xstats_get_by_id_t)(struct rte_eth_dev *dev,
1214 const uint64_t *ids,
1217 /**< @internal Get extended stats of an Ethernet device. */
1219 typedef void (*eth_xstats_reset_t)(struct rte_eth_dev *dev);
1220 /**< @internal Reset extended stats of an Ethernet device. */
1222 typedef int (*eth_xstats_get_names_t)(struct rte_eth_dev *dev,
1223 struct rte_eth_xstat_name *xstats_names, unsigned size);
1224 /**< @internal Get names of extended stats of an Ethernet device. */
1226 typedef int (*eth_xstats_get_names_by_id_t)(struct rte_eth_dev *dev,
1227 struct rte_eth_xstat_name *xstats_names, const uint64_t *ids,
1229 /**< @internal Get names of extended stats of an Ethernet device. */
1231 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
1235 /**< @internal Set a queue statistics mapping for a tx/rx queue of an Ethernet device. */
1237 typedef void (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
1238 struct rte_eth_dev_info *dev_info);
1239 /**< @internal Get specific informations of an Ethernet device. */
1241 typedef const uint32_t *(*eth_dev_supported_ptypes_get_t)(struct rte_eth_dev *dev);
1242 /**< @internal Get supported ptypes of an Ethernet device. */
1244 typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
1246 /**< @internal Start rx and tx of a queue of an Ethernet device. */
1248 typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
1250 /**< @internal Stop rx and tx of a queue of an Ethernet device. */
1252 typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
1253 uint16_t rx_queue_id,
1254 uint16_t nb_rx_desc,
1255 unsigned int socket_id,
1256 const struct rte_eth_rxconf *rx_conf,
1257 struct rte_mempool *mb_pool);
1258 /**< @internal Set up a receive queue of an Ethernet device. */
1260 typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
1261 uint16_t tx_queue_id,
1262 uint16_t nb_tx_desc,
1263 unsigned int socket_id,
1264 const struct rte_eth_txconf *tx_conf);
1265 /**< @internal Setup a transmit queue of an Ethernet device. */
1267 typedef int (*eth_rx_enable_intr_t)(struct rte_eth_dev *dev,
1268 uint16_t rx_queue_id);
1269 /**< @internal Enable interrupt of a receive queue of an Ethernet device. */
1271 typedef int (*eth_rx_disable_intr_t)(struct rte_eth_dev *dev,
1272 uint16_t rx_queue_id);
1273 /**< @internal Disable interrupt of a receive queue of an Ethernet device. */
1275 typedef void (*eth_queue_release_t)(void *queue);
1276 /**< @internal Release memory resources allocated by given RX/TX queue. */
1278 typedef uint32_t (*eth_rx_queue_count_t)(struct rte_eth_dev *dev,
1279 uint16_t rx_queue_id);
1280 /**< @internal Get number of used descriptors on a receive queue. */
1282 typedef int (*eth_rx_descriptor_done_t)(void *rxq, uint16_t offset);
1283 /**< @internal Check DD bit of specific RX descriptor */
1285 typedef int (*eth_rx_descriptor_status_t)(void *rxq, uint16_t offset);
1286 /**< @internal Check the status of a Rx descriptor */
1288 typedef int (*eth_tx_descriptor_status_t)(void *txq, uint16_t offset);
1289 /**< @internal Check the status of a Tx descriptor */
1291 typedef int (*eth_fw_version_get_t)(struct rte_eth_dev *dev,
1292 char *fw_version, size_t fw_size);
1293 /**< @internal Get firmware information of an Ethernet device. */
1295 typedef int (*eth_tx_done_cleanup_t)(void *txq, uint32_t free_cnt);
1296 /**< @internal Force mbufs to be from TX ring. */
1298 typedef void (*eth_rxq_info_get_t)(struct rte_eth_dev *dev,
1299 uint16_t rx_queue_id, struct rte_eth_rxq_info *qinfo);
1301 typedef void (*eth_txq_info_get_t)(struct rte_eth_dev *dev,
1302 uint16_t tx_queue_id, struct rte_eth_txq_info *qinfo);
1304 typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);
1305 /**< @internal Set MTU. */
1307 typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
1310 /**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */
1312 typedef int (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
1313 enum rte_vlan_type type, uint16_t tpid);
1314 /**< @internal set the outer/inner VLAN-TPID by an Ethernet device. */
1316 typedef int (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
1317 /**< @internal set VLAN offload function by an Ethernet device. */
1319 typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
1322 /**< @internal set port based TX VLAN insertion by an Ethernet device. */
1324 typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
1325 uint16_t rx_queue_id,
1327 /**< @internal VLAN stripping enable/disable by an queue of Ethernet device. */
1329 typedef uint16_t (*eth_rx_burst_t)(void *rxq,
1330 struct rte_mbuf **rx_pkts,
1332 /**< @internal Retrieve input packets from a receive queue of an Ethernet device. */
1334 typedef uint16_t (*eth_tx_burst_t)(void *txq,
1335 struct rte_mbuf **tx_pkts,
1337 /**< @internal Send output packets on a transmit queue of an Ethernet device. */
1339 typedef uint16_t (*eth_tx_prep_t)(void *txq,
1340 struct rte_mbuf **tx_pkts,
1342 /**< @internal Prepare output packets on a transmit queue of an Ethernet device. */
1344 typedef int (*flow_ctrl_get_t)(struct rte_eth_dev *dev,
1345 struct rte_eth_fc_conf *fc_conf);
1346 /**< @internal Get current flow control parameter on an Ethernet device */
1348 typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
1349 struct rte_eth_fc_conf *fc_conf);
1350 /**< @internal Setup flow control parameter on an Ethernet device */
1352 typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
1353 struct rte_eth_pfc_conf *pfc_conf);
1354 /**< @internal Setup priority flow control parameter on an Ethernet device */
1356 typedef int (*reta_update_t)(struct rte_eth_dev *dev,
1357 struct rte_eth_rss_reta_entry64 *reta_conf,
1358 uint16_t reta_size);
1359 /**< @internal Update RSS redirection table on an Ethernet device */
1361 typedef int (*reta_query_t)(struct rte_eth_dev *dev,
1362 struct rte_eth_rss_reta_entry64 *reta_conf,
1363 uint16_t reta_size);
1364 /**< @internal Query RSS redirection table on an Ethernet device */
1366 typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
1367 struct rte_eth_rss_conf *rss_conf);
1368 /**< @internal Update RSS hash configuration of an Ethernet device */
1370 typedef int (*rss_hash_conf_get_t)(struct rte_eth_dev *dev,
1371 struct rte_eth_rss_conf *rss_conf);
1372 /**< @internal Get current RSS hash configuration of an Ethernet device */
1374 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
1375 /**< @internal Turn on SW controllable LED on an Ethernet device */
1377 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
1378 /**< @internal Turn off SW controllable LED on an Ethernet device */
1380 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
1381 /**< @internal Remove MAC address from receive address register */
1383 typedef int (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
1384 struct ether_addr *mac_addr,
1387 /**< @internal Set a MAC address into Receive Address Address Register */
1389 typedef void (*eth_mac_addr_set_t)(struct rte_eth_dev *dev,
1390 struct ether_addr *mac_addr);
1391 /**< @internal Set a MAC address into Receive Address Address Register */
1393 typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
1394 struct ether_addr *mac_addr,
1396 /**< @internal Set a Unicast Hash bitmap */
1398 typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
1400 /**< @internal Set all Unicast Hash bitmap */
1402 typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
1405 /**< @internal Set queue TX rate */
1407 typedef int (*eth_mirror_rule_set_t)(struct rte_eth_dev *dev,
1408 struct rte_eth_mirror_conf *mirror_conf,
1411 /**< @internal Add a traffic mirroring rule on an Ethernet device */
1413 typedef int (*eth_mirror_rule_reset_t)(struct rte_eth_dev *dev,
1415 /**< @internal Remove a traffic mirroring rule on an Ethernet device */
1417 typedef int (*eth_udp_tunnel_port_add_t)(struct rte_eth_dev *dev,
1418 struct rte_eth_udp_tunnel *tunnel_udp);
1419 /**< @internal Add tunneling UDP port */
1421 typedef int (*eth_udp_tunnel_port_del_t)(struct rte_eth_dev *dev,
1422 struct rte_eth_udp_tunnel *tunnel_udp);
1423 /**< @internal Delete tunneling UDP port */
1425 typedef int (*eth_set_mc_addr_list_t)(struct rte_eth_dev *dev,
1426 struct ether_addr *mc_addr_set,
1427 uint32_t nb_mc_addr);
1428 /**< @internal set the list of multicast addresses on an Ethernet device */
1430 typedef int (*eth_timesync_enable_t)(struct rte_eth_dev *dev);
1431 /**< @internal Function used to enable IEEE1588/802.1AS timestamping. */
1433 typedef int (*eth_timesync_disable_t)(struct rte_eth_dev *dev);
1434 /**< @internal Function used to disable IEEE1588/802.1AS timestamping. */
1436 typedef int (*eth_timesync_read_rx_timestamp_t)(struct rte_eth_dev *dev,
1437 struct timespec *timestamp,
1439 /**< @internal Function used to read an RX IEEE1588/802.1AS timestamp. */
1441 typedef int (*eth_timesync_read_tx_timestamp_t)(struct rte_eth_dev *dev,
1442 struct timespec *timestamp);
1443 /**< @internal Function used to read a TX IEEE1588/802.1AS timestamp. */
1445 typedef int (*eth_timesync_adjust_time)(struct rte_eth_dev *dev, int64_t);
1446 /**< @internal Function used to adjust the device clock */
1448 typedef int (*eth_timesync_read_time)(struct rte_eth_dev *dev,
1449 struct timespec *timestamp);
1450 /**< @internal Function used to get time from the device clock. */
1452 typedef int (*eth_timesync_write_time)(struct rte_eth_dev *dev,
1453 const struct timespec *timestamp);
1454 /**< @internal Function used to get time from the device clock */
1456 typedef int (*eth_get_reg_t)(struct rte_eth_dev *dev,
1457 struct rte_dev_reg_info *info);
1458 /**< @internal Retrieve registers */
1460 typedef int (*eth_get_eeprom_length_t)(struct rte_eth_dev *dev);
1461 /**< @internal Retrieve eeprom size */
1463 typedef int (*eth_get_eeprom_t)(struct rte_eth_dev *dev,
1464 struct rte_dev_eeprom_info *info);
1465 /**< @internal Retrieve eeprom data */
1467 typedef int (*eth_set_eeprom_t)(struct rte_eth_dev *dev,
1468 struct rte_dev_eeprom_info *info);
1469 /**< @internal Program eeprom data */
1471 typedef int (*eth_l2_tunnel_eth_type_conf_t)
1472 (struct rte_eth_dev *dev, struct rte_eth_l2_tunnel_conf *l2_tunnel);
1473 /**< @internal config l2 tunnel ether type */
1475 typedef int (*eth_l2_tunnel_offload_set_t)
1476 (struct rte_eth_dev *dev,
1477 struct rte_eth_l2_tunnel_conf *l2_tunnel,
1480 /**< @internal enable/disable the l2 tunnel offload functions */
1483 typedef int (*eth_filter_ctrl_t)(struct rte_eth_dev *dev,
1484 enum rte_filter_type filter_type,
1485 enum rte_filter_op filter_op,
1487 /**< @internal Take operations to assigned filter type on an Ethernet device */
1489 typedef int (*eth_tm_ops_get_t)(struct rte_eth_dev *dev, void *ops);
1490 /**< @internal Get Traffic Management (TM) operations on an Ethernet device */
1492 typedef int (*eth_mtr_ops_get_t)(struct rte_eth_dev *dev, void *ops);
1493 /**< @internal Get Trafffic Metering and Policing (MTR) operations */
1495 typedef int (*eth_get_dcb_info)(struct rte_eth_dev *dev,
1496 struct rte_eth_dcb_info *dcb_info);
1497 /**< @internal Get dcb information on an Ethernet device */
1499 typedef int (*eth_pool_ops_supported_t)(struct rte_eth_dev *dev,
1501 /**< @internal Test if a port supports specific mempool ops */
1504 * @internal A structure containing the functions exported by an Ethernet driver.
1506 struct eth_dev_ops {
1507 eth_dev_configure_t dev_configure; /**< Configure device. */
1508 eth_dev_start_t dev_start; /**< Start device. */
1509 eth_dev_stop_t dev_stop; /**< Stop device. */
1510 eth_dev_set_link_up_t dev_set_link_up; /**< Device link up. */
1511 eth_dev_set_link_down_t dev_set_link_down; /**< Device link down. */
1512 eth_dev_close_t dev_close; /**< Close device. */
1513 eth_dev_reset_t dev_reset; /**< Reset device. */
1514 eth_link_update_t link_update; /**< Get device link state. */
1515 eth_is_removed_t is_removed;
1516 /**< Check if the device was physically removed. */
1518 eth_promiscuous_enable_t promiscuous_enable; /**< Promiscuous ON. */
1519 eth_promiscuous_disable_t promiscuous_disable;/**< Promiscuous OFF. */
1520 eth_allmulticast_enable_t allmulticast_enable;/**< RX multicast ON. */
1521 eth_allmulticast_disable_t allmulticast_disable;/**< RX multicast OFF. */
1522 eth_mac_addr_remove_t mac_addr_remove; /**< Remove MAC address. */
1523 eth_mac_addr_add_t mac_addr_add; /**< Add a MAC address. */
1524 eth_mac_addr_set_t mac_addr_set; /**< Set a MAC address. */
1525 eth_set_mc_addr_list_t set_mc_addr_list; /**< set list of mcast addrs. */
1526 mtu_set_t mtu_set; /**< Set MTU. */
1528 eth_stats_get_t stats_get; /**< Get generic device statistics. */
1529 eth_stats_reset_t stats_reset; /**< Reset generic device statistics. */
1530 eth_xstats_get_t xstats_get; /**< Get extended device statistics. */
1531 eth_xstats_reset_t xstats_reset; /**< Reset extended device statistics. */
1532 eth_xstats_get_names_t xstats_get_names;
1533 /**< Get names of extended statistics. */
1534 eth_queue_stats_mapping_set_t queue_stats_mapping_set;
1535 /**< Configure per queue stat counter mapping. */
1537 eth_dev_infos_get_t dev_infos_get; /**< Get device info. */
1538 eth_rxq_info_get_t rxq_info_get; /**< retrieve RX queue information. */
1539 eth_txq_info_get_t txq_info_get; /**< retrieve TX queue information. */
1540 eth_fw_version_get_t fw_version_get; /**< Get firmware version. */
1541 eth_dev_supported_ptypes_get_t dev_supported_ptypes_get;
1542 /**< Get packet types supported and identified by device. */
1544 vlan_filter_set_t vlan_filter_set; /**< Filter VLAN Setup. */
1545 vlan_tpid_set_t vlan_tpid_set; /**< Outer/Inner VLAN TPID Setup. */
1546 vlan_strip_queue_set_t vlan_strip_queue_set; /**< VLAN Stripping on queue. */
1547 vlan_offload_set_t vlan_offload_set; /**< Set VLAN Offload. */
1548 vlan_pvid_set_t vlan_pvid_set; /**< Set port based TX VLAN insertion. */
1550 eth_queue_start_t rx_queue_start;/**< Start RX for a queue. */
1551 eth_queue_stop_t rx_queue_stop; /**< Stop RX for a queue. */
1552 eth_queue_start_t tx_queue_start;/**< Start TX for a queue. */
1553 eth_queue_stop_t tx_queue_stop; /**< Stop TX for a queue. */
1554 eth_rx_queue_setup_t rx_queue_setup;/**< Set up device RX queue. */
1555 eth_queue_release_t rx_queue_release; /**< Release RX queue. */
1556 eth_rx_queue_count_t rx_queue_count;
1557 /**< Get the number of used RX descriptors. */
1558 eth_rx_descriptor_done_t rx_descriptor_done; /**< Check rxd DD bit. */
1559 eth_rx_descriptor_status_t rx_descriptor_status;
1560 /**< Check the status of a Rx descriptor. */
1561 eth_tx_descriptor_status_t tx_descriptor_status;
1562 /**< Check the status of a Tx descriptor. */
1563 eth_rx_enable_intr_t rx_queue_intr_enable; /**< Enable Rx queue interrupt. */
1564 eth_rx_disable_intr_t rx_queue_intr_disable; /**< Disable Rx queue interrupt. */
1565 eth_tx_queue_setup_t tx_queue_setup;/**< Set up device TX queue. */
1566 eth_queue_release_t tx_queue_release; /**< Release TX queue. */
1567 eth_tx_done_cleanup_t tx_done_cleanup;/**< Free tx ring mbufs */
1569 eth_dev_led_on_t dev_led_on; /**< Turn on LED. */
1570 eth_dev_led_off_t dev_led_off; /**< Turn off LED. */
1572 flow_ctrl_get_t flow_ctrl_get; /**< Get flow control. */
1573 flow_ctrl_set_t flow_ctrl_set; /**< Setup flow control. */
1574 priority_flow_ctrl_set_t priority_flow_ctrl_set; /**< Setup priority flow control. */
1576 eth_uc_hash_table_set_t uc_hash_table_set; /**< Set Unicast Table Array. */
1577 eth_uc_all_hash_table_set_t uc_all_hash_table_set; /**< Set Unicast hash bitmap. */
1579 eth_mirror_rule_set_t mirror_rule_set; /**< Add a traffic mirror rule. */
1580 eth_mirror_rule_reset_t mirror_rule_reset; /**< reset a traffic mirror rule. */
1582 eth_udp_tunnel_port_add_t udp_tunnel_port_add; /** Add UDP tunnel port. */
1583 eth_udp_tunnel_port_del_t udp_tunnel_port_del; /** Del UDP tunnel port. */
1584 eth_l2_tunnel_eth_type_conf_t l2_tunnel_eth_type_conf;
1585 /** Config ether type of l2 tunnel. */
1586 eth_l2_tunnel_offload_set_t l2_tunnel_offload_set;
1587 /** Enable/disable l2 tunnel offload functions. */
1589 eth_set_queue_rate_limit_t set_queue_rate_limit; /**< Set queue rate limit. */
1591 rss_hash_update_t rss_hash_update; /** Configure RSS hash protocols. */
1592 rss_hash_conf_get_t rss_hash_conf_get; /** Get current RSS hash configuration. */
1593 reta_update_t reta_update; /** Update redirection table. */
1594 reta_query_t reta_query; /** Query redirection table. */
1596 eth_get_reg_t get_reg; /**< Get registers. */
1597 eth_get_eeprom_length_t get_eeprom_length; /**< Get eeprom length. */
1598 eth_get_eeprom_t get_eeprom; /**< Get eeprom data. */
1599 eth_set_eeprom_t set_eeprom; /**< Set eeprom. */
1602 eth_filter_ctrl_t filter_ctrl; /**< common filter control. */
1604 eth_get_dcb_info get_dcb_info; /** Get DCB information. */
1606 eth_timesync_enable_t timesync_enable;
1607 /** Turn IEEE1588/802.1AS timestamping on. */
1608 eth_timesync_disable_t timesync_disable;
1609 /** Turn IEEE1588/802.1AS timestamping off. */
1610 eth_timesync_read_rx_timestamp_t timesync_read_rx_timestamp;
1611 /** Read the IEEE1588/802.1AS RX timestamp. */
1612 eth_timesync_read_tx_timestamp_t timesync_read_tx_timestamp;
1613 /** Read the IEEE1588/802.1AS TX timestamp. */
1614 eth_timesync_adjust_time timesync_adjust_time; /** Adjust the device clock. */
1615 eth_timesync_read_time timesync_read_time; /** Get the device clock time. */
1616 eth_timesync_write_time timesync_write_time; /** Set the device clock time. */
1618 eth_xstats_get_by_id_t xstats_get_by_id;
1619 /**< Get extended device statistic values by ID. */
1620 eth_xstats_get_names_by_id_t xstats_get_names_by_id;
1621 /**< Get name of extended device statistics by ID. */
1623 eth_tm_ops_get_t tm_ops_get;
1624 /**< Get Traffic Management (TM) operations. */
1626 eth_mtr_ops_get_t mtr_ops_get;
1627 /**< Get Traffic Metering and Policing (MTR) operations. */
1629 eth_pool_ops_supported_t pool_ops_supported;
1630 /**< Test if a port supports specific mempool ops */
1634 * Function type used for RX packet processing packet callbacks.
1636 * The callback function is called on RX with a burst of packets that have
1637 * been received on the given port and queue.
1640 * The Ethernet port on which RX is being performed.
1642 * The queue on the Ethernet port which is being used to receive the packets.
1644 * The burst of packets that have just been received.
1646 * The number of packets in the burst pointed to by "pkts".
1648 * The max number of packets that can be stored in the "pkts" array.
1650 * The arbitrary user parameter passed in by the application when the callback
1651 * was originally configured.
1653 * The number of packets returned to the user.
1655 typedef uint16_t (*rte_rx_callback_fn)(uint16_t port, uint16_t queue,
1656 struct rte_mbuf *pkts[], uint16_t nb_pkts, uint16_t max_pkts,
1660 * Function type used for TX packet processing packet callbacks.
1662 * The callback function is called on TX with a burst of packets immediately
1663 * before the packets are put onto the hardware queue for transmission.
1666 * The Ethernet port on which TX is being performed.
1668 * The queue on the Ethernet port which is being used to transmit the packets.
1670 * The burst of packets that are about to be transmitted.
1672 * The number of packets in the burst pointed to by "pkts".
1674 * The arbitrary user parameter passed in by the application when the callback
1675 * was originally configured.
1677 * The number of packets to be written to the NIC.
1679 typedef uint16_t (*rte_tx_callback_fn)(uint16_t port, uint16_t queue,
1680 struct rte_mbuf *pkts[], uint16_t nb_pkts, void *user_param);
1684 * Structure used to hold information about the callbacks to be called for a
1685 * queue on RX and TX.
1687 struct rte_eth_rxtx_callback {
1688 struct rte_eth_rxtx_callback *next;
1690 rte_rx_callback_fn rx;
1691 rte_tx_callback_fn tx;
1697 * A set of values to describe the possible states of an eth device.
1699 enum rte_eth_dev_state {
1700 RTE_ETH_DEV_UNUSED = 0,
1701 RTE_ETH_DEV_ATTACHED,
1702 RTE_ETH_DEV_DEFERRED,
1703 RTE_ETH_DEV_REMOVED,
1708 * The generic data structure associated with each ethernet device.
1710 * Pointers to burst-oriented packet receive and transmit functions are
1711 * located at the beginning of the structure, along with the pointer to
1712 * where all the data elements for the particular device are stored in shared
1713 * memory. This split allows the function pointer and driver data to be per-
1714 * process, while the actual configuration data for the device is shared.
1716 struct rte_eth_dev {
1717 eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
1718 eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
1719 eth_tx_prep_t tx_pkt_prepare; /**< Pointer to PMD transmit prepare function. */
1720 struct rte_eth_dev_data *data; /**< Pointer to device data */
1721 const struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
1722 struct rte_device *device; /**< Backing device */
1723 struct rte_intr_handle *intr_handle; /**< Device interrupt handle */
1724 /** User application callbacks for NIC interrupts */
1725 struct rte_eth_dev_cb_list link_intr_cbs;
1727 * User-supplied functions called from rx_burst to post-process
1728 * received packets before passing them to the user
1730 struct rte_eth_rxtx_callback *post_rx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
1732 * User-supplied functions called from tx_burst to pre-process
1733 * received packets before passing them to the driver for transmission.
1735 struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
1736 enum rte_eth_dev_state state; /**< Flag indicating the port state */
1737 void *security_ctx; /**< Context for security ops */
1738 } __rte_cache_aligned;
1740 struct rte_eth_dev_sriov {
1741 uint8_t active; /**< SRIOV is active with 16, 32 or 64 pools */
1742 uint8_t nb_q_per_pool; /**< rx queue number per pool */
1743 uint16_t def_vmdq_idx; /**< Default pool num used for PF */
1744 uint16_t def_pool_q_idx; /**< Default pool queue start reg index */
1746 #define RTE_ETH_DEV_SRIOV(dev) ((dev)->data->sriov)
1748 #define RTE_ETH_NAME_MAX_LEN RTE_DEV_NAME_MAX_LEN
1752 * The data part, with no function pointers, associated with each ethernet device.
1754 * This structure is safe to place in shared memory to be common among different
1755 * processes in a multi-process configuration.
1757 struct rte_eth_dev_data {
1758 char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
1760 void **rx_queues; /**< Array of pointers to RX queues. */
1761 void **tx_queues; /**< Array of pointers to TX queues. */
1762 uint16_t nb_rx_queues; /**< Number of RX queues. */
1763 uint16_t nb_tx_queues; /**< Number of TX queues. */
1765 struct rte_eth_dev_sriov sriov; /**< SRIOV data */
1767 void *dev_private; /**< PMD-specific private data */
1769 struct rte_eth_link dev_link;
1770 /**< Link-level information & status */
1772 struct rte_eth_conf dev_conf; /**< Configuration applied to device. */
1773 uint16_t mtu; /**< Maximum Transmission Unit. */
1775 uint32_t min_rx_buf_size;
1776 /**< Common rx buffer size handled by all queues */
1778 uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
1779 struct ether_addr* mac_addrs;/**< Device Ethernet Link address. */
1780 uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
1781 /** bitmap array of associating Ethernet MAC addresses to pools */
1782 struct ether_addr* hash_mac_addrs;
1783 /** Device Ethernet MAC addresses of hash filtering. */
1784 uint16_t port_id; /**< Device [external] port identifier. */
1786 uint8_t promiscuous : 1, /**< RX promiscuous mode ON(1) / OFF(0). */
1787 scattered_rx : 1, /**< RX of scattered packets is ON(1) / OFF(0) */
1788 all_multicast : 1, /**< RX all multicast mode ON(1) / OFF(0). */
1789 dev_started : 1, /**< Device state: STARTED(1) / STOPPED(0). */
1790 lro : 1; /**< RX LRO is ON(1) / OFF(0) */
1791 uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT];
1792 /** Queues state: STARTED(1) / STOPPED(0) */
1793 uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
1794 /** Queues state: STARTED(1) / STOPPED(0) */
1795 uint32_t dev_flags; /**< Capabilities */
1796 enum rte_kernel_driver kdrv; /**< Kernel driver passthrough */
1797 int numa_node; /**< NUMA node connection */
1798 struct rte_vlan_filter_conf vlan_filter_conf;
1799 /**< VLAN filter configuration. */
1802 /** Device supports link state interrupt */
1803 #define RTE_ETH_DEV_INTR_LSC 0x0002
1804 /** Device is a bonded slave */
1805 #define RTE_ETH_DEV_BONDED_SLAVE 0x0004
1806 /** Device supports device removal interrupt */
1807 #define RTE_ETH_DEV_INTR_RMV 0x0008
1811 * The pool of *rte_eth_dev* structures. The size of the pool
1812 * is configured at compile-time in the <rte_ethdev.c> file.
1814 extern struct rte_eth_dev rte_eth_devices[];
1817 * Iterates over valid ethdev ports.
1820 * The id of the next possible valid port.
1822 * Next valid port id, RTE_MAX_ETHPORTS if there is none.
1824 uint16_t rte_eth_find_next(uint16_t port_id);
1827 * Macro to iterate over all enabled ethdev ports.
1829 #define RTE_ETH_FOREACH_DEV(p) \
1830 for (p = rte_eth_find_next(0); \
1831 (unsigned int)p < (unsigned int)RTE_MAX_ETHPORTS; \
1832 p = rte_eth_find_next(p + 1))
1836 * Get the total number of Ethernet devices that have been successfully
1837 * initialized by the matching Ethernet driver during the PCI probing phase
1838 * and that are available for applications to use. These devices must be
1839 * accessed by using the ``RTE_ETH_FOREACH_DEV()`` macro to deal with
1840 * non-contiguous ranges of devices.
1841 * These non-contiguous ranges can be created by calls to hotplug functions or
1845 * - The total number of usable Ethernet devices.
1847 uint16_t rte_eth_dev_count(void);
1851 * Returns a ethdev slot specified by the unique identifier name.
1854 * The pointer to the Unique identifier name for each Ethernet device
1856 * - The pointer to the ethdev slot, on success. NULL on error
1858 struct rte_eth_dev *rte_eth_dev_allocated(const char *name);
1862 * Allocates a new ethdev slot for an ethernet device and returns the pointer
1863 * to that slot for the driver to use.
1865 * @param name Unique identifier name for each Ethernet device
1866 * @param type Device type of this Ethernet device
1868 * - Slot in the rte_dev_devices array for a new device;
1870 struct rte_eth_dev *rte_eth_dev_allocate(const char *name);
1874 * Attach to the ethdev already initialized by the primary
1877 * @param name Ethernet device's name.
1879 * - Success: Slot in the rte_dev_devices array for attached
1881 * - Error: Null pointer.
1883 struct rte_eth_dev *rte_eth_dev_attach_secondary(const char *name);
1887 * Release the specified ethdev port.
1890 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure.
1892 * - 0 on success, negative on error
1894 int rte_eth_dev_release_port(struct rte_eth_dev *eth_dev);
1897 * Attach a new Ethernet device specified by arguments.
1900 * A pointer to a strings array describing the new device
1901 * to be attached. The strings should be a pci address like
1902 * '0000:01:00.0' or virtual device name like 'net_pcap0'.
1904 * A pointer to a port identifier actually attached.
1906 * 0 on success and port_id is filled, negative on error
1908 int rte_eth_dev_attach(const char *devargs, uint16_t *port_id);
1911 * Detach a Ethernet device specified by port identifier.
1912 * This function must be called when the device is in the
1916 * The port identifier of the device to detach.
1918 * A pointer to a buffer that will be filled with the device name.
1919 * This buffer must be at least RTE_DEV_NAME_MAX_LEN long.
1921 * 0 on success and devname is filled, negative on error
1923 int rte_eth_dev_detach(uint16_t port_id, char *devname);
1926 * Convert a numerical speed in Mbps to a bitmap flag that can be used in
1927 * the bitmap link_speeds of the struct rte_eth_conf
1930 * Numerical speed value in Mbps
1932 * ETH_LINK_[HALF/FULL]_DUPLEX (only for 10/100M speeds)
1934 * 0 if the speed cannot be mapped
1936 uint32_t rte_eth_speed_bitflag(uint32_t speed, int duplex);
1940 * @b EXPERIMENTAL: this API may change without prior notice
1942 * Get DEV_RX_OFFLOAD_* flag name.
1947 * Offload name or 'UNKNOWN' if the flag cannot be recognised.
1949 const char *rte_eth_dev_rx_offload_name(uint64_t offload);
1953 * @b EXPERIMENTAL: this API may change without prior notice
1955 * Get DEV_TX_OFFLOAD_* flag name.
1960 * Offload name or 'UNKNOWN' if the flag cannot be recognised.
1962 const char *rte_eth_dev_tx_offload_name(uint64_t offload);
1965 * Configure an Ethernet device.
1966 * This function must be invoked first before any other function in the
1967 * Ethernet API. This function can also be re-invoked when a device is in the
1971 * The port identifier of the Ethernet device to configure.
1972 * @param nb_rx_queue
1973 * The number of receive queues to set up for the Ethernet device.
1974 * @param nb_tx_queue
1975 * The number of transmit queues to set up for the Ethernet device.
1977 * The pointer to the configuration data to be used for the Ethernet device.
1978 * The *rte_eth_conf* structure includes:
1979 * - the hardware offload features to activate, with dedicated fields for
1980 * each statically configurable offload hardware feature provided by
1981 * Ethernet devices, such as IP checksum or VLAN tag stripping for
1983 * The Rx offload bitfield API is obsolete and will be deprecated.
1984 * Applications should set the ignore_bitfield_offloads bit on *rxmode*
1985 * structure and use offloads field to set per-port offloads instead.
1986 * - the Receive Side Scaling (RSS) configuration when using multiple RX
1989 * Embedding all configuration information in a single data structure
1990 * is the more flexible method that allows the addition of new features
1991 * without changing the syntax of the API.
1993 * - 0: Success, device configured.
1994 * - <0: Error code returned by the driver configuration function.
1996 int rte_eth_dev_configure(uint16_t port_id, uint16_t nb_rx_queue,
1997 uint16_t nb_tx_queue, const struct rte_eth_conf *eth_conf);
2001 * Release device queues and clear its configuration to force the user
2002 * application to reconfigure it. It is for internal use only.
2005 * Pointer to struct rte_eth_dev.
2010 void _rte_eth_dev_reset(struct rte_eth_dev *dev);
2014 * @b EXPERIMENTAL: this API may change without prior notice.
2016 * Check if an Ethernet device was physically removed.
2019 * The port identifier of the Ethernet device.
2021 * 1 when the Ethernet device is removed, otherwise 0.
2024 rte_eth_dev_is_removed(uint16_t port_id);
2027 * Allocate and set up a receive queue for an Ethernet device.
2029 * The function allocates a contiguous block of memory for *nb_rx_desc*
2030 * receive descriptors from a memory zone associated with *socket_id*
2031 * and initializes each receive descriptor with a network buffer allocated
2032 * from the memory pool *mb_pool*.
2035 * The port identifier of the Ethernet device.
2036 * @param rx_queue_id
2037 * The index of the receive queue to set up.
2038 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2039 * to rte_eth_dev_configure().
2041 * The number of receive descriptors to allocate for the receive ring.
2043 * The *socket_id* argument is the socket identifier in case of NUMA.
2044 * The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
2045 * the DMA memory allocated for the receive descriptors of the ring.
2047 * The pointer to the configuration data to be used for the receive queue.
2048 * NULL value is allowed, in which case default RX configuration
2050 * The *rx_conf* structure contains an *rx_thresh* structure with the values
2051 * of the Prefetch, Host, and Write-Back threshold registers of the receive
2053 * In addition it contains the hardware offloads features to activate using
2054 * the DEV_RX_OFFLOAD_* flags.
2056 * The pointer to the memory pool from which to allocate *rte_mbuf* network
2057 * memory buffers to populate each descriptor of the receive ring.
2059 * - 0: Success, receive queue correctly set up.
2060 * - -EIO: if device is removed.
2061 * - -EINVAL: The size of network buffers which can be allocated from the
2062 * memory pool does not fit the various buffer sizes allowed by the
2063 * device controller.
2064 * - -ENOMEM: Unable to allocate the receive ring descriptors or to
2065 * allocate network memory buffers from the memory pool when
2066 * initializing receive descriptors.
2068 int rte_eth_rx_queue_setup(uint16_t port_id, uint16_t rx_queue_id,
2069 uint16_t nb_rx_desc, unsigned int socket_id,
2070 const struct rte_eth_rxconf *rx_conf,
2071 struct rte_mempool *mb_pool);
2074 * Allocate and set up a transmit queue for an Ethernet device.
2077 * The port identifier of the Ethernet device.
2078 * @param tx_queue_id
2079 * The index of the transmit queue to set up.
2080 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2081 * to rte_eth_dev_configure().
2083 * The number of transmit descriptors to allocate for the transmit ring.
2085 * The *socket_id* argument is the socket identifier in case of NUMA.
2086 * Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
2087 * the DMA memory allocated for the transmit descriptors of the ring.
2089 * The pointer to the configuration data to be used for the transmit queue.
2090 * NULL value is allowed, in which case default TX configuration
2092 * The *tx_conf* structure contains the following data:
2093 * - The *tx_thresh* structure with the values of the Prefetch, Host, and
2094 * Write-Back threshold registers of the transmit ring.
2095 * When setting Write-Back threshold to the value greater then zero,
2096 * *tx_rs_thresh* value should be explicitly set to one.
2097 * - The *tx_free_thresh* value indicates the [minimum] number of network
2098 * buffers that must be pending in the transmit ring to trigger their
2099 * [implicit] freeing by the driver transmit function.
2100 * - The *tx_rs_thresh* value indicates the [minimum] number of transmit
2101 * descriptors that must be pending in the transmit ring before setting the
2102 * RS bit on a descriptor by the driver transmit function.
2103 * The *tx_rs_thresh* value should be less or equal then
2104 * *tx_free_thresh* value, and both of them should be less then
2106 * - The *txq_flags* member contains flags to pass to the TX queue setup
2107 * function to configure the behavior of the TX queue. This should be set
2108 * to 0 if no special configuration is required.
2109 * This API is obsolete and will be deprecated. Applications
2110 * should set it to ETH_TXQ_FLAGS_IGNORE and use
2111 * the offloads field below.
2112 * - The *offloads* member contains Tx offloads to be enabled.
2113 * Offloads which are not set cannot be used on the datapath.
2115 * Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces
2116 * the transmit function to use default values.
2118 * - 0: Success, the transmit queue is correctly set up.
2119 * - -ENOMEM: Unable to allocate the transmit ring descriptors.
2121 int rte_eth_tx_queue_setup(uint16_t port_id, uint16_t tx_queue_id,
2122 uint16_t nb_tx_desc, unsigned int socket_id,
2123 const struct rte_eth_txconf *tx_conf);
2126 * Return the NUMA socket to which an Ethernet device is connected
2129 * The port identifier of the Ethernet device
2131 * The NUMA socket id to which the Ethernet device is connected or
2132 * a default of zero if the socket could not be determined.
2133 * -1 is returned is the port_id value is out of range.
2135 int rte_eth_dev_socket_id(uint16_t port_id);
2138 * Check if port_id of device is attached
2141 * The port identifier of the Ethernet device
2143 * - 0 if port is out of range or not attached
2144 * - 1 if device is attached
2146 int rte_eth_dev_is_valid_port(uint16_t port_id);
2149 * Start specified RX queue of a port. It is used when rx_deferred_start
2150 * flag of the specified queue is true.
2153 * The port identifier of the Ethernet device
2154 * @param rx_queue_id
2155 * The index of the rx queue to update the ring.
2156 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2157 * to rte_eth_dev_configure().
2159 * - 0: Success, the receive queue is started.
2160 * - -EINVAL: The port_id or the queue_id out of range.
2161 * - -EIO: if device is removed.
2162 * - -ENOTSUP: The function not supported in PMD driver.
2164 int rte_eth_dev_rx_queue_start(uint16_t port_id, uint16_t rx_queue_id);
2167 * Stop specified RX queue of a port
2170 * The port identifier of the Ethernet device
2171 * @param rx_queue_id
2172 * The index of the rx queue to update the ring.
2173 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2174 * to rte_eth_dev_configure().
2176 * - 0: Success, the receive queue is stopped.
2177 * - -EINVAL: The port_id or the queue_id out of range.
2178 * - -EIO: if device is removed.
2179 * - -ENOTSUP: The function not supported in PMD driver.
2181 int rte_eth_dev_rx_queue_stop(uint16_t port_id, uint16_t rx_queue_id);
2184 * Start TX for specified queue of a port. It is used when tx_deferred_start
2185 * flag of the specified queue is true.
2188 * The port identifier of the Ethernet device
2189 * @param tx_queue_id
2190 * The index of the tx queue to update the ring.
2191 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2192 * to rte_eth_dev_configure().
2194 * - 0: Success, the transmit queue is started.
2195 * - -EINVAL: The port_id or the queue_id out of range.
2196 * - -EIO: if device is removed.
2197 * - -ENOTSUP: The function not supported in PMD driver.
2199 int rte_eth_dev_tx_queue_start(uint16_t port_id, uint16_t tx_queue_id);
2202 * Stop specified TX queue of a port
2205 * The port identifier of the Ethernet device
2206 * @param tx_queue_id
2207 * The index of the tx queue to update the ring.
2208 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2209 * to rte_eth_dev_configure().
2211 * - 0: Success, the transmit queue is stopped.
2212 * - -EINVAL: The port_id or the queue_id out of range.
2213 * - -EIO: if device is removed.
2214 * - -ENOTSUP: The function not supported in PMD driver.
2216 int rte_eth_dev_tx_queue_stop(uint16_t port_id, uint16_t tx_queue_id);
2221 * Start an Ethernet device.
2223 * The device start step is the last one and consists of setting the configured
2224 * offload features and in starting the transmit and the receive units of the
2226 * On success, all basic functions exported by the Ethernet API (link status,
2227 * receive/transmit, and so on) can be invoked.
2230 * The port identifier of the Ethernet device.
2232 * - 0: Success, Ethernet device started.
2233 * - <0: Error code of the driver device start function.
2235 int rte_eth_dev_start(uint16_t port_id);
2238 * Stop an Ethernet device. The device can be restarted with a call to
2239 * rte_eth_dev_start()
2242 * The port identifier of the Ethernet device.
2244 void rte_eth_dev_stop(uint16_t port_id);
2248 * Link up an Ethernet device.
2250 * Set device link up will re-enable the device rx/tx
2251 * functionality after it is previously set device linked down.
2254 * The port identifier of the Ethernet device.
2256 * - 0: Success, Ethernet device linked up.
2257 * - <0: Error code of the driver device link up function.
2259 int rte_eth_dev_set_link_up(uint16_t port_id);
2262 * Link down an Ethernet device.
2263 * The device rx/tx functionality will be disabled if success,
2264 * and it can be re-enabled with a call to
2265 * rte_eth_dev_set_link_up()
2268 * The port identifier of the Ethernet device.
2270 int rte_eth_dev_set_link_down(uint16_t port_id);
2273 * Close a stopped Ethernet device. The device cannot be restarted!
2274 * The function frees all resources except for needed by the
2275 * closed state. To free these resources, call rte_eth_dev_detach().
2278 * The port identifier of the Ethernet device.
2280 void rte_eth_dev_close(uint16_t port_id);
2283 * Reset a Ethernet device and keep its port id.
2285 * When a port has to be reset passively, the DPDK application can invoke
2286 * this function. For example when a PF is reset, all its VFs should also
2287 * be reset. Normally a DPDK application can invoke this function when
2288 * RTE_ETH_EVENT_INTR_RESET event is detected, but can also use it to start
2289 * a port reset in other circumstances.
2291 * When this function is called, it first stops the port and then calls the
2292 * PMD specific dev_uninit( ) and dev_init( ) to return the port to initial
2293 * state, in which no Tx and Rx queues are setup, as if the port has been
2294 * reset and not started. The port keeps the port id it had before the
2297 * After calling rte_eth_dev_reset( ), the application should use
2298 * rte_eth_dev_configure( ), rte_eth_rx_queue_setup( ),
2299 * rte_eth_tx_queue_setup( ), and rte_eth_dev_start( )
2300 * to reconfigure the device as appropriate.
2302 * Note: To avoid unexpected behavior, the application should stop calling
2303 * Tx and Rx functions before calling rte_eth_dev_reset( ). For thread
2304 * safety, all these controlling functions should be called from the same
2308 * The port identifier of the Ethernet device.
2311 * - (0) if successful.
2312 * - (-EINVAL) if port identifier is invalid.
2313 * - (-ENOTSUP) if hardware doesn't support this function.
2314 * - (-EPERM) if not ran from the primary process.
2315 * - (-EIO) if re-initialisation failed or device is removed.
2316 * - (-ENOMEM) if the reset failed due to OOM.
2317 * - (-EAGAIN) if the reset temporarily failed and should be retried later.
2319 int rte_eth_dev_reset(uint16_t port_id);
2322 * Enable receipt in promiscuous mode for an Ethernet device.
2325 * The port identifier of the Ethernet device.
2327 void rte_eth_promiscuous_enable(uint16_t port_id);
2330 * Disable receipt in promiscuous mode for an Ethernet device.
2333 * The port identifier of the Ethernet device.
2335 void rte_eth_promiscuous_disable(uint16_t port_id);
2338 * Return the value of promiscuous mode for an Ethernet device.
2341 * The port identifier of the Ethernet device.
2343 * - (1) if promiscuous is enabled
2344 * - (0) if promiscuous is disabled.
2347 int rte_eth_promiscuous_get(uint16_t port_id);
2350 * Enable the receipt of any multicast frame by an Ethernet device.
2353 * The port identifier of the Ethernet device.
2355 void rte_eth_allmulticast_enable(uint16_t port_id);
2358 * Disable the receipt of all multicast frames by an Ethernet device.
2361 * The port identifier of the Ethernet device.
2363 void rte_eth_allmulticast_disable(uint16_t port_id);
2366 * Return the value of allmulticast mode for an Ethernet device.
2369 * The port identifier of the Ethernet device.
2371 * - (1) if allmulticast is enabled
2372 * - (0) if allmulticast is disabled.
2375 int rte_eth_allmulticast_get(uint16_t port_id);
2378 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2379 * or FULL-DUPLEX) of the physical link of an Ethernet device. It might need
2380 * to wait up to 9 seconds in it.
2383 * The port identifier of the Ethernet device.
2385 * A pointer to an *rte_eth_link* structure to be filled with
2386 * the status, the speed and the mode of the Ethernet device link.
2388 void rte_eth_link_get(uint16_t port_id, struct rte_eth_link *link);
2391 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2392 * or FULL-DUPLEX) of the physical link of an Ethernet device. It is a no-wait
2393 * version of rte_eth_link_get().
2396 * The port identifier of the Ethernet device.
2398 * A pointer to an *rte_eth_link* structure to be filled with
2399 * the status, the speed and the mode of the Ethernet device link.
2401 void rte_eth_link_get_nowait(uint16_t port_id, struct rte_eth_link *link);
2404 * Retrieve the general I/O statistics of an Ethernet device.
2407 * The port identifier of the Ethernet device.
2409 * A pointer to a structure of type *rte_eth_stats* to be filled with
2410 * the values of device counters for the following set of statistics:
2411 * - *ipackets* with the total of successfully received packets.
2412 * - *opackets* with the total of successfully transmitted packets.
2413 * - *ibytes* with the total of successfully received bytes.
2414 * - *obytes* with the total of successfully transmitted bytes.
2415 * - *ierrors* with the total of erroneous received packets.
2416 * - *oerrors* with the total of failed transmitted packets.
2418 * Zero if successful. Non-zero otherwise.
2420 int rte_eth_stats_get(uint16_t port_id, struct rte_eth_stats *stats);
2423 * Reset the general I/O statistics of an Ethernet device.
2426 * The port identifier of the Ethernet device.
2428 * - (0) if device notified to reset stats.
2429 * - (-ENOTSUP) if hardware doesn't support.
2430 * - (-ENODEV) if *port_id* invalid.
2432 int rte_eth_stats_reset(uint16_t port_id);
2435 * Retrieve names of extended statistics of an Ethernet device.
2438 * The port identifier of the Ethernet device.
2439 * @param xstats_names
2440 * An rte_eth_xstat_name array of at least *size* elements to
2441 * be filled. If set to NULL, the function returns the required number
2444 * The size of the xstats_names array (number of elements).
2446 * - A positive value lower or equal to size: success. The return value
2447 * is the number of entries filled in the stats table.
2448 * - A positive value higher than size: error, the given statistics table
2449 * is too small. The return value corresponds to the size that should
2450 * be given to succeed. The entries in the table are not valid and
2451 * shall not be used by the caller.
2452 * - A negative value on error (invalid port id).
2454 int rte_eth_xstats_get_names(uint16_t port_id,
2455 struct rte_eth_xstat_name *xstats_names,
2459 * Retrieve extended statistics of an Ethernet device.
2462 * The port identifier of the Ethernet device.
2464 * A pointer to a table of structure of type *rte_eth_xstat*
2465 * to be filled with device statistics ids and values: id is the
2466 * index of the name string in xstats_names (see rte_eth_xstats_get_names()),
2467 * and value is the statistic counter.
2468 * This parameter can be set to NULL if n is 0.
2470 * The size of the xstats array (number of elements).
2472 * - A positive value lower or equal to n: success. The return value
2473 * is the number of entries filled in the stats table.
2474 * - A positive value higher than n: error, the given statistics table
2475 * is too small. The return value corresponds to the size that should
2476 * be given to succeed. The entries in the table are not valid and
2477 * shall not be used by the caller.
2478 * - A negative value on error (invalid port id).
2480 int rte_eth_xstats_get(uint16_t port_id, struct rte_eth_xstat *xstats,
2484 * Retrieve names of extended statistics of an Ethernet device.
2487 * The port identifier of the Ethernet device.
2488 * @param xstats_names
2489 * An rte_eth_xstat_name array of at least *size* elements to
2490 * be filled. If set to NULL, the function returns the required number
2493 * IDs array given by app to retrieve specific statistics
2495 * The size of the xstats_names array (number of elements).
2497 * - A positive value lower or equal to size: success. The return value
2498 * is the number of entries filled in the stats table.
2499 * - A positive value higher than size: error, the given statistics table
2500 * is too small. The return value corresponds to the size that should
2501 * be given to succeed. The entries in the table are not valid and
2502 * shall not be used by the caller.
2503 * - A negative value on error (invalid port id).
2506 rte_eth_xstats_get_names_by_id(uint16_t port_id,
2507 struct rte_eth_xstat_name *xstats_names, unsigned int size,
2511 * Retrieve extended statistics of an Ethernet device.
2514 * The port identifier of the Ethernet device.
2516 * A pointer to an ids array passed by application. This tells which
2517 * statistics values function should retrieve. This parameter
2518 * can be set to NULL if size is 0. In this case function will retrieve
2519 * all avalible statistics.
2521 * A pointer to a table to be filled with device statistics values.
2523 * The size of the ids array (number of elements).
2525 * - A positive value lower or equal to size: success. The return value
2526 * is the number of entries filled in the stats table.
2527 * - A positive value higher than size: error, the given statistics table
2528 * is too small. The return value corresponds to the size that should
2529 * be given to succeed. The entries in the table are not valid and
2530 * shall not be used by the caller.
2531 * - A negative value on error (invalid port id).
2533 int rte_eth_xstats_get_by_id(uint16_t port_id, const uint64_t *ids,
2534 uint64_t *values, unsigned int size);
2537 * Gets the ID of a statistic from its name.
2539 * This function searches for the statistics using string compares, and
2540 * as such should not be used on the fast-path. For fast-path retrieval of
2541 * specific statistics, store the ID as provided in *id* from this function,
2542 * and pass the ID to rte_eth_xstats_get()
2544 * @param port_id The port to look up statistics from
2545 * @param xstat_name The name of the statistic to return
2546 * @param[out] id A pointer to an app-supplied uint64_t which should be
2547 * set to the ID of the stat if the stat exists.
2550 * -ENODEV for invalid port_id,
2551 * -EIO if device is removed,
2552 * -EINVAL if the xstat_name doesn't exist in port_id
2554 int rte_eth_xstats_get_id_by_name(uint16_t port_id, const char *xstat_name,
2558 * Reset extended statistics of an Ethernet device.
2561 * The port identifier of the Ethernet device.
2563 void rte_eth_xstats_reset(uint16_t port_id);
2566 * Set a mapping for the specified transmit queue to the specified per-queue
2567 * statistics counter.
2570 * The port identifier of the Ethernet device.
2571 * @param tx_queue_id
2572 * The index of the transmit queue for which a queue stats mapping is required.
2573 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2574 * to rte_eth_dev_configure().
2576 * The per-queue packet statistics functionality number that the transmit
2577 * queue is to be assigned.
2578 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2580 * Zero if successful. Non-zero otherwise.
2582 int rte_eth_dev_set_tx_queue_stats_mapping(uint16_t port_id,
2583 uint16_t tx_queue_id, uint8_t stat_idx);
2586 * Set a mapping for the specified receive queue to the specified per-queue
2587 * statistics counter.
2590 * The port identifier of the Ethernet device.
2591 * @param rx_queue_id
2592 * The index of the receive queue for which a queue stats mapping is required.
2593 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2594 * to rte_eth_dev_configure().
2596 * The per-queue packet statistics functionality number that the receive
2597 * queue is to be assigned.
2598 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2600 * Zero if successful. Non-zero otherwise.
2602 int rte_eth_dev_set_rx_queue_stats_mapping(uint16_t port_id,
2603 uint16_t rx_queue_id,
2607 * Retrieve the Ethernet address of an Ethernet device.
2610 * The port identifier of the Ethernet device.
2612 * A pointer to a structure of type *ether_addr* to be filled with
2613 * the Ethernet address of the Ethernet device.
2615 void rte_eth_macaddr_get(uint16_t port_id, struct ether_addr *mac_addr);
2618 * Retrieve the contextual information of an Ethernet device.
2621 * The port identifier of the Ethernet device.
2623 * A pointer to a structure of type *rte_eth_dev_info* to be filled with
2624 * the contextual information of the Ethernet device.
2626 void rte_eth_dev_info_get(uint16_t port_id, struct rte_eth_dev_info *dev_info);
2629 * Retrieve the firmware version of a device.
2632 * The port identifier of the device.
2634 * A pointer to a string array storing the firmware version of a device,
2635 * the string includes terminating null. This pointer is allocated by caller.
2637 * The size of the string array pointed by fw_version, which should be
2638 * large enough to store firmware version of the device.
2640 * - (0) if successful.
2641 * - (-ENOTSUP) if operation is not supported.
2642 * - (-ENODEV) if *port_id* invalid.
2643 * - (-EIO) if device is removed.
2644 * - (>0) if *fw_size* is not enough to store firmware version, return
2645 * the size of the non truncated string.
2647 int rte_eth_dev_fw_version_get(uint16_t port_id,
2648 char *fw_version, size_t fw_size);
2651 * Retrieve the supported packet types of an Ethernet device.
2653 * When a packet type is announced as supported, it *must* be recognized by
2654 * the PMD. For instance, if RTE_PTYPE_L2_ETHER, RTE_PTYPE_L2_ETHER_VLAN
2655 * and RTE_PTYPE_L3_IPV4 are announced, the PMD must return the following
2656 * packet types for these packets:
2657 * - Ether/IPv4 -> RTE_PTYPE_L2_ETHER | RTE_PTYPE_L3_IPV4
2658 * - Ether/Vlan/IPv4 -> RTE_PTYPE_L2_ETHER_VLAN | RTE_PTYPE_L3_IPV4
2659 * - Ether/[anything else] -> RTE_PTYPE_L2_ETHER
2660 * - Ether/Vlan/[anything else] -> RTE_PTYPE_L2_ETHER_VLAN
2662 * When a packet is received by a PMD, the most precise type must be
2663 * returned among the ones supported. However a PMD is allowed to set
2664 * packet type that is not in the supported list, at the condition that it
2665 * is more precise. Therefore, a PMD announcing no supported packet types
2666 * can still set a matching packet type in a received packet.
2669 * Better to invoke this API after the device is already started or rx burst
2670 * function is decided, to obtain correct supported ptypes.
2672 * if a given PMD does not report what ptypes it supports, then the supported
2673 * ptype count is reported as 0.
2675 * The port identifier of the Ethernet device.
2677 * A hint of what kind of packet type which the caller is interested in.
2679 * An array pointer to store adequate packet types, allocated by caller.
2681 * Size of the array pointed by param ptypes.
2683 * - (>=0) Number of supported ptypes. If the number of types exceeds num,
2684 * only num entries will be filled into the ptypes array, but the full
2685 * count of supported ptypes will be returned.
2686 * - (-ENODEV) if *port_id* invalid.
2688 int rte_eth_dev_get_supported_ptypes(uint16_t port_id, uint32_t ptype_mask,
2689 uint32_t *ptypes, int num);
2692 * Retrieve the MTU of an Ethernet device.
2695 * The port identifier of the Ethernet device.
2697 * A pointer to a uint16_t where the retrieved MTU is to be stored.
2699 * - (0) if successful.
2700 * - (-ENODEV) if *port_id* invalid.
2702 int rte_eth_dev_get_mtu(uint16_t port_id, uint16_t *mtu);
2705 * Change the MTU of an Ethernet device.
2708 * The port identifier of the Ethernet device.
2710 * A uint16_t for the MTU to be applied.
2712 * - (0) if successful.
2713 * - (-ENOTSUP) if operation is not supported.
2714 * - (-ENODEV) if *port_id* invalid.
2715 * - (-EIO) if device is removed.
2716 * - (-EINVAL) if *mtu* invalid.
2717 * - (-EBUSY) if operation is not allowed when the port is running
2719 int rte_eth_dev_set_mtu(uint16_t port_id, uint16_t mtu);
2722 * Enable/Disable hardware filtering by an Ethernet device of received
2723 * VLAN packets tagged with a given VLAN Tag Identifier.
2726 * The port identifier of the Ethernet device.
2728 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
2730 * If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*.
2731 * Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*.
2733 * - (0) if successful.
2734 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2735 * - (-ENODEV) if *port_id* invalid.
2736 * - (-EIO) if device is removed.
2737 * - (-ENOSYS) if VLAN filtering on *port_id* disabled.
2738 * - (-EINVAL) if *vlan_id* > 4095.
2740 int rte_eth_dev_vlan_filter(uint16_t port_id, uint16_t vlan_id, int on);
2743 * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
2744 * 82599/X540/X550 can support VLAN stripping at the rx queue level
2747 * The port identifier of the Ethernet device.
2748 * @param rx_queue_id
2749 * The index of the receive queue for which a queue stats mapping is required.
2750 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2751 * to rte_eth_dev_configure().
2753 * If 1, Enable VLAN Stripping of the receive queue of the Ethernet port.
2754 * If 0, Disable VLAN Stripping of the receive queue of the Ethernet port.
2756 * - (0) if successful.
2757 * - (-ENOSUP) if hardware-assisted VLAN stripping not configured.
2758 * - (-ENODEV) if *port_id* invalid.
2759 * - (-EINVAL) if *rx_queue_id* invalid.
2761 int rte_eth_dev_set_vlan_strip_on_queue(uint16_t port_id, uint16_t rx_queue_id,
2765 * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
2766 * the VLAN Header. This is a register setup available on some Intel NIC, not
2767 * but all, please check the data sheet for availability.
2770 * The port identifier of the Ethernet device.
2774 * The Tag Protocol ID
2776 * - (0) if successful.
2777 * - (-ENOSUP) if hardware-assisted VLAN TPID setup is not supported.
2778 * - (-ENODEV) if *port_id* invalid.
2779 * - (-EIO) if device is removed.
2781 int rte_eth_dev_set_vlan_ether_type(uint16_t port_id,
2782 enum rte_vlan_type vlan_type,
2786 * Set VLAN offload configuration on an Ethernet device
2787 * Enable/Disable Extended VLAN by an Ethernet device, This is a register setup
2788 * available on some Intel NIC, not but all, please check the data sheet for
2790 * Enable/Disable VLAN Strip can be done on rx queue for certain NIC, but here
2791 * the configuration is applied on the port level.
2794 * The port identifier of the Ethernet device.
2795 * @param offload_mask
2796 * The VLAN Offload bit mask can be mixed use with "OR"
2797 * ETH_VLAN_STRIP_OFFLOAD
2798 * ETH_VLAN_FILTER_OFFLOAD
2799 * ETH_VLAN_EXTEND_OFFLOAD
2801 * - (0) if successful.
2802 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2803 * - (-ENODEV) if *port_id* invalid.
2804 * - (-EIO) if device is removed.
2806 int rte_eth_dev_set_vlan_offload(uint16_t port_id, int offload_mask);
2809 * Read VLAN Offload configuration from an Ethernet device
2812 * The port identifier of the Ethernet device.
2814 * - (>0) if successful. Bit mask to indicate
2815 * ETH_VLAN_STRIP_OFFLOAD
2816 * ETH_VLAN_FILTER_OFFLOAD
2817 * ETH_VLAN_EXTEND_OFFLOAD
2818 * - (-ENODEV) if *port_id* invalid.
2820 int rte_eth_dev_get_vlan_offload(uint16_t port_id);
2823 * Set port based TX VLAN insertion on or off.
2826 * The port identifier of the Ethernet device.
2828 * Port based TX VLAN identifier together with user priority.
2830 * Turn on or off the port based TX VLAN insertion.
2833 * - (0) if successful.
2834 * - negative if failed.
2836 int rte_eth_dev_set_vlan_pvid(uint16_t port_id, uint16_t pvid, int on);
2840 * Retrieve a burst of input packets from a receive queue of an Ethernet
2841 * device. The retrieved packets are stored in *rte_mbuf* structures whose
2842 * pointers are supplied in the *rx_pkts* array.
2844 * The rte_eth_rx_burst() function loops, parsing the RX ring of the
2845 * receive queue, up to *nb_pkts* packets, and for each completed RX
2846 * descriptor in the ring, it performs the following operations:
2848 * - Initialize the *rte_mbuf* data structure associated with the
2849 * RX descriptor according to the information provided by the NIC into
2850 * that RX descriptor.
2852 * - Store the *rte_mbuf* data structure into the next entry of the
2855 * - Replenish the RX descriptor with a new *rte_mbuf* buffer
2856 * allocated from the memory pool associated with the receive queue at
2857 * initialization time.
2859 * When retrieving an input packet that was scattered by the controller
2860 * into multiple receive descriptors, the rte_eth_rx_burst() function
2861 * appends the associated *rte_mbuf* buffers to the first buffer of the
2864 * The rte_eth_rx_burst() function returns the number of packets
2865 * actually retrieved, which is the number of *rte_mbuf* data structures
2866 * effectively supplied into the *rx_pkts* array.
2867 * A return value equal to *nb_pkts* indicates that the RX queue contained
2868 * at least *rx_pkts* packets, and this is likely to signify that other
2869 * received packets remain in the input queue. Applications implementing
2870 * a "retrieve as much received packets as possible" policy can check this
2871 * specific case and keep invoking the rte_eth_rx_burst() function until
2872 * a value less than *nb_pkts* is returned.
2874 * This receive method has the following advantages:
2876 * - It allows a run-to-completion network stack engine to retrieve and
2877 * to immediately process received packets in a fast burst-oriented
2878 * approach, avoiding the overhead of unnecessary intermediate packet
2879 * queue/dequeue operations.
2881 * - Conversely, it also allows an asynchronous-oriented processing
2882 * method to retrieve bursts of received packets and to immediately
2883 * queue them for further parallel processing by another logical core,
2884 * for instance. However, instead of having received packets being
2885 * individually queued by the driver, this approach allows the caller
2886 * of the rte_eth_rx_burst() function to queue a burst of retrieved
2887 * packets at a time and therefore dramatically reduce the cost of
2888 * enqueue/dequeue operations per packet.
2890 * - It allows the rte_eth_rx_burst() function of the driver to take
2891 * advantage of burst-oriented hardware features (CPU cache,
2892 * prefetch instructions, and so on) to minimize the number of CPU
2893 * cycles per packet.
2895 * To summarize, the proposed receive API enables many
2896 * burst-oriented optimizations in both synchronous and asynchronous
2897 * packet processing environments with no overhead in both cases.
2899 * The rte_eth_rx_burst() function does not provide any error
2900 * notification to avoid the corresponding overhead. As a hint, the
2901 * upper-level application might check the status of the device link once
2902 * being systematically returned a 0 value for a given number of tries.
2905 * The port identifier of the Ethernet device.
2907 * The index of the receive queue from which to retrieve input packets.
2908 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2909 * to rte_eth_dev_configure().
2911 * The address of an array of pointers to *rte_mbuf* structures that
2912 * must be large enough to store *nb_pkts* pointers in it.
2914 * The maximum number of packets to retrieve.
2916 * The number of packets actually retrieved, which is the number
2917 * of pointers to *rte_mbuf* structures effectively supplied to the
2920 static inline uint16_t
2921 rte_eth_rx_burst(uint16_t port_id, uint16_t queue_id,
2922 struct rte_mbuf **rx_pkts, const uint16_t nb_pkts)
2924 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2926 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2927 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
2928 RTE_FUNC_PTR_OR_ERR_RET(*dev->rx_pkt_burst, 0);
2930 if (queue_id >= dev->data->nb_rx_queues) {
2931 RTE_PMD_DEBUG_TRACE("Invalid RX queue_id=%d\n", queue_id);
2935 int16_t nb_rx = (*dev->rx_pkt_burst)(dev->data->rx_queues[queue_id],
2938 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
2939 struct rte_eth_rxtx_callback *cb = dev->post_rx_burst_cbs[queue_id];
2941 if (unlikely(cb != NULL)) {
2943 nb_rx = cb->fn.rx(port_id, queue_id, rx_pkts, nb_rx,
2944 nb_pkts, cb->param);
2946 } while (cb != NULL);
2954 * Get the number of used descriptors of a rx queue
2957 * The port identifier of the Ethernet device.
2959 * The queue id on the specific port.
2961 * The number of used descriptors in the specific queue, or:
2962 * (-EINVAL) if *port_id* or *queue_id* is invalid
2963 * (-ENOTSUP) if the device does not support this function
2966 rte_eth_rx_queue_count(uint16_t port_id, uint16_t queue_id)
2968 struct rte_eth_dev *dev;
2970 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -EINVAL);
2971 dev = &rte_eth_devices[port_id];
2972 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_queue_count, -ENOTSUP);
2973 if (queue_id >= dev->data->nb_rx_queues)
2976 return (*dev->dev_ops->rx_queue_count)(dev, queue_id);
2980 * Check if the DD bit of the specific RX descriptor in the queue has been set
2983 * The port identifier of the Ethernet device.
2985 * The queue id on the specific port.
2987 * The offset of the descriptor ID from tail.
2989 * - (1) if the specific DD bit is set.
2990 * - (0) if the specific DD bit is not set.
2991 * - (-ENODEV) if *port_id* invalid.
2992 * - (-ENOTSUP) if the device does not support this function
2995 rte_eth_rx_descriptor_done(uint16_t port_id, uint16_t queue_id, uint16_t offset)
2997 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2998 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
2999 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_descriptor_done, -ENOTSUP);
3000 return (*dev->dev_ops->rx_descriptor_done)( \
3001 dev->data->rx_queues[queue_id], offset);
3004 #define RTE_ETH_RX_DESC_AVAIL 0 /**< Desc available for hw. */
3005 #define RTE_ETH_RX_DESC_DONE 1 /**< Desc done, filled by hw. */
3006 #define RTE_ETH_RX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */
3009 * Check the status of a Rx descriptor in the queue
3011 * It should be called in a similar context than the Rx function:
3012 * - on a dataplane core
3013 * - not concurrently on the same queue
3015 * Since it's a dataplane function, no check is performed on port_id and
3016 * queue_id. The caller must therefore ensure that the port is enabled
3017 * and the queue is configured and running.
3019 * Note: accessing to a random descriptor in the ring may trigger cache
3020 * misses and have a performance impact.
3023 * A valid port identifier of the Ethernet device which.
3025 * A valid Rx queue identifier on this port.
3027 * The offset of the descriptor starting from tail (0 is the next
3028 * packet to be received by the driver).
3031 * - (RTE_ETH_RX_DESC_AVAIL): Descriptor is available for the hardware to
3033 * - (RTE_ETH_RX_DESC_DONE): Descriptor is done, it is filled by hw, but
3034 * not yet processed by the driver (i.e. in the receive queue).
3035 * - (RTE_ETH_RX_DESC_UNAVAIL): Descriptor is unavailable, either hold by
3036 * the driver and not yet returned to hw, or reserved by the hw.
3037 * - (-EINVAL) bad descriptor offset.
3038 * - (-ENOTSUP) if the device does not support this function.
3039 * - (-ENODEV) bad port or queue (only if compiled with debug).
3042 rte_eth_rx_descriptor_status(uint16_t port_id, uint16_t queue_id,
3045 struct rte_eth_dev *dev;
3048 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3049 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
3051 dev = &rte_eth_devices[port_id];
3052 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3053 if (queue_id >= dev->data->nb_rx_queues)
3056 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_descriptor_status, -ENOTSUP);
3057 rxq = dev->data->rx_queues[queue_id];
3059 return (*dev->dev_ops->rx_descriptor_status)(rxq, offset);
3062 #define RTE_ETH_TX_DESC_FULL 0 /**< Desc filled for hw, waiting xmit. */
3063 #define RTE_ETH_TX_DESC_DONE 1 /**< Desc done, packet is transmitted. */
3064 #define RTE_ETH_TX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */
3067 * Check the status of a Tx descriptor in the queue.
3069 * It should be called in a similar context than the Tx function:
3070 * - on a dataplane core
3071 * - not concurrently on the same queue
3073 * Since it's a dataplane function, no check is performed on port_id and
3074 * queue_id. The caller must therefore ensure that the port is enabled
3075 * and the queue is configured and running.
3077 * Note: accessing to a random descriptor in the ring may trigger cache
3078 * misses and have a performance impact.
3081 * A valid port identifier of the Ethernet device which.
3083 * A valid Tx queue identifier on this port.
3085 * The offset of the descriptor starting from tail (0 is the place where
3086 * the next packet will be send).
3089 * - (RTE_ETH_TX_DESC_FULL) Descriptor is being processed by the hw, i.e.
3090 * in the transmit queue.
3091 * - (RTE_ETH_TX_DESC_DONE) Hardware is done with this descriptor, it can
3092 * be reused by the driver.
3093 * - (RTE_ETH_TX_DESC_UNAVAIL): Descriptor is unavailable, reserved by the
3094 * driver or the hardware.
3095 * - (-EINVAL) bad descriptor offset.
3096 * - (-ENOTSUP) if the device does not support this function.
3097 * - (-ENODEV) bad port or queue (only if compiled with debug).
3099 static inline int rte_eth_tx_descriptor_status(uint16_t port_id,
3100 uint16_t queue_id, uint16_t offset)
3102 struct rte_eth_dev *dev;
3105 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3106 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
3108 dev = &rte_eth_devices[port_id];
3109 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3110 if (queue_id >= dev->data->nb_tx_queues)
3113 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->tx_descriptor_status, -ENOTSUP);
3114 txq = dev->data->tx_queues[queue_id];
3116 return (*dev->dev_ops->tx_descriptor_status)(txq, offset);
3120 * Send a burst of output packets on a transmit queue of an Ethernet device.
3122 * The rte_eth_tx_burst() function is invoked to transmit output packets
3123 * on the output queue *queue_id* of the Ethernet device designated by its
3125 * The *nb_pkts* parameter is the number of packets to send which are
3126 * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
3127 * allocated from a pool created with rte_pktmbuf_pool_create().
3128 * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
3129 * up to the number of transmit descriptors available in the TX ring of the
3131 * For each packet to send, the rte_eth_tx_burst() function performs
3132 * the following operations:
3134 * - Pick up the next available descriptor in the transmit ring.
3136 * - Free the network buffer previously sent with that descriptor, if any.
3138 * - Initialize the transmit descriptor with the information provided
3139 * in the *rte_mbuf data structure.
3141 * In the case of a segmented packet composed of a list of *rte_mbuf* buffers,
3142 * the rte_eth_tx_burst() function uses several transmit descriptors
3145 * The rte_eth_tx_burst() function returns the number of packets it
3146 * actually sent. A return value equal to *nb_pkts* means that all packets
3147 * have been sent, and this is likely to signify that other output packets
3148 * could be immediately transmitted again. Applications that implement a
3149 * "send as many packets to transmit as possible" policy can check this
3150 * specific case and keep invoking the rte_eth_tx_burst() function until
3151 * a value less than *nb_pkts* is returned.
3153 * It is the responsibility of the rte_eth_tx_burst() function to
3154 * transparently free the memory buffers of packets previously sent.
3155 * This feature is driven by the *tx_free_thresh* value supplied to the
3156 * rte_eth_dev_configure() function at device configuration time.
3157 * When the number of free TX descriptors drops below this threshold, the
3158 * rte_eth_tx_burst() function must [attempt to] free the *rte_mbuf* buffers
3159 * of those packets whose transmission was effectively completed.
3161 * If the PMD is DEV_TX_OFFLOAD_MT_LOCKFREE capable, multiple threads can
3162 * invoke this function concurrently on the same tx queue without SW lock.
3163 * @see rte_eth_dev_info_get, struct rte_eth_txconf::txq_flags
3166 * The port identifier of the Ethernet device.
3168 * The index of the transmit queue through which output packets must be
3170 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3171 * to rte_eth_dev_configure().
3173 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
3174 * which contain the output packets.
3176 * The maximum number of packets to transmit.
3178 * The number of output packets actually stored in transmit descriptors of
3179 * the transmit ring. The return value can be less than the value of the
3180 * *tx_pkts* parameter when the transmit ring is full or has been filled up.
3182 static inline uint16_t
3183 rte_eth_tx_burst(uint16_t port_id, uint16_t queue_id,
3184 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
3186 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
3188 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3189 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
3190 RTE_FUNC_PTR_OR_ERR_RET(*dev->tx_pkt_burst, 0);
3192 if (queue_id >= dev->data->nb_tx_queues) {
3193 RTE_PMD_DEBUG_TRACE("Invalid TX queue_id=%d\n", queue_id);
3198 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
3199 struct rte_eth_rxtx_callback *cb = dev->pre_tx_burst_cbs[queue_id];
3201 if (unlikely(cb != NULL)) {
3203 nb_pkts = cb->fn.tx(port_id, queue_id, tx_pkts, nb_pkts,
3206 } while (cb != NULL);
3210 return (*dev->tx_pkt_burst)(dev->data->tx_queues[queue_id], tx_pkts, nb_pkts);
3215 * @b EXPERIMENTAL: this API may change without prior notice
3217 * Process a burst of output packets on a transmit queue of an Ethernet device.
3219 * The rte_eth_tx_prepare() function is invoked to prepare output packets to be
3220 * transmitted on the output queue *queue_id* of the Ethernet device designated
3222 * The *nb_pkts* parameter is the number of packets to be prepared which are
3223 * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
3224 * allocated from a pool created with rte_pktmbuf_pool_create().
3225 * For each packet to send, the rte_eth_tx_prepare() function performs
3226 * the following operations:
3228 * - Check if packet meets devices requirements for tx offloads.
3230 * - Check limitations about number of segments.
3232 * - Check additional requirements when debug is enabled.
3234 * - Update and/or reset required checksums when tx offload is set for packet.
3236 * Since this function can modify packet data, provided mbufs must be safely
3237 * writable (e.g. modified data cannot be in shared segment).
3239 * The rte_eth_tx_prepare() function returns the number of packets ready to be
3240 * sent. A return value equal to *nb_pkts* means that all packets are valid and
3241 * ready to be sent, otherwise stops processing on the first invalid packet and
3242 * leaves the rest packets untouched.
3244 * When this functionality is not implemented in the driver, all packets are
3245 * are returned untouched.
3248 * The port identifier of the Ethernet device.
3249 * The value must be a valid port id.
3251 * The index of the transmit queue through which output packets must be
3253 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3254 * to rte_eth_dev_configure().
3256 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
3257 * which contain the output packets.
3259 * The maximum number of packets to process.
3261 * The number of packets correct and ready to be sent. The return value can be
3262 * less than the value of the *tx_pkts* parameter when some packet doesn't
3263 * meet devices requirements with rte_errno set appropriately:
3264 * - -EINVAL: offload flags are not correctly set
3265 * - -ENOTSUP: the offload feature is not supported by the hardware
3269 #ifndef RTE_ETHDEV_TX_PREPARE_NOOP
3271 static inline uint16_t
3272 rte_eth_tx_prepare(uint16_t port_id, uint16_t queue_id,
3273 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
3275 struct rte_eth_dev *dev;
3277 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3278 if (!rte_eth_dev_is_valid_port(port_id)) {
3279 RTE_PMD_DEBUG_TRACE("Invalid TX port_id=%d\n", port_id);
3280 rte_errno = -EINVAL;
3285 dev = &rte_eth_devices[port_id];
3287 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3288 if (queue_id >= dev->data->nb_tx_queues) {
3289 RTE_PMD_DEBUG_TRACE("Invalid TX queue_id=%d\n", queue_id);
3290 rte_errno = -EINVAL;
3295 if (!dev->tx_pkt_prepare)
3298 return (*dev->tx_pkt_prepare)(dev->data->tx_queues[queue_id],
3305 * Native NOOP operation for compilation targets which doesn't require any
3306 * preparations steps, and functional NOOP may introduce unnecessary performance
3309 * Generally this is not a good idea to turn it on globally and didn't should
3310 * be used if behavior of tx_preparation can change.
3313 static inline uint16_t
3314 rte_eth_tx_prepare(__rte_unused uint16_t port_id,
3315 __rte_unused uint16_t queue_id,
3316 __rte_unused struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
3323 typedef void (*buffer_tx_error_fn)(struct rte_mbuf **unsent, uint16_t count,
3327 * Structure used to buffer packets for future TX
3328 * Used by APIs rte_eth_tx_buffer and rte_eth_tx_buffer_flush
3330 struct rte_eth_dev_tx_buffer {
3331 buffer_tx_error_fn error_callback;
3332 void *error_userdata;
3333 uint16_t size; /**< Size of buffer for buffered tx */
3334 uint16_t length; /**< Number of packets in the array */
3335 struct rte_mbuf *pkts[];
3336 /**< Pending packets to be sent on explicit flush or when full */
3340 * Calculate the size of the tx buffer.
3343 * Number of stored packets.
3345 #define RTE_ETH_TX_BUFFER_SIZE(sz) \
3346 (sizeof(struct rte_eth_dev_tx_buffer) + (sz) * sizeof(struct rte_mbuf *))
3349 * Initialize default values for buffered transmitting
3352 * Tx buffer to be initialized.
3359 rte_eth_tx_buffer_init(struct rte_eth_dev_tx_buffer *buffer, uint16_t size);
3362 * Send any packets queued up for transmission on a port and HW queue
3364 * This causes an explicit flush of packets previously buffered via the
3365 * rte_eth_tx_buffer() function. It returns the number of packets successfully
3366 * sent to the NIC, and calls the error callback for any unsent packets. Unless
3367 * explicitly set up otherwise, the default callback simply frees the unsent
3368 * packets back to the owning mempool.
3371 * The port identifier of the Ethernet device.
3373 * The index of the transmit queue through which output packets must be
3375 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3376 * to rte_eth_dev_configure().
3378 * Buffer of packets to be transmit.
3380 * The number of packets successfully sent to the Ethernet device. The error
3381 * callback is called for any packets which could not be sent.
3383 static inline uint16_t
3384 rte_eth_tx_buffer_flush(uint16_t port_id, uint16_t queue_id,
3385 struct rte_eth_dev_tx_buffer *buffer)
3388 uint16_t to_send = buffer->length;
3393 sent = rte_eth_tx_burst(port_id, queue_id, buffer->pkts, to_send);
3397 /* All packets sent, or to be dealt with by callback below */
3398 if (unlikely(sent != to_send))
3399 buffer->error_callback(&buffer->pkts[sent], to_send - sent,
3400 buffer->error_userdata);
3406 * Buffer a single packet for future transmission on a port and queue
3408 * This function takes a single mbuf/packet and buffers it for later
3409 * transmission on the particular port and queue specified. Once the buffer is
3410 * full of packets, an attempt will be made to transmit all the buffered
3411 * packets. In case of error, where not all packets can be transmitted, a
3412 * callback is called with the unsent packets as a parameter. If no callback
3413 * is explicitly set up, the unsent packets are just freed back to the owning
3414 * mempool. The function returns the number of packets actually sent i.e.
3415 * 0 if no buffer flush occurred, otherwise the number of packets successfully
3419 * The port identifier of the Ethernet device.
3421 * The index of the transmit queue through which output packets must be
3423 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3424 * to rte_eth_dev_configure().
3426 * Buffer used to collect packets to be sent.
3428 * Pointer to the packet mbuf to be sent.
3430 * 0 = packet has been buffered for later transmission
3431 * N > 0 = packet has been buffered, and the buffer was subsequently flushed,
3432 * causing N packets to be sent, and the error callback to be called for
3435 static __rte_always_inline uint16_t
3436 rte_eth_tx_buffer(uint16_t port_id, uint16_t queue_id,
3437 struct rte_eth_dev_tx_buffer *buffer, struct rte_mbuf *tx_pkt)
3439 buffer->pkts[buffer->length++] = tx_pkt;
3440 if (buffer->length < buffer->size)
3443 return rte_eth_tx_buffer_flush(port_id, queue_id, buffer);
3447 * Configure a callback for buffered packets which cannot be sent
3449 * Register a specific callback to be called when an attempt is made to send
3450 * all packets buffered on an ethernet port, but not all packets can
3451 * successfully be sent. The callback registered here will be called only
3452 * from calls to rte_eth_tx_buffer() and rte_eth_tx_buffer_flush() APIs.
3453 * The default callback configured for each queue by default just frees the
3454 * packets back to the calling mempool. If additional behaviour is required,
3455 * for example, to count dropped packets, or to retry transmission of packets
3456 * which cannot be sent, this function should be used to register a suitable
3457 * callback function to implement the desired behaviour.
3458 * The example callback "rte_eth_count_unsent_packet_callback()" is also
3459 * provided as reference.
3462 * The port identifier of the Ethernet device.
3464 * The function to be used as the callback.
3466 * Arbitrary parameter to be passed to the callback function
3468 * 0 on success, or -1 on error with rte_errno set appropriately
3471 rte_eth_tx_buffer_set_err_callback(struct rte_eth_dev_tx_buffer *buffer,
3472 buffer_tx_error_fn callback, void *userdata);
3475 * Callback function for silently dropping unsent buffered packets.
3477 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
3478 * adjust the default behavior when buffered packets cannot be sent. This
3479 * function drops any unsent packets silently and is used by tx buffered
3480 * operations as default behavior.
3482 * NOTE: this function should not be called directly, instead it should be used
3483 * as a callback for packet buffering.
3485 * NOTE: when configuring this function as a callback with
3486 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
3487 * should point to an uint64_t value.
3490 * The previously buffered packets which could not be sent
3492 * The number of unsent packets in the pkts array
3497 rte_eth_tx_buffer_drop_callback(struct rte_mbuf **pkts, uint16_t unsent,
3501 * Callback function for tracking unsent buffered packets.
3503 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
3504 * adjust the default behavior when buffered packets cannot be sent. This
3505 * function drops any unsent packets, but also updates a user-supplied counter
3506 * to track the overall number of packets dropped. The counter should be an
3507 * uint64_t variable.
3509 * NOTE: this function should not be called directly, instead it should be used
3510 * as a callback for packet buffering.
3512 * NOTE: when configuring this function as a callback with
3513 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
3514 * should point to an uint64_t value.
3517 * The previously buffered packets which could not be sent
3519 * The number of unsent packets in the pkts array
3521 * Pointer to an uint64_t value, which will be incremented by unsent
3524 rte_eth_tx_buffer_count_callback(struct rte_mbuf **pkts, uint16_t unsent,
3528 * Request the driver to free mbufs currently cached by the driver. The
3529 * driver will only free the mbuf if it is no longer in use. It is the
3530 * application's responsibity to ensure rte_eth_tx_buffer_flush(..) is
3534 * The port identifier of the Ethernet device.
3536 * The index of the transmit queue through which output packets must be
3538 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3539 * to rte_eth_dev_configure().
3541 * Maximum number of packets to free. Use 0 to indicate all possible packets
3542 * should be freed. Note that a packet may be using multiple mbufs.
3545 * -ENODEV: Invalid interface
3546 * -EIO: device is removed
3547 * -ENOTSUP: Driver does not support function
3549 * 0-n: Number of packets freed. More packets may still remain in ring that
3553 rte_eth_tx_done_cleanup(uint16_t port_id, uint16_t queue_id, uint32_t free_cnt);
3556 * The eth device event type for interrupt, and maybe others in the future.
3558 enum rte_eth_event_type {
3559 RTE_ETH_EVENT_UNKNOWN, /**< unknown event type */
3560 RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
3561 RTE_ETH_EVENT_QUEUE_STATE,
3562 /**< queue state event (enabled/disabled) */
3563 RTE_ETH_EVENT_INTR_RESET,
3564 /**< reset interrupt event, sent to VF on PF reset */
3565 RTE_ETH_EVENT_VF_MBOX, /**< message from the VF received by PF */
3566 RTE_ETH_EVENT_MACSEC, /**< MACsec offload related event */
3567 RTE_ETH_EVENT_INTR_RMV, /**< device removal event */
3568 RTE_ETH_EVENT_NEW, /**< port is probed */
3569 RTE_ETH_EVENT_DESTROY, /**< port is released */
3570 RTE_ETH_EVENT_MAX /**< max value of this enum */
3573 typedef int (*rte_eth_dev_cb_fn)(uint16_t port_id,
3574 enum rte_eth_event_type event, void *cb_arg, void *ret_param);
3575 /**< user application callback to be registered for interrupts */
3580 * Register a callback function for port event.
3584 * RTE_ETH_ALL means register the event for all port ids.
3588 * User supplied callback function to be called.
3590 * Pointer to the parameters for the registered callback.
3593 * - On success, zero.
3594 * - On failure, a negative value.
3596 int rte_eth_dev_callback_register(uint16_t port_id,
3597 enum rte_eth_event_type event,
3598 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
3601 * Unregister a callback function for port event.
3605 * RTE_ETH_ALL means unregister the event for all port ids.
3609 * User supplied callback function to be called.
3611 * Pointer to the parameters for the registered callback. -1 means to
3612 * remove all for the same callback address and same event.
3615 * - On success, zero.
3616 * - On failure, a negative value.
3618 int rte_eth_dev_callback_unregister(uint16_t port_id,
3619 enum rte_eth_event_type event,
3620 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
3623 * @internal Executes all the user application registered callbacks for
3624 * the specific device. It is for DPDK internal user only. User
3625 * application should not call it directly.
3628 * Pointer to struct rte_eth_dev.
3630 * Eth device interrupt event type.
3632 * To pass data back to user application.
3633 * This allows the user application to decide if a particular function
3634 * is permitted or not.
3639 int _rte_eth_dev_callback_process(struct rte_eth_dev *dev,
3640 enum rte_eth_event_type event, void *ret_param);
3643 * When there is no rx packet coming in Rx Queue for a long time, we can
3644 * sleep lcore related to RX Queue for power saving, and enable rx interrupt
3645 * to be triggered when Rx packet arrives.
3647 * The rte_eth_dev_rx_intr_enable() function enables rx queue
3648 * interrupt on specific rx queue of a port.
3651 * The port identifier of the Ethernet device.
3653 * The index of the receive queue from which to retrieve input packets.
3654 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3655 * to rte_eth_dev_configure().
3657 * - (0) if successful.
3658 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3660 * - (-ENODEV) if *port_id* invalid.
3661 * - (-EIO) if device is removed.
3663 int rte_eth_dev_rx_intr_enable(uint16_t port_id, uint16_t queue_id);
3666 * When lcore wakes up from rx interrupt indicating packet coming, disable rx
3667 * interrupt and returns to polling mode.
3669 * The rte_eth_dev_rx_intr_disable() function disables rx queue
3670 * interrupt on specific rx queue of a port.
3673 * The port identifier of the Ethernet device.
3675 * The index of the receive queue from which to retrieve input packets.
3676 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3677 * to rte_eth_dev_configure().
3679 * - (0) if successful.
3680 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3682 * - (-ENODEV) if *port_id* invalid.
3683 * - (-EIO) if device is removed.
3685 int rte_eth_dev_rx_intr_disable(uint16_t port_id, uint16_t queue_id);
3688 * RX Interrupt control per port.
3691 * The port identifier of the Ethernet device.
3693 * Epoll instance fd which the intr vector associated to.
3694 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
3696 * The operation be performed for the vector.
3697 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
3701 * - On success, zero.
3702 * - On failure, a negative value.
3704 int rte_eth_dev_rx_intr_ctl(uint16_t port_id, int epfd, int op, void *data);
3707 * RX Interrupt control per queue.
3710 * The port identifier of the Ethernet device.
3712 * The index of the receive queue from which to retrieve input packets.
3713 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3714 * to rte_eth_dev_configure().
3716 * Epoll instance fd which the intr vector associated to.
3717 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
3719 * The operation be performed for the vector.
3720 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
3724 * - On success, zero.
3725 * - On failure, a negative value.
3727 int rte_eth_dev_rx_intr_ctl_q(uint16_t port_id, uint16_t queue_id,
3728 int epfd, int op, void *data);
3731 * Turn on the LED on the Ethernet device.
3732 * This function turns on the LED on the Ethernet device.
3735 * The port identifier of the Ethernet device.
3737 * - (0) if successful.
3738 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3740 * - (-ENODEV) if *port_id* invalid.
3741 * - (-EIO) if device is removed.
3743 int rte_eth_led_on(uint16_t port_id);
3746 * Turn off the LED on the Ethernet device.
3747 * This function turns off the LED on the Ethernet device.
3750 * The port identifier of the Ethernet device.
3752 * - (0) if successful.
3753 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3755 * - (-ENODEV) if *port_id* invalid.
3756 * - (-EIO) if device is removed.
3758 int rte_eth_led_off(uint16_t port_id);
3761 * Get current status of the Ethernet link flow control for Ethernet device
3764 * The port identifier of the Ethernet device.
3766 * The pointer to the structure where to store the flow control parameters.
3768 * - (0) if successful.
3769 * - (-ENOTSUP) if hardware doesn't support flow control.
3770 * - (-ENODEV) if *port_id* invalid.
3771 * - (-EIO) if device is removed.
3773 int rte_eth_dev_flow_ctrl_get(uint16_t port_id,
3774 struct rte_eth_fc_conf *fc_conf);
3777 * Configure the Ethernet link flow control for Ethernet device
3780 * The port identifier of the Ethernet device.
3782 * The pointer to the structure of the flow control parameters.
3784 * - (0) if successful.
3785 * - (-ENOTSUP) if hardware doesn't support flow control mode.
3786 * - (-ENODEV) if *port_id* invalid.
3787 * - (-EINVAL) if bad parameter
3788 * - (-EIO) if flow control setup failure or device is removed.
3790 int rte_eth_dev_flow_ctrl_set(uint16_t port_id,
3791 struct rte_eth_fc_conf *fc_conf);
3794 * Configure the Ethernet priority flow control under DCB environment
3795 * for Ethernet device.
3798 * The port identifier of the Ethernet device.
3800 * The pointer to the structure of the priority flow control parameters.
3802 * - (0) if successful.
3803 * - (-ENOTSUP) if hardware doesn't support priority flow control mode.
3804 * - (-ENODEV) if *port_id* invalid.
3805 * - (-EINVAL) if bad parameter
3806 * - (-EIO) if flow control setup failure or device is removed.
3808 int rte_eth_dev_priority_flow_ctrl_set(uint16_t port_id,
3809 struct rte_eth_pfc_conf *pfc_conf);
3812 * Add a MAC address to an internal array of addresses used to enable whitelist
3813 * filtering to accept packets only if the destination MAC address matches.
3816 * The port identifier of the Ethernet device.
3818 * The MAC address to add.
3820 * VMDq pool index to associate address with (if VMDq is enabled). If VMDq is
3821 * not enabled, this should be set to 0.
3823 * - (0) if successfully added or *mac_addr" was already added.
3824 * - (-ENOTSUP) if hardware doesn't support this feature.
3825 * - (-ENODEV) if *port* is invalid.
3826 * - (-EIO) if device is removed.
3827 * - (-ENOSPC) if no more MAC addresses can be added.
3828 * - (-EINVAL) if MAC address is invalid.
3830 int rte_eth_dev_mac_addr_add(uint16_t port, struct ether_addr *mac_addr,
3834 * Remove a MAC address from the internal array of addresses.
3837 * The port identifier of the Ethernet device.
3839 * MAC address to remove.
3841 * - (0) if successful, or *mac_addr* didn't exist.
3842 * - (-ENOTSUP) if hardware doesn't support.
3843 * - (-ENODEV) if *port* invalid.
3844 * - (-EADDRINUSE) if attempting to remove the default MAC address
3846 int rte_eth_dev_mac_addr_remove(uint16_t port, struct ether_addr *mac_addr);
3849 * Set the default MAC address.
3852 * The port identifier of the Ethernet device.
3854 * New default MAC address.
3856 * - (0) if successful, or *mac_addr* didn't exist.
3857 * - (-ENOTSUP) if hardware doesn't support.
3858 * - (-ENODEV) if *port* invalid.
3859 * - (-EINVAL) if MAC address is invalid.
3861 int rte_eth_dev_default_mac_addr_set(uint16_t port,
3862 struct ether_addr *mac_addr);
3865 * Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3868 * The port identifier of the Ethernet device.
3872 * Redirection table size. The table size can be queried by
3873 * rte_eth_dev_info_get().
3875 * - (0) if successful.
3876 * - (-ENOTSUP) if hardware doesn't support.
3877 * - (-EINVAL) if bad parameter.
3878 * - (-EIO) if device is removed.
3880 int rte_eth_dev_rss_reta_update(uint16_t port,
3881 struct rte_eth_rss_reta_entry64 *reta_conf,
3882 uint16_t reta_size);
3885 * Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3888 * The port identifier of the Ethernet device.
3892 * Redirection table size. The table size can be queried by
3893 * rte_eth_dev_info_get().
3895 * - (0) if successful.
3896 * - (-ENOTSUP) if hardware doesn't support.
3897 * - (-EINVAL) if bad parameter.
3898 * - (-EIO) if device is removed.
3900 int rte_eth_dev_rss_reta_query(uint16_t port,
3901 struct rte_eth_rss_reta_entry64 *reta_conf,
3902 uint16_t reta_size);
3905 * Updates unicast hash table for receiving packet with the given destination
3906 * MAC address, and the packet is routed to all VFs for which the RX mode is
3907 * accept packets that match the unicast hash table.
3910 * The port identifier of the Ethernet device.
3912 * Unicast MAC address.
3914 * 1 - Set an unicast hash bit for receiving packets with the MAC address.
3915 * 0 - Clear an unicast hash bit.
3917 * - (0) if successful.
3918 * - (-ENOTSUP) if hardware doesn't support.
3919 * - (-ENODEV) if *port_id* invalid.
3920 * - (-EIO) if device is removed.
3921 * - (-EINVAL) if bad parameter.
3923 int rte_eth_dev_uc_hash_table_set(uint16_t port, struct ether_addr *addr,
3927 * Updates all unicast hash bitmaps for receiving packet with any Unicast
3928 * Ethernet MAC addresses,the packet is routed to all VFs for which the RX
3929 * mode is accept packets that match the unicast hash table.
3932 * The port identifier of the Ethernet device.
3934 * 1 - Set all unicast hash bitmaps for receiving all the Ethernet
3936 * 0 - Clear all unicast hash bitmaps
3938 * - (0) if successful.
3939 * - (-ENOTSUP) if hardware doesn't support.
3940 * - (-ENODEV) if *port_id* invalid.
3941 * - (-EIO) if device is removed.
3942 * - (-EINVAL) if bad parameter.
3944 int rte_eth_dev_uc_all_hash_table_set(uint16_t port, uint8_t on);
3947 * Set a traffic mirroring rule on an Ethernet device
3950 * The port identifier of the Ethernet device.
3951 * @param mirror_conf
3952 * The pointer to the traffic mirroring structure describing the mirroring rule.
3953 * The *rte_eth_vm_mirror_conf* structure includes the type of mirroring rule,
3954 * destination pool and the value of rule if enable vlan or pool mirroring.
3957 * The index of traffic mirroring rule, we support four separated rules.
3959 * 1 - Enable a mirroring rule.
3960 * 0 - Disable a mirroring rule.
3962 * - (0) if successful.
3963 * - (-ENOTSUP) if hardware doesn't support this feature.
3964 * - (-ENODEV) if *port_id* invalid.
3965 * - (-EIO) if device is removed.
3966 * - (-EINVAL) if the mr_conf information is not correct.
3968 int rte_eth_mirror_rule_set(uint16_t port_id,
3969 struct rte_eth_mirror_conf *mirror_conf,
3974 * Reset a traffic mirroring rule on an Ethernet device.
3977 * The port identifier of the Ethernet device.
3979 * The index of traffic mirroring rule, we support four separated rules.
3981 * - (0) if successful.
3982 * - (-ENOTSUP) if hardware doesn't support this feature.
3983 * - (-ENODEV) if *port_id* invalid.
3984 * - (-EIO) if device is removed.
3985 * - (-EINVAL) if bad parameter.
3987 int rte_eth_mirror_rule_reset(uint16_t port_id,
3991 * Set the rate limitation for a queue on an Ethernet device.
3994 * The port identifier of the Ethernet device.
3998 * The tx rate in Mbps. Allocated from the total port link speed.
4000 * - (0) if successful.
4001 * - (-ENOTSUP) if hardware doesn't support this feature.
4002 * - (-ENODEV) if *port_id* invalid.
4003 * - (-EIO) if device is removed.
4004 * - (-EINVAL) if bad parameter.
4006 int rte_eth_set_queue_rate_limit(uint16_t port_id, uint16_t queue_idx,
4010 * Configuration of Receive Side Scaling hash computation of Ethernet device.
4013 * The port identifier of the Ethernet device.
4015 * The new configuration to use for RSS hash computation on the port.
4017 * - (0) if successful.
4018 * - (-ENODEV) if port identifier is invalid.
4019 * - (-EIO) if device is removed.
4020 * - (-ENOTSUP) if hardware doesn't support.
4021 * - (-EINVAL) if bad parameter.
4023 int rte_eth_dev_rss_hash_update(uint16_t port_id,
4024 struct rte_eth_rss_conf *rss_conf);
4027 * Retrieve current configuration of Receive Side Scaling hash computation
4028 * of Ethernet device.
4031 * The port identifier of the Ethernet device.
4033 * Where to store the current RSS hash configuration of the Ethernet device.
4035 * - (0) if successful.
4036 * - (-ENODEV) if port identifier is invalid.
4037 * - (-EIO) if device is removed.
4038 * - (-ENOTSUP) if hardware doesn't support RSS.
4041 rte_eth_dev_rss_hash_conf_get(uint16_t port_id,
4042 struct rte_eth_rss_conf *rss_conf);
4045 * Add UDP tunneling port for a specific type of tunnel.
4046 * The packets with this UDP port will be identified as this type of tunnel.
4047 * Before enabling any offloading function for a tunnel, users can call this API
4048 * to change or add more UDP port for the tunnel. So the offloading function
4049 * can take effect on the packets with the specific UDP port.
4052 * The port identifier of the Ethernet device.
4054 * UDP tunneling configuration.
4057 * - (0) if successful.
4058 * - (-ENODEV) if port identifier is invalid.
4059 * - (-EIO) if device is removed.
4060 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4063 rte_eth_dev_udp_tunnel_port_add(uint16_t port_id,
4064 struct rte_eth_udp_tunnel *tunnel_udp);
4067 * Delete UDP tunneling port a specific type of tunnel.
4068 * The packets with this UDP port will not be identified as this type of tunnel
4070 * Before enabling any offloading function for a tunnel, users can call this API
4071 * to delete a UDP port for the tunnel. So the offloading function will not take
4072 * effect on the packets with the specific UDP port.
4075 * The port identifier of the Ethernet device.
4077 * UDP tunneling configuration.
4080 * - (0) if successful.
4081 * - (-ENODEV) if port identifier is invalid.
4082 * - (-EIO) if device is removed.
4083 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4086 rte_eth_dev_udp_tunnel_port_delete(uint16_t port_id,
4087 struct rte_eth_udp_tunnel *tunnel_udp);
4090 * Check whether the filter type is supported on an Ethernet device.
4091 * All the supported filter types are defined in 'rte_eth_ctrl.h'.
4094 * The port identifier of the Ethernet device.
4095 * @param filter_type
4098 * - (0) if successful.
4099 * - (-ENOTSUP) if hardware doesn't support this filter type.
4100 * - (-ENODEV) if *port_id* invalid.
4101 * - (-EIO) if device is removed.
4103 int rte_eth_dev_filter_supported(uint16_t port_id,
4104 enum rte_filter_type filter_type);
4107 * Take operations to assigned filter type on an Ethernet device.
4108 * All the supported operations and filter types are defined in 'rte_eth_ctrl.h'.
4111 * The port identifier of the Ethernet device.
4112 * @param filter_type
4115 * Type of operation.
4117 * A pointer to arguments defined specifically for the operation.
4119 * - (0) if successful.
4120 * - (-ENOTSUP) if hardware doesn't support.
4121 * - (-ENODEV) if *port_id* invalid.
4122 * - (-EIO) if device is removed.
4123 * - others depends on the specific operations implementation.
4125 int rte_eth_dev_filter_ctrl(uint16_t port_id, enum rte_filter_type filter_type,
4126 enum rte_filter_op filter_op, void *arg);
4129 * Get DCB information on an Ethernet device.
4132 * The port identifier of the Ethernet device.
4136 * - (0) if successful.
4137 * - (-ENODEV) if port identifier is invalid.
4138 * - (-EIO) if device is removed.
4139 * - (-ENOTSUP) if hardware doesn't support.
4141 int rte_eth_dev_get_dcb_info(uint16_t port_id,
4142 struct rte_eth_dcb_info *dcb_info);
4145 * Add a callback to be called on packet RX on a given port and queue.
4147 * This API configures a function to be called for each burst of
4148 * packets received on a given NIC port queue. The return value is a pointer
4149 * that can be used to later remove the callback using
4150 * rte_eth_remove_rx_callback().
4152 * Multiple functions are called in the order that they are added.
4155 * The port identifier of the Ethernet device.
4157 * The queue on the Ethernet device on which the callback is to be added.
4159 * The callback function
4161 * A generic pointer parameter which will be passed to each invocation of the
4162 * callback function on this port and queue.
4166 * On success, a pointer value which can later be used to remove the callback.
4168 void *rte_eth_add_rx_callback(uint16_t port_id, uint16_t queue_id,
4169 rte_rx_callback_fn fn, void *user_param);
4172 * Add a callback that must be called first on packet RX on a given port
4175 * This API configures a first function to be called for each burst of
4176 * packets received on a given NIC port queue. The return value is a pointer
4177 * that can be used to later remove the callback using
4178 * rte_eth_remove_rx_callback().
4180 * Multiple functions are called in the order that they are added.
4183 * The port identifier of the Ethernet device.
4185 * The queue on the Ethernet device on which the callback is to be added.
4187 * The callback function
4189 * A generic pointer parameter which will be passed to each invocation of the
4190 * callback function on this port and queue.
4194 * On success, a pointer value which can later be used to remove the callback.
4196 void *rte_eth_add_first_rx_callback(uint16_t port_id, uint16_t queue_id,
4197 rte_rx_callback_fn fn, void *user_param);
4200 * Add a callback to be called on packet TX on a given port and queue.
4202 * This API configures a function to be called for each burst of
4203 * packets sent on a given NIC port queue. The return value is a pointer
4204 * that can be used to later remove the callback using
4205 * rte_eth_remove_tx_callback().
4207 * Multiple functions are called in the order that they are added.
4210 * The port identifier of the Ethernet device.
4212 * The queue on the Ethernet device on which the callback is to be added.
4214 * The callback function
4216 * A generic pointer parameter which will be passed to each invocation of the
4217 * callback function on this port and queue.
4221 * On success, a pointer value which can later be used to remove the callback.
4223 void *rte_eth_add_tx_callback(uint16_t port_id, uint16_t queue_id,
4224 rte_tx_callback_fn fn, void *user_param);
4227 * Remove an RX packet callback from a given port and queue.
4229 * This function is used to removed callbacks that were added to a NIC port
4230 * queue using rte_eth_add_rx_callback().
4232 * Note: the callback is removed from the callback list but it isn't freed
4233 * since the it may still be in use. The memory for the callback can be
4234 * subsequently freed back by the application by calling rte_free():
4236 * - Immediately - if the port is stopped, or the user knows that no
4237 * callbacks are in flight e.g. if called from the thread doing RX/TX
4240 * - After a short delay - where the delay is sufficient to allow any
4241 * in-flight callbacks to complete.
4244 * The port identifier of the Ethernet device.
4246 * The queue on the Ethernet device from which the callback is to be removed.
4248 * User supplied callback created via rte_eth_add_rx_callback().
4251 * - 0: Success. Callback was removed.
4252 * - -ENOTSUP: Callback support is not available.
4253 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
4254 * is NULL or not found for the port/queue.
4256 int rte_eth_remove_rx_callback(uint16_t port_id, uint16_t queue_id,
4257 struct rte_eth_rxtx_callback *user_cb);
4260 * Remove a TX packet callback from a given port and queue.
4262 * This function is used to removed callbacks that were added to a NIC port
4263 * queue using rte_eth_add_tx_callback().
4265 * Note: the callback is removed from the callback list but it isn't freed
4266 * since the it may still be in use. The memory for the callback can be
4267 * subsequently freed back by the application by calling rte_free():
4269 * - Immediately - if the port is stopped, or the user knows that no
4270 * callbacks are in flight e.g. if called from the thread doing RX/TX
4273 * - After a short delay - where the delay is sufficient to allow any
4274 * in-flight callbacks to complete.
4277 * The port identifier of the Ethernet device.
4279 * The queue on the Ethernet device from which the callback is to be removed.
4281 * User supplied callback created via rte_eth_add_tx_callback().
4284 * - 0: Success. Callback was removed.
4285 * - -ENOTSUP: Callback support is not available.
4286 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
4287 * is NULL or not found for the port/queue.
4289 int rte_eth_remove_tx_callback(uint16_t port_id, uint16_t queue_id,
4290 struct rte_eth_rxtx_callback *user_cb);
4293 * Retrieve information about given port's RX queue.
4296 * The port identifier of the Ethernet device.
4298 * The RX queue on the Ethernet device for which information
4299 * will be retrieved.
4301 * A pointer to a structure of type *rte_eth_rxq_info_info* to be filled with
4302 * the information of the Ethernet device.
4306 * - -ENOTSUP: routine is not supported by the device PMD.
4307 * - -EINVAL: The port_id or the queue_id is out of range.
4309 int rte_eth_rx_queue_info_get(uint16_t port_id, uint16_t queue_id,
4310 struct rte_eth_rxq_info *qinfo);
4313 * Retrieve information about given port's TX queue.
4316 * The port identifier of the Ethernet device.
4318 * The TX queue on the Ethernet device for which information
4319 * will be retrieved.
4321 * A pointer to a structure of type *rte_eth_txq_info_info* to be filled with
4322 * the information of the Ethernet device.
4326 * - -ENOTSUP: routine is not supported by the device PMD.
4327 * - -EINVAL: The port_id or the queue_id is out of range.
4329 int rte_eth_tx_queue_info_get(uint16_t port_id, uint16_t queue_id,
4330 struct rte_eth_txq_info *qinfo);
4333 * Retrieve device registers and register attributes (number of registers and
4337 * The port identifier of the Ethernet device.
4339 * Pointer to rte_dev_reg_info structure to fill in. If info->data is
4340 * NULL the function fills in the width and length fields. If non-NULL
4341 * the registers are put into the buffer pointed at by the data field.
4343 * - (0) if successful.
4344 * - (-ENOTSUP) if hardware doesn't support.
4345 * - (-ENODEV) if *port_id* invalid.
4346 * - (-EIO) if device is removed.
4347 * - others depends on the specific operations implementation.
4349 int rte_eth_dev_get_reg_info(uint16_t port_id, struct rte_dev_reg_info *info);
4352 * Retrieve size of device EEPROM
4355 * The port identifier of the Ethernet device.
4357 * - (>=0) EEPROM size if successful.
4358 * - (-ENOTSUP) if hardware doesn't support.
4359 * - (-ENODEV) if *port_id* invalid.
4360 * - (-EIO) if device is removed.
4361 * - others depends on the specific operations implementation.
4363 int rte_eth_dev_get_eeprom_length(uint16_t port_id);
4366 * Retrieve EEPROM and EEPROM attribute
4369 * The port identifier of the Ethernet device.
4371 * The template includes buffer for return EEPROM data and
4372 * EEPROM attributes to be filled.
4374 * - (0) if successful.
4375 * - (-ENOTSUP) if hardware doesn't support.
4376 * - (-ENODEV) if *port_id* invalid.
4377 * - (-EIO) if device is removed.
4378 * - others depends on the specific operations implementation.
4380 int rte_eth_dev_get_eeprom(uint16_t port_id, struct rte_dev_eeprom_info *info);
4383 * Program EEPROM with provided data
4386 * The port identifier of the Ethernet device.
4388 * The template includes EEPROM data for programming and
4389 * EEPROM attributes to be filled
4391 * - (0) if successful.
4392 * - (-ENOTSUP) if hardware doesn't support.
4393 * - (-ENODEV) if *port_id* invalid.
4394 * - (-EIO) if device is removed.
4395 * - others depends on the specific operations implementation.
4397 int rte_eth_dev_set_eeprom(uint16_t port_id, struct rte_dev_eeprom_info *info);
4400 * Set the list of multicast addresses to filter on an Ethernet device.
4403 * The port identifier of the Ethernet device.
4404 * @param mc_addr_set
4405 * The array of multicast addresses to set. Equal to NULL when the function
4406 * is invoked to flush the set of filtered addresses.
4408 * The number of multicast addresses in the *mc_addr_set* array. Equal to 0
4409 * when the function is invoked to flush the set of filtered addresses.
4411 * - (0) if successful.
4412 * - (-ENODEV) if *port_id* invalid.
4413 * - (-EIO) if device is removed.
4414 * - (-ENOTSUP) if PMD of *port_id* doesn't support multicast filtering.
4415 * - (-ENOSPC) if *port_id* has not enough multicast filtering resources.
4417 int rte_eth_dev_set_mc_addr_list(uint16_t port_id,
4418 struct ether_addr *mc_addr_set,
4419 uint32_t nb_mc_addr);
4422 * Enable IEEE1588/802.1AS timestamping for an Ethernet device.
4425 * The port identifier of the Ethernet device.
4429 * - -ENODEV: The port ID is invalid.
4430 * - -EIO: if device is removed.
4431 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4433 int rte_eth_timesync_enable(uint16_t port_id);
4436 * Disable IEEE1588/802.1AS timestamping for an Ethernet device.
4439 * The port identifier of the Ethernet device.
4443 * - -ENODEV: The port ID is invalid.
4444 * - -EIO: if device is removed.
4445 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4447 int rte_eth_timesync_disable(uint16_t port_id);
4450 * Read an IEEE1588/802.1AS RX timestamp from an Ethernet device.
4453 * The port identifier of the Ethernet device.
4455 * Pointer to the timestamp struct.
4457 * Device specific flags. Used to pass the RX timesync register index to
4458 * i40e. Unused in igb/ixgbe, pass 0 instead.
4462 * - -EINVAL: No timestamp is available.
4463 * - -ENODEV: The port ID is invalid.
4464 * - -EIO: if device is removed.
4465 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4467 int rte_eth_timesync_read_rx_timestamp(uint16_t port_id,
4468 struct timespec *timestamp, uint32_t flags);
4471 * Read an IEEE1588/802.1AS TX timestamp from an Ethernet device.
4474 * The port identifier of the Ethernet device.
4476 * Pointer to the timestamp struct.
4480 * - -EINVAL: No timestamp is available.
4481 * - -ENODEV: The port ID is invalid.
4482 * - -EIO: if device is removed.
4483 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4485 int rte_eth_timesync_read_tx_timestamp(uint16_t port_id,
4486 struct timespec *timestamp);
4489 * Adjust the timesync clock on an Ethernet device.
4491 * This is usually used in conjunction with other Ethdev timesync functions to
4492 * synchronize the device time using the IEEE1588/802.1AS protocol.
4495 * The port identifier of the Ethernet device.
4497 * The adjustment in nanoseconds.
4501 * - -ENODEV: The port ID is invalid.
4502 * - -EIO: if device is removed.
4503 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4505 int rte_eth_timesync_adjust_time(uint16_t port_id, int64_t delta);
4508 * Read the time from the timesync clock on an Ethernet device.
4510 * This is usually used in conjunction with other Ethdev timesync functions to
4511 * synchronize the device time using the IEEE1588/802.1AS protocol.
4514 * The port identifier of the Ethernet device.
4516 * Pointer to the timespec struct that holds the time.
4521 int rte_eth_timesync_read_time(uint16_t port_id, struct timespec *time);
4524 * Set the time of the timesync clock on an Ethernet device.
4526 * This is usually used in conjunction with other Ethdev timesync functions to
4527 * synchronize the device time using the IEEE1588/802.1AS protocol.
4530 * The port identifier of the Ethernet device.
4532 * Pointer to the timespec struct that holds the time.
4536 * - -EINVAL: No timestamp is available.
4537 * - -ENODEV: The port ID is invalid.
4538 * - -EIO: if device is removed.
4539 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4541 int rte_eth_timesync_write_time(uint16_t port_id, const struct timespec *time);
4544 * Create memzone for HW rings.
4545 * malloc can't be used as the physical address is needed.
4546 * If the memzone is already created, then this function returns a ptr
4550 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
4552 * The name of the memory zone
4554 * The index of the queue to add to name
4556 * The sizeof of the memory area
4558 * Alignment for resulting memzone. Must be a power of 2.
4560 * The *socket_id* argument is the socket identifier in case of NUMA.
4562 const struct rte_memzone *
4563 rte_eth_dma_zone_reserve(const struct rte_eth_dev *eth_dev, const char *name,
4564 uint16_t queue_id, size_t size,
4565 unsigned align, int socket_id);
4568 * Config l2 tunnel ether type of an Ethernet device for filtering specific
4569 * tunnel packets by ether type.
4572 * The port identifier of the Ethernet device.
4574 * l2 tunnel configuration.
4577 * - (0) if successful.
4578 * - (-ENODEV) if port identifier is invalid.
4579 * - (-EIO) if device is removed.
4580 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4583 rte_eth_dev_l2_tunnel_eth_type_conf(uint16_t port_id,
4584 struct rte_eth_l2_tunnel_conf *l2_tunnel);
4587 * Enable/disable l2 tunnel offload functions. Include,
4588 * 1, The ability of parsing a type of l2 tunnel of an Ethernet device.
4589 * Filtering, forwarding and offloading this type of tunnel packets depend on
4591 * 2, Stripping the l2 tunnel tag.
4592 * 3, Insertion of the l2 tunnel tag.
4593 * 4, Forwarding the packets based on the l2 tunnel tag.
4596 * The port identifier of the Ethernet device.
4598 * l2 tunnel parameters.
4600 * Indicate the offload function.
4602 * Enable or disable this function.
4605 * - (0) if successful.
4606 * - (-ENODEV) if port identifier is invalid.
4607 * - (-EIO) if device is removed.
4608 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4611 rte_eth_dev_l2_tunnel_offload_set(uint16_t port_id,
4612 struct rte_eth_l2_tunnel_conf *l2_tunnel,
4617 * Get the port id from pci address or device name
4618 * Ex: 0000:2:00.0 or vdev name net_pcap0
4621 * pci address or name of the device
4623 * pointer to port identifier of the device
4625 * - (0) if successful and port_id is filled.
4626 * - (-ENODEV or -EINVAL) on failure.
4629 rte_eth_dev_get_port_by_name(const char *name, uint16_t *port_id);
4632 * Get the device name from port id
4635 * pointer to port identifier of the device
4637 * pci address or name of the device
4639 * - (0) if successful.
4640 * - (-EINVAL) on failure.
4643 rte_eth_dev_get_name_by_port(uint16_t port_id, char *name);
4646 * Check that numbers of Rx and Tx descriptors satisfy descriptors limits from
4647 * the ethernet device information, otherwise adjust them to boundaries.
4650 * The port identifier of the Ethernet device.
4652 * A pointer to a uint16_t where the number of receive
4653 * descriptors stored.
4655 * A pointer to a uint16_t where the number of transmit
4656 * descriptors stored.
4658 * - (0) if successful.
4659 * - (-ENOTSUP, -ENODEV or -EINVAL) on failure.
4661 int rte_eth_dev_adjust_nb_rx_tx_desc(uint16_t port_id,
4662 uint16_t *nb_rx_desc,
4663 uint16_t *nb_tx_desc);
4667 * Test if a port supports specific mempool ops.
4670 * Port identifier of the Ethernet device.
4672 * The name of the pool operations to test.
4674 * - 0: best mempool ops choice for this port.
4675 * - 1: mempool ops are supported for this port.
4676 * - -ENOTSUP: mempool ops not supported for this port.
4677 * - -ENODEV: Invalid port Identifier.
4678 * - -EINVAL: Pool param is null.
4681 rte_eth_dev_pool_ops_supported(uint16_t port_id, const char *pool);
4684 * Get the security context for the Ethernet device.
4687 * Port identifier of the Ethernet device
4690 * - pointer to security context on success.
4693 rte_eth_dev_get_sec_ctx(uint8_t port_id);
4699 #endif /* _RTE_ETHDEV_H_ */