4 * Copyright(c) 2010-2017 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 #ifndef _RTE_ETHDEV_H_
35 #define _RTE_ETHDEV_H_
40 * RTE Ethernet Device API
42 * The Ethernet Device API is composed of two parts:
44 * - The application-oriented Ethernet API that includes functions to setup
45 * an Ethernet device (configure it, setup its RX and TX queues and start it),
46 * to get its MAC address, the speed and the status of its physical link,
47 * to receive and to transmit packets, and so on.
49 * - The driver-oriented Ethernet API that exports a function allowing
50 * an Ethernet Poll Mode Driver (PMD) to simultaneously register itself as
51 * an Ethernet device driver and as a PCI driver for a set of matching PCI
52 * [Ethernet] devices classes.
54 * By default, all the functions of the Ethernet Device API exported by a PMD
55 * are lock-free functions which assume to not be invoked in parallel on
56 * different logical cores to work on the same target object. For instance,
57 * the receive function of a PMD cannot be invoked in parallel on two logical
58 * cores to poll the same RX queue [of the same port]. Of course, this function
59 * can be invoked in parallel by different logical cores on different RX queues.
60 * It is the responsibility of the upper level application to enforce this rule.
62 * If needed, parallel accesses by multiple logical cores to shared queues
63 * shall be explicitly protected by dedicated inline lock-aware functions
64 * built on top of their corresponding lock-free functions of the PMD API.
66 * In all functions of the Ethernet API, the Ethernet device is
67 * designated by an integer >= 0 named the device port identifier.
69 * At the Ethernet driver level, Ethernet devices are represented by a generic
70 * data structure of type *rte_eth_dev*.
72 * Ethernet devices are dynamically registered during the PCI probing phase
73 * performed at EAL initialization time.
74 * When an Ethernet device is being probed, an *rte_eth_dev* structure and
75 * a new port identifier are allocated for that device. Then, the eth_dev_init()
76 * function supplied by the Ethernet driver matching the probed PCI
77 * device is invoked to properly initialize the device.
79 * The role of the device init function consists of resetting the hardware,
80 * checking access to Non-volatile Memory (NVM), reading the MAC address
83 * If the device init operation is successful, the correspondence between
84 * the port identifier assigned to the new device and its associated
85 * *rte_eth_dev* structure is effectively registered.
86 * Otherwise, both the *rte_eth_dev* structure and the port identifier are
89 * The functions exported by the application Ethernet API to setup a device
90 * designated by its port identifier must be invoked in the following order:
91 * - rte_eth_dev_configure()
92 * - rte_eth_tx_queue_setup()
93 * - rte_eth_rx_queue_setup()
94 * - rte_eth_dev_start()
96 * Then, the network application can invoke, in any order, the functions
97 * exported by the Ethernet API to get the MAC address of a given device, to
98 * get the speed and the status of a device physical link, to receive/transmit
99 * [burst of] packets, and so on.
101 * If the application wants to change the configuration (i.e. call
102 * rte_eth_dev_configure(), rte_eth_tx_queue_setup(), or
103 * rte_eth_rx_queue_setup()), it must call rte_eth_dev_stop() first to stop the
104 * device and then do the reconfiguration before calling rte_eth_dev_start()
105 * again. The transmit and receive functions should not be invoked when the
108 * Please note that some configuration is not stored between calls to
109 * rte_eth_dev_stop()/rte_eth_dev_start(). The following configuration will
112 * - flow control settings
113 * - receive mode configuration (promiscuous mode, hardware checksum mode,
114 * RSS/VMDQ settings etc.)
115 * - VLAN filtering configuration
116 * - MAC addresses supplied to MAC address array
117 * - flow director filtering mode (but not filtering rules)
118 * - NIC queue statistics mappings
120 * Any other configuration will not be stored and will need to be re-entered
121 * before a call to rte_eth_dev_start().
123 * Finally, a network application can close an Ethernet device by invoking the
124 * rte_eth_dev_close() function.
126 * Each function of the application Ethernet API invokes a specific function
127 * of the PMD that controls the target device designated by its port
129 * For this purpose, all device-specific functions of an Ethernet driver are
130 * supplied through a set of pointers contained in a generic structure of type
132 * The address of the *eth_dev_ops* structure is stored in the *rte_eth_dev*
133 * structure by the device init function of the Ethernet driver, which is
134 * invoked during the PCI probing phase, as explained earlier.
136 * In other words, each function of the Ethernet API simply retrieves the
137 * *rte_eth_dev* structure associated with the device port identifier and
138 * performs an indirect invocation of the corresponding driver function
139 * supplied in the *eth_dev_ops* structure of the *rte_eth_dev* structure.
141 * For performance reasons, the address of the burst-oriented RX and TX
142 * functions of the Ethernet driver are not contained in the *eth_dev_ops*
143 * structure. Instead, they are directly stored at the beginning of the
144 * *rte_eth_dev* structure to avoid an extra indirect memory access during
147 * RTE ethernet device drivers do not use interrupts for transmitting or
148 * receiving. Instead, Ethernet drivers export Poll-Mode receive and transmit
149 * functions to applications.
150 * Both receive and transmit functions are packet-burst oriented to minimize
151 * their cost per packet through the following optimizations:
153 * - Sharing among multiple packets the incompressible cost of the
154 * invocation of receive/transmit functions.
156 * - Enabling receive/transmit functions to take advantage of burst-oriented
157 * hardware features (L1 cache, prefetch instructions, NIC head/tail
158 * registers) to minimize the number of CPU cycles per packet, for instance,
159 * by avoiding useless read memory accesses to ring descriptors, or by
160 * systematically using arrays of pointers that exactly fit L1 cache line
161 * boundaries and sizes.
163 * The burst-oriented receive function does not provide any error notification,
164 * to avoid the corresponding overhead. As a hint, the upper-level application
165 * might check the status of the device link once being systematically returned
166 * a 0 value by the receive function of the driver for a given number of tries.
175 /* Use this macro to check if LRO API is supported */
176 #define RTE_ETHDEV_HAS_LRO_SUPPORT
179 #include <rte_interrupts.h>
181 #include <rte_devargs.h>
182 #include <rte_errno.h>
183 #include <rte_common.h>
184 #include <rte_config.h>
186 #include "rte_ether.h"
187 #include "rte_eth_ctrl.h"
188 #include "rte_dev_info.h"
193 * A structure used to retrieve statistics for an Ethernet port.
194 * Not all statistics fields in struct rte_eth_stats are supported
195 * by any type of network interface card (NIC). If any statistics
196 * field is not supported, its value is 0.
198 struct rte_eth_stats {
199 uint64_t ipackets; /**< Total number of successfully received packets. */
200 uint64_t opackets; /**< Total number of successfully transmitted packets.*/
201 uint64_t ibytes; /**< Total number of successfully received bytes. */
202 uint64_t obytes; /**< Total number of successfully transmitted bytes. */
204 /**< Total of RX packets dropped by the HW,
205 * because there are no available buffer (i.e. RX queues are full).
207 uint64_t ierrors; /**< Total number of erroneous received packets. */
208 uint64_t oerrors; /**< Total number of failed transmitted packets. */
209 uint64_t rx_nombuf; /**< Total number of RX mbuf allocation failures. */
210 uint64_t q_ipackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
211 /**< Total number of queue RX packets. */
212 uint64_t q_opackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
213 /**< Total number of queue TX packets. */
214 uint64_t q_ibytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
215 /**< Total number of successfully received queue bytes. */
216 uint64_t q_obytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
217 /**< Total number of successfully transmitted queue bytes. */
218 uint64_t q_errors[RTE_ETHDEV_QUEUE_STAT_CNTRS];
219 /**< Total number of queue packets received that are dropped. */
223 * Device supported speeds bitmap flags
225 #define ETH_LINK_SPEED_AUTONEG (0 << 0) /**< Autonegotiate (all speeds) */
226 #define ETH_LINK_SPEED_FIXED (1 << 0) /**< Disable autoneg (fixed speed) */
227 #define ETH_LINK_SPEED_10M_HD (1 << 1) /**< 10 Mbps half-duplex */
228 #define ETH_LINK_SPEED_10M (1 << 2) /**< 10 Mbps full-duplex */
229 #define ETH_LINK_SPEED_100M_HD (1 << 3) /**< 100 Mbps half-duplex */
230 #define ETH_LINK_SPEED_100M (1 << 4) /**< 100 Mbps full-duplex */
231 #define ETH_LINK_SPEED_1G (1 << 5) /**< 1 Gbps */
232 #define ETH_LINK_SPEED_2_5G (1 << 6) /**< 2.5 Gbps */
233 #define ETH_LINK_SPEED_5G (1 << 7) /**< 5 Gbps */
234 #define ETH_LINK_SPEED_10G (1 << 8) /**< 10 Gbps */
235 #define ETH_LINK_SPEED_20G (1 << 9) /**< 20 Gbps */
236 #define ETH_LINK_SPEED_25G (1 << 10) /**< 25 Gbps */
237 #define ETH_LINK_SPEED_40G (1 << 11) /**< 40 Gbps */
238 #define ETH_LINK_SPEED_50G (1 << 12) /**< 50 Gbps */
239 #define ETH_LINK_SPEED_56G (1 << 13) /**< 56 Gbps */
240 #define ETH_LINK_SPEED_100G (1 << 14) /**< 100 Gbps */
243 * Ethernet numeric link speeds in Mbps
245 #define ETH_SPEED_NUM_NONE 0 /**< Not defined */
246 #define ETH_SPEED_NUM_10M 10 /**< 10 Mbps */
247 #define ETH_SPEED_NUM_100M 100 /**< 100 Mbps */
248 #define ETH_SPEED_NUM_1G 1000 /**< 1 Gbps */
249 #define ETH_SPEED_NUM_2_5G 2500 /**< 2.5 Gbps */
250 #define ETH_SPEED_NUM_5G 5000 /**< 5 Gbps */
251 #define ETH_SPEED_NUM_10G 10000 /**< 10 Gbps */
252 #define ETH_SPEED_NUM_20G 20000 /**< 20 Gbps */
253 #define ETH_SPEED_NUM_25G 25000 /**< 25 Gbps */
254 #define ETH_SPEED_NUM_40G 40000 /**< 40 Gbps */
255 #define ETH_SPEED_NUM_50G 50000 /**< 50 Gbps */
256 #define ETH_SPEED_NUM_56G 56000 /**< 56 Gbps */
257 #define ETH_SPEED_NUM_100G 100000 /**< 100 Gbps */
260 * A structure used to retrieve link-level information of an Ethernet port.
263 struct rte_eth_link {
264 uint32_t link_speed; /**< ETH_SPEED_NUM_ */
265 uint16_t link_duplex : 1; /**< ETH_LINK_[HALF/FULL]_DUPLEX */
266 uint16_t link_autoneg : 1; /**< ETH_LINK_[AUTONEG/FIXED] */
267 uint16_t link_status : 1; /**< ETH_LINK_[DOWN/UP] */
268 } __attribute__((aligned(8))); /**< aligned for atomic64 read/write */
270 /* Utility constants */
271 #define ETH_LINK_HALF_DUPLEX 0 /**< Half-duplex connection (see link_duplex). */
272 #define ETH_LINK_FULL_DUPLEX 1 /**< Full-duplex connection (see link_duplex). */
273 #define ETH_LINK_DOWN 0 /**< Link is down (see link_status). */
274 #define ETH_LINK_UP 1 /**< Link is up (see link_status). */
275 #define ETH_LINK_FIXED 0 /**< No autonegotiation (see link_autoneg). */
276 #define ETH_LINK_AUTONEG 1 /**< Autonegotiated (see link_autoneg). */
279 * A structure used to configure the ring threshold registers of an RX/TX
280 * queue for an Ethernet port.
282 struct rte_eth_thresh {
283 uint8_t pthresh; /**< Ring prefetch threshold. */
284 uint8_t hthresh; /**< Ring host threshold. */
285 uint8_t wthresh; /**< Ring writeback threshold. */
289 * Simple flags are used for rte_eth_conf.rxmode.mq_mode.
291 #define ETH_MQ_RX_RSS_FLAG 0x1
292 #define ETH_MQ_RX_DCB_FLAG 0x2
293 #define ETH_MQ_RX_VMDQ_FLAG 0x4
296 * A set of values to identify what method is to be used to route
297 * packets to multiple queues.
299 enum rte_eth_rx_mq_mode {
300 /** None of DCB,RSS or VMDQ mode */
303 /** For RX side, only RSS is on */
304 ETH_MQ_RX_RSS = ETH_MQ_RX_RSS_FLAG,
305 /** For RX side,only DCB is on. */
306 ETH_MQ_RX_DCB = ETH_MQ_RX_DCB_FLAG,
307 /** Both DCB and RSS enable */
308 ETH_MQ_RX_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG,
310 /** Only VMDQ, no RSS nor DCB */
311 ETH_MQ_RX_VMDQ_ONLY = ETH_MQ_RX_VMDQ_FLAG,
312 /** RSS mode with VMDQ */
313 ETH_MQ_RX_VMDQ_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_VMDQ_FLAG,
314 /** Use VMDQ+DCB to route traffic to queues */
315 ETH_MQ_RX_VMDQ_DCB = ETH_MQ_RX_VMDQ_FLAG | ETH_MQ_RX_DCB_FLAG,
316 /** Enable both VMDQ and DCB in VMDq */
317 ETH_MQ_RX_VMDQ_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG |
322 * for rx mq mode backward compatible
324 #define ETH_RSS ETH_MQ_RX_RSS
325 #define VMDQ_DCB ETH_MQ_RX_VMDQ_DCB
326 #define ETH_DCB_RX ETH_MQ_RX_DCB
329 * A set of values to identify what method is to be used to transmit
330 * packets using multi-TCs.
332 enum rte_eth_tx_mq_mode {
333 ETH_MQ_TX_NONE = 0, /**< It is in neither DCB nor VT mode. */
334 ETH_MQ_TX_DCB, /**< For TX side,only DCB is on. */
335 ETH_MQ_TX_VMDQ_DCB, /**< For TX side,both DCB and VT is on. */
336 ETH_MQ_TX_VMDQ_ONLY, /**< Only VT on, no DCB */
340 * for tx mq mode backward compatible
342 #define ETH_DCB_NONE ETH_MQ_TX_NONE
343 #define ETH_VMDQ_DCB_TX ETH_MQ_TX_VMDQ_DCB
344 #define ETH_DCB_TX ETH_MQ_TX_DCB
347 * A structure used to configure the RX features of an Ethernet port.
349 struct rte_eth_rxmode {
350 /** The multi-queue packet distribution mode to be used, e.g. RSS. */
351 enum rte_eth_rx_mq_mode mq_mode;
352 uint32_t max_rx_pkt_len; /**< Only used if jumbo_frame enabled. */
353 uint16_t split_hdr_size; /**< hdr buf size (header_split enabled).*/
355 * Per-port Rx offloads to be set using DEV_RX_OFFLOAD_* flags.
356 * Only offloads set on rx_offload_capa field on rte_eth_dev_info
357 * structure are allowed to be set.
362 * Below bitfield API is obsolete. Application should
363 * enable per-port offloads using the offload field
366 uint16_t header_split : 1, /**< Header Split enable. */
367 hw_ip_checksum : 1, /**< IP/UDP/TCP checksum offload enable. */
368 hw_vlan_filter : 1, /**< VLAN filter enable. */
369 hw_vlan_strip : 1, /**< VLAN strip enable. */
370 hw_vlan_extend : 1, /**< Extended VLAN enable. */
371 jumbo_frame : 1, /**< Jumbo Frame Receipt enable. */
372 hw_strip_crc : 1, /**< Enable CRC stripping by hardware. */
373 enable_scatter : 1, /**< Enable scatter packets rx handler */
374 enable_lro : 1, /**< Enable LRO */
375 hw_timestamp : 1, /**< Enable HW timestamp */
376 security : 1, /**< Enable rte_security offloads */
378 * When set the offload bitfield should be ignored.
379 * Instead per-port Rx offloads should be set on offloads
381 * Per-queue offloads shuold be set on rte_eth_rxq_conf
383 * This bit is temporary till rxmode bitfield offloads API will
386 ignore_offload_bitfield : 1;
390 * VLAN types to indicate if it is for single VLAN, inner VLAN or outer VLAN.
391 * Note that single VLAN is treated the same as inner VLAN.
394 ETH_VLAN_TYPE_UNKNOWN = 0,
395 ETH_VLAN_TYPE_INNER, /**< Inner VLAN. */
396 ETH_VLAN_TYPE_OUTER, /**< Single VLAN, or outer VLAN. */
401 * A structure used to describe a vlan filter.
402 * If the bit corresponding to a VID is set, such VID is on.
404 struct rte_vlan_filter_conf {
409 * A structure used to configure the Receive Side Scaling (RSS) feature
410 * of an Ethernet port.
411 * If not NULL, the *rss_key* pointer of the *rss_conf* structure points
412 * to an array holding the RSS key to use for hashing specific header
413 * fields of received packets. The length of this array should be indicated
414 * by *rss_key_len* below. Otherwise, a default random hash key is used by
417 * The *rss_key_len* field of the *rss_conf* structure indicates the length
418 * in bytes of the array pointed by *rss_key*. To be compatible, this length
419 * will be checked in i40e only. Others assume 40 bytes to be used as before.
421 * The *rss_hf* field of the *rss_conf* structure indicates the different
422 * types of IPv4/IPv6 packets to which the RSS hashing must be applied.
423 * Supplying an *rss_hf* equal to zero disables the RSS feature.
425 struct rte_eth_rss_conf {
426 uint8_t *rss_key; /**< If not NULL, 40-byte hash key. */
427 uint8_t rss_key_len; /**< hash key length in bytes. */
428 uint64_t rss_hf; /**< Hash functions to apply - see below. */
432 * The RSS offload types are defined based on flow types which are defined
433 * in rte_eth_ctrl.h. Different NIC hardwares may support different RSS offload
434 * types. The supported flow types or RSS offload types can be queried by
435 * rte_eth_dev_info_get().
437 #define ETH_RSS_IPV4 (1ULL << RTE_ETH_FLOW_IPV4)
438 #define ETH_RSS_FRAG_IPV4 (1ULL << RTE_ETH_FLOW_FRAG_IPV4)
439 #define ETH_RSS_NONFRAG_IPV4_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_TCP)
440 #define ETH_RSS_NONFRAG_IPV4_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_UDP)
441 #define ETH_RSS_NONFRAG_IPV4_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_SCTP)
442 #define ETH_RSS_NONFRAG_IPV4_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_OTHER)
443 #define ETH_RSS_IPV6 (1ULL << RTE_ETH_FLOW_IPV6)
444 #define ETH_RSS_FRAG_IPV6 (1ULL << RTE_ETH_FLOW_FRAG_IPV6)
445 #define ETH_RSS_NONFRAG_IPV6_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_TCP)
446 #define ETH_RSS_NONFRAG_IPV6_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_UDP)
447 #define ETH_RSS_NONFRAG_IPV6_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_SCTP)
448 #define ETH_RSS_NONFRAG_IPV6_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_OTHER)
449 #define ETH_RSS_L2_PAYLOAD (1ULL << RTE_ETH_FLOW_L2_PAYLOAD)
450 #define ETH_RSS_IPV6_EX (1ULL << RTE_ETH_FLOW_IPV6_EX)
451 #define ETH_RSS_IPV6_TCP_EX (1ULL << RTE_ETH_FLOW_IPV6_TCP_EX)
452 #define ETH_RSS_IPV6_UDP_EX (1ULL << RTE_ETH_FLOW_IPV6_UDP_EX)
453 #define ETH_RSS_PORT (1ULL << RTE_ETH_FLOW_PORT)
454 #define ETH_RSS_VXLAN (1ULL << RTE_ETH_FLOW_VXLAN)
455 #define ETH_RSS_GENEVE (1ULL << RTE_ETH_FLOW_GENEVE)
456 #define ETH_RSS_NVGRE (1ULL << RTE_ETH_FLOW_NVGRE)
458 #define ETH_RSS_IP ( \
460 ETH_RSS_FRAG_IPV4 | \
461 ETH_RSS_NONFRAG_IPV4_OTHER | \
463 ETH_RSS_FRAG_IPV6 | \
464 ETH_RSS_NONFRAG_IPV6_OTHER | \
467 #define ETH_RSS_UDP ( \
468 ETH_RSS_NONFRAG_IPV4_UDP | \
469 ETH_RSS_NONFRAG_IPV6_UDP | \
472 #define ETH_RSS_TCP ( \
473 ETH_RSS_NONFRAG_IPV4_TCP | \
474 ETH_RSS_NONFRAG_IPV6_TCP | \
477 #define ETH_RSS_SCTP ( \
478 ETH_RSS_NONFRAG_IPV4_SCTP | \
479 ETH_RSS_NONFRAG_IPV6_SCTP)
481 #define ETH_RSS_TUNNEL ( \
487 /**< Mask of valid RSS hash protocols */
488 #define ETH_RSS_PROTO_MASK ( \
490 ETH_RSS_FRAG_IPV4 | \
491 ETH_RSS_NONFRAG_IPV4_TCP | \
492 ETH_RSS_NONFRAG_IPV4_UDP | \
493 ETH_RSS_NONFRAG_IPV4_SCTP | \
494 ETH_RSS_NONFRAG_IPV4_OTHER | \
496 ETH_RSS_FRAG_IPV6 | \
497 ETH_RSS_NONFRAG_IPV6_TCP | \
498 ETH_RSS_NONFRAG_IPV6_UDP | \
499 ETH_RSS_NONFRAG_IPV6_SCTP | \
500 ETH_RSS_NONFRAG_IPV6_OTHER | \
501 ETH_RSS_L2_PAYLOAD | \
503 ETH_RSS_IPV6_TCP_EX | \
504 ETH_RSS_IPV6_UDP_EX | \
511 * Definitions used for redirection table entry size.
512 * Some RSS RETA sizes may not be supported by some drivers, check the
513 * documentation or the description of relevant functions for more details.
515 #define ETH_RSS_RETA_SIZE_64 64
516 #define ETH_RSS_RETA_SIZE_128 128
517 #define ETH_RSS_RETA_SIZE_256 256
518 #define ETH_RSS_RETA_SIZE_512 512
519 #define RTE_RETA_GROUP_SIZE 64
521 /* Definitions used for VMDQ and DCB functionality */
522 #define ETH_VMDQ_MAX_VLAN_FILTERS 64 /**< Maximum nb. of VMDQ vlan filters. */
523 #define ETH_DCB_NUM_USER_PRIORITIES 8 /**< Maximum nb. of DCB priorities. */
524 #define ETH_VMDQ_DCB_NUM_QUEUES 128 /**< Maximum nb. of VMDQ DCB queues. */
525 #define ETH_DCB_NUM_QUEUES 128 /**< Maximum nb. of DCB queues. */
527 /* DCB capability defines */
528 #define ETH_DCB_PG_SUPPORT 0x00000001 /**< Priority Group(ETS) support. */
529 #define ETH_DCB_PFC_SUPPORT 0x00000002 /**< Priority Flow Control support. */
531 /* Definitions used for VLAN Offload functionality */
532 #define ETH_VLAN_STRIP_OFFLOAD 0x0001 /**< VLAN Strip On/Off */
533 #define ETH_VLAN_FILTER_OFFLOAD 0x0002 /**< VLAN Filter On/Off */
534 #define ETH_VLAN_EXTEND_OFFLOAD 0x0004 /**< VLAN Extend On/Off */
536 /* Definitions used for mask VLAN setting */
537 #define ETH_VLAN_STRIP_MASK 0x0001 /**< VLAN Strip setting mask */
538 #define ETH_VLAN_FILTER_MASK 0x0002 /**< VLAN Filter setting mask*/
539 #define ETH_VLAN_EXTEND_MASK 0x0004 /**< VLAN Extend setting mask*/
540 #define ETH_VLAN_ID_MAX 0x0FFF /**< VLAN ID is in lower 12 bits*/
542 /* Definitions used for receive MAC address */
543 #define ETH_NUM_RECEIVE_MAC_ADDR 128 /**< Maximum nb. of receive mac addr. */
545 /* Definitions used for unicast hash */
546 #define ETH_VMDQ_NUM_UC_HASH_ARRAY 128 /**< Maximum nb. of UC hash array. */
548 /* Definitions used for VMDQ pool rx mode setting */
549 #define ETH_VMDQ_ACCEPT_UNTAG 0x0001 /**< accept untagged packets. */
550 #define ETH_VMDQ_ACCEPT_HASH_MC 0x0002 /**< accept packets in multicast table . */
551 #define ETH_VMDQ_ACCEPT_HASH_UC 0x0004 /**< accept packets in unicast table. */
552 #define ETH_VMDQ_ACCEPT_BROADCAST 0x0008 /**< accept broadcast packets. */
553 #define ETH_VMDQ_ACCEPT_MULTICAST 0x0010 /**< multicast promiscuous. */
555 /** Maximum nb. of vlan per mirror rule */
556 #define ETH_MIRROR_MAX_VLANS 64
558 #define ETH_MIRROR_VIRTUAL_POOL_UP 0x01 /**< Virtual Pool uplink Mirroring. */
559 #define ETH_MIRROR_UPLINK_PORT 0x02 /**< Uplink Port Mirroring. */
560 #define ETH_MIRROR_DOWNLINK_PORT 0x04 /**< Downlink Port Mirroring. */
561 #define ETH_MIRROR_VLAN 0x08 /**< VLAN Mirroring. */
562 #define ETH_MIRROR_VIRTUAL_POOL_DOWN 0x10 /**< Virtual Pool downlink Mirroring. */
565 * A structure used to configure VLAN traffic mirror of an Ethernet port.
567 struct rte_eth_vlan_mirror {
568 uint64_t vlan_mask; /**< mask for valid VLAN ID. */
569 /** VLAN ID list for vlan mirroring. */
570 uint16_t vlan_id[ETH_MIRROR_MAX_VLANS];
574 * A structure used to configure traffic mirror of an Ethernet port.
576 struct rte_eth_mirror_conf {
577 uint8_t rule_type; /**< Mirroring rule type */
578 uint8_t dst_pool; /**< Destination pool for this mirror rule. */
579 uint64_t pool_mask; /**< Bitmap of pool for pool mirroring */
580 /** VLAN ID setting for VLAN mirroring. */
581 struct rte_eth_vlan_mirror vlan;
585 * A structure used to configure 64 entries of Redirection Table of the
586 * Receive Side Scaling (RSS) feature of an Ethernet port. To configure
587 * more than 64 entries supported by hardware, an array of this structure
590 struct rte_eth_rss_reta_entry64 {
592 /**< Mask bits indicate which entries need to be updated/queried. */
593 uint16_t reta[RTE_RETA_GROUP_SIZE];
594 /**< Group of 64 redirection table entries. */
598 * This enum indicates the possible number of traffic classes
599 * in DCB configurations
601 enum rte_eth_nb_tcs {
602 ETH_4_TCS = 4, /**< 4 TCs with DCB. */
603 ETH_8_TCS = 8 /**< 8 TCs with DCB. */
607 * This enum indicates the possible number of queue pools
608 * in VMDQ configurations.
610 enum rte_eth_nb_pools {
611 ETH_8_POOLS = 8, /**< 8 VMDq pools. */
612 ETH_16_POOLS = 16, /**< 16 VMDq pools. */
613 ETH_32_POOLS = 32, /**< 32 VMDq pools. */
614 ETH_64_POOLS = 64 /**< 64 VMDq pools. */
617 /* This structure may be extended in future. */
618 struct rte_eth_dcb_rx_conf {
619 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs */
620 /** Traffic class each UP mapped to. */
621 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
624 struct rte_eth_vmdq_dcb_tx_conf {
625 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools. */
626 /** Traffic class each UP mapped to. */
627 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
630 struct rte_eth_dcb_tx_conf {
631 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs. */
632 /** Traffic class each UP mapped to. */
633 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
636 struct rte_eth_vmdq_tx_conf {
637 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq mode, 64 pools. */
641 * A structure used to configure the VMDQ+DCB feature
642 * of an Ethernet port.
644 * Using this feature, packets are routed to a pool of queues, based
645 * on the vlan id in the vlan tag, and then to a specific queue within
646 * that pool, using the user priority vlan tag field.
648 * A default pool may be used, if desired, to route all traffic which
649 * does not match the vlan filter rules.
651 struct rte_eth_vmdq_dcb_conf {
652 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools */
653 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
654 uint8_t default_pool; /**< The default pool, if applicable */
655 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
657 uint16_t vlan_id; /**< The vlan id of the received frame */
658 uint64_t pools; /**< Bitmask of pools for packet rx */
659 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
660 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
661 /**< Selects a queue in a pool */
665 * A structure used to configure the VMDQ feature of an Ethernet port when
666 * not combined with the DCB feature.
668 * Using this feature, packets are routed to a pool of queues. By default,
669 * the pool selection is based on the MAC address, the vlan id in the
670 * vlan tag as specified in the pool_map array.
671 * Passing the ETH_VMDQ_ACCEPT_UNTAG in the rx_mode field allows pool
672 * selection using only the MAC address. MAC address to pool mapping is done
673 * using the rte_eth_dev_mac_addr_add function, with the pool parameter
674 * corresponding to the pool id.
676 * Queue selection within the selected pool will be done using RSS when
677 * it is enabled or revert to the first queue of the pool if not.
679 * A default pool may be used, if desired, to route all traffic which
680 * does not match the vlan filter rules or any pool MAC address.
682 struct rte_eth_vmdq_rx_conf {
683 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq only mode, 8 or 64 pools */
684 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
685 uint8_t default_pool; /**< The default pool, if applicable */
686 uint8_t enable_loop_back; /**< Enable VT loop back */
687 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
688 uint32_t rx_mode; /**< Flags from ETH_VMDQ_ACCEPT_* */
690 uint16_t vlan_id; /**< The vlan id of the received frame */
691 uint64_t pools; /**< Bitmask of pools for packet rx */
692 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
696 * A structure used to configure the TX features of an Ethernet port.
698 struct rte_eth_txmode {
699 enum rte_eth_tx_mq_mode mq_mode; /**< TX multi-queues mode. */
701 * Per-port Tx offloads to be set using DEV_TX_OFFLOAD_* flags.
702 * Only offloads set on tx_offload_capa field on rte_eth_dev_info
703 * structure are allowed to be set.
707 /* For i40e specifically */
710 uint8_t hw_vlan_reject_tagged : 1,
711 /**< If set, reject sending out tagged pkts */
712 hw_vlan_reject_untagged : 1,
713 /**< If set, reject sending out untagged pkts */
714 hw_vlan_insert_pvid : 1;
715 /**< If set, enable port based VLAN insertion */
719 * A structure used to configure an RX ring of an Ethernet port.
721 struct rte_eth_rxconf {
722 struct rte_eth_thresh rx_thresh; /**< RX ring threshold registers. */
723 uint16_t rx_free_thresh; /**< Drives the freeing of RX descriptors. */
724 uint8_t rx_drop_en; /**< Drop packets if no descriptors are available. */
725 uint8_t rx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
727 * Per-queue Rx offloads to be set using DEV_RX_OFFLOAD_* flags.
728 * Only offloads set on rx_queue_offload_capa or rx_offload_capa
729 * fields on rte_eth_dev_info structure are allowed to be set.
734 #define ETH_TXQ_FLAGS_NOMULTSEGS 0x0001 /**< nb_segs=1 for all mbufs */
735 #define ETH_TXQ_FLAGS_NOREFCOUNT 0x0002 /**< refcnt can be ignored */
736 #define ETH_TXQ_FLAGS_NOMULTMEMP 0x0004 /**< all bufs come from same mempool */
737 #define ETH_TXQ_FLAGS_NOVLANOFFL 0x0100 /**< disable VLAN offload */
738 #define ETH_TXQ_FLAGS_NOXSUMSCTP 0x0200 /**< disable SCTP checksum offload */
739 #define ETH_TXQ_FLAGS_NOXSUMUDP 0x0400 /**< disable UDP checksum offload */
740 #define ETH_TXQ_FLAGS_NOXSUMTCP 0x0800 /**< disable TCP checksum offload */
741 #define ETH_TXQ_FLAGS_NOOFFLOADS \
742 (ETH_TXQ_FLAGS_NOVLANOFFL | ETH_TXQ_FLAGS_NOXSUMSCTP | \
743 ETH_TXQ_FLAGS_NOXSUMUDP | ETH_TXQ_FLAGS_NOXSUMTCP)
744 #define ETH_TXQ_FLAGS_NOXSUMS \
745 (ETH_TXQ_FLAGS_NOXSUMSCTP | ETH_TXQ_FLAGS_NOXSUMUDP | \
746 ETH_TXQ_FLAGS_NOXSUMTCP)
748 * When set the txq_flags should be ignored,
749 * instead per-queue Tx offloads will be set on offloads field
750 * located on rte_eth_txq_conf struct.
751 * This flag is temporary till the rte_eth_txq_conf.txq_flags
752 * API will be deprecated.
754 #define ETH_TXQ_FLAGS_IGNORE 0x8000
757 * A structure used to configure a TX ring of an Ethernet port.
759 struct rte_eth_txconf {
760 struct rte_eth_thresh tx_thresh; /**< TX ring threshold registers. */
761 uint16_t tx_rs_thresh; /**< Drives the setting of RS bit on TXDs. */
762 uint16_t tx_free_thresh; /**< Start freeing TX buffers if there are
763 less free descriptors than this value. */
765 uint32_t txq_flags; /**< Set flags for the Tx queue */
766 uint8_t tx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
768 * Per-queue Tx offloads to be set using DEV_TX_OFFLOAD_* flags.
769 * Only offloads set on tx_queue_offload_capa or tx_offload_capa
770 * fields on rte_eth_dev_info structure are allowed to be set.
776 * A structure contains information about HW descriptor ring limitations.
778 struct rte_eth_desc_lim {
779 uint16_t nb_max; /**< Max allowed number of descriptors. */
780 uint16_t nb_min; /**< Min allowed number of descriptors. */
781 uint16_t nb_align; /**< Number of descriptors should be aligned to. */
784 * Max allowed number of segments per whole packet.
786 * - For TSO packet this is the total number of data descriptors allowed
789 * @see nb_mtu_seg_max
794 * Max number of segments per one MTU.
796 * - For non-TSO packet, this is the maximum allowed number of segments
797 * in a single transmit packet.
799 * - For TSO packet each segment within the TSO may span up to this
804 uint16_t nb_mtu_seg_max;
808 * This enum indicates the flow control mode
810 enum rte_eth_fc_mode {
811 RTE_FC_NONE = 0, /**< Disable flow control. */
812 RTE_FC_RX_PAUSE, /**< RX pause frame, enable flowctrl on TX side. */
813 RTE_FC_TX_PAUSE, /**< TX pause frame, enable flowctrl on RX side. */
814 RTE_FC_FULL /**< Enable flow control on both side. */
818 * A structure used to configure Ethernet flow control parameter.
819 * These parameters will be configured into the register of the NIC.
820 * Please refer to the corresponding data sheet for proper value.
822 struct rte_eth_fc_conf {
823 uint32_t high_water; /**< High threshold value to trigger XOFF */
824 uint32_t low_water; /**< Low threshold value to trigger XON */
825 uint16_t pause_time; /**< Pause quota in the Pause frame */
826 uint16_t send_xon; /**< Is XON frame need be sent */
827 enum rte_eth_fc_mode mode; /**< Link flow control mode */
828 uint8_t mac_ctrl_frame_fwd; /**< Forward MAC control frames */
829 uint8_t autoneg; /**< Use Pause autoneg */
833 * A structure used to configure Ethernet priority flow control parameter.
834 * These parameters will be configured into the register of the NIC.
835 * Please refer to the corresponding data sheet for proper value.
837 struct rte_eth_pfc_conf {
838 struct rte_eth_fc_conf fc; /**< General flow control parameter. */
839 uint8_t priority; /**< VLAN User Priority. */
843 * Memory space that can be configured to store Flow Director filters
844 * in the board memory.
846 enum rte_fdir_pballoc_type {
847 RTE_FDIR_PBALLOC_64K = 0, /**< 64k. */
848 RTE_FDIR_PBALLOC_128K, /**< 128k. */
849 RTE_FDIR_PBALLOC_256K, /**< 256k. */
853 * Select report mode of FDIR hash information in RX descriptors.
855 enum rte_fdir_status_mode {
856 RTE_FDIR_NO_REPORT_STATUS = 0, /**< Never report FDIR hash. */
857 RTE_FDIR_REPORT_STATUS, /**< Only report FDIR hash for matching pkts. */
858 RTE_FDIR_REPORT_STATUS_ALWAYS, /**< Always report FDIR hash. */
862 * A structure used to configure the Flow Director (FDIR) feature
863 * of an Ethernet port.
865 * If mode is RTE_FDIR_DISABLE, the pballoc value is ignored.
867 struct rte_fdir_conf {
868 enum rte_fdir_mode mode; /**< Flow Director mode. */
869 enum rte_fdir_pballoc_type pballoc; /**< Space for FDIR filters. */
870 enum rte_fdir_status_mode status; /**< How to report FDIR hash. */
871 /** RX queue of packets matching a "drop" filter in perfect mode. */
873 struct rte_eth_fdir_masks mask;
874 struct rte_eth_fdir_flex_conf flex_conf;
875 /**< Flex payload configuration. */
879 * UDP tunneling configuration.
880 * Used to config the UDP port for a type of tunnel.
881 * NICs need the UDP port to identify the tunnel type.
882 * Normally a type of tunnel has a default UDP port, this structure can be used
883 * in case if the users want to change or support more UDP port.
885 struct rte_eth_udp_tunnel {
886 uint16_t udp_port; /**< UDP port used for the tunnel. */
887 uint8_t prot_type; /**< Tunnel type. Defined in rte_eth_tunnel_type. */
891 * A structure used to enable/disable specific device interrupts.
893 struct rte_intr_conf {
894 /** enable/disable lsc interrupt. 0 (default) - disable, 1 enable */
896 /** enable/disable rxq interrupt. 0 (default) - disable, 1 enable */
898 /** enable/disable rmv interrupt. 0 (default) - disable, 1 enable */
903 * A structure used to configure an Ethernet port.
904 * Depending upon the RX multi-queue mode, extra advanced
905 * configuration settings may be needed.
907 struct rte_eth_conf {
908 uint32_t link_speeds; /**< bitmap of ETH_LINK_SPEED_XXX of speeds to be
909 used. ETH_LINK_SPEED_FIXED disables link
910 autonegotiation, and a unique speed shall be
911 set. Otherwise, the bitmap defines the set of
912 speeds to be advertised. If the special value
913 ETH_LINK_SPEED_AUTONEG (0) is used, all speeds
914 supported are advertised. */
915 struct rte_eth_rxmode rxmode; /**< Port RX configuration. */
916 struct rte_eth_txmode txmode; /**< Port TX configuration. */
917 uint32_t lpbk_mode; /**< Loopback operation mode. By default the value
918 is 0, meaning the loopback mode is disabled.
919 Read the datasheet of given ethernet controller
920 for details. The possible values of this field
921 are defined in implementation of each driver. */
923 struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
924 struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
925 /**< Port vmdq+dcb configuration. */
926 struct rte_eth_dcb_rx_conf dcb_rx_conf;
927 /**< Port dcb RX configuration. */
928 struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
929 /**< Port vmdq RX configuration. */
930 } rx_adv_conf; /**< Port RX filtering configuration. */
932 struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
933 /**< Port vmdq+dcb TX configuration. */
934 struct rte_eth_dcb_tx_conf dcb_tx_conf;
935 /**< Port dcb TX configuration. */
936 struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
937 /**< Port vmdq TX configuration. */
938 } tx_adv_conf; /**< Port TX DCB configuration (union). */
939 /** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
940 is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
941 uint32_t dcb_capability_en;
942 struct rte_fdir_conf fdir_conf; /**< FDIR configuration. */
943 struct rte_intr_conf intr_conf; /**< Interrupt mode configuration. */
947 * A structure used to retrieve the contextual information of
948 * an Ethernet device, such as the controlling driver of the device,
949 * its PCI context, etc...
953 * RX offload capabilities of a device.
955 #define DEV_RX_OFFLOAD_VLAN_STRIP 0x00000001
956 #define DEV_RX_OFFLOAD_IPV4_CKSUM 0x00000002
957 #define DEV_RX_OFFLOAD_UDP_CKSUM 0x00000004
958 #define DEV_RX_OFFLOAD_TCP_CKSUM 0x00000008
959 #define DEV_RX_OFFLOAD_TCP_LRO 0x00000010
960 #define DEV_RX_OFFLOAD_QINQ_STRIP 0x00000020
961 #define DEV_RX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000040
962 #define DEV_RX_OFFLOAD_MACSEC_STRIP 0x00000080
963 #define DEV_RX_OFFLOAD_HEADER_SPLIT 0x00000100
964 #define DEV_RX_OFFLOAD_VLAN_FILTER 0x00000200
965 #define DEV_RX_OFFLOAD_VLAN_EXTEND 0x00000400
966 #define DEV_RX_OFFLOAD_JUMBO_FRAME 0x00000800
967 #define DEV_RX_OFFLOAD_CRC_STRIP 0x00001000
968 #define DEV_RX_OFFLOAD_SCATTER 0x00002000
969 #define DEV_RX_OFFLOAD_TIMESTAMP 0x00004000
970 #define DEV_RX_OFFLOAD_SECURITY 0x00008000
971 #define DEV_RX_OFFLOAD_CHECKSUM (DEV_RX_OFFLOAD_IPV4_CKSUM | \
972 DEV_RX_OFFLOAD_UDP_CKSUM | \
973 DEV_RX_OFFLOAD_TCP_CKSUM)
974 #define DEV_RX_OFFLOAD_VLAN (DEV_RX_OFFLOAD_VLAN_STRIP | \
975 DEV_RX_OFFLOAD_VLAN_FILTER | \
976 DEV_RX_OFFLOAD_VLAN_EXTEND)
979 * TX offload capabilities of a device.
981 #define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001
982 #define DEV_TX_OFFLOAD_IPV4_CKSUM 0x00000002
983 #define DEV_TX_OFFLOAD_UDP_CKSUM 0x00000004
984 #define DEV_TX_OFFLOAD_TCP_CKSUM 0x00000008
985 #define DEV_TX_OFFLOAD_SCTP_CKSUM 0x00000010
986 #define DEV_TX_OFFLOAD_TCP_TSO 0x00000020
987 #define DEV_TX_OFFLOAD_UDP_TSO 0x00000040
988 #define DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000080 /**< Used for tunneling packet. */
989 #define DEV_TX_OFFLOAD_QINQ_INSERT 0x00000100
990 #define DEV_TX_OFFLOAD_VXLAN_TNL_TSO 0x00000200 /**< Used for tunneling packet. */
991 #define DEV_TX_OFFLOAD_GRE_TNL_TSO 0x00000400 /**< Used for tunneling packet. */
992 #define DEV_TX_OFFLOAD_IPIP_TNL_TSO 0x00000800 /**< Used for tunneling packet. */
993 #define DEV_TX_OFFLOAD_GENEVE_TNL_TSO 0x00001000 /**< Used for tunneling packet. */
994 #define DEV_TX_OFFLOAD_MACSEC_INSERT 0x00002000
995 #define DEV_TX_OFFLOAD_MT_LOCKFREE 0x00004000
996 /**< Multiple threads can invoke rte_eth_tx_burst() concurrently on the same
997 * tx queue without SW lock.
999 #define DEV_TX_OFFLOAD_MULTI_SEGS 0x00008000
1000 /**< Device supports multi segment send. */
1001 #define DEV_TX_OFFLOAD_MBUF_FAST_FREE 0x00010000
1002 /**< Device supports optimization for fast release of mbufs.
1003 * When set application must guarantee that per-queue all mbufs comes from
1004 * the same mempool and has refcnt = 1.
1006 #define DEV_TX_OFFLOAD_SECURITY 0x00020000
1008 struct rte_pci_device;
1011 * Ethernet device information
1013 struct rte_eth_dev_info {
1014 struct rte_pci_device *pci_dev; /**< Device PCI information. */
1015 const char *driver_name; /**< Device Driver name. */
1016 unsigned int if_index; /**< Index to bound host interface, or 0 if none.
1017 Use if_indextoname() to translate into an interface name. */
1018 uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
1019 uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
1020 uint16_t max_rx_queues; /**< Maximum number of RX queues. */
1021 uint16_t max_tx_queues; /**< Maximum number of TX queues. */
1022 uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
1023 uint32_t max_hash_mac_addrs;
1024 /** Maximum number of hash MAC addresses for MTA and UTA. */
1025 uint16_t max_vfs; /**< Maximum number of VFs. */
1026 uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
1027 uint64_t rx_offload_capa;
1028 /**< Device per port RX offload capabilities. */
1029 uint64_t tx_offload_capa;
1030 /**< Device per port TX offload capabilities. */
1031 uint64_t rx_queue_offload_capa;
1032 /**< Device per queue RX offload capabilities. */
1033 uint64_t tx_queue_offload_capa;
1034 /**< Device per queue TX offload capabilities. */
1036 /**< Device redirection table size, the total number of entries. */
1037 uint8_t hash_key_size; /**< Hash key size in bytes */
1038 /** Bit mask of RSS offloads, the bit offset also means flow type */
1039 uint64_t flow_type_rss_offloads;
1040 struct rte_eth_rxconf default_rxconf; /**< Default RX configuration */
1041 struct rte_eth_txconf default_txconf; /**< Default TX configuration */
1042 uint16_t vmdq_queue_base; /**< First queue ID for VMDQ pools. */
1043 uint16_t vmdq_queue_num; /**< Queue number for VMDQ pools. */
1044 uint16_t vmdq_pool_base; /**< First ID of VMDQ pools. */
1045 struct rte_eth_desc_lim rx_desc_lim; /**< RX descriptors limits */
1046 struct rte_eth_desc_lim tx_desc_lim; /**< TX descriptors limits */
1047 uint32_t speed_capa; /**< Supported speeds bitmap (ETH_LINK_SPEED_). */
1048 /** Configured number of rx/tx queues */
1049 uint16_t nb_rx_queues; /**< Number of RX queues. */
1050 uint16_t nb_tx_queues; /**< Number of TX queues. */
1054 * Ethernet device RX queue information structure.
1055 * Used to retieve information about configured queue.
1057 struct rte_eth_rxq_info {
1058 struct rte_mempool *mp; /**< mempool used by that queue. */
1059 struct rte_eth_rxconf conf; /**< queue config parameters. */
1060 uint8_t scattered_rx; /**< scattered packets RX supported. */
1061 uint16_t nb_desc; /**< configured number of RXDs. */
1062 } __rte_cache_min_aligned;
1065 * Ethernet device TX queue information structure.
1066 * Used to retrieve information about configured queue.
1068 struct rte_eth_txq_info {
1069 struct rte_eth_txconf conf; /**< queue config parameters. */
1070 uint16_t nb_desc; /**< configured number of TXDs. */
1071 } __rte_cache_min_aligned;
1073 /** Maximum name length for extended statistics counters */
1074 #define RTE_ETH_XSTATS_NAME_SIZE 64
1077 * An Ethernet device extended statistic structure
1079 * This structure is used by rte_eth_xstats_get() to provide
1080 * statistics that are not provided in the generic *rte_eth_stats*
1082 * It maps a name id, corresponding to an index in the array returned
1083 * by rte_eth_xstats_get_names(), to a statistic value.
1085 struct rte_eth_xstat {
1086 uint64_t id; /**< The index in xstats name array. */
1087 uint64_t value; /**< The statistic counter value. */
1091 * A name element for extended statistics.
1093 * An array of this structure is returned by rte_eth_xstats_get_names().
1094 * It lists the names of extended statistics for a PMD. The *rte_eth_xstat*
1095 * structure references these names by their array index.
1097 struct rte_eth_xstat_name {
1098 char name[RTE_ETH_XSTATS_NAME_SIZE]; /**< The statistic name. */
1101 #define ETH_DCB_NUM_TCS 8
1102 #define ETH_MAX_VMDQ_POOL 64
1105 * A structure used to get the information of queue and
1106 * TC mapping on both TX and RX paths.
1108 struct rte_eth_dcb_tc_queue_mapping {
1109 /** rx queues assigned to tc per Pool */
1113 } tc_rxq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
1114 /** rx queues assigned to tc per Pool */
1118 } tc_txq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
1122 * A structure used to get the information of DCB.
1123 * It includes TC UP mapping and queue TC mapping.
1125 struct rte_eth_dcb_info {
1126 uint8_t nb_tcs; /**< number of TCs */
1127 uint8_t prio_tc[ETH_DCB_NUM_USER_PRIORITIES]; /**< Priority to tc */
1128 uint8_t tc_bws[ETH_DCB_NUM_TCS]; /**< TX BW percentage for each TC */
1129 /** rx queues assigned to tc */
1130 struct rte_eth_dcb_tc_queue_mapping tc_queue;
1134 * RX/TX queue states
1136 #define RTE_ETH_QUEUE_STATE_STOPPED 0
1137 #define RTE_ETH_QUEUE_STATE_STARTED 1
1141 struct rte_eth_dev_callback;
1142 /** @internal Structure to keep track of registered callbacks */
1143 TAILQ_HEAD(rte_eth_dev_cb_list, rte_eth_dev_callback);
1145 /* Macros to check for valid port */
1146 #define RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, retval) do { \
1147 if (!rte_eth_dev_is_valid_port(port_id)) { \
1148 RTE_PMD_DEBUG_TRACE("Invalid port_id=%d\n", port_id); \
1153 #define RTE_ETH_VALID_PORTID_OR_RET(port_id) do { \
1154 if (!rte_eth_dev_is_valid_port(port_id)) { \
1155 RTE_PMD_DEBUG_TRACE("Invalid port_id=%d\n", port_id); \
1161 * l2 tunnel configuration.
1164 /**< l2 tunnel enable mask */
1165 #define ETH_L2_TUNNEL_ENABLE_MASK 0x00000001
1166 /**< l2 tunnel insertion mask */
1167 #define ETH_L2_TUNNEL_INSERTION_MASK 0x00000002
1168 /**< l2 tunnel stripping mask */
1169 #define ETH_L2_TUNNEL_STRIPPING_MASK 0x00000004
1170 /**< l2 tunnel forwarding mask */
1171 #define ETH_L2_TUNNEL_FORWARDING_MASK 0x00000008
1174 * Definitions of all functions exported by an Ethernet driver through the
1175 * the generic structure of type *eth_dev_ops* supplied in the *rte_eth_dev*
1176 * structure associated with an Ethernet device.
1179 typedef int (*eth_dev_configure_t)(struct rte_eth_dev *dev);
1180 /**< @internal Ethernet device configuration. */
1182 typedef int (*eth_dev_start_t)(struct rte_eth_dev *dev);
1183 /**< @internal Function used to start a configured Ethernet device. */
1185 typedef void (*eth_dev_stop_t)(struct rte_eth_dev *dev);
1186 /**< @internal Function used to stop a configured Ethernet device. */
1188 typedef int (*eth_dev_set_link_up_t)(struct rte_eth_dev *dev);
1189 /**< @internal Function used to link up a configured Ethernet device. */
1191 typedef int (*eth_dev_set_link_down_t)(struct rte_eth_dev *dev);
1192 /**< @internal Function used to link down a configured Ethernet device. */
1194 typedef void (*eth_dev_close_t)(struct rte_eth_dev *dev);
1195 /**< @internal Function used to close a configured Ethernet device. */
1197 typedef int (*eth_dev_reset_t)(struct rte_eth_dev *dev);
1198 /** <@internal Function used to reset a configured Ethernet device. */
1200 typedef void (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev);
1201 /**< @internal Function used to enable the RX promiscuous mode of an Ethernet device. */
1203 typedef void (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev);
1204 /**< @internal Function used to disable the RX promiscuous mode of an Ethernet device. */
1206 typedef void (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
1207 /**< @internal Enable the receipt of all multicast packets by an Ethernet device. */
1209 typedef void (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
1210 /**< @internal Disable the receipt of all multicast packets by an Ethernet device. */
1212 typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
1213 int wait_to_complete);
1214 /**< @internal Get link speed, duplex mode and state (up/down) of an Ethernet device. */
1216 typedef int (*eth_stats_get_t)(struct rte_eth_dev *dev,
1217 struct rte_eth_stats *igb_stats);
1218 /**< @internal Get global I/O statistics of an Ethernet device. */
1220 typedef void (*eth_stats_reset_t)(struct rte_eth_dev *dev);
1221 /**< @internal Reset global I/O statistics of an Ethernet device to 0. */
1223 typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev,
1224 struct rte_eth_xstat *stats, unsigned n);
1225 /**< @internal Get extended stats of an Ethernet device. */
1227 typedef int (*eth_xstats_get_by_id_t)(struct rte_eth_dev *dev,
1228 const uint64_t *ids,
1231 /**< @internal Get extended stats of an Ethernet device. */
1233 typedef void (*eth_xstats_reset_t)(struct rte_eth_dev *dev);
1234 /**< @internal Reset extended stats of an Ethernet device. */
1236 typedef int (*eth_xstats_get_names_t)(struct rte_eth_dev *dev,
1237 struct rte_eth_xstat_name *xstats_names, unsigned size);
1238 /**< @internal Get names of extended stats of an Ethernet device. */
1240 typedef int (*eth_xstats_get_names_by_id_t)(struct rte_eth_dev *dev,
1241 struct rte_eth_xstat_name *xstats_names, const uint64_t *ids,
1243 /**< @internal Get names of extended stats of an Ethernet device. */
1245 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
1249 /**< @internal Set a queue statistics mapping for a tx/rx queue of an Ethernet device. */
1251 typedef void (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
1252 struct rte_eth_dev_info *dev_info);
1253 /**< @internal Get specific informations of an Ethernet device. */
1255 typedef const uint32_t *(*eth_dev_supported_ptypes_get_t)(struct rte_eth_dev *dev);
1256 /**< @internal Get supported ptypes of an Ethernet device. */
1258 typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
1260 /**< @internal Start rx and tx of a queue of an Ethernet device. */
1262 typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
1264 /**< @internal Stop rx and tx of a queue of an Ethernet device. */
1266 typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
1267 uint16_t rx_queue_id,
1268 uint16_t nb_rx_desc,
1269 unsigned int socket_id,
1270 const struct rte_eth_rxconf *rx_conf,
1271 struct rte_mempool *mb_pool);
1272 /**< @internal Set up a receive queue of an Ethernet device. */
1274 typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
1275 uint16_t tx_queue_id,
1276 uint16_t nb_tx_desc,
1277 unsigned int socket_id,
1278 const struct rte_eth_txconf *tx_conf);
1279 /**< @internal Setup a transmit queue of an Ethernet device. */
1281 typedef int (*eth_rx_enable_intr_t)(struct rte_eth_dev *dev,
1282 uint16_t rx_queue_id);
1283 /**< @internal Enable interrupt of a receive queue of an Ethernet device. */
1285 typedef int (*eth_rx_disable_intr_t)(struct rte_eth_dev *dev,
1286 uint16_t rx_queue_id);
1287 /**< @internal Disable interrupt of a receive queue of an Ethernet device. */
1289 typedef void (*eth_queue_release_t)(void *queue);
1290 /**< @internal Release memory resources allocated by given RX/TX queue. */
1292 typedef uint32_t (*eth_rx_queue_count_t)(struct rte_eth_dev *dev,
1293 uint16_t rx_queue_id);
1294 /**< @internal Get number of used descriptors on a receive queue. */
1296 typedef int (*eth_rx_descriptor_done_t)(void *rxq, uint16_t offset);
1297 /**< @internal Check DD bit of specific RX descriptor */
1299 typedef int (*eth_rx_descriptor_status_t)(void *rxq, uint16_t offset);
1300 /**< @internal Check the status of a Rx descriptor */
1302 typedef int (*eth_tx_descriptor_status_t)(void *txq, uint16_t offset);
1303 /**< @internal Check the status of a Tx descriptor */
1305 typedef int (*eth_fw_version_get_t)(struct rte_eth_dev *dev,
1306 char *fw_version, size_t fw_size);
1307 /**< @internal Get firmware information of an Ethernet device. */
1309 typedef int (*eth_tx_done_cleanup_t)(void *txq, uint32_t free_cnt);
1310 /**< @internal Force mbufs to be from TX ring. */
1312 typedef void (*eth_rxq_info_get_t)(struct rte_eth_dev *dev,
1313 uint16_t rx_queue_id, struct rte_eth_rxq_info *qinfo);
1315 typedef void (*eth_txq_info_get_t)(struct rte_eth_dev *dev,
1316 uint16_t tx_queue_id, struct rte_eth_txq_info *qinfo);
1318 typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);
1319 /**< @internal Set MTU. */
1321 typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
1324 /**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */
1326 typedef int (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
1327 enum rte_vlan_type type, uint16_t tpid);
1328 /**< @internal set the outer/inner VLAN-TPID by an Ethernet device. */
1330 typedef int (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
1331 /**< @internal set VLAN offload function by an Ethernet device. */
1333 typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
1336 /**< @internal set port based TX VLAN insertion by an Ethernet device. */
1338 typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
1339 uint16_t rx_queue_id,
1341 /**< @internal VLAN stripping enable/disable by an queue of Ethernet device. */
1343 typedef uint16_t (*eth_rx_burst_t)(void *rxq,
1344 struct rte_mbuf **rx_pkts,
1346 /**< @internal Retrieve input packets from a receive queue of an Ethernet device. */
1348 typedef uint16_t (*eth_tx_burst_t)(void *txq,
1349 struct rte_mbuf **tx_pkts,
1351 /**< @internal Send output packets on a transmit queue of an Ethernet device. */
1353 typedef uint16_t (*eth_tx_prep_t)(void *txq,
1354 struct rte_mbuf **tx_pkts,
1356 /**< @internal Prepare output packets on a transmit queue of an Ethernet device. */
1358 typedef int (*flow_ctrl_get_t)(struct rte_eth_dev *dev,
1359 struct rte_eth_fc_conf *fc_conf);
1360 /**< @internal Get current flow control parameter on an Ethernet device */
1362 typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
1363 struct rte_eth_fc_conf *fc_conf);
1364 /**< @internal Setup flow control parameter on an Ethernet device */
1366 typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
1367 struct rte_eth_pfc_conf *pfc_conf);
1368 /**< @internal Setup priority flow control parameter on an Ethernet device */
1370 typedef int (*reta_update_t)(struct rte_eth_dev *dev,
1371 struct rte_eth_rss_reta_entry64 *reta_conf,
1372 uint16_t reta_size);
1373 /**< @internal Update RSS redirection table on an Ethernet device */
1375 typedef int (*reta_query_t)(struct rte_eth_dev *dev,
1376 struct rte_eth_rss_reta_entry64 *reta_conf,
1377 uint16_t reta_size);
1378 /**< @internal Query RSS redirection table on an Ethernet device */
1380 typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
1381 struct rte_eth_rss_conf *rss_conf);
1382 /**< @internal Update RSS hash configuration of an Ethernet device */
1384 typedef int (*rss_hash_conf_get_t)(struct rte_eth_dev *dev,
1385 struct rte_eth_rss_conf *rss_conf);
1386 /**< @internal Get current RSS hash configuration of an Ethernet device */
1388 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
1389 /**< @internal Turn on SW controllable LED on an Ethernet device */
1391 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
1392 /**< @internal Turn off SW controllable LED on an Ethernet device */
1394 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
1395 /**< @internal Remove MAC address from receive address register */
1397 typedef int (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
1398 struct ether_addr *mac_addr,
1401 /**< @internal Set a MAC address into Receive Address Address Register */
1403 typedef void (*eth_mac_addr_set_t)(struct rte_eth_dev *dev,
1404 struct ether_addr *mac_addr);
1405 /**< @internal Set a MAC address into Receive Address Address Register */
1407 typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
1408 struct ether_addr *mac_addr,
1410 /**< @internal Set a Unicast Hash bitmap */
1412 typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
1414 /**< @internal Set all Unicast Hash bitmap */
1416 typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
1419 /**< @internal Set queue TX rate */
1421 typedef int (*eth_mirror_rule_set_t)(struct rte_eth_dev *dev,
1422 struct rte_eth_mirror_conf *mirror_conf,
1425 /**< @internal Add a traffic mirroring rule on an Ethernet device */
1427 typedef int (*eth_mirror_rule_reset_t)(struct rte_eth_dev *dev,
1429 /**< @internal Remove a traffic mirroring rule on an Ethernet device */
1431 typedef int (*eth_udp_tunnel_port_add_t)(struct rte_eth_dev *dev,
1432 struct rte_eth_udp_tunnel *tunnel_udp);
1433 /**< @internal Add tunneling UDP port */
1435 typedef int (*eth_udp_tunnel_port_del_t)(struct rte_eth_dev *dev,
1436 struct rte_eth_udp_tunnel *tunnel_udp);
1437 /**< @internal Delete tunneling UDP port */
1439 typedef int (*eth_set_mc_addr_list_t)(struct rte_eth_dev *dev,
1440 struct ether_addr *mc_addr_set,
1441 uint32_t nb_mc_addr);
1442 /**< @internal set the list of multicast addresses on an Ethernet device */
1444 typedef int (*eth_timesync_enable_t)(struct rte_eth_dev *dev);
1445 /**< @internal Function used to enable IEEE1588/802.1AS timestamping. */
1447 typedef int (*eth_timesync_disable_t)(struct rte_eth_dev *dev);
1448 /**< @internal Function used to disable IEEE1588/802.1AS timestamping. */
1450 typedef int (*eth_timesync_read_rx_timestamp_t)(struct rte_eth_dev *dev,
1451 struct timespec *timestamp,
1453 /**< @internal Function used to read an RX IEEE1588/802.1AS timestamp. */
1455 typedef int (*eth_timesync_read_tx_timestamp_t)(struct rte_eth_dev *dev,
1456 struct timespec *timestamp);
1457 /**< @internal Function used to read a TX IEEE1588/802.1AS timestamp. */
1459 typedef int (*eth_timesync_adjust_time)(struct rte_eth_dev *dev, int64_t);
1460 /**< @internal Function used to adjust the device clock */
1462 typedef int (*eth_timesync_read_time)(struct rte_eth_dev *dev,
1463 struct timespec *timestamp);
1464 /**< @internal Function used to get time from the device clock. */
1466 typedef int (*eth_timesync_write_time)(struct rte_eth_dev *dev,
1467 const struct timespec *timestamp);
1468 /**< @internal Function used to get time from the device clock */
1470 typedef int (*eth_get_reg_t)(struct rte_eth_dev *dev,
1471 struct rte_dev_reg_info *info);
1472 /**< @internal Retrieve registers */
1474 typedef int (*eth_get_eeprom_length_t)(struct rte_eth_dev *dev);
1475 /**< @internal Retrieve eeprom size */
1477 typedef int (*eth_get_eeprom_t)(struct rte_eth_dev *dev,
1478 struct rte_dev_eeprom_info *info);
1479 /**< @internal Retrieve eeprom data */
1481 typedef int (*eth_set_eeprom_t)(struct rte_eth_dev *dev,
1482 struct rte_dev_eeprom_info *info);
1483 /**< @internal Program eeprom data */
1485 typedef int (*eth_l2_tunnel_eth_type_conf_t)
1486 (struct rte_eth_dev *dev, struct rte_eth_l2_tunnel_conf *l2_tunnel);
1487 /**< @internal config l2 tunnel ether type */
1489 typedef int (*eth_l2_tunnel_offload_set_t)
1490 (struct rte_eth_dev *dev,
1491 struct rte_eth_l2_tunnel_conf *l2_tunnel,
1494 /**< @internal enable/disable the l2 tunnel offload functions */
1497 typedef int (*eth_filter_ctrl_t)(struct rte_eth_dev *dev,
1498 enum rte_filter_type filter_type,
1499 enum rte_filter_op filter_op,
1501 /**< @internal Take operations to assigned filter type on an Ethernet device */
1503 typedef int (*eth_tm_ops_get_t)(struct rte_eth_dev *dev, void *ops);
1504 /**< @internal Get Traffic Management (TM) operations on an Ethernet device */
1506 typedef int (*eth_mtr_ops_get_t)(struct rte_eth_dev *dev, void *ops);
1507 /**< @internal Get Trafffic Metering and Policing (MTR) operations */
1509 typedef int (*eth_get_dcb_info)(struct rte_eth_dev *dev,
1510 struct rte_eth_dcb_info *dcb_info);
1511 /**< @internal Get dcb information on an Ethernet device */
1513 typedef int (*eth_pool_ops_supported_t)(struct rte_eth_dev *dev,
1515 /**< @internal Test if a port supports specific mempool ops */
1518 * @internal A structure containing the functions exported by an Ethernet driver.
1520 struct eth_dev_ops {
1521 eth_dev_configure_t dev_configure; /**< Configure device. */
1522 eth_dev_start_t dev_start; /**< Start device. */
1523 eth_dev_stop_t dev_stop; /**< Stop device. */
1524 eth_dev_set_link_up_t dev_set_link_up; /**< Device link up. */
1525 eth_dev_set_link_down_t dev_set_link_down; /**< Device link down. */
1526 eth_dev_close_t dev_close; /**< Close device. */
1527 eth_dev_reset_t dev_reset; /**< Reset device. */
1528 eth_link_update_t link_update; /**< Get device link state. */
1530 eth_promiscuous_enable_t promiscuous_enable; /**< Promiscuous ON. */
1531 eth_promiscuous_disable_t promiscuous_disable;/**< Promiscuous OFF. */
1532 eth_allmulticast_enable_t allmulticast_enable;/**< RX multicast ON. */
1533 eth_allmulticast_disable_t allmulticast_disable;/**< RX multicast OFF. */
1534 eth_mac_addr_remove_t mac_addr_remove; /**< Remove MAC address. */
1535 eth_mac_addr_add_t mac_addr_add; /**< Add a MAC address. */
1536 eth_mac_addr_set_t mac_addr_set; /**< Set a MAC address. */
1537 eth_set_mc_addr_list_t set_mc_addr_list; /**< set list of mcast addrs. */
1538 mtu_set_t mtu_set; /**< Set MTU. */
1540 eth_stats_get_t stats_get; /**< Get generic device statistics. */
1541 eth_stats_reset_t stats_reset; /**< Reset generic device statistics. */
1542 eth_xstats_get_t xstats_get; /**< Get extended device statistics. */
1543 eth_xstats_reset_t xstats_reset; /**< Reset extended device statistics. */
1544 eth_xstats_get_names_t xstats_get_names;
1545 /**< Get names of extended statistics. */
1546 eth_queue_stats_mapping_set_t queue_stats_mapping_set;
1547 /**< Configure per queue stat counter mapping. */
1549 eth_dev_infos_get_t dev_infos_get; /**< Get device info. */
1550 eth_rxq_info_get_t rxq_info_get; /**< retrieve RX queue information. */
1551 eth_txq_info_get_t txq_info_get; /**< retrieve TX queue information. */
1552 eth_fw_version_get_t fw_version_get; /**< Get firmware version. */
1553 eth_dev_supported_ptypes_get_t dev_supported_ptypes_get;
1554 /**< Get packet types supported and identified by device. */
1556 vlan_filter_set_t vlan_filter_set; /**< Filter VLAN Setup. */
1557 vlan_tpid_set_t vlan_tpid_set; /**< Outer/Inner VLAN TPID Setup. */
1558 vlan_strip_queue_set_t vlan_strip_queue_set; /**< VLAN Stripping on queue. */
1559 vlan_offload_set_t vlan_offload_set; /**< Set VLAN Offload. */
1560 vlan_pvid_set_t vlan_pvid_set; /**< Set port based TX VLAN insertion. */
1562 eth_queue_start_t rx_queue_start;/**< Start RX for a queue. */
1563 eth_queue_stop_t rx_queue_stop; /**< Stop RX for a queue. */
1564 eth_queue_start_t tx_queue_start;/**< Start TX for a queue. */
1565 eth_queue_stop_t tx_queue_stop; /**< Stop TX for a queue. */
1566 eth_rx_queue_setup_t rx_queue_setup;/**< Set up device RX queue. */
1567 eth_queue_release_t rx_queue_release; /**< Release RX queue. */
1568 eth_rx_queue_count_t rx_queue_count;
1569 /**< Get the number of used RX descriptors. */
1570 eth_rx_descriptor_done_t rx_descriptor_done; /**< Check rxd DD bit. */
1571 eth_rx_descriptor_status_t rx_descriptor_status;
1572 /**< Check the status of a Rx descriptor. */
1573 eth_tx_descriptor_status_t tx_descriptor_status;
1574 /**< Check the status of a Tx descriptor. */
1575 eth_rx_enable_intr_t rx_queue_intr_enable; /**< Enable Rx queue interrupt. */
1576 eth_rx_disable_intr_t rx_queue_intr_disable; /**< Disable Rx queue interrupt. */
1577 eth_tx_queue_setup_t tx_queue_setup;/**< Set up device TX queue. */
1578 eth_queue_release_t tx_queue_release; /**< Release TX queue. */
1579 eth_tx_done_cleanup_t tx_done_cleanup;/**< Free tx ring mbufs */
1581 eth_dev_led_on_t dev_led_on; /**< Turn on LED. */
1582 eth_dev_led_off_t dev_led_off; /**< Turn off LED. */
1584 flow_ctrl_get_t flow_ctrl_get; /**< Get flow control. */
1585 flow_ctrl_set_t flow_ctrl_set; /**< Setup flow control. */
1586 priority_flow_ctrl_set_t priority_flow_ctrl_set; /**< Setup priority flow control. */
1588 eth_uc_hash_table_set_t uc_hash_table_set; /**< Set Unicast Table Array. */
1589 eth_uc_all_hash_table_set_t uc_all_hash_table_set; /**< Set Unicast hash bitmap. */
1591 eth_mirror_rule_set_t mirror_rule_set; /**< Add a traffic mirror rule. */
1592 eth_mirror_rule_reset_t mirror_rule_reset; /**< reset a traffic mirror rule. */
1594 eth_udp_tunnel_port_add_t udp_tunnel_port_add; /** Add UDP tunnel port. */
1595 eth_udp_tunnel_port_del_t udp_tunnel_port_del; /** Del UDP tunnel port. */
1596 eth_l2_tunnel_eth_type_conf_t l2_tunnel_eth_type_conf;
1597 /** Config ether type of l2 tunnel. */
1598 eth_l2_tunnel_offload_set_t l2_tunnel_offload_set;
1599 /** Enable/disable l2 tunnel offload functions. */
1601 eth_set_queue_rate_limit_t set_queue_rate_limit; /**< Set queue rate limit. */
1603 rss_hash_update_t rss_hash_update; /** Configure RSS hash protocols. */
1604 rss_hash_conf_get_t rss_hash_conf_get; /** Get current RSS hash configuration. */
1605 reta_update_t reta_update; /** Update redirection table. */
1606 reta_query_t reta_query; /** Query redirection table. */
1608 eth_get_reg_t get_reg; /**< Get registers. */
1609 eth_get_eeprom_length_t get_eeprom_length; /**< Get eeprom length. */
1610 eth_get_eeprom_t get_eeprom; /**< Get eeprom data. */
1611 eth_set_eeprom_t set_eeprom; /**< Set eeprom. */
1614 eth_filter_ctrl_t filter_ctrl; /**< common filter control. */
1616 eth_get_dcb_info get_dcb_info; /** Get DCB information. */
1618 eth_timesync_enable_t timesync_enable;
1619 /** Turn IEEE1588/802.1AS timestamping on. */
1620 eth_timesync_disable_t timesync_disable;
1621 /** Turn IEEE1588/802.1AS timestamping off. */
1622 eth_timesync_read_rx_timestamp_t timesync_read_rx_timestamp;
1623 /** Read the IEEE1588/802.1AS RX timestamp. */
1624 eth_timesync_read_tx_timestamp_t timesync_read_tx_timestamp;
1625 /** Read the IEEE1588/802.1AS TX timestamp. */
1626 eth_timesync_adjust_time timesync_adjust_time; /** Adjust the device clock. */
1627 eth_timesync_read_time timesync_read_time; /** Get the device clock time. */
1628 eth_timesync_write_time timesync_write_time; /** Set the device clock time. */
1630 eth_xstats_get_by_id_t xstats_get_by_id;
1631 /**< Get extended device statistic values by ID. */
1632 eth_xstats_get_names_by_id_t xstats_get_names_by_id;
1633 /**< Get name of extended device statistics by ID. */
1635 eth_tm_ops_get_t tm_ops_get;
1636 /**< Get Traffic Management (TM) operations. */
1638 eth_mtr_ops_get_t mtr_ops_get;
1639 /**< Get Traffic Metering and Policing (MTR) operations. */
1641 eth_pool_ops_supported_t pool_ops_supported;
1642 /**< Test if a port supports specific mempool ops */
1646 * Function type used for RX packet processing packet callbacks.
1648 * The callback function is called on RX with a burst of packets that have
1649 * been received on the given port and queue.
1652 * The Ethernet port on which RX is being performed.
1654 * The queue on the Ethernet port which is being used to receive the packets.
1656 * The burst of packets that have just been received.
1658 * The number of packets in the burst pointed to by "pkts".
1660 * The max number of packets that can be stored in the "pkts" array.
1662 * The arbitrary user parameter passed in by the application when the callback
1663 * was originally configured.
1665 * The number of packets returned to the user.
1667 typedef uint16_t (*rte_rx_callback_fn)(uint16_t port, uint16_t queue,
1668 struct rte_mbuf *pkts[], uint16_t nb_pkts, uint16_t max_pkts,
1672 * Function type used for TX packet processing packet callbacks.
1674 * The callback function is called on TX with a burst of packets immediately
1675 * before the packets are put onto the hardware queue for transmission.
1678 * The Ethernet port on which TX is being performed.
1680 * The queue on the Ethernet port which is being used to transmit the packets.
1682 * The burst of packets that are about to be transmitted.
1684 * The number of packets in the burst pointed to by "pkts".
1686 * The arbitrary user parameter passed in by the application when the callback
1687 * was originally configured.
1689 * The number of packets to be written to the NIC.
1691 typedef uint16_t (*rte_tx_callback_fn)(uint16_t port, uint16_t queue,
1692 struct rte_mbuf *pkts[], uint16_t nb_pkts, void *user_param);
1696 * Structure used to hold information about the callbacks to be called for a
1697 * queue on RX and TX.
1699 struct rte_eth_rxtx_callback {
1700 struct rte_eth_rxtx_callback *next;
1702 rte_rx_callback_fn rx;
1703 rte_tx_callback_fn tx;
1709 * A set of values to describe the possible states of an eth device.
1711 enum rte_eth_dev_state {
1712 RTE_ETH_DEV_UNUSED = 0,
1713 RTE_ETH_DEV_ATTACHED,
1714 RTE_ETH_DEV_DEFERRED,
1719 * The generic data structure associated with each ethernet device.
1721 * Pointers to burst-oriented packet receive and transmit functions are
1722 * located at the beginning of the structure, along with the pointer to
1723 * where all the data elements for the particular device are stored in shared
1724 * memory. This split allows the function pointer and driver data to be per-
1725 * process, while the actual configuration data for the device is shared.
1727 struct rte_eth_dev {
1728 eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
1729 eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
1730 eth_tx_prep_t tx_pkt_prepare; /**< Pointer to PMD transmit prepare function. */
1731 struct rte_eth_dev_data *data; /**< Pointer to device data */
1732 const struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
1733 struct rte_device *device; /**< Backing device */
1734 struct rte_intr_handle *intr_handle; /**< Device interrupt handle */
1735 /** User application callbacks for NIC interrupts */
1736 struct rte_eth_dev_cb_list link_intr_cbs;
1738 * User-supplied functions called from rx_burst to post-process
1739 * received packets before passing them to the user
1741 struct rte_eth_rxtx_callback *post_rx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
1743 * User-supplied functions called from tx_burst to pre-process
1744 * received packets before passing them to the driver for transmission.
1746 struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
1747 enum rte_eth_dev_state state; /**< Flag indicating the port state */
1748 void *security_ctx; /**< Context for security ops */
1749 } __rte_cache_aligned;
1752 rte_eth_dev_get_sec_ctx(uint8_t port_id);
1754 struct rte_eth_dev_sriov {
1755 uint8_t active; /**< SRIOV is active with 16, 32 or 64 pools */
1756 uint8_t nb_q_per_pool; /**< rx queue number per pool */
1757 uint16_t def_vmdq_idx; /**< Default pool num used for PF */
1758 uint16_t def_pool_q_idx; /**< Default pool queue start reg index */
1760 #define RTE_ETH_DEV_SRIOV(dev) ((dev)->data->sriov)
1762 #define RTE_ETH_NAME_MAX_LEN RTE_DEV_NAME_MAX_LEN
1766 * The data part, with no function pointers, associated with each ethernet device.
1768 * This structure is safe to place in shared memory to be common among different
1769 * processes in a multi-process configuration.
1771 struct rte_eth_dev_data {
1772 char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
1774 void **rx_queues; /**< Array of pointers to RX queues. */
1775 void **tx_queues; /**< Array of pointers to TX queues. */
1776 uint16_t nb_rx_queues; /**< Number of RX queues. */
1777 uint16_t nb_tx_queues; /**< Number of TX queues. */
1779 struct rte_eth_dev_sriov sriov; /**< SRIOV data */
1781 void *dev_private; /**< PMD-specific private data */
1783 struct rte_eth_link dev_link;
1784 /**< Link-level information & status */
1786 struct rte_eth_conf dev_conf; /**< Configuration applied to device. */
1787 uint16_t mtu; /**< Maximum Transmission Unit. */
1789 uint32_t min_rx_buf_size;
1790 /**< Common rx buffer size handled by all queues */
1792 uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
1793 struct ether_addr* mac_addrs;/**< Device Ethernet Link address. */
1794 uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
1795 /** bitmap array of associating Ethernet MAC addresses to pools */
1796 struct ether_addr* hash_mac_addrs;
1797 /** Device Ethernet MAC addresses of hash filtering. */
1798 uint16_t port_id; /**< Device [external] port identifier. */
1800 uint8_t promiscuous : 1, /**< RX promiscuous mode ON(1) / OFF(0). */
1801 scattered_rx : 1, /**< RX of scattered packets is ON(1) / OFF(0) */
1802 all_multicast : 1, /**< RX all multicast mode ON(1) / OFF(0). */
1803 dev_started : 1, /**< Device state: STARTED(1) / STOPPED(0). */
1804 lro : 1; /**< RX LRO is ON(1) / OFF(0) */
1805 uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT];
1806 /** Queues state: STARTED(1) / STOPPED(0) */
1807 uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
1808 /** Queues state: STARTED(1) / STOPPED(0) */
1809 uint32_t dev_flags; /**< Capabilities */
1810 enum rte_kernel_driver kdrv; /**< Kernel driver passthrough */
1811 int numa_node; /**< NUMA node connection */
1812 struct rte_vlan_filter_conf vlan_filter_conf;
1813 /**< VLAN filter configuration. */
1816 /** Device supports link state interrupt */
1817 #define RTE_ETH_DEV_INTR_LSC 0x0002
1818 /** Device is a bonded slave */
1819 #define RTE_ETH_DEV_BONDED_SLAVE 0x0004
1820 /** Device supports device removal interrupt */
1821 #define RTE_ETH_DEV_INTR_RMV 0x0008
1825 * The pool of *rte_eth_dev* structures. The size of the pool
1826 * is configured at compile-time in the <rte_ethdev.c> file.
1828 extern struct rte_eth_dev rte_eth_devices[];
1831 * Iterates over valid ethdev ports.
1834 * The id of the next possible valid port.
1836 * Next valid port id, RTE_MAX_ETHPORTS if there is none.
1838 uint16_t rte_eth_find_next(uint16_t port_id);
1841 * Macro to iterate over all enabled ethdev ports.
1843 #define RTE_ETH_FOREACH_DEV(p) \
1844 for (p = rte_eth_find_next(0); \
1845 (unsigned int)p < (unsigned int)RTE_MAX_ETHPORTS; \
1846 p = rte_eth_find_next(p + 1))
1850 * Get the total number of Ethernet devices that have been successfully
1851 * initialized by the matching Ethernet driver during the PCI probing phase
1852 * and that are available for applications to use. These devices must be
1853 * accessed by using the ``RTE_ETH_FOREACH_DEV()`` macro to deal with
1854 * non-contiguous ranges of devices.
1855 * These non-contiguous ranges can be created by calls to hotplug functions or
1859 * - The total number of usable Ethernet devices.
1861 uint16_t rte_eth_dev_count(void);
1865 * Returns a ethdev slot specified by the unique identifier name.
1868 * The pointer to the Unique identifier name for each Ethernet device
1870 * - The pointer to the ethdev slot, on success. NULL on error
1872 struct rte_eth_dev *rte_eth_dev_allocated(const char *name);
1876 * Allocates a new ethdev slot for an ethernet device and returns the pointer
1877 * to that slot for the driver to use.
1879 * @param name Unique identifier name for each Ethernet device
1880 * @param type Device type of this Ethernet device
1882 * - Slot in the rte_dev_devices array for a new device;
1884 struct rte_eth_dev *rte_eth_dev_allocate(const char *name);
1888 * Attach to the ethdev already initialized by the primary
1891 * @param name Ethernet device's name.
1893 * - Success: Slot in the rte_dev_devices array for attached
1895 * - Error: Null pointer.
1897 struct rte_eth_dev *rte_eth_dev_attach_secondary(const char *name);
1901 * Release the specified ethdev port.
1904 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure.
1906 * - 0 on success, negative on error
1908 int rte_eth_dev_release_port(struct rte_eth_dev *eth_dev);
1911 * Attach a new Ethernet device specified by arguments.
1914 * A pointer to a strings array describing the new device
1915 * to be attached. The strings should be a pci address like
1916 * '0000:01:00.0' or virtual device name like 'net_pcap0'.
1918 * A pointer to a port identifier actually attached.
1920 * 0 on success and port_id is filled, negative on error
1922 int rte_eth_dev_attach(const char *devargs, uint16_t *port_id);
1925 * Detach a Ethernet device specified by port identifier.
1926 * This function must be called when the device is in the
1930 * The port identifier of the device to detach.
1932 * A pointer to a buffer that will be filled with the device name.
1933 * This buffer must be at least RTE_DEV_NAME_MAX_LEN long.
1935 * 0 on success and devname is filled, negative on error
1937 int rte_eth_dev_detach(uint16_t port_id, char *devname);
1940 * Convert a numerical speed in Mbps to a bitmap flag that can be used in
1941 * the bitmap link_speeds of the struct rte_eth_conf
1944 * Numerical speed value in Mbps
1946 * ETH_LINK_[HALF/FULL]_DUPLEX (only for 10/100M speeds)
1948 * 0 if the speed cannot be mapped
1950 uint32_t rte_eth_speed_bitflag(uint32_t speed, int duplex);
1953 * Configure an Ethernet device.
1954 * This function must be invoked first before any other function in the
1955 * Ethernet API. This function can also be re-invoked when a device is in the
1959 * The port identifier of the Ethernet device to configure.
1960 * @param nb_rx_queue
1961 * The number of receive queues to set up for the Ethernet device.
1962 * @param nb_tx_queue
1963 * The number of transmit queues to set up for the Ethernet device.
1965 * The pointer to the configuration data to be used for the Ethernet device.
1966 * The *rte_eth_conf* structure includes:
1967 * - the hardware offload features to activate, with dedicated fields for
1968 * each statically configurable offload hardware feature provided by
1969 * Ethernet devices, such as IP checksum or VLAN tag stripping for
1971 * The Rx offload bitfield API is obsolete and will be deprecated.
1972 * Applications should set the ignore_bitfield_offloads bit on *rxmode*
1973 * structure and use offloads field to set per-port offloads instead.
1974 * - the Receive Side Scaling (RSS) configuration when using multiple RX
1977 * Embedding all configuration information in a single data structure
1978 * is the more flexible method that allows the addition of new features
1979 * without changing the syntax of the API.
1981 * - 0: Success, device configured.
1982 * - <0: Error code returned by the driver configuration function.
1984 int rte_eth_dev_configure(uint16_t port_id, uint16_t nb_rx_queue,
1985 uint16_t nb_tx_queue, const struct rte_eth_conf *eth_conf);
1989 * Release device queues and clear its configuration to force the user
1990 * application to reconfigure it. It is for internal use only.
1993 * Pointer to struct rte_eth_dev.
1998 void _rte_eth_dev_reset(struct rte_eth_dev *dev);
2001 * Allocate and set up a receive queue for an Ethernet device.
2003 * The function allocates a contiguous block of memory for *nb_rx_desc*
2004 * receive descriptors from a memory zone associated with *socket_id*
2005 * and initializes each receive descriptor with a network buffer allocated
2006 * from the memory pool *mb_pool*.
2009 * The port identifier of the Ethernet device.
2010 * @param rx_queue_id
2011 * The index of the receive queue to set up.
2012 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2013 * to rte_eth_dev_configure().
2015 * The number of receive descriptors to allocate for the receive ring.
2017 * The *socket_id* argument is the socket identifier in case of NUMA.
2018 * The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
2019 * the DMA memory allocated for the receive descriptors of the ring.
2021 * The pointer to the configuration data to be used for the receive queue.
2022 * NULL value is allowed, in which case default RX configuration
2024 * The *rx_conf* structure contains an *rx_thresh* structure with the values
2025 * of the Prefetch, Host, and Write-Back threshold registers of the receive
2027 * In addition it contains the hardware offloads features to activate using
2028 * the DEV_RX_OFFLOAD_* flags.
2030 * The pointer to the memory pool from which to allocate *rte_mbuf* network
2031 * memory buffers to populate each descriptor of the receive ring.
2033 * - 0: Success, receive queue correctly set up.
2034 * - -EINVAL: The size of network buffers which can be allocated from the
2035 * memory pool does not fit the various buffer sizes allowed by the
2036 * device controller.
2037 * - -ENOMEM: Unable to allocate the receive ring descriptors or to
2038 * allocate network memory buffers from the memory pool when
2039 * initializing receive descriptors.
2041 int rte_eth_rx_queue_setup(uint16_t port_id, uint16_t rx_queue_id,
2042 uint16_t nb_rx_desc, unsigned int socket_id,
2043 const struct rte_eth_rxconf *rx_conf,
2044 struct rte_mempool *mb_pool);
2047 * Allocate and set up a transmit queue for an Ethernet device.
2050 * The port identifier of the Ethernet device.
2051 * @param tx_queue_id
2052 * The index of the transmit queue to set up.
2053 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2054 * to rte_eth_dev_configure().
2056 * The number of transmit descriptors to allocate for the transmit ring.
2058 * The *socket_id* argument is the socket identifier in case of NUMA.
2059 * Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
2060 * the DMA memory allocated for the transmit descriptors of the ring.
2062 * The pointer to the configuration data to be used for the transmit queue.
2063 * NULL value is allowed, in which case default RX configuration
2065 * The *tx_conf* structure contains the following data:
2066 * - The *tx_thresh* structure with the values of the Prefetch, Host, and
2067 * Write-Back threshold registers of the transmit ring.
2068 * When setting Write-Back threshold to the value greater then zero,
2069 * *tx_rs_thresh* value should be explicitly set to one.
2070 * - The *tx_free_thresh* value indicates the [minimum] number of network
2071 * buffers that must be pending in the transmit ring to trigger their
2072 * [implicit] freeing by the driver transmit function.
2073 * - The *tx_rs_thresh* value indicates the [minimum] number of transmit
2074 * descriptors that must be pending in the transmit ring before setting the
2075 * RS bit on a descriptor by the driver transmit function.
2076 * The *tx_rs_thresh* value should be less or equal then
2077 * *tx_free_thresh* value, and both of them should be less then
2079 * - The *txq_flags* member contains flags to pass to the TX queue setup
2080 * function to configure the behavior of the TX queue. This should be set
2081 * to 0 if no special configuration is required.
2082 * This API is obsolete and will be deprecated. Applications
2083 * should set it to ETH_TXQ_FLAGS_IGNORE and use
2084 * the offloads field below.
2085 * - The *offloads* member contains Tx offloads to be enabled.
2086 * Offloads which are not set cannot be used on the datapath.
2088 * Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces
2089 * the transmit function to use default values.
2091 * - 0: Success, the transmit queue is correctly set up.
2092 * - -ENOMEM: Unable to allocate the transmit ring descriptors.
2094 int rte_eth_tx_queue_setup(uint16_t port_id, uint16_t tx_queue_id,
2095 uint16_t nb_tx_desc, unsigned int socket_id,
2096 const struct rte_eth_txconf *tx_conf);
2099 * Return the NUMA socket to which an Ethernet device is connected
2102 * The port identifier of the Ethernet device
2104 * The NUMA socket id to which the Ethernet device is connected or
2105 * a default of zero if the socket could not be determined.
2106 * -1 is returned is the port_id value is out of range.
2108 int rte_eth_dev_socket_id(uint16_t port_id);
2111 * Check if port_id of device is attached
2114 * The port identifier of the Ethernet device
2116 * - 0 if port is out of range or not attached
2117 * - 1 if device is attached
2119 int rte_eth_dev_is_valid_port(uint16_t port_id);
2122 * Start specified RX queue of a port. It is used when rx_deferred_start
2123 * flag of the specified queue is true.
2126 * The port identifier of the Ethernet device
2127 * @param rx_queue_id
2128 * The index of the rx queue to update the ring.
2129 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2130 * to rte_eth_dev_configure().
2132 * - 0: Success, the receive queue is started.
2133 * - -EINVAL: The port_id or the queue_id out of range.
2134 * - -ENOTSUP: The function not supported in PMD driver.
2136 int rte_eth_dev_rx_queue_start(uint16_t port_id, uint16_t rx_queue_id);
2139 * Stop specified RX queue of a port
2142 * The port identifier of the Ethernet device
2143 * @param rx_queue_id
2144 * The index of the rx queue to update the ring.
2145 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2146 * to rte_eth_dev_configure().
2148 * - 0: Success, the receive queue is stopped.
2149 * - -EINVAL: The port_id or the queue_id out of range.
2150 * - -ENOTSUP: The function not supported in PMD driver.
2152 int rte_eth_dev_rx_queue_stop(uint16_t port_id, uint16_t rx_queue_id);
2155 * Start TX for specified queue of a port. It is used when tx_deferred_start
2156 * flag of the specified queue is true.
2159 * The port identifier of the Ethernet device
2160 * @param tx_queue_id
2161 * The index of the tx queue to update the ring.
2162 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2163 * to rte_eth_dev_configure().
2165 * - 0: Success, the transmit queue is started.
2166 * - -EINVAL: The port_id or the queue_id out of range.
2167 * - -ENOTSUP: The function not supported in PMD driver.
2169 int rte_eth_dev_tx_queue_start(uint16_t port_id, uint16_t tx_queue_id);
2172 * Stop specified TX queue of a port
2175 * The port identifier of the Ethernet device
2176 * @param tx_queue_id
2177 * The index of the tx queue to update the ring.
2178 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2179 * to rte_eth_dev_configure().
2181 * - 0: Success, the transmit queue is stopped.
2182 * - -EINVAL: The port_id or the queue_id out of range.
2183 * - -ENOTSUP: The function not supported in PMD driver.
2185 int rte_eth_dev_tx_queue_stop(uint16_t port_id, uint16_t tx_queue_id);
2190 * Start an Ethernet device.
2192 * The device start step is the last one and consists of setting the configured
2193 * offload features and in starting the transmit and the receive units of the
2195 * On success, all basic functions exported by the Ethernet API (link status,
2196 * receive/transmit, and so on) can be invoked.
2199 * The port identifier of the Ethernet device.
2201 * - 0: Success, Ethernet device started.
2202 * - <0: Error code of the driver device start function.
2204 int rte_eth_dev_start(uint16_t port_id);
2207 * Stop an Ethernet device. The device can be restarted with a call to
2208 * rte_eth_dev_start()
2211 * The port identifier of the Ethernet device.
2213 void rte_eth_dev_stop(uint16_t port_id);
2217 * Link up an Ethernet device.
2219 * Set device link up will re-enable the device rx/tx
2220 * functionality after it is previously set device linked down.
2223 * The port identifier of the Ethernet device.
2225 * - 0: Success, Ethernet device linked up.
2226 * - <0: Error code of the driver device link up function.
2228 int rte_eth_dev_set_link_up(uint16_t port_id);
2231 * Link down an Ethernet device.
2232 * The device rx/tx functionality will be disabled if success,
2233 * and it can be re-enabled with a call to
2234 * rte_eth_dev_set_link_up()
2237 * The port identifier of the Ethernet device.
2239 int rte_eth_dev_set_link_down(uint16_t port_id);
2242 * Close a stopped Ethernet device. The device cannot be restarted!
2243 * The function frees all resources except for needed by the
2244 * closed state. To free these resources, call rte_eth_dev_detach().
2247 * The port identifier of the Ethernet device.
2249 void rte_eth_dev_close(uint16_t port_id);
2252 * Reset a Ethernet device and keep its port id.
2254 * When a port has to be reset passively, the DPDK application can invoke
2255 * this function. For example when a PF is reset, all its VFs should also
2256 * be reset. Normally a DPDK application can invoke this function when
2257 * RTE_ETH_EVENT_INTR_RESET event is detected, but can also use it to start
2258 * a port reset in other circumstances.
2260 * When this function is called, it first stops the port and then calls the
2261 * PMD specific dev_uninit( ) and dev_init( ) to return the port to initial
2262 * state, in which no Tx and Rx queues are setup, as if the port has been
2263 * reset and not started. The port keeps the port id it had before the
2266 * After calling rte_eth_dev_reset( ), the application should use
2267 * rte_eth_dev_configure( ), rte_eth_rx_queue_setup( ),
2268 * rte_eth_tx_queue_setup( ), and rte_eth_dev_start( )
2269 * to reconfigure the device as appropriate.
2271 * Note: To avoid unexpected behavior, the application should stop calling
2272 * Tx and Rx functions before calling rte_eth_dev_reset( ). For thread
2273 * safety, all these controlling functions should be called from the same
2277 * The port identifier of the Ethernet device.
2280 * - (0) if successful.
2281 * - (-EINVAL) if port identifier is invalid.
2282 * - (-ENOTSUP) if hardware doesn't support this function.
2283 * - (-EPERM) if not ran from the primary process.
2284 * - (-EIO) if re-initialisation failed.
2285 * - (-ENOMEM) if the reset failed due to OOM.
2286 * - (-EAGAIN) if the reset temporarily failed and should be retried later.
2288 int rte_eth_dev_reset(uint16_t port_id);
2291 * Enable receipt in promiscuous mode for an Ethernet device.
2294 * The port identifier of the Ethernet device.
2296 void rte_eth_promiscuous_enable(uint16_t port_id);
2299 * Disable receipt in promiscuous mode for an Ethernet device.
2302 * The port identifier of the Ethernet device.
2304 void rte_eth_promiscuous_disable(uint16_t port_id);
2307 * Return the value of promiscuous mode for an Ethernet device.
2310 * The port identifier of the Ethernet device.
2312 * - (1) if promiscuous is enabled
2313 * - (0) if promiscuous is disabled.
2316 int rte_eth_promiscuous_get(uint16_t port_id);
2319 * Enable the receipt of any multicast frame by an Ethernet device.
2322 * The port identifier of the Ethernet device.
2324 void rte_eth_allmulticast_enable(uint16_t port_id);
2327 * Disable the receipt of all multicast frames by an Ethernet device.
2330 * The port identifier of the Ethernet device.
2332 void rte_eth_allmulticast_disable(uint16_t port_id);
2335 * Return the value of allmulticast mode for an Ethernet device.
2338 * The port identifier of the Ethernet device.
2340 * - (1) if allmulticast is enabled
2341 * - (0) if allmulticast is disabled.
2344 int rte_eth_allmulticast_get(uint16_t port_id);
2347 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2348 * or FULL-DUPLEX) of the physical link of an Ethernet device. It might need
2349 * to wait up to 9 seconds in it.
2352 * The port identifier of the Ethernet device.
2354 * A pointer to an *rte_eth_link* structure to be filled with
2355 * the status, the speed and the mode of the Ethernet device link.
2357 void rte_eth_link_get(uint16_t port_id, struct rte_eth_link *link);
2360 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2361 * or FULL-DUPLEX) of the physical link of an Ethernet device. It is a no-wait
2362 * version of rte_eth_link_get().
2365 * The port identifier of the Ethernet device.
2367 * A pointer to an *rte_eth_link* structure to be filled with
2368 * the status, the speed and the mode of the Ethernet device link.
2370 void rte_eth_link_get_nowait(uint16_t port_id, struct rte_eth_link *link);
2373 * Retrieve the general I/O statistics of an Ethernet device.
2376 * The port identifier of the Ethernet device.
2378 * A pointer to a structure of type *rte_eth_stats* to be filled with
2379 * the values of device counters for the following set of statistics:
2380 * - *ipackets* with the total of successfully received packets.
2381 * - *opackets* with the total of successfully transmitted packets.
2382 * - *ibytes* with the total of successfully received bytes.
2383 * - *obytes* with the total of successfully transmitted bytes.
2384 * - *ierrors* with the total of erroneous received packets.
2385 * - *oerrors* with the total of failed transmitted packets.
2387 * Zero if successful. Non-zero otherwise.
2389 int rte_eth_stats_get(uint16_t port_id, struct rte_eth_stats *stats);
2392 * Reset the general I/O statistics of an Ethernet device.
2395 * The port identifier of the Ethernet device.
2397 * - (0) if device notified to reset stats.
2398 * - (-ENOTSUP) if hardware doesn't support.
2399 * - (-ENODEV) if *port_id* invalid.
2401 int rte_eth_stats_reset(uint16_t port_id);
2404 * Retrieve names of extended statistics of an Ethernet device.
2407 * The port identifier of the Ethernet device.
2408 * @param xstats_names
2409 * An rte_eth_xstat_name array of at least *size* elements to
2410 * be filled. If set to NULL, the function returns the required number
2413 * The size of the xstats_names array (number of elements).
2415 * - A positive value lower or equal to size: success. The return value
2416 * is the number of entries filled in the stats table.
2417 * - A positive value higher than size: error, the given statistics table
2418 * is too small. The return value corresponds to the size that should
2419 * be given to succeed. The entries in the table are not valid and
2420 * shall not be used by the caller.
2421 * - A negative value on error (invalid port id).
2423 int rte_eth_xstats_get_names(uint16_t port_id,
2424 struct rte_eth_xstat_name *xstats_names,
2428 * Retrieve extended statistics of an Ethernet device.
2431 * The port identifier of the Ethernet device.
2433 * A pointer to a table of structure of type *rte_eth_xstat*
2434 * to be filled with device statistics ids and values: id is the
2435 * index of the name string in xstats_names (see rte_eth_xstats_get_names()),
2436 * and value is the statistic counter.
2437 * This parameter can be set to NULL if n is 0.
2439 * The size of the xstats array (number of elements).
2441 * - A positive value lower or equal to n: success. The return value
2442 * is the number of entries filled in the stats table.
2443 * - A positive value higher than n: error, the given statistics table
2444 * is too small. The return value corresponds to the size that should
2445 * be given to succeed. The entries in the table are not valid and
2446 * shall not be used by the caller.
2447 * - A negative value on error (invalid port id).
2449 int rte_eth_xstats_get(uint16_t port_id, struct rte_eth_xstat *xstats,
2453 * Retrieve names of extended statistics of an Ethernet device.
2456 * The port identifier of the Ethernet device.
2457 * @param xstats_names
2458 * An rte_eth_xstat_name array of at least *size* elements to
2459 * be filled. If set to NULL, the function returns the required number
2462 * IDs array given by app to retrieve specific statistics
2464 * The size of the xstats_names array (number of elements).
2466 * - A positive value lower or equal to size: success. The return value
2467 * is the number of entries filled in the stats table.
2468 * - A positive value higher than size: error, the given statistics table
2469 * is too small. The return value corresponds to the size that should
2470 * be given to succeed. The entries in the table are not valid and
2471 * shall not be used by the caller.
2472 * - A negative value on error (invalid port id).
2475 rte_eth_xstats_get_names_by_id(uint16_t port_id,
2476 struct rte_eth_xstat_name *xstats_names, unsigned int size,
2480 * Retrieve extended statistics of an Ethernet device.
2483 * The port identifier of the Ethernet device.
2485 * A pointer to an ids array passed by application. This tells which
2486 * statistics values function should retrieve. This parameter
2487 * can be set to NULL if size is 0. In this case function will retrieve
2488 * all avalible statistics.
2490 * A pointer to a table to be filled with device statistics values.
2492 * The size of the ids array (number of elements).
2494 * - A positive value lower or equal to size: success. The return value
2495 * is the number of entries filled in the stats table.
2496 * - A positive value higher than size: error, the given statistics table
2497 * is too small. The return value corresponds to the size that should
2498 * be given to succeed. The entries in the table are not valid and
2499 * shall not be used by the caller.
2500 * - A negative value on error (invalid port id).
2502 int rte_eth_xstats_get_by_id(uint16_t port_id, const uint64_t *ids,
2503 uint64_t *values, unsigned int size);
2506 * Gets the ID of a statistic from its name.
2508 * This function searches for the statistics using string compares, and
2509 * as such should not be used on the fast-path. For fast-path retrieval of
2510 * specific statistics, store the ID as provided in *id* from this function,
2511 * and pass the ID to rte_eth_xstats_get()
2513 * @param port_id The port to look up statistics from
2514 * @param xstat_name The name of the statistic to return
2515 * @param[out] id A pointer to an app-supplied uint64_t which should be
2516 * set to the ID of the stat if the stat exists.
2519 * -ENODEV for invalid port_id,
2520 * -EINVAL if the xstat_name doesn't exist in port_id
2522 int rte_eth_xstats_get_id_by_name(uint16_t port_id, const char *xstat_name,
2526 * Reset extended statistics of an Ethernet device.
2529 * The port identifier of the Ethernet device.
2531 void rte_eth_xstats_reset(uint16_t port_id);
2534 * Set a mapping for the specified transmit queue to the specified per-queue
2535 * statistics counter.
2538 * The port identifier of the Ethernet device.
2539 * @param tx_queue_id
2540 * The index of the transmit queue for which a queue stats mapping is required.
2541 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2542 * to rte_eth_dev_configure().
2544 * The per-queue packet statistics functionality number that the transmit
2545 * queue is to be assigned.
2546 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2548 * Zero if successful. Non-zero otherwise.
2550 int rte_eth_dev_set_tx_queue_stats_mapping(uint16_t port_id,
2551 uint16_t tx_queue_id, uint8_t stat_idx);
2554 * Set a mapping for the specified receive queue to the specified per-queue
2555 * statistics counter.
2558 * The port identifier of the Ethernet device.
2559 * @param rx_queue_id
2560 * The index of the receive queue for which a queue stats mapping is required.
2561 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2562 * to rte_eth_dev_configure().
2564 * The per-queue packet statistics functionality number that the receive
2565 * queue is to be assigned.
2566 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2568 * Zero if successful. Non-zero otherwise.
2570 int rte_eth_dev_set_rx_queue_stats_mapping(uint16_t port_id,
2571 uint16_t rx_queue_id,
2575 * Retrieve the Ethernet address of an Ethernet device.
2578 * The port identifier of the Ethernet device.
2580 * A pointer to a structure of type *ether_addr* to be filled with
2581 * the Ethernet address of the Ethernet device.
2583 void rte_eth_macaddr_get(uint16_t port_id, struct ether_addr *mac_addr);
2586 * Retrieve the contextual information of an Ethernet device.
2589 * The port identifier of the Ethernet device.
2591 * A pointer to a structure of type *rte_eth_dev_info* to be filled with
2592 * the contextual information of the Ethernet device.
2594 void rte_eth_dev_info_get(uint16_t port_id, struct rte_eth_dev_info *dev_info);
2597 * Retrieve the firmware version of a device.
2600 * The port identifier of the device.
2602 * A pointer to a string array storing the firmware version of a device,
2603 * the string includes terminating null. This pointer is allocated by caller.
2605 * The size of the string array pointed by fw_version, which should be
2606 * large enough to store firmware version of the device.
2608 * - (0) if successful.
2609 * - (-ENOTSUP) if operation is not supported.
2610 * - (-ENODEV) if *port_id* invalid.
2611 * - (>0) if *fw_size* is not enough to store firmware version, return
2612 * the size of the non truncated string.
2614 int rte_eth_dev_fw_version_get(uint16_t port_id,
2615 char *fw_version, size_t fw_size);
2618 * Retrieve the supported packet types of an Ethernet device.
2620 * When a packet type is announced as supported, it *must* be recognized by
2621 * the PMD. For instance, if RTE_PTYPE_L2_ETHER, RTE_PTYPE_L2_ETHER_VLAN
2622 * and RTE_PTYPE_L3_IPV4 are announced, the PMD must return the following
2623 * packet types for these packets:
2624 * - Ether/IPv4 -> RTE_PTYPE_L2_ETHER | RTE_PTYPE_L3_IPV4
2625 * - Ether/Vlan/IPv4 -> RTE_PTYPE_L2_ETHER_VLAN | RTE_PTYPE_L3_IPV4
2626 * - Ether/[anything else] -> RTE_PTYPE_L2_ETHER
2627 * - Ether/Vlan/[anything else] -> RTE_PTYPE_L2_ETHER_VLAN
2629 * When a packet is received by a PMD, the most precise type must be
2630 * returned among the ones supported. However a PMD is allowed to set
2631 * packet type that is not in the supported list, at the condition that it
2632 * is more precise. Therefore, a PMD announcing no supported packet types
2633 * can still set a matching packet type in a received packet.
2636 * Better to invoke this API after the device is already started or rx burst
2637 * function is decided, to obtain correct supported ptypes.
2639 * if a given PMD does not report what ptypes it supports, then the supported
2640 * ptype count is reported as 0.
2642 * The port identifier of the Ethernet device.
2644 * A hint of what kind of packet type which the caller is interested in.
2646 * An array pointer to store adequate packet types, allocated by caller.
2648 * Size of the array pointed by param ptypes.
2650 * - (>=0) Number of supported ptypes. If the number of types exceeds num,
2651 * only num entries will be filled into the ptypes array, but the full
2652 * count of supported ptypes will be returned.
2653 * - (-ENODEV) if *port_id* invalid.
2655 int rte_eth_dev_get_supported_ptypes(uint16_t port_id, uint32_t ptype_mask,
2656 uint32_t *ptypes, int num);
2659 * Retrieve the MTU of an Ethernet device.
2662 * The port identifier of the Ethernet device.
2664 * A pointer to a uint16_t where the retrieved MTU is to be stored.
2666 * - (0) if successful.
2667 * - (-ENODEV) if *port_id* invalid.
2669 int rte_eth_dev_get_mtu(uint16_t port_id, uint16_t *mtu);
2672 * Change the MTU of an Ethernet device.
2675 * The port identifier of the Ethernet device.
2677 * A uint16_t for the MTU to be applied.
2679 * - (0) if successful.
2680 * - (-ENOTSUP) if operation is not supported.
2681 * - (-ENODEV) if *port_id* invalid.
2682 * - (-EINVAL) if *mtu* invalid.
2683 * - (-EBUSY) if operation is not allowed when the port is running
2685 int rte_eth_dev_set_mtu(uint16_t port_id, uint16_t mtu);
2688 * Enable/Disable hardware filtering by an Ethernet device of received
2689 * VLAN packets tagged with a given VLAN Tag Identifier.
2692 * The port identifier of the Ethernet device.
2694 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
2696 * If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*.
2697 * Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*.
2699 * - (0) if successful.
2700 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2701 * - (-ENODEV) if *port_id* invalid.
2702 * - (-ENOSYS) if VLAN filtering on *port_id* disabled.
2703 * - (-EINVAL) if *vlan_id* > 4095.
2705 int rte_eth_dev_vlan_filter(uint16_t port_id, uint16_t vlan_id, int on);
2708 * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
2709 * 82599/X540/X550 can support VLAN stripping at the rx queue level
2712 * The port identifier of the Ethernet device.
2713 * @param rx_queue_id
2714 * The index of the receive queue for which a queue stats mapping is required.
2715 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2716 * to rte_eth_dev_configure().
2718 * If 1, Enable VLAN Stripping of the receive queue of the Ethernet port.
2719 * If 0, Disable VLAN Stripping of the receive queue of the Ethernet port.
2721 * - (0) if successful.
2722 * - (-ENOSUP) if hardware-assisted VLAN stripping not configured.
2723 * - (-ENODEV) if *port_id* invalid.
2724 * - (-EINVAL) if *rx_queue_id* invalid.
2726 int rte_eth_dev_set_vlan_strip_on_queue(uint16_t port_id, uint16_t rx_queue_id,
2730 * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
2731 * the VLAN Header. This is a register setup available on some Intel NIC, not
2732 * but all, please check the data sheet for availability.
2735 * The port identifier of the Ethernet device.
2739 * The Tag Protocol ID
2741 * - (0) if successful.
2742 * - (-ENOSUP) if hardware-assisted VLAN TPID setup is not supported.
2743 * - (-ENODEV) if *port_id* invalid.
2745 int rte_eth_dev_set_vlan_ether_type(uint16_t port_id,
2746 enum rte_vlan_type vlan_type,
2750 * Set VLAN offload configuration on an Ethernet device
2751 * Enable/Disable Extended VLAN by an Ethernet device, This is a register setup
2752 * available on some Intel NIC, not but all, please check the data sheet for
2754 * Enable/Disable VLAN Strip can be done on rx queue for certain NIC, but here
2755 * the configuration is applied on the port level.
2758 * The port identifier of the Ethernet device.
2759 * @param offload_mask
2760 * The VLAN Offload bit mask can be mixed use with "OR"
2761 * ETH_VLAN_STRIP_OFFLOAD
2762 * ETH_VLAN_FILTER_OFFLOAD
2763 * ETH_VLAN_EXTEND_OFFLOAD
2765 * - (0) if successful.
2766 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2767 * - (-ENODEV) if *port_id* invalid.
2769 int rte_eth_dev_set_vlan_offload(uint16_t port_id, int offload_mask);
2772 * Read VLAN Offload configuration from an Ethernet device
2775 * The port identifier of the Ethernet device.
2777 * - (>0) if successful. Bit mask to indicate
2778 * ETH_VLAN_STRIP_OFFLOAD
2779 * ETH_VLAN_FILTER_OFFLOAD
2780 * ETH_VLAN_EXTEND_OFFLOAD
2781 * - (-ENODEV) if *port_id* invalid.
2783 int rte_eth_dev_get_vlan_offload(uint16_t port_id);
2786 * Set port based TX VLAN insertion on or off.
2789 * The port identifier of the Ethernet device.
2791 * Port based TX VLAN identifier together with user priority.
2793 * Turn on or off the port based TX VLAN insertion.
2796 * - (0) if successful.
2797 * - negative if failed.
2799 int rte_eth_dev_set_vlan_pvid(uint16_t port_id, uint16_t pvid, int on);
2803 * Retrieve a burst of input packets from a receive queue of an Ethernet
2804 * device. The retrieved packets are stored in *rte_mbuf* structures whose
2805 * pointers are supplied in the *rx_pkts* array.
2807 * The rte_eth_rx_burst() function loops, parsing the RX ring of the
2808 * receive queue, up to *nb_pkts* packets, and for each completed RX
2809 * descriptor in the ring, it performs the following operations:
2811 * - Initialize the *rte_mbuf* data structure associated with the
2812 * RX descriptor according to the information provided by the NIC into
2813 * that RX descriptor.
2815 * - Store the *rte_mbuf* data structure into the next entry of the
2818 * - Replenish the RX descriptor with a new *rte_mbuf* buffer
2819 * allocated from the memory pool associated with the receive queue at
2820 * initialization time.
2822 * When retrieving an input packet that was scattered by the controller
2823 * into multiple receive descriptors, the rte_eth_rx_burst() function
2824 * appends the associated *rte_mbuf* buffers to the first buffer of the
2827 * The rte_eth_rx_burst() function returns the number of packets
2828 * actually retrieved, which is the number of *rte_mbuf* data structures
2829 * effectively supplied into the *rx_pkts* array.
2830 * A return value equal to *nb_pkts* indicates that the RX queue contained
2831 * at least *rx_pkts* packets, and this is likely to signify that other
2832 * received packets remain in the input queue. Applications implementing
2833 * a "retrieve as much received packets as possible" policy can check this
2834 * specific case and keep invoking the rte_eth_rx_burst() function until
2835 * a value less than *nb_pkts* is returned.
2837 * This receive method has the following advantages:
2839 * - It allows a run-to-completion network stack engine to retrieve and
2840 * to immediately process received packets in a fast burst-oriented
2841 * approach, avoiding the overhead of unnecessary intermediate packet
2842 * queue/dequeue operations.
2844 * - Conversely, it also allows an asynchronous-oriented processing
2845 * method to retrieve bursts of received packets and to immediately
2846 * queue them for further parallel processing by another logical core,
2847 * for instance. However, instead of having received packets being
2848 * individually queued by the driver, this approach allows the caller
2849 * of the rte_eth_rx_burst() function to queue a burst of retrieved
2850 * packets at a time and therefore dramatically reduce the cost of
2851 * enqueue/dequeue operations per packet.
2853 * - It allows the rte_eth_rx_burst() function of the driver to take
2854 * advantage of burst-oriented hardware features (CPU cache,
2855 * prefetch instructions, and so on) to minimize the number of CPU
2856 * cycles per packet.
2858 * To summarize, the proposed receive API enables many
2859 * burst-oriented optimizations in both synchronous and asynchronous
2860 * packet processing environments with no overhead in both cases.
2862 * The rte_eth_rx_burst() function does not provide any error
2863 * notification to avoid the corresponding overhead. As a hint, the
2864 * upper-level application might check the status of the device link once
2865 * being systematically returned a 0 value for a given number of tries.
2868 * The port identifier of the Ethernet device.
2870 * The index of the receive queue from which to retrieve input packets.
2871 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2872 * to rte_eth_dev_configure().
2874 * The address of an array of pointers to *rte_mbuf* structures that
2875 * must be large enough to store *nb_pkts* pointers in it.
2877 * The maximum number of packets to retrieve.
2879 * The number of packets actually retrieved, which is the number
2880 * of pointers to *rte_mbuf* structures effectively supplied to the
2883 static inline uint16_t
2884 rte_eth_rx_burst(uint16_t port_id, uint16_t queue_id,
2885 struct rte_mbuf **rx_pkts, const uint16_t nb_pkts)
2887 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2889 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2890 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
2891 RTE_FUNC_PTR_OR_ERR_RET(*dev->rx_pkt_burst, 0);
2893 if (queue_id >= dev->data->nb_rx_queues) {
2894 RTE_PMD_DEBUG_TRACE("Invalid RX queue_id=%d\n", queue_id);
2898 int16_t nb_rx = (*dev->rx_pkt_burst)(dev->data->rx_queues[queue_id],
2901 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
2902 struct rte_eth_rxtx_callback *cb = dev->post_rx_burst_cbs[queue_id];
2904 if (unlikely(cb != NULL)) {
2906 nb_rx = cb->fn.rx(port_id, queue_id, rx_pkts, nb_rx,
2907 nb_pkts, cb->param);
2909 } while (cb != NULL);
2917 * Get the number of used descriptors of a rx queue
2920 * The port identifier of the Ethernet device.
2922 * The queue id on the specific port.
2924 * The number of used descriptors in the specific queue, or:
2925 * (-EINVAL) if *port_id* or *queue_id* is invalid
2926 * (-ENOTSUP) if the device does not support this function
2929 rte_eth_rx_queue_count(uint16_t port_id, uint16_t queue_id)
2931 struct rte_eth_dev *dev;
2933 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -EINVAL);
2934 dev = &rte_eth_devices[port_id];
2935 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_queue_count, -ENOTSUP);
2936 if (queue_id >= dev->data->nb_rx_queues)
2939 return (*dev->dev_ops->rx_queue_count)(dev, queue_id);
2943 * Check if the DD bit of the specific RX descriptor in the queue has been set
2946 * The port identifier of the Ethernet device.
2948 * The queue id on the specific port.
2950 * The offset of the descriptor ID from tail.
2952 * - (1) if the specific DD bit is set.
2953 * - (0) if the specific DD bit is not set.
2954 * - (-ENODEV) if *port_id* invalid.
2955 * - (-ENOTSUP) if the device does not support this function
2958 rte_eth_rx_descriptor_done(uint16_t port_id, uint16_t queue_id, uint16_t offset)
2960 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2961 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
2962 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_descriptor_done, -ENOTSUP);
2963 return (*dev->dev_ops->rx_descriptor_done)( \
2964 dev->data->rx_queues[queue_id], offset);
2967 #define RTE_ETH_RX_DESC_AVAIL 0 /**< Desc available for hw. */
2968 #define RTE_ETH_RX_DESC_DONE 1 /**< Desc done, filled by hw. */
2969 #define RTE_ETH_RX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */
2972 * Check the status of a Rx descriptor in the queue
2974 * It should be called in a similar context than the Rx function:
2975 * - on a dataplane core
2976 * - not concurrently on the same queue
2978 * Since it's a dataplane function, no check is performed on port_id and
2979 * queue_id. The caller must therefore ensure that the port is enabled
2980 * and the queue is configured and running.
2982 * Note: accessing to a random descriptor in the ring may trigger cache
2983 * misses and have a performance impact.
2986 * A valid port identifier of the Ethernet device which.
2988 * A valid Rx queue identifier on this port.
2990 * The offset of the descriptor starting from tail (0 is the next
2991 * packet to be received by the driver).
2994 * - (RTE_ETH_RX_DESC_AVAIL): Descriptor is available for the hardware to
2996 * - (RTE_ETH_RX_DESC_DONE): Descriptor is done, it is filled by hw, but
2997 * not yet processed by the driver (i.e. in the receive queue).
2998 * - (RTE_ETH_RX_DESC_UNAVAIL): Descriptor is unavailable, either hold by
2999 * the driver and not yet returned to hw, or reserved by the hw.
3000 * - (-EINVAL) bad descriptor offset.
3001 * - (-ENOTSUP) if the device does not support this function.
3002 * - (-ENODEV) bad port or queue (only if compiled with debug).
3005 rte_eth_rx_descriptor_status(uint16_t port_id, uint16_t queue_id,
3008 struct rte_eth_dev *dev;
3011 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3012 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
3014 dev = &rte_eth_devices[port_id];
3015 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3016 if (queue_id >= dev->data->nb_rx_queues)
3019 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_descriptor_status, -ENOTSUP);
3020 rxq = dev->data->rx_queues[queue_id];
3022 return (*dev->dev_ops->rx_descriptor_status)(rxq, offset);
3025 #define RTE_ETH_TX_DESC_FULL 0 /**< Desc filled for hw, waiting xmit. */
3026 #define RTE_ETH_TX_DESC_DONE 1 /**< Desc done, packet is transmitted. */
3027 #define RTE_ETH_TX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */
3030 * Check the status of a Tx descriptor in the queue.
3032 * It should be called in a similar context than the Tx function:
3033 * - on a dataplane core
3034 * - not concurrently on the same queue
3036 * Since it's a dataplane function, no check is performed on port_id and
3037 * queue_id. The caller must therefore ensure that the port is enabled
3038 * and the queue is configured and running.
3040 * Note: accessing to a random descriptor in the ring may trigger cache
3041 * misses and have a performance impact.
3044 * A valid port identifier of the Ethernet device which.
3046 * A valid Tx queue identifier on this port.
3048 * The offset of the descriptor starting from tail (0 is the place where
3049 * the next packet will be send).
3052 * - (RTE_ETH_TX_DESC_FULL) Descriptor is being processed by the hw, i.e.
3053 * in the transmit queue.
3054 * - (RTE_ETH_TX_DESC_DONE) Hardware is done with this descriptor, it can
3055 * be reused by the driver.
3056 * - (RTE_ETH_TX_DESC_UNAVAIL): Descriptor is unavailable, reserved by the
3057 * driver or the hardware.
3058 * - (-EINVAL) bad descriptor offset.
3059 * - (-ENOTSUP) if the device does not support this function.
3060 * - (-ENODEV) bad port or queue (only if compiled with debug).
3062 static inline int rte_eth_tx_descriptor_status(uint16_t port_id,
3063 uint16_t queue_id, uint16_t offset)
3065 struct rte_eth_dev *dev;
3068 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3069 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
3071 dev = &rte_eth_devices[port_id];
3072 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3073 if (queue_id >= dev->data->nb_tx_queues)
3076 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->tx_descriptor_status, -ENOTSUP);
3077 txq = dev->data->tx_queues[queue_id];
3079 return (*dev->dev_ops->tx_descriptor_status)(txq, offset);
3083 * Send a burst of output packets on a transmit queue of an Ethernet device.
3085 * The rte_eth_tx_burst() function is invoked to transmit output packets
3086 * on the output queue *queue_id* of the Ethernet device designated by its
3088 * The *nb_pkts* parameter is the number of packets to send which are
3089 * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
3090 * allocated from a pool created with rte_pktmbuf_pool_create().
3091 * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
3092 * up to the number of transmit descriptors available in the TX ring of the
3094 * For each packet to send, the rte_eth_tx_burst() function performs
3095 * the following operations:
3097 * - Pick up the next available descriptor in the transmit ring.
3099 * - Free the network buffer previously sent with that descriptor, if any.
3101 * - Initialize the transmit descriptor with the information provided
3102 * in the *rte_mbuf data structure.
3104 * In the case of a segmented packet composed of a list of *rte_mbuf* buffers,
3105 * the rte_eth_tx_burst() function uses several transmit descriptors
3108 * The rte_eth_tx_burst() function returns the number of packets it
3109 * actually sent. A return value equal to *nb_pkts* means that all packets
3110 * have been sent, and this is likely to signify that other output packets
3111 * could be immediately transmitted again. Applications that implement a
3112 * "send as many packets to transmit as possible" policy can check this
3113 * specific case and keep invoking the rte_eth_tx_burst() function until
3114 * a value less than *nb_pkts* is returned.
3116 * It is the responsibility of the rte_eth_tx_burst() function to
3117 * transparently free the memory buffers of packets previously sent.
3118 * This feature is driven by the *tx_free_thresh* value supplied to the
3119 * rte_eth_dev_configure() function at device configuration time.
3120 * When the number of free TX descriptors drops below this threshold, the
3121 * rte_eth_tx_burst() function must [attempt to] free the *rte_mbuf* buffers
3122 * of those packets whose transmission was effectively completed.
3124 * If the PMD is DEV_TX_OFFLOAD_MT_LOCKFREE capable, multiple threads can
3125 * invoke this function concurrently on the same tx queue without SW lock.
3126 * @see rte_eth_dev_info_get, struct rte_eth_txconf::txq_flags
3129 * The port identifier of the Ethernet device.
3131 * The index of the transmit queue through which output packets must be
3133 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3134 * to rte_eth_dev_configure().
3136 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
3137 * which contain the output packets.
3139 * The maximum number of packets to transmit.
3141 * The number of output packets actually stored in transmit descriptors of
3142 * the transmit ring. The return value can be less than the value of the
3143 * *tx_pkts* parameter when the transmit ring is full or has been filled up.
3145 static inline uint16_t
3146 rte_eth_tx_burst(uint16_t port_id, uint16_t queue_id,
3147 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
3149 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
3151 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3152 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
3153 RTE_FUNC_PTR_OR_ERR_RET(*dev->tx_pkt_burst, 0);
3155 if (queue_id >= dev->data->nb_tx_queues) {
3156 RTE_PMD_DEBUG_TRACE("Invalid TX queue_id=%d\n", queue_id);
3161 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
3162 struct rte_eth_rxtx_callback *cb = dev->pre_tx_burst_cbs[queue_id];
3164 if (unlikely(cb != NULL)) {
3166 nb_pkts = cb->fn.tx(port_id, queue_id, tx_pkts, nb_pkts,
3169 } while (cb != NULL);
3173 return (*dev->tx_pkt_burst)(dev->data->tx_queues[queue_id], tx_pkts, nb_pkts);
3178 * @b EXPERIMENTAL: this API may change without prior notice
3180 * Process a burst of output packets on a transmit queue of an Ethernet device.
3182 * The rte_eth_tx_prepare() function is invoked to prepare output packets to be
3183 * transmitted on the output queue *queue_id* of the Ethernet device designated
3185 * The *nb_pkts* parameter is the number of packets to be prepared which are
3186 * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
3187 * allocated from a pool created with rte_pktmbuf_pool_create().
3188 * For each packet to send, the rte_eth_tx_prepare() function performs
3189 * the following operations:
3191 * - Check if packet meets devices requirements for tx offloads.
3193 * - Check limitations about number of segments.
3195 * - Check additional requirements when debug is enabled.
3197 * - Update and/or reset required checksums when tx offload is set for packet.
3199 * Since this function can modify packet data, provided mbufs must be safely
3200 * writable (e.g. modified data cannot be in shared segment).
3202 * The rte_eth_tx_prepare() function returns the number of packets ready to be
3203 * sent. A return value equal to *nb_pkts* means that all packets are valid and
3204 * ready to be sent, otherwise stops processing on the first invalid packet and
3205 * leaves the rest packets untouched.
3207 * When this functionality is not implemented in the driver, all packets are
3208 * are returned untouched.
3211 * The port identifier of the Ethernet device.
3212 * The value must be a valid port id.
3214 * The index of the transmit queue through which output packets must be
3216 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3217 * to rte_eth_dev_configure().
3219 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
3220 * which contain the output packets.
3222 * The maximum number of packets to process.
3224 * The number of packets correct and ready to be sent. The return value can be
3225 * less than the value of the *tx_pkts* parameter when some packet doesn't
3226 * meet devices requirements with rte_errno set appropriately:
3227 * - -EINVAL: offload flags are not correctly set
3228 * - -ENOTSUP: the offload feature is not supported by the hardware
3232 #ifndef RTE_ETHDEV_TX_PREPARE_NOOP
3234 static inline uint16_t
3235 rte_eth_tx_prepare(uint16_t port_id, uint16_t queue_id,
3236 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
3238 struct rte_eth_dev *dev;
3240 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3241 if (!rte_eth_dev_is_valid_port(port_id)) {
3242 RTE_PMD_DEBUG_TRACE("Invalid TX port_id=%d\n", port_id);
3243 rte_errno = -EINVAL;
3248 dev = &rte_eth_devices[port_id];
3250 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3251 if (queue_id >= dev->data->nb_tx_queues) {
3252 RTE_PMD_DEBUG_TRACE("Invalid TX queue_id=%d\n", queue_id);
3253 rte_errno = -EINVAL;
3258 if (!dev->tx_pkt_prepare)
3261 return (*dev->tx_pkt_prepare)(dev->data->tx_queues[queue_id],
3268 * Native NOOP operation for compilation targets which doesn't require any
3269 * preparations steps, and functional NOOP may introduce unnecessary performance
3272 * Generally this is not a good idea to turn it on globally and didn't should
3273 * be used if behavior of tx_preparation can change.
3276 static inline uint16_t
3277 rte_eth_tx_prepare(__rte_unused uint16_t port_id,
3278 __rte_unused uint16_t queue_id,
3279 __rte_unused struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
3286 typedef void (*buffer_tx_error_fn)(struct rte_mbuf **unsent, uint16_t count,
3290 * Structure used to buffer packets for future TX
3291 * Used by APIs rte_eth_tx_buffer and rte_eth_tx_buffer_flush
3293 struct rte_eth_dev_tx_buffer {
3294 buffer_tx_error_fn error_callback;
3295 void *error_userdata;
3296 uint16_t size; /**< Size of buffer for buffered tx */
3297 uint16_t length; /**< Number of packets in the array */
3298 struct rte_mbuf *pkts[];
3299 /**< Pending packets to be sent on explicit flush or when full */
3303 * Calculate the size of the tx buffer.
3306 * Number of stored packets.
3308 #define RTE_ETH_TX_BUFFER_SIZE(sz) \
3309 (sizeof(struct rte_eth_dev_tx_buffer) + (sz) * sizeof(struct rte_mbuf *))
3312 * Initialize default values for buffered transmitting
3315 * Tx buffer to be initialized.
3322 rte_eth_tx_buffer_init(struct rte_eth_dev_tx_buffer *buffer, uint16_t size);
3325 * Send any packets queued up for transmission on a port and HW queue
3327 * This causes an explicit flush of packets previously buffered via the
3328 * rte_eth_tx_buffer() function. It returns the number of packets successfully
3329 * sent to the NIC, and calls the error callback for any unsent packets. Unless
3330 * explicitly set up otherwise, the default callback simply frees the unsent
3331 * packets back to the owning mempool.
3334 * The port identifier of the Ethernet device.
3336 * The index of the transmit queue through which output packets must be
3338 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3339 * to rte_eth_dev_configure().
3341 * Buffer of packets to be transmit.
3343 * The number of packets successfully sent to the Ethernet device. The error
3344 * callback is called for any packets which could not be sent.
3346 static inline uint16_t
3347 rte_eth_tx_buffer_flush(uint16_t port_id, uint16_t queue_id,
3348 struct rte_eth_dev_tx_buffer *buffer)
3351 uint16_t to_send = buffer->length;
3356 sent = rte_eth_tx_burst(port_id, queue_id, buffer->pkts, to_send);
3360 /* All packets sent, or to be dealt with by callback below */
3361 if (unlikely(sent != to_send))
3362 buffer->error_callback(&buffer->pkts[sent], to_send - sent,
3363 buffer->error_userdata);
3369 * Buffer a single packet for future transmission on a port and queue
3371 * This function takes a single mbuf/packet and buffers it for later
3372 * transmission on the particular port and queue specified. Once the buffer is
3373 * full of packets, an attempt will be made to transmit all the buffered
3374 * packets. In case of error, where not all packets can be transmitted, a
3375 * callback is called with the unsent packets as a parameter. If no callback
3376 * is explicitly set up, the unsent packets are just freed back to the owning
3377 * mempool. The function returns the number of packets actually sent i.e.
3378 * 0 if no buffer flush occurred, otherwise the number of packets successfully
3382 * The port identifier of the Ethernet device.
3384 * The index of the transmit queue through which output packets must be
3386 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3387 * to rte_eth_dev_configure().
3389 * Buffer used to collect packets to be sent.
3391 * Pointer to the packet mbuf to be sent.
3393 * 0 = packet has been buffered for later transmission
3394 * N > 0 = packet has been buffered, and the buffer was subsequently flushed,
3395 * causing N packets to be sent, and the error callback to be called for
3398 static __rte_always_inline uint16_t
3399 rte_eth_tx_buffer(uint16_t port_id, uint16_t queue_id,
3400 struct rte_eth_dev_tx_buffer *buffer, struct rte_mbuf *tx_pkt)
3402 buffer->pkts[buffer->length++] = tx_pkt;
3403 if (buffer->length < buffer->size)
3406 return rte_eth_tx_buffer_flush(port_id, queue_id, buffer);
3410 * Configure a callback for buffered packets which cannot be sent
3412 * Register a specific callback to be called when an attempt is made to send
3413 * all packets buffered on an ethernet port, but not all packets can
3414 * successfully be sent. The callback registered here will be called only
3415 * from calls to rte_eth_tx_buffer() and rte_eth_tx_buffer_flush() APIs.
3416 * The default callback configured for each queue by default just frees the
3417 * packets back to the calling mempool. If additional behaviour is required,
3418 * for example, to count dropped packets, or to retry transmission of packets
3419 * which cannot be sent, this function should be used to register a suitable
3420 * callback function to implement the desired behaviour.
3421 * The example callback "rte_eth_count_unsent_packet_callback()" is also
3422 * provided as reference.
3425 * The port identifier of the Ethernet device.
3427 * The function to be used as the callback.
3429 * Arbitrary parameter to be passed to the callback function
3431 * 0 on success, or -1 on error with rte_errno set appropriately
3434 rte_eth_tx_buffer_set_err_callback(struct rte_eth_dev_tx_buffer *buffer,
3435 buffer_tx_error_fn callback, void *userdata);
3438 * Callback function for silently dropping unsent buffered packets.
3440 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
3441 * adjust the default behavior when buffered packets cannot be sent. This
3442 * function drops any unsent packets silently and is used by tx buffered
3443 * operations as default behavior.
3445 * NOTE: this function should not be called directly, instead it should be used
3446 * as a callback for packet buffering.
3448 * NOTE: when configuring this function as a callback with
3449 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
3450 * should point to an uint64_t value.
3453 * The previously buffered packets which could not be sent
3455 * The number of unsent packets in the pkts array
3460 rte_eth_tx_buffer_drop_callback(struct rte_mbuf **pkts, uint16_t unsent,
3464 * Callback function for tracking unsent buffered packets.
3466 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
3467 * adjust the default behavior when buffered packets cannot be sent. This
3468 * function drops any unsent packets, but also updates a user-supplied counter
3469 * to track the overall number of packets dropped. The counter should be an
3470 * uint64_t variable.
3472 * NOTE: this function should not be called directly, instead it should be used
3473 * as a callback for packet buffering.
3475 * NOTE: when configuring this function as a callback with
3476 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
3477 * should point to an uint64_t value.
3480 * The previously buffered packets which could not be sent
3482 * The number of unsent packets in the pkts array
3484 * Pointer to an uint64_t value, which will be incremented by unsent
3487 rte_eth_tx_buffer_count_callback(struct rte_mbuf **pkts, uint16_t unsent,
3491 * Request the driver to free mbufs currently cached by the driver. The
3492 * driver will only free the mbuf if it is no longer in use. It is the
3493 * application's responsibity to ensure rte_eth_tx_buffer_flush(..) is
3497 * The port identifier of the Ethernet device.
3499 * The index of the transmit queue through which output packets must be
3501 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3502 * to rte_eth_dev_configure().
3504 * Maximum number of packets to free. Use 0 to indicate all possible packets
3505 * should be freed. Note that a packet may be using multiple mbufs.
3508 * -ENODEV: Invalid interface
3509 * -ENOTSUP: Driver does not support function
3511 * 0-n: Number of packets freed. More packets may still remain in ring that
3515 rte_eth_tx_done_cleanup(uint16_t port_id, uint16_t queue_id, uint32_t free_cnt);
3518 * The eth device event type for interrupt, and maybe others in the future.
3520 enum rte_eth_event_type {
3521 RTE_ETH_EVENT_UNKNOWN, /**< unknown event type */
3522 RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
3523 RTE_ETH_EVENT_QUEUE_STATE,
3524 /**< queue state event (enabled/disabled) */
3525 RTE_ETH_EVENT_INTR_RESET,
3526 /**< reset interrupt event, sent to VF on PF reset */
3527 RTE_ETH_EVENT_VF_MBOX, /**< message from the VF received by PF */
3528 RTE_ETH_EVENT_MACSEC, /**< MACsec offload related event */
3529 RTE_ETH_EVENT_INTR_RMV, /**< device removal event */
3530 RTE_ETH_EVENT_MAX /**< max value of this enum */
3533 typedef int (*rte_eth_dev_cb_fn)(uint16_t port_id,
3534 enum rte_eth_event_type event, void *cb_arg, void *ret_param);
3535 /**< user application callback to be registered for interrupts */
3540 * Register a callback function for specific port id.
3547 * User supplied callback function to be called.
3549 * Pointer to the parameters for the registered callback.
3552 * - On success, zero.
3553 * - On failure, a negative value.
3555 int rte_eth_dev_callback_register(uint16_t port_id,
3556 enum rte_eth_event_type event,
3557 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
3560 * Unregister a callback function for specific port id.
3567 * User supplied callback function to be called.
3569 * Pointer to the parameters for the registered callback. -1 means to
3570 * remove all for the same callback address and same event.
3573 * - On success, zero.
3574 * - On failure, a negative value.
3576 int rte_eth_dev_callback_unregister(uint16_t port_id,
3577 enum rte_eth_event_type event,
3578 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
3581 * @internal Executes all the user application registered callbacks for
3582 * the specific device. It is for DPDK internal user only. User
3583 * application should not call it directly.
3586 * Pointer to struct rte_eth_dev.
3588 * Eth device interrupt event type.
3590 * callback parameter.
3592 * To pass data back to user application.
3593 * This allows the user application to decide if a particular function
3594 * is permitted or not.
3599 int _rte_eth_dev_callback_process(struct rte_eth_dev *dev,
3600 enum rte_eth_event_type event, void *cb_arg, void *ret_param);
3603 * When there is no rx packet coming in Rx Queue for a long time, we can
3604 * sleep lcore related to RX Queue for power saving, and enable rx interrupt
3605 * to be triggered when Rx packet arrives.
3607 * The rte_eth_dev_rx_intr_enable() function enables rx queue
3608 * interrupt on specific rx queue of a port.
3611 * The port identifier of the Ethernet device.
3613 * The index of the receive queue from which to retrieve input packets.
3614 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3615 * to rte_eth_dev_configure().
3617 * - (0) if successful.
3618 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3620 * - (-ENODEV) if *port_id* invalid.
3622 int rte_eth_dev_rx_intr_enable(uint16_t port_id, uint16_t queue_id);
3625 * When lcore wakes up from rx interrupt indicating packet coming, disable rx
3626 * interrupt and returns to polling mode.
3628 * The rte_eth_dev_rx_intr_disable() function disables rx queue
3629 * interrupt on specific rx queue of a port.
3632 * The port identifier of the Ethernet device.
3634 * The index of the receive queue from which to retrieve input packets.
3635 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3636 * to rte_eth_dev_configure().
3638 * - (0) if successful.
3639 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3641 * - (-ENODEV) if *port_id* invalid.
3643 int rte_eth_dev_rx_intr_disable(uint16_t port_id, uint16_t queue_id);
3646 * RX Interrupt control per port.
3649 * The port identifier of the Ethernet device.
3651 * Epoll instance fd which the intr vector associated to.
3652 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
3654 * The operation be performed for the vector.
3655 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
3659 * - On success, zero.
3660 * - On failure, a negative value.
3662 int rte_eth_dev_rx_intr_ctl(uint16_t port_id, int epfd, int op, void *data);
3665 * RX Interrupt control per queue.
3668 * The port identifier of the Ethernet device.
3670 * The index of the receive queue from which to retrieve input packets.
3671 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3672 * to rte_eth_dev_configure().
3674 * Epoll instance fd which the intr vector associated to.
3675 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
3677 * The operation be performed for the vector.
3678 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
3682 * - On success, zero.
3683 * - On failure, a negative value.
3685 int rte_eth_dev_rx_intr_ctl_q(uint16_t port_id, uint16_t queue_id,
3686 int epfd, int op, void *data);
3689 * Turn on the LED on the Ethernet device.
3690 * This function turns on the LED on the Ethernet device.
3693 * The port identifier of the Ethernet device.
3695 * - (0) if successful.
3696 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3698 * - (-ENODEV) if *port_id* invalid.
3700 int rte_eth_led_on(uint16_t port_id);
3703 * Turn off the LED on the Ethernet device.
3704 * This function turns off the LED on the Ethernet device.
3707 * The port identifier of the Ethernet device.
3709 * - (0) if successful.
3710 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3712 * - (-ENODEV) if *port_id* invalid.
3714 int rte_eth_led_off(uint16_t port_id);
3717 * Get current status of the Ethernet link flow control for Ethernet device
3720 * The port identifier of the Ethernet device.
3722 * The pointer to the structure where to store the flow control parameters.
3724 * - (0) if successful.
3725 * - (-ENOTSUP) if hardware doesn't support flow control.
3726 * - (-ENODEV) if *port_id* invalid.
3728 int rte_eth_dev_flow_ctrl_get(uint16_t port_id,
3729 struct rte_eth_fc_conf *fc_conf);
3732 * Configure the Ethernet link flow control for Ethernet device
3735 * The port identifier of the Ethernet device.
3737 * The pointer to the structure of the flow control parameters.
3739 * - (0) if successful.
3740 * - (-ENOTSUP) if hardware doesn't support flow control mode.
3741 * - (-ENODEV) if *port_id* invalid.
3742 * - (-EINVAL) if bad parameter
3743 * - (-EIO) if flow control setup failure
3745 int rte_eth_dev_flow_ctrl_set(uint16_t port_id,
3746 struct rte_eth_fc_conf *fc_conf);
3749 * Configure the Ethernet priority flow control under DCB environment
3750 * for Ethernet device.
3753 * The port identifier of the Ethernet device.
3755 * The pointer to the structure of the priority flow control parameters.
3757 * - (0) if successful.
3758 * - (-ENOTSUP) if hardware doesn't support priority flow control mode.
3759 * - (-ENODEV) if *port_id* invalid.
3760 * - (-EINVAL) if bad parameter
3761 * - (-EIO) if flow control setup failure
3763 int rte_eth_dev_priority_flow_ctrl_set(uint16_t port_id,
3764 struct rte_eth_pfc_conf *pfc_conf);
3767 * Add a MAC address to an internal array of addresses used to enable whitelist
3768 * filtering to accept packets only if the destination MAC address matches.
3771 * The port identifier of the Ethernet device.
3773 * The MAC address to add.
3775 * VMDq pool index to associate address with (if VMDq is enabled). If VMDq is
3776 * not enabled, this should be set to 0.
3778 * - (0) if successfully added or *mac_addr" was already added.
3779 * - (-ENOTSUP) if hardware doesn't support this feature.
3780 * - (-ENODEV) if *port* is invalid.
3781 * - (-ENOSPC) if no more MAC addresses can be added.
3782 * - (-EINVAL) if MAC address is invalid.
3784 int rte_eth_dev_mac_addr_add(uint16_t port, struct ether_addr *mac_addr,
3788 * Remove a MAC address from the internal array of addresses.
3791 * The port identifier of the Ethernet device.
3793 * MAC address to remove.
3795 * - (0) if successful, or *mac_addr* didn't exist.
3796 * - (-ENOTSUP) if hardware doesn't support.
3797 * - (-ENODEV) if *port* invalid.
3798 * - (-EADDRINUSE) if attempting to remove the default MAC address
3800 int rte_eth_dev_mac_addr_remove(uint16_t port, struct ether_addr *mac_addr);
3803 * Set the default MAC address.
3806 * The port identifier of the Ethernet device.
3808 * New default MAC address.
3810 * - (0) if successful, or *mac_addr* didn't exist.
3811 * - (-ENOTSUP) if hardware doesn't support.
3812 * - (-ENODEV) if *port* invalid.
3813 * - (-EINVAL) if MAC address is invalid.
3815 int rte_eth_dev_default_mac_addr_set(uint16_t port,
3816 struct ether_addr *mac_addr);
3819 * Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3822 * The port identifier of the Ethernet device.
3826 * Redirection table size. The table size can be queried by
3827 * rte_eth_dev_info_get().
3829 * - (0) if successful.
3830 * - (-ENOTSUP) if hardware doesn't support.
3831 * - (-EINVAL) if bad parameter.
3833 int rte_eth_dev_rss_reta_update(uint16_t port,
3834 struct rte_eth_rss_reta_entry64 *reta_conf,
3835 uint16_t reta_size);
3838 * Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3841 * The port identifier of the Ethernet device.
3845 * Redirection table size. The table size can be queried by
3846 * rte_eth_dev_info_get().
3848 * - (0) if successful.
3849 * - (-ENOTSUP) if hardware doesn't support.
3850 * - (-EINVAL) if bad parameter.
3852 int rte_eth_dev_rss_reta_query(uint16_t port,
3853 struct rte_eth_rss_reta_entry64 *reta_conf,
3854 uint16_t reta_size);
3857 * Updates unicast hash table for receiving packet with the given destination
3858 * MAC address, and the packet is routed to all VFs for which the RX mode is
3859 * accept packets that match the unicast hash table.
3862 * The port identifier of the Ethernet device.
3864 * Unicast MAC address.
3866 * 1 - Set an unicast hash bit for receiving packets with the MAC address.
3867 * 0 - Clear an unicast hash bit.
3869 * - (0) if successful.
3870 * - (-ENOTSUP) if hardware doesn't support.
3871 * - (-ENODEV) if *port_id* invalid.
3872 * - (-EINVAL) if bad parameter.
3874 int rte_eth_dev_uc_hash_table_set(uint16_t port, struct ether_addr *addr,
3878 * Updates all unicast hash bitmaps for receiving packet with any Unicast
3879 * Ethernet MAC addresses,the packet is routed to all VFs for which the RX
3880 * mode is accept packets that match the unicast hash table.
3883 * The port identifier of the Ethernet device.
3885 * 1 - Set all unicast hash bitmaps for receiving all the Ethernet
3887 * 0 - Clear all unicast hash bitmaps
3889 * - (0) if successful.
3890 * - (-ENOTSUP) if hardware doesn't support.
3891 * - (-ENODEV) if *port_id* invalid.
3892 * - (-EINVAL) if bad parameter.
3894 int rte_eth_dev_uc_all_hash_table_set(uint16_t port, uint8_t on);
3897 * Set a traffic mirroring rule on an Ethernet device
3900 * The port identifier of the Ethernet device.
3901 * @param mirror_conf
3902 * The pointer to the traffic mirroring structure describing the mirroring rule.
3903 * The *rte_eth_vm_mirror_conf* structure includes the type of mirroring rule,
3904 * destination pool and the value of rule if enable vlan or pool mirroring.
3907 * The index of traffic mirroring rule, we support four separated rules.
3909 * 1 - Enable a mirroring rule.
3910 * 0 - Disable a mirroring rule.
3912 * - (0) if successful.
3913 * - (-ENOTSUP) if hardware doesn't support this feature.
3914 * - (-ENODEV) if *port_id* invalid.
3915 * - (-EINVAL) if the mr_conf information is not correct.
3917 int rte_eth_mirror_rule_set(uint16_t port_id,
3918 struct rte_eth_mirror_conf *mirror_conf,
3923 * Reset a traffic mirroring rule on an Ethernet device.
3926 * The port identifier of the Ethernet device.
3928 * The index of traffic mirroring rule, we support four separated rules.
3930 * - (0) if successful.
3931 * - (-ENOTSUP) if hardware doesn't support this feature.
3932 * - (-ENODEV) if *port_id* invalid.
3933 * - (-EINVAL) if bad parameter.
3935 int rte_eth_mirror_rule_reset(uint16_t port_id,
3939 * Set the rate limitation for a queue on an Ethernet device.
3942 * The port identifier of the Ethernet device.
3946 * The tx rate in Mbps. Allocated from the total port link speed.
3948 * - (0) if successful.
3949 * - (-ENOTSUP) if hardware doesn't support this feature.
3950 * - (-ENODEV) if *port_id* invalid.
3951 * - (-EINVAL) if bad parameter.
3953 int rte_eth_set_queue_rate_limit(uint16_t port_id, uint16_t queue_idx,
3957 * Configuration of Receive Side Scaling hash computation of Ethernet device.
3960 * The port identifier of the Ethernet device.
3962 * The new configuration to use for RSS hash computation on the port.
3964 * - (0) if successful.
3965 * - (-ENODEV) if port identifier is invalid.
3966 * - (-ENOTSUP) if hardware doesn't support.
3967 * - (-EINVAL) if bad parameter.
3969 int rte_eth_dev_rss_hash_update(uint16_t port_id,
3970 struct rte_eth_rss_conf *rss_conf);
3973 * Retrieve current configuration of Receive Side Scaling hash computation
3974 * of Ethernet device.
3977 * The port identifier of the Ethernet device.
3979 * Where to store the current RSS hash configuration of the Ethernet device.
3981 * - (0) if successful.
3982 * - (-ENODEV) if port identifier is invalid.
3983 * - (-ENOTSUP) if hardware doesn't support RSS.
3986 rte_eth_dev_rss_hash_conf_get(uint16_t port_id,
3987 struct rte_eth_rss_conf *rss_conf);
3990 * Add UDP tunneling port for a specific type of tunnel.
3991 * The packets with this UDP port will be identified as this type of tunnel.
3992 * Before enabling any offloading function for a tunnel, users can call this API
3993 * to change or add more UDP port for the tunnel. So the offloading function
3994 * can take effect on the packets with the specific UDP port.
3997 * The port identifier of the Ethernet device.
3999 * UDP tunneling configuration.
4002 * - (0) if successful.
4003 * - (-ENODEV) if port identifier is invalid.
4004 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4007 rte_eth_dev_udp_tunnel_port_add(uint16_t port_id,
4008 struct rte_eth_udp_tunnel *tunnel_udp);
4011 * Delete UDP tunneling port a specific type of tunnel.
4012 * The packets with this UDP port will not be identified as this type of tunnel
4014 * Before enabling any offloading function for a tunnel, users can call this API
4015 * to delete a UDP port for the tunnel. So the offloading function will not take
4016 * effect on the packets with the specific UDP port.
4019 * The port identifier of the Ethernet device.
4021 * UDP tunneling configuration.
4024 * - (0) if successful.
4025 * - (-ENODEV) if port identifier is invalid.
4026 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4029 rte_eth_dev_udp_tunnel_port_delete(uint16_t port_id,
4030 struct rte_eth_udp_tunnel *tunnel_udp);
4033 * Check whether the filter type is supported on an Ethernet device.
4034 * All the supported filter types are defined in 'rte_eth_ctrl.h'.
4037 * The port identifier of the Ethernet device.
4038 * @param filter_type
4041 * - (0) if successful.
4042 * - (-ENOTSUP) if hardware doesn't support this filter type.
4043 * - (-ENODEV) if *port_id* invalid.
4045 int rte_eth_dev_filter_supported(uint16_t port_id,
4046 enum rte_filter_type filter_type);
4049 * Take operations to assigned filter type on an Ethernet device.
4050 * All the supported operations and filter types are defined in 'rte_eth_ctrl.h'.
4053 * The port identifier of the Ethernet device.
4054 * @param filter_type
4057 * Type of operation.
4059 * A pointer to arguments defined specifically for the operation.
4061 * - (0) if successful.
4062 * - (-ENOTSUP) if hardware doesn't support.
4063 * - (-ENODEV) if *port_id* invalid.
4064 * - others depends on the specific operations implementation.
4066 int rte_eth_dev_filter_ctrl(uint16_t port_id, enum rte_filter_type filter_type,
4067 enum rte_filter_op filter_op, void *arg);
4070 * Get DCB information on an Ethernet device.
4073 * The port identifier of the Ethernet device.
4077 * - (0) if successful.
4078 * - (-ENODEV) if port identifier is invalid.
4079 * - (-ENOTSUP) if hardware doesn't support.
4081 int rte_eth_dev_get_dcb_info(uint16_t port_id,
4082 struct rte_eth_dcb_info *dcb_info);
4085 * Add a callback to be called on packet RX on a given port and queue.
4087 * This API configures a function to be called for each burst of
4088 * packets received on a given NIC port queue. The return value is a pointer
4089 * that can be used to later remove the callback using
4090 * rte_eth_remove_rx_callback().
4092 * Multiple functions are called in the order that they are added.
4095 * The port identifier of the Ethernet device.
4097 * The queue on the Ethernet device on which the callback is to be added.
4099 * The callback function
4101 * A generic pointer parameter which will be passed to each invocation of the
4102 * callback function on this port and queue.
4106 * On success, a pointer value which can later be used to remove the callback.
4108 void *rte_eth_add_rx_callback(uint16_t port_id, uint16_t queue_id,
4109 rte_rx_callback_fn fn, void *user_param);
4112 * Add a callback that must be called first on packet RX on a given port
4115 * This API configures a first function to be called for each burst of
4116 * packets received on a given NIC port queue. The return value is a pointer
4117 * that can be used to later remove the callback using
4118 * rte_eth_remove_rx_callback().
4120 * Multiple functions are called in the order that they are added.
4123 * The port identifier of the Ethernet device.
4125 * The queue on the Ethernet device on which the callback is to be added.
4127 * The callback function
4129 * A generic pointer parameter which will be passed to each invocation of the
4130 * callback function on this port and queue.
4134 * On success, a pointer value which can later be used to remove the callback.
4136 void *rte_eth_add_first_rx_callback(uint16_t port_id, uint16_t queue_id,
4137 rte_rx_callback_fn fn, void *user_param);
4140 * Add a callback to be called on packet TX on a given port and queue.
4142 * This API configures a function to be called for each burst of
4143 * packets sent on a given NIC port queue. The return value is a pointer
4144 * that can be used to later remove the callback using
4145 * rte_eth_remove_tx_callback().
4147 * Multiple functions are called in the order that they are added.
4150 * The port identifier of the Ethernet device.
4152 * The queue on the Ethernet device on which the callback is to be added.
4154 * The callback function
4156 * A generic pointer parameter which will be passed to each invocation of the
4157 * callback function on this port and queue.
4161 * On success, a pointer value which can later be used to remove the callback.
4163 void *rte_eth_add_tx_callback(uint16_t port_id, uint16_t queue_id,
4164 rte_tx_callback_fn fn, void *user_param);
4167 * Remove an RX packet callback from a given port and queue.
4169 * This function is used to removed callbacks that were added to a NIC port
4170 * queue using rte_eth_add_rx_callback().
4172 * Note: the callback is removed from the callback list but it isn't freed
4173 * since the it may still be in use. The memory for the callback can be
4174 * subsequently freed back by the application by calling rte_free():
4176 * - Immediately - if the port is stopped, or the user knows that no
4177 * callbacks are in flight e.g. if called from the thread doing RX/TX
4180 * - After a short delay - where the delay is sufficient to allow any
4181 * in-flight callbacks to complete.
4184 * The port identifier of the Ethernet device.
4186 * The queue on the Ethernet device from which the callback is to be removed.
4188 * User supplied callback created via rte_eth_add_rx_callback().
4191 * - 0: Success. Callback was removed.
4192 * - -ENOTSUP: Callback support is not available.
4193 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
4194 * is NULL or not found for the port/queue.
4196 int rte_eth_remove_rx_callback(uint16_t port_id, uint16_t queue_id,
4197 struct rte_eth_rxtx_callback *user_cb);
4200 * Remove a TX packet callback from a given port and queue.
4202 * This function is used to removed callbacks that were added to a NIC port
4203 * queue using rte_eth_add_tx_callback().
4205 * Note: the callback is removed from the callback list but it isn't freed
4206 * since the it may still be in use. The memory for the callback can be
4207 * subsequently freed back by the application by calling rte_free():
4209 * - Immediately - if the port is stopped, or the user knows that no
4210 * callbacks are in flight e.g. if called from the thread doing RX/TX
4213 * - After a short delay - where the delay is sufficient to allow any
4214 * in-flight callbacks to complete.
4217 * The port identifier of the Ethernet device.
4219 * The queue on the Ethernet device from which the callback is to be removed.
4221 * User supplied callback created via rte_eth_add_tx_callback().
4224 * - 0: Success. Callback was removed.
4225 * - -ENOTSUP: Callback support is not available.
4226 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
4227 * is NULL or not found for the port/queue.
4229 int rte_eth_remove_tx_callback(uint16_t port_id, uint16_t queue_id,
4230 struct rte_eth_rxtx_callback *user_cb);
4233 * Retrieve information about given port's RX queue.
4236 * The port identifier of the Ethernet device.
4238 * The RX queue on the Ethernet device for which information
4239 * will be retrieved.
4241 * A pointer to a structure of type *rte_eth_rxq_info_info* to be filled with
4242 * the information of the Ethernet device.
4246 * - -ENOTSUP: routine is not supported by the device PMD.
4247 * - -EINVAL: The port_id or the queue_id is out of range.
4249 int rte_eth_rx_queue_info_get(uint16_t port_id, uint16_t queue_id,
4250 struct rte_eth_rxq_info *qinfo);
4253 * Retrieve information about given port's TX queue.
4256 * The port identifier of the Ethernet device.
4258 * The TX queue on the Ethernet device for which information
4259 * will be retrieved.
4261 * A pointer to a structure of type *rte_eth_txq_info_info* to be filled with
4262 * the information of the Ethernet device.
4266 * - -ENOTSUP: routine is not supported by the device PMD.
4267 * - -EINVAL: The port_id or the queue_id is out of range.
4269 int rte_eth_tx_queue_info_get(uint16_t port_id, uint16_t queue_id,
4270 struct rte_eth_txq_info *qinfo);
4273 * Retrieve device registers and register attributes (number of registers and
4277 * The port identifier of the Ethernet device.
4279 * Pointer to rte_dev_reg_info structure to fill in. If info->data is
4280 * NULL the function fills in the width and length fields. If non-NULL
4281 * the registers are put into the buffer pointed at by the data field.
4283 * - (0) if successful.
4284 * - (-ENOTSUP) if hardware doesn't support.
4285 * - (-ENODEV) if *port_id* invalid.
4286 * - others depends on the specific operations implementation.
4288 int rte_eth_dev_get_reg_info(uint16_t port_id, struct rte_dev_reg_info *info);
4291 * Retrieve size of device EEPROM
4294 * The port identifier of the Ethernet device.
4296 * - (>=0) EEPROM size if successful.
4297 * - (-ENOTSUP) if hardware doesn't support.
4298 * - (-ENODEV) if *port_id* invalid.
4299 * - others depends on the specific operations implementation.
4301 int rte_eth_dev_get_eeprom_length(uint16_t port_id);
4304 * Retrieve EEPROM and EEPROM attribute
4307 * The port identifier of the Ethernet device.
4309 * The template includes buffer for return EEPROM data and
4310 * EEPROM attributes to be filled.
4312 * - (0) if successful.
4313 * - (-ENOTSUP) if hardware doesn't support.
4314 * - (-ENODEV) if *port_id* invalid.
4315 * - others depends on the specific operations implementation.
4317 int rte_eth_dev_get_eeprom(uint16_t port_id, struct rte_dev_eeprom_info *info);
4320 * Program EEPROM with provided data
4323 * The port identifier of the Ethernet device.
4325 * The template includes EEPROM data for programming and
4326 * EEPROM attributes to be filled
4328 * - (0) if successful.
4329 * - (-ENOTSUP) if hardware doesn't support.
4330 * - (-ENODEV) if *port_id* invalid.
4331 * - others depends on the specific operations implementation.
4333 int rte_eth_dev_set_eeprom(uint16_t port_id, struct rte_dev_eeprom_info *info);
4336 * Set the list of multicast addresses to filter on an Ethernet device.
4339 * The port identifier of the Ethernet device.
4340 * @param mc_addr_set
4341 * The array of multicast addresses to set. Equal to NULL when the function
4342 * is invoked to flush the set of filtered addresses.
4344 * The number of multicast addresses in the *mc_addr_set* array. Equal to 0
4345 * when the function is invoked to flush the set of filtered addresses.
4347 * - (0) if successful.
4348 * - (-ENODEV) if *port_id* invalid.
4349 * - (-ENOTSUP) if PMD of *port_id* doesn't support multicast filtering.
4350 * - (-ENOSPC) if *port_id* has not enough multicast filtering resources.
4352 int rte_eth_dev_set_mc_addr_list(uint16_t port_id,
4353 struct ether_addr *mc_addr_set,
4354 uint32_t nb_mc_addr);
4357 * Enable IEEE1588/802.1AS timestamping for an Ethernet device.
4360 * The port identifier of the Ethernet device.
4364 * - -ENODEV: The port ID is invalid.
4365 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4367 int rte_eth_timesync_enable(uint16_t port_id);
4370 * Disable IEEE1588/802.1AS timestamping for an Ethernet device.
4373 * The port identifier of the Ethernet device.
4377 * - -ENODEV: The port ID is invalid.
4378 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4380 int rte_eth_timesync_disable(uint16_t port_id);
4383 * Read an IEEE1588/802.1AS RX timestamp from an Ethernet device.
4386 * The port identifier of the Ethernet device.
4388 * Pointer to the timestamp struct.
4390 * Device specific flags. Used to pass the RX timesync register index to
4391 * i40e. Unused in igb/ixgbe, pass 0 instead.
4395 * - -EINVAL: No timestamp is available.
4396 * - -ENODEV: The port ID is invalid.
4397 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4399 int rte_eth_timesync_read_rx_timestamp(uint16_t port_id,
4400 struct timespec *timestamp, uint32_t flags);
4403 * Read an IEEE1588/802.1AS TX timestamp from an Ethernet device.
4406 * The port identifier of the Ethernet device.
4408 * Pointer to the timestamp struct.
4412 * - -EINVAL: No timestamp is available.
4413 * - -ENODEV: The port ID is invalid.
4414 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4416 int rte_eth_timesync_read_tx_timestamp(uint16_t port_id,
4417 struct timespec *timestamp);
4420 * Adjust the timesync clock on an Ethernet device.
4422 * This is usually used in conjunction with other Ethdev timesync functions to
4423 * synchronize the device time using the IEEE1588/802.1AS protocol.
4426 * The port identifier of the Ethernet device.
4428 * The adjustment in nanoseconds.
4432 * - -ENODEV: The port ID is invalid.
4433 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4435 int rte_eth_timesync_adjust_time(uint16_t port_id, int64_t delta);
4438 * Read the time from the timesync clock on an Ethernet device.
4440 * This is usually used in conjunction with other Ethdev timesync functions to
4441 * synchronize the device time using the IEEE1588/802.1AS protocol.
4444 * The port identifier of the Ethernet device.
4446 * Pointer to the timespec struct that holds the time.
4451 int rte_eth_timesync_read_time(uint16_t port_id, struct timespec *time);
4454 * Set the time of the timesync clock on an Ethernet device.
4456 * This is usually used in conjunction with other Ethdev timesync functions to
4457 * synchronize the device time using the IEEE1588/802.1AS protocol.
4460 * The port identifier of the Ethernet device.
4462 * Pointer to the timespec struct that holds the time.
4466 * - -EINVAL: No timestamp is available.
4467 * - -ENODEV: The port ID is invalid.
4468 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4470 int rte_eth_timesync_write_time(uint16_t port_id, const struct timespec *time);
4473 * Create memzone for HW rings.
4474 * malloc can't be used as the physical address is needed.
4475 * If the memzone is already created, then this function returns a ptr
4479 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
4481 * The name of the memory zone
4483 * The index of the queue to add to name
4485 * The sizeof of the memory area
4487 * Alignment for resulting memzone. Must be a power of 2.
4489 * The *socket_id* argument is the socket identifier in case of NUMA.
4491 const struct rte_memzone *
4492 rte_eth_dma_zone_reserve(const struct rte_eth_dev *eth_dev, const char *name,
4493 uint16_t queue_id, size_t size,
4494 unsigned align, int socket_id);
4497 * Config l2 tunnel ether type of an Ethernet device for filtering specific
4498 * tunnel packets by ether type.
4501 * The port identifier of the Ethernet device.
4503 * l2 tunnel configuration.
4506 * - (0) if successful.
4507 * - (-ENODEV) if port identifier is invalid.
4508 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4511 rte_eth_dev_l2_tunnel_eth_type_conf(uint16_t port_id,
4512 struct rte_eth_l2_tunnel_conf *l2_tunnel);
4515 * Enable/disable l2 tunnel offload functions. Include,
4516 * 1, The ability of parsing a type of l2 tunnel of an Ethernet device.
4517 * Filtering, forwarding and offloading this type of tunnel packets depend on
4519 * 2, Stripping the l2 tunnel tag.
4520 * 3, Insertion of the l2 tunnel tag.
4521 * 4, Forwarding the packets based on the l2 tunnel tag.
4524 * The port identifier of the Ethernet device.
4526 * l2 tunnel parameters.
4528 * Indicate the offload function.
4530 * Enable or disable this function.
4533 * - (0) if successful.
4534 * - (-ENODEV) if port identifier is invalid.
4535 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4538 rte_eth_dev_l2_tunnel_offload_set(uint16_t port_id,
4539 struct rte_eth_l2_tunnel_conf *l2_tunnel,
4544 * Get the port id from pci address or device name
4545 * Ex: 0000:2:00.0 or vdev name net_pcap0
4548 * pci address or name of the device
4550 * pointer to port identifier of the device
4552 * - (0) if successful and port_id is filled.
4553 * - (-ENODEV or -EINVAL) on failure.
4556 rte_eth_dev_get_port_by_name(const char *name, uint16_t *port_id);
4559 * Get the device name from port id
4562 * pointer to port identifier of the device
4564 * pci address or name of the device
4566 * - (0) if successful.
4567 * - (-EINVAL) on failure.
4570 rte_eth_dev_get_name_by_port(uint16_t port_id, char *name);
4573 * Check that numbers of Rx and Tx descriptors satisfy descriptors limits from
4574 * the ethernet device information, otherwise adjust them to boundaries.
4577 * The port identifier of the Ethernet device.
4579 * A pointer to a uint16_t where the number of receive
4580 * descriptors stored.
4582 * A pointer to a uint16_t where the number of transmit
4583 * descriptors stored.
4585 * - (0) if successful.
4586 * - (-ENOTSUP, -ENODEV or -EINVAL) on failure.
4588 int rte_eth_dev_adjust_nb_rx_tx_desc(uint16_t port_id,
4589 uint16_t *nb_rx_desc,
4590 uint16_t *nb_tx_desc);
4594 * Test if a port supports specific mempool ops.
4597 * Port identifier of the Ethernet device.
4599 * The name of the pool operations to test.
4601 * - 0: best mempool ops choice for this port.
4602 * - 1: mempool ops are supported for this port.
4603 * - -ENOTSUP: mempool ops not supported for this port.
4604 * - -ENODEV: Invalid port Identifier.
4605 * - -EINVAL: Pool param is null.
4608 rte_eth_dev_pool_ops_supported(uint16_t port_id, const char *pool);
4614 #endif /* _RTE_ETHDEV_H_ */