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>
185 #include "rte_ether.h"
186 #include "rte_eth_ctrl.h"
187 #include "rte_dev_info.h"
192 * A structure used to retrieve statistics for an Ethernet port.
193 * Not all statistics fields in struct rte_eth_stats are supported
194 * by any type of network interface card (NIC). If any statistics
195 * field is not supported, its value is 0.
197 struct rte_eth_stats {
198 uint64_t ipackets; /**< Total number of successfully received packets. */
199 uint64_t opackets; /**< Total number of successfully transmitted packets.*/
200 uint64_t ibytes; /**< Total number of successfully received bytes. */
201 uint64_t obytes; /**< Total number of successfully transmitted bytes. */
203 /**< Total of RX packets dropped by the HW,
204 * because there are no available buffer (i.e. RX queues are full).
206 uint64_t ierrors; /**< Total number of erroneous received packets. */
207 uint64_t oerrors; /**< Total number of failed transmitted packets. */
208 uint64_t rx_nombuf; /**< Total number of RX mbuf allocation failures. */
209 uint64_t q_ipackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
210 /**< Total number of queue RX packets. */
211 uint64_t q_opackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
212 /**< Total number of queue TX packets. */
213 uint64_t q_ibytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
214 /**< Total number of successfully received queue bytes. */
215 uint64_t q_obytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
216 /**< Total number of successfully transmitted queue bytes. */
217 uint64_t q_errors[RTE_ETHDEV_QUEUE_STAT_CNTRS];
218 /**< Total number of queue packets received that are dropped. */
222 * Device supported speeds bitmap flags
224 #define ETH_LINK_SPEED_AUTONEG (0 << 0) /**< Autonegotiate (all speeds) */
225 #define ETH_LINK_SPEED_FIXED (1 << 0) /**< Disable autoneg (fixed speed) */
226 #define ETH_LINK_SPEED_10M_HD (1 << 1) /**< 10 Mbps half-duplex */
227 #define ETH_LINK_SPEED_10M (1 << 2) /**< 10 Mbps full-duplex */
228 #define ETH_LINK_SPEED_100M_HD (1 << 3) /**< 100 Mbps half-duplex */
229 #define ETH_LINK_SPEED_100M (1 << 4) /**< 100 Mbps full-duplex */
230 #define ETH_LINK_SPEED_1G (1 << 5) /**< 1 Gbps */
231 #define ETH_LINK_SPEED_2_5G (1 << 6) /**< 2.5 Gbps */
232 #define ETH_LINK_SPEED_5G (1 << 7) /**< 5 Gbps */
233 #define ETH_LINK_SPEED_10G (1 << 8) /**< 10 Gbps */
234 #define ETH_LINK_SPEED_20G (1 << 9) /**< 20 Gbps */
235 #define ETH_LINK_SPEED_25G (1 << 10) /**< 25 Gbps */
236 #define ETH_LINK_SPEED_40G (1 << 11) /**< 40 Gbps */
237 #define ETH_LINK_SPEED_50G (1 << 12) /**< 50 Gbps */
238 #define ETH_LINK_SPEED_56G (1 << 13) /**< 56 Gbps */
239 #define ETH_LINK_SPEED_100G (1 << 14) /**< 100 Gbps */
242 * Ethernet numeric link speeds in Mbps
244 #define ETH_SPEED_NUM_NONE 0 /**< Not defined */
245 #define ETH_SPEED_NUM_10M 10 /**< 10 Mbps */
246 #define ETH_SPEED_NUM_100M 100 /**< 100 Mbps */
247 #define ETH_SPEED_NUM_1G 1000 /**< 1 Gbps */
248 #define ETH_SPEED_NUM_2_5G 2500 /**< 2.5 Gbps */
249 #define ETH_SPEED_NUM_5G 5000 /**< 5 Gbps */
250 #define ETH_SPEED_NUM_10G 10000 /**< 10 Gbps */
251 #define ETH_SPEED_NUM_20G 20000 /**< 20 Gbps */
252 #define ETH_SPEED_NUM_25G 25000 /**< 25 Gbps */
253 #define ETH_SPEED_NUM_40G 40000 /**< 40 Gbps */
254 #define ETH_SPEED_NUM_50G 50000 /**< 50 Gbps */
255 #define ETH_SPEED_NUM_56G 56000 /**< 56 Gbps */
256 #define ETH_SPEED_NUM_100G 100000 /**< 100 Gbps */
259 * A structure used to retrieve link-level information of an Ethernet port.
262 struct rte_eth_link {
263 uint32_t link_speed; /**< ETH_SPEED_NUM_ */
264 uint16_t link_duplex : 1; /**< ETH_LINK_[HALF/FULL]_DUPLEX */
265 uint16_t link_autoneg : 1; /**< ETH_LINK_SPEED_[AUTONEG/FIXED] */
266 uint16_t link_status : 1; /**< ETH_LINK_[DOWN/UP] */
267 } __attribute__((aligned(8))); /**< aligned for atomic64 read/write */
269 /* Utility constants */
270 #define ETH_LINK_HALF_DUPLEX 0 /**< Half-duplex connection. */
271 #define ETH_LINK_FULL_DUPLEX 1 /**< Full-duplex connection. */
272 #define ETH_LINK_DOWN 0 /**< Link is down. */
273 #define ETH_LINK_UP 1 /**< Link is up. */
274 #define ETH_LINK_FIXED 0 /**< No autonegotiation. */
275 #define ETH_LINK_AUTONEG 1 /**< Autonegotiated. */
278 * A structure used to configure the ring threshold registers of an RX/TX
279 * queue for an Ethernet port.
281 struct rte_eth_thresh {
282 uint8_t pthresh; /**< Ring prefetch threshold. */
283 uint8_t hthresh; /**< Ring host threshold. */
284 uint8_t wthresh; /**< Ring writeback threshold. */
288 * Simple flags are used for rte_eth_conf.rxmode.mq_mode.
290 #define ETH_MQ_RX_RSS_FLAG 0x1
291 #define ETH_MQ_RX_DCB_FLAG 0x2
292 #define ETH_MQ_RX_VMDQ_FLAG 0x4
295 * A set of values to identify what method is to be used to route
296 * packets to multiple queues.
298 enum rte_eth_rx_mq_mode {
299 /** None of DCB,RSS or VMDQ mode */
302 /** For RX side, only RSS is on */
303 ETH_MQ_RX_RSS = ETH_MQ_RX_RSS_FLAG,
304 /** For RX side,only DCB is on. */
305 ETH_MQ_RX_DCB = ETH_MQ_RX_DCB_FLAG,
306 /** Both DCB and RSS enable */
307 ETH_MQ_RX_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG,
309 /** Only VMDQ, no RSS nor DCB */
310 ETH_MQ_RX_VMDQ_ONLY = ETH_MQ_RX_VMDQ_FLAG,
311 /** RSS mode with VMDQ */
312 ETH_MQ_RX_VMDQ_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_VMDQ_FLAG,
313 /** Use VMDQ+DCB to route traffic to queues */
314 ETH_MQ_RX_VMDQ_DCB = ETH_MQ_RX_VMDQ_FLAG | ETH_MQ_RX_DCB_FLAG,
315 /** Enable both VMDQ and DCB in VMDq */
316 ETH_MQ_RX_VMDQ_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG |
321 * for rx mq mode backward compatible
323 #define ETH_RSS ETH_MQ_RX_RSS
324 #define VMDQ_DCB ETH_MQ_RX_VMDQ_DCB
325 #define ETH_DCB_RX ETH_MQ_RX_DCB
328 * A set of values to identify what method is to be used to transmit
329 * packets using multi-TCs.
331 enum rte_eth_tx_mq_mode {
332 ETH_MQ_TX_NONE = 0, /**< It is in neither DCB nor VT mode. */
333 ETH_MQ_TX_DCB, /**< For TX side,only DCB is on. */
334 ETH_MQ_TX_VMDQ_DCB, /**< For TX side,both DCB and VT is on. */
335 ETH_MQ_TX_VMDQ_ONLY, /**< Only VT on, no DCB */
339 * for tx mq mode backward compatible
341 #define ETH_DCB_NONE ETH_MQ_TX_NONE
342 #define ETH_VMDQ_DCB_TX ETH_MQ_TX_VMDQ_DCB
343 #define ETH_DCB_TX ETH_MQ_TX_DCB
346 * A structure used to configure the RX features of an Ethernet port.
348 struct rte_eth_rxmode {
349 /** The multi-queue packet distribution mode to be used, e.g. RSS. */
350 enum rte_eth_rx_mq_mode mq_mode;
351 uint32_t max_rx_pkt_len; /**< Only used if jumbo_frame enabled. */
352 uint16_t split_hdr_size; /**< hdr buf size (header_split enabled).*/
354 * Per-port Rx offloads to be set using DEV_RX_OFFLOAD_* flags.
355 * Only offloads set on rx_offload_capa field on rte_eth_dev_info
356 * structure are allowed to be set.
361 * Below bitfield API is obsolete. Application should
362 * enable per-port offloads using the offload field
365 uint16_t header_split : 1, /**< Header Split enable. */
366 hw_ip_checksum : 1, /**< IP/UDP/TCP checksum offload enable. */
367 hw_vlan_filter : 1, /**< VLAN filter enable. */
368 hw_vlan_strip : 1, /**< VLAN strip enable. */
369 hw_vlan_extend : 1, /**< Extended VLAN enable. */
370 jumbo_frame : 1, /**< Jumbo Frame Receipt enable. */
371 hw_strip_crc : 1, /**< Enable CRC stripping by hardware. */
372 enable_scatter : 1, /**< Enable scatter packets rx handler */
373 enable_lro : 1, /**< Enable LRO */
374 hw_timestamp : 1, /**< Enable HW timestamp */
375 security : 1, /**< Enable rte_security offloads */
377 * When set the offload bitfield should be ignored.
378 * Instead per-port Rx offloads should be set on offloads
380 * Per-queue offloads shuold be set on rte_eth_rxq_conf
382 * This bit is temporary till rxmode bitfield offloads API will
385 ignore_offload_bitfield : 1;
389 * VLAN types to indicate if it is for single VLAN, inner VLAN or outer VLAN.
390 * Note that single VLAN is treated the same as inner VLAN.
393 ETH_VLAN_TYPE_UNKNOWN = 0,
394 ETH_VLAN_TYPE_INNER, /**< Inner VLAN. */
395 ETH_VLAN_TYPE_OUTER, /**< Single VLAN, or outer VLAN. */
400 * A structure used to describe a vlan filter.
401 * If the bit corresponding to a VID is set, such VID is on.
403 struct rte_vlan_filter_conf {
408 * A structure used to configure the Receive Side Scaling (RSS) feature
409 * of an Ethernet port.
410 * If not NULL, the *rss_key* pointer of the *rss_conf* structure points
411 * to an array holding the RSS key to use for hashing specific header
412 * fields of received packets. The length of this array should be indicated
413 * by *rss_key_len* below. Otherwise, a default random hash key is used by
416 * The *rss_key_len* field of the *rss_conf* structure indicates the length
417 * in bytes of the array pointed by *rss_key*. To be compatible, this length
418 * will be checked in i40e only. Others assume 40 bytes to be used as before.
420 * The *rss_hf* field of the *rss_conf* structure indicates the different
421 * types of IPv4/IPv6 packets to which the RSS hashing must be applied.
422 * Supplying an *rss_hf* equal to zero disables the RSS feature.
424 struct rte_eth_rss_conf {
425 uint8_t *rss_key; /**< If not NULL, 40-byte hash key. */
426 uint8_t rss_key_len; /**< hash key length in bytes. */
427 uint64_t rss_hf; /**< Hash functions to apply - see below. */
431 * The RSS offload types are defined based on flow types which are defined
432 * in rte_eth_ctrl.h. Different NIC hardwares may support different RSS offload
433 * types. The supported flow types or RSS offload types can be queried by
434 * rte_eth_dev_info_get().
436 #define ETH_RSS_IPV4 (1ULL << RTE_ETH_FLOW_IPV4)
437 #define ETH_RSS_FRAG_IPV4 (1ULL << RTE_ETH_FLOW_FRAG_IPV4)
438 #define ETH_RSS_NONFRAG_IPV4_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_TCP)
439 #define ETH_RSS_NONFRAG_IPV4_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_UDP)
440 #define ETH_RSS_NONFRAG_IPV4_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_SCTP)
441 #define ETH_RSS_NONFRAG_IPV4_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_OTHER)
442 #define ETH_RSS_IPV6 (1ULL << RTE_ETH_FLOW_IPV6)
443 #define ETH_RSS_FRAG_IPV6 (1ULL << RTE_ETH_FLOW_FRAG_IPV6)
444 #define ETH_RSS_NONFRAG_IPV6_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_TCP)
445 #define ETH_RSS_NONFRAG_IPV6_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_UDP)
446 #define ETH_RSS_NONFRAG_IPV6_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_SCTP)
447 #define ETH_RSS_NONFRAG_IPV6_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_OTHER)
448 #define ETH_RSS_L2_PAYLOAD (1ULL << RTE_ETH_FLOW_L2_PAYLOAD)
449 #define ETH_RSS_IPV6_EX (1ULL << RTE_ETH_FLOW_IPV6_EX)
450 #define ETH_RSS_IPV6_TCP_EX (1ULL << RTE_ETH_FLOW_IPV6_TCP_EX)
451 #define ETH_RSS_IPV6_UDP_EX (1ULL << RTE_ETH_FLOW_IPV6_UDP_EX)
452 #define ETH_RSS_PORT (1ULL << RTE_ETH_FLOW_PORT)
453 #define ETH_RSS_VXLAN (1ULL << RTE_ETH_FLOW_VXLAN)
454 #define ETH_RSS_GENEVE (1ULL << RTE_ETH_FLOW_GENEVE)
455 #define ETH_RSS_NVGRE (1ULL << RTE_ETH_FLOW_NVGRE)
457 #define ETH_RSS_IP ( \
459 ETH_RSS_FRAG_IPV4 | \
460 ETH_RSS_NONFRAG_IPV4_OTHER | \
462 ETH_RSS_FRAG_IPV6 | \
463 ETH_RSS_NONFRAG_IPV6_OTHER | \
466 #define ETH_RSS_UDP ( \
467 ETH_RSS_NONFRAG_IPV4_UDP | \
468 ETH_RSS_NONFRAG_IPV6_UDP | \
471 #define ETH_RSS_TCP ( \
472 ETH_RSS_NONFRAG_IPV4_TCP | \
473 ETH_RSS_NONFRAG_IPV6_TCP | \
476 #define ETH_RSS_SCTP ( \
477 ETH_RSS_NONFRAG_IPV4_SCTP | \
478 ETH_RSS_NONFRAG_IPV6_SCTP)
480 #define ETH_RSS_TUNNEL ( \
486 /**< Mask of valid RSS hash protocols */
487 #define ETH_RSS_PROTO_MASK ( \
489 ETH_RSS_FRAG_IPV4 | \
490 ETH_RSS_NONFRAG_IPV4_TCP | \
491 ETH_RSS_NONFRAG_IPV4_UDP | \
492 ETH_RSS_NONFRAG_IPV4_SCTP | \
493 ETH_RSS_NONFRAG_IPV4_OTHER | \
495 ETH_RSS_FRAG_IPV6 | \
496 ETH_RSS_NONFRAG_IPV6_TCP | \
497 ETH_RSS_NONFRAG_IPV6_UDP | \
498 ETH_RSS_NONFRAG_IPV6_SCTP | \
499 ETH_RSS_NONFRAG_IPV6_OTHER | \
500 ETH_RSS_L2_PAYLOAD | \
502 ETH_RSS_IPV6_TCP_EX | \
503 ETH_RSS_IPV6_UDP_EX | \
510 * Definitions used for redirection table entry size.
511 * Some RSS RETA sizes may not be supported by some drivers, check the
512 * documentation or the description of relevant functions for more details.
514 #define ETH_RSS_RETA_SIZE_64 64
515 #define ETH_RSS_RETA_SIZE_128 128
516 #define ETH_RSS_RETA_SIZE_256 256
517 #define ETH_RSS_RETA_SIZE_512 512
518 #define RTE_RETA_GROUP_SIZE 64
520 /* Definitions used for VMDQ and DCB functionality */
521 #define ETH_VMDQ_MAX_VLAN_FILTERS 64 /**< Maximum nb. of VMDQ vlan filters. */
522 #define ETH_DCB_NUM_USER_PRIORITIES 8 /**< Maximum nb. of DCB priorities. */
523 #define ETH_VMDQ_DCB_NUM_QUEUES 128 /**< Maximum nb. of VMDQ DCB queues. */
524 #define ETH_DCB_NUM_QUEUES 128 /**< Maximum nb. of DCB queues. */
526 /* DCB capability defines */
527 #define ETH_DCB_PG_SUPPORT 0x00000001 /**< Priority Group(ETS) support. */
528 #define ETH_DCB_PFC_SUPPORT 0x00000002 /**< Priority Flow Control support. */
530 /* Definitions used for VLAN Offload functionality */
531 #define ETH_VLAN_STRIP_OFFLOAD 0x0001 /**< VLAN Strip On/Off */
532 #define ETH_VLAN_FILTER_OFFLOAD 0x0002 /**< VLAN Filter On/Off */
533 #define ETH_VLAN_EXTEND_OFFLOAD 0x0004 /**< VLAN Extend On/Off */
535 /* Definitions used for mask VLAN setting */
536 #define ETH_VLAN_STRIP_MASK 0x0001 /**< VLAN Strip setting mask */
537 #define ETH_VLAN_FILTER_MASK 0x0002 /**< VLAN Filter setting mask*/
538 #define ETH_VLAN_EXTEND_MASK 0x0004 /**< VLAN Extend setting mask*/
539 #define ETH_VLAN_ID_MAX 0x0FFF /**< VLAN ID is in lower 12 bits*/
541 /* Definitions used for receive MAC address */
542 #define ETH_NUM_RECEIVE_MAC_ADDR 128 /**< Maximum nb. of receive mac addr. */
544 /* Definitions used for unicast hash */
545 #define ETH_VMDQ_NUM_UC_HASH_ARRAY 128 /**< Maximum nb. of UC hash array. */
547 /* Definitions used for VMDQ pool rx mode setting */
548 #define ETH_VMDQ_ACCEPT_UNTAG 0x0001 /**< accept untagged packets. */
549 #define ETH_VMDQ_ACCEPT_HASH_MC 0x0002 /**< accept packets in multicast table . */
550 #define ETH_VMDQ_ACCEPT_HASH_UC 0x0004 /**< accept packets in unicast table. */
551 #define ETH_VMDQ_ACCEPT_BROADCAST 0x0008 /**< accept broadcast packets. */
552 #define ETH_VMDQ_ACCEPT_MULTICAST 0x0010 /**< multicast promiscuous. */
554 /** Maximum nb. of vlan per mirror rule */
555 #define ETH_MIRROR_MAX_VLANS 64
557 #define ETH_MIRROR_VIRTUAL_POOL_UP 0x01 /**< Virtual Pool uplink Mirroring. */
558 #define ETH_MIRROR_UPLINK_PORT 0x02 /**< Uplink Port Mirroring. */
559 #define ETH_MIRROR_DOWNLINK_PORT 0x04 /**< Downlink Port Mirroring. */
560 #define ETH_MIRROR_VLAN 0x08 /**< VLAN Mirroring. */
561 #define ETH_MIRROR_VIRTUAL_POOL_DOWN 0x10 /**< Virtual Pool downlink Mirroring. */
564 * A structure used to configure VLAN traffic mirror of an Ethernet port.
566 struct rte_eth_vlan_mirror {
567 uint64_t vlan_mask; /**< mask for valid VLAN ID. */
568 /** VLAN ID list for vlan mirroring. */
569 uint16_t vlan_id[ETH_MIRROR_MAX_VLANS];
573 * A structure used to configure traffic mirror of an Ethernet port.
575 struct rte_eth_mirror_conf {
576 uint8_t rule_type; /**< Mirroring rule type */
577 uint8_t dst_pool; /**< Destination pool for this mirror rule. */
578 uint64_t pool_mask; /**< Bitmap of pool for pool mirroring */
579 /** VLAN ID setting for VLAN mirroring. */
580 struct rte_eth_vlan_mirror vlan;
584 * A structure used to configure 64 entries of Redirection Table of the
585 * Receive Side Scaling (RSS) feature of an Ethernet port. To configure
586 * more than 64 entries supported by hardware, an array of this structure
589 struct rte_eth_rss_reta_entry64 {
591 /**< Mask bits indicate which entries need to be updated/queried. */
592 uint16_t reta[RTE_RETA_GROUP_SIZE];
593 /**< Group of 64 redirection table entries. */
597 * This enum indicates the possible number of traffic classes
598 * in DCB configurations
600 enum rte_eth_nb_tcs {
601 ETH_4_TCS = 4, /**< 4 TCs with DCB. */
602 ETH_8_TCS = 8 /**< 8 TCs with DCB. */
606 * This enum indicates the possible number of queue pools
607 * in VMDQ configurations.
609 enum rte_eth_nb_pools {
610 ETH_8_POOLS = 8, /**< 8 VMDq pools. */
611 ETH_16_POOLS = 16, /**< 16 VMDq pools. */
612 ETH_32_POOLS = 32, /**< 32 VMDq pools. */
613 ETH_64_POOLS = 64 /**< 64 VMDq pools. */
616 /* This structure may be extended in future. */
617 struct rte_eth_dcb_rx_conf {
618 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs */
619 /** Traffic class each UP mapped to. */
620 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
623 struct rte_eth_vmdq_dcb_tx_conf {
624 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools. */
625 /** Traffic class each UP mapped to. */
626 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
629 struct rte_eth_dcb_tx_conf {
630 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs. */
631 /** Traffic class each UP mapped to. */
632 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
635 struct rte_eth_vmdq_tx_conf {
636 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq mode, 64 pools. */
640 * A structure used to configure the VMDQ+DCB feature
641 * of an Ethernet port.
643 * Using this feature, packets are routed to a pool of queues, based
644 * on the vlan id in the vlan tag, and then to a specific queue within
645 * that pool, using the user priority vlan tag field.
647 * A default pool may be used, if desired, to route all traffic which
648 * does not match the vlan filter rules.
650 struct rte_eth_vmdq_dcb_conf {
651 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools */
652 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
653 uint8_t default_pool; /**< The default pool, if applicable */
654 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
656 uint16_t vlan_id; /**< The vlan id of the received frame */
657 uint64_t pools; /**< Bitmask of pools for packet rx */
658 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
659 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
660 /**< Selects a queue in a pool */
664 * A structure used to configure the VMDQ feature of an Ethernet port when
665 * not combined with the DCB feature.
667 * Using this feature, packets are routed to a pool of queues. By default,
668 * the pool selection is based on the MAC address, the vlan id in the
669 * vlan tag as specified in the pool_map array.
670 * Passing the ETH_VMDQ_ACCEPT_UNTAG in the rx_mode field allows pool
671 * selection using only the MAC address. MAC address to pool mapping is done
672 * using the rte_eth_dev_mac_addr_add function, with the pool parameter
673 * corresponding to the pool id.
675 * Queue selection within the selected pool will be done using RSS when
676 * it is enabled or revert to the first queue of the pool if not.
678 * A default pool may be used, if desired, to route all traffic which
679 * does not match the vlan filter rules or any pool MAC address.
681 struct rte_eth_vmdq_rx_conf {
682 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq only mode, 8 or 64 pools */
683 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
684 uint8_t default_pool; /**< The default pool, if applicable */
685 uint8_t enable_loop_back; /**< Enable VT loop back */
686 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
687 uint32_t rx_mode; /**< Flags from ETH_VMDQ_ACCEPT_* */
689 uint16_t vlan_id; /**< The vlan id of the received frame */
690 uint64_t pools; /**< Bitmask of pools for packet rx */
691 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
695 * A structure used to configure the TX features of an Ethernet port.
697 struct rte_eth_txmode {
698 enum rte_eth_tx_mq_mode mq_mode; /**< TX multi-queues mode. */
700 * Per-port Tx offloads to be set using DEV_TX_OFFLOAD_* flags.
701 * Only offloads set on tx_offload_capa field on rte_eth_dev_info
702 * structure are allowed to be set.
706 /* For i40e specifically */
709 uint8_t hw_vlan_reject_tagged : 1,
710 /**< If set, reject sending out tagged pkts */
711 hw_vlan_reject_untagged : 1,
712 /**< If set, reject sending out untagged pkts */
713 hw_vlan_insert_pvid : 1;
714 /**< If set, enable port based VLAN insertion */
718 * A structure used to configure an RX ring of an Ethernet port.
720 struct rte_eth_rxconf {
721 struct rte_eth_thresh rx_thresh; /**< RX ring threshold registers. */
722 uint16_t rx_free_thresh; /**< Drives the freeing of RX descriptors. */
723 uint8_t rx_drop_en; /**< Drop packets if no descriptors are available. */
724 uint8_t rx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
726 * Per-queue Rx offloads to be set using DEV_RX_OFFLOAD_* flags.
727 * Only offloads set on rx_queue_offload_capa or rx_offload_capa
728 * fields on rte_eth_dev_info structure are allowed to be set.
733 #define ETH_TXQ_FLAGS_NOMULTSEGS 0x0001 /**< nb_segs=1 for all mbufs */
734 #define ETH_TXQ_FLAGS_NOREFCOUNT 0x0002 /**< refcnt can be ignored */
735 #define ETH_TXQ_FLAGS_NOMULTMEMP 0x0004 /**< all bufs come from same mempool */
736 #define ETH_TXQ_FLAGS_NOVLANOFFL 0x0100 /**< disable VLAN offload */
737 #define ETH_TXQ_FLAGS_NOXSUMSCTP 0x0200 /**< disable SCTP checksum offload */
738 #define ETH_TXQ_FLAGS_NOXSUMUDP 0x0400 /**< disable UDP checksum offload */
739 #define ETH_TXQ_FLAGS_NOXSUMTCP 0x0800 /**< disable TCP checksum offload */
740 #define ETH_TXQ_FLAGS_NOOFFLOADS \
741 (ETH_TXQ_FLAGS_NOVLANOFFL | ETH_TXQ_FLAGS_NOXSUMSCTP | \
742 ETH_TXQ_FLAGS_NOXSUMUDP | ETH_TXQ_FLAGS_NOXSUMTCP)
743 #define ETH_TXQ_FLAGS_NOXSUMS \
744 (ETH_TXQ_FLAGS_NOXSUMSCTP | ETH_TXQ_FLAGS_NOXSUMUDP | \
745 ETH_TXQ_FLAGS_NOXSUMTCP)
747 * When set the txq_flags should be ignored,
748 * instead per-queue Tx offloads will be set on offloads field
749 * located on rte_eth_txq_conf struct.
750 * This flag is temporary till the rte_eth_txq_conf.txq_flags
751 * API will be deprecated.
753 #define ETH_TXQ_FLAGS_IGNORE 0x8000
756 * A structure used to configure a TX ring of an Ethernet port.
758 struct rte_eth_txconf {
759 struct rte_eth_thresh tx_thresh; /**< TX ring threshold registers. */
760 uint16_t tx_rs_thresh; /**< Drives the setting of RS bit on TXDs. */
761 uint16_t tx_free_thresh; /**< Start freeing TX buffers if there are
762 less free descriptors than this value. */
764 uint32_t txq_flags; /**< Set flags for the Tx queue */
765 uint8_t tx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
767 * Per-queue Tx offloads to be set using DEV_TX_OFFLOAD_* flags.
768 * Only offloads set on tx_queue_offload_capa or tx_offload_capa
769 * fields on rte_eth_dev_info structure are allowed to be set.
775 * A structure contains information about HW descriptor ring limitations.
777 struct rte_eth_desc_lim {
778 uint16_t nb_max; /**< Max allowed number of descriptors. */
779 uint16_t nb_min; /**< Min allowed number of descriptors. */
780 uint16_t nb_align; /**< Number of descriptors should be aligned to. */
783 * Max allowed number of segments per whole packet.
785 * - For TSO packet this is the total number of data descriptors allowed
788 * @see nb_mtu_seg_max
793 * Max number of segments per one MTU.
795 * - For non-TSO packet, this is the maximum allowed number of segments
796 * in a single transmit packet.
798 * - For TSO packet each segment within the TSO may span up to this
803 uint16_t nb_mtu_seg_max;
807 * This enum indicates the flow control mode
809 enum rte_eth_fc_mode {
810 RTE_FC_NONE = 0, /**< Disable flow control. */
811 RTE_FC_RX_PAUSE, /**< RX pause frame, enable flowctrl on TX side. */
812 RTE_FC_TX_PAUSE, /**< TX pause frame, enable flowctrl on RX side. */
813 RTE_FC_FULL /**< Enable flow control on both side. */
817 * A structure used to configure Ethernet flow control parameter.
818 * These parameters will be configured into the register of the NIC.
819 * Please refer to the corresponding data sheet for proper value.
821 struct rte_eth_fc_conf {
822 uint32_t high_water; /**< High threshold value to trigger XOFF */
823 uint32_t low_water; /**< Low threshold value to trigger XON */
824 uint16_t pause_time; /**< Pause quota in the Pause frame */
825 uint16_t send_xon; /**< Is XON frame need be sent */
826 enum rte_eth_fc_mode mode; /**< Link flow control mode */
827 uint8_t mac_ctrl_frame_fwd; /**< Forward MAC control frames */
828 uint8_t autoneg; /**< Use Pause autoneg */
832 * A structure used to configure Ethernet priority flow control parameter.
833 * These parameters will be configured into the register of the NIC.
834 * Please refer to the corresponding data sheet for proper value.
836 struct rte_eth_pfc_conf {
837 struct rte_eth_fc_conf fc; /**< General flow control parameter. */
838 uint8_t priority; /**< VLAN User Priority. */
842 * Memory space that can be configured to store Flow Director filters
843 * in the board memory.
845 enum rte_fdir_pballoc_type {
846 RTE_FDIR_PBALLOC_64K = 0, /**< 64k. */
847 RTE_FDIR_PBALLOC_128K, /**< 128k. */
848 RTE_FDIR_PBALLOC_256K, /**< 256k. */
852 * Select report mode of FDIR hash information in RX descriptors.
854 enum rte_fdir_status_mode {
855 RTE_FDIR_NO_REPORT_STATUS = 0, /**< Never report FDIR hash. */
856 RTE_FDIR_REPORT_STATUS, /**< Only report FDIR hash for matching pkts. */
857 RTE_FDIR_REPORT_STATUS_ALWAYS, /**< Always report FDIR hash. */
861 * A structure used to configure the Flow Director (FDIR) feature
862 * of an Ethernet port.
864 * If mode is RTE_FDIR_DISABLE, the pballoc value is ignored.
866 struct rte_fdir_conf {
867 enum rte_fdir_mode mode; /**< Flow Director mode. */
868 enum rte_fdir_pballoc_type pballoc; /**< Space for FDIR filters. */
869 enum rte_fdir_status_mode status; /**< How to report FDIR hash. */
870 /** RX queue of packets matching a "drop" filter in perfect mode. */
872 struct rte_eth_fdir_masks mask;
873 struct rte_eth_fdir_flex_conf flex_conf;
874 /**< Flex payload configuration. */
878 * UDP tunneling configuration.
879 * Used to config the UDP port for a type of tunnel.
880 * NICs need the UDP port to identify the tunnel type.
881 * Normally a type of tunnel has a default UDP port, this structure can be used
882 * in case if the users want to change or support more UDP port.
884 struct rte_eth_udp_tunnel {
885 uint16_t udp_port; /**< UDP port used for the tunnel. */
886 uint8_t prot_type; /**< Tunnel type. Defined in rte_eth_tunnel_type. */
890 * A structure used to enable/disable specific device interrupts.
892 struct rte_intr_conf {
893 /** enable/disable lsc interrupt. 0 (default) - disable, 1 enable */
895 /** enable/disable rxq interrupt. 0 (default) - disable, 1 enable */
897 /** enable/disable rmv interrupt. 0 (default) - disable, 1 enable */
902 * A structure used to configure an Ethernet port.
903 * Depending upon the RX multi-queue mode, extra advanced
904 * configuration settings may be needed.
906 struct rte_eth_conf {
907 uint32_t link_speeds; /**< bitmap of ETH_LINK_SPEED_XXX of speeds to be
908 used. ETH_LINK_SPEED_FIXED disables link
909 autonegotiation, and a unique speed shall be
910 set. Otherwise, the bitmap defines the set of
911 speeds to be advertised. If the special value
912 ETH_LINK_SPEED_AUTONEG (0) is used, all speeds
913 supported are advertised. */
914 struct rte_eth_rxmode rxmode; /**< Port RX configuration. */
915 struct rte_eth_txmode txmode; /**< Port TX configuration. */
916 uint32_t lpbk_mode; /**< Loopback operation mode. By default the value
917 is 0, meaning the loopback mode is disabled.
918 Read the datasheet of given ethernet controller
919 for details. The possible values of this field
920 are defined in implementation of each driver. */
922 struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
923 struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
924 /**< Port vmdq+dcb configuration. */
925 struct rte_eth_dcb_rx_conf dcb_rx_conf;
926 /**< Port dcb RX configuration. */
927 struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
928 /**< Port vmdq RX configuration. */
929 } rx_adv_conf; /**< Port RX filtering configuration. */
931 struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
932 /**< Port vmdq+dcb TX configuration. */
933 struct rte_eth_dcb_tx_conf dcb_tx_conf;
934 /**< Port dcb TX configuration. */
935 struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
936 /**< Port vmdq TX configuration. */
937 } tx_adv_conf; /**< Port TX DCB configuration (union). */
938 /** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
939 is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
940 uint32_t dcb_capability_en;
941 struct rte_fdir_conf fdir_conf; /**< FDIR configuration. */
942 struct rte_intr_conf intr_conf; /**< Interrupt mode configuration. */
946 * A structure used to retrieve the contextual information of
947 * an Ethernet device, such as the controlling driver of the device,
948 * its PCI context, etc...
952 * RX offload capabilities of a device.
954 #define DEV_RX_OFFLOAD_VLAN_STRIP 0x00000001
955 #define DEV_RX_OFFLOAD_IPV4_CKSUM 0x00000002
956 #define DEV_RX_OFFLOAD_UDP_CKSUM 0x00000004
957 #define DEV_RX_OFFLOAD_TCP_CKSUM 0x00000008
958 #define DEV_RX_OFFLOAD_TCP_LRO 0x00000010
959 #define DEV_RX_OFFLOAD_QINQ_STRIP 0x00000020
960 #define DEV_RX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000040
961 #define DEV_RX_OFFLOAD_MACSEC_STRIP 0x00000080
962 #define DEV_RX_OFFLOAD_HEADER_SPLIT 0x00000100
963 #define DEV_RX_OFFLOAD_VLAN_FILTER 0x00000200
964 #define DEV_RX_OFFLOAD_VLAN_EXTEND 0x00000400
965 #define DEV_RX_OFFLOAD_JUMBO_FRAME 0x00000800
966 #define DEV_RX_OFFLOAD_CRC_STRIP 0x00001000
967 #define DEV_RX_OFFLOAD_SCATTER 0x00002000
968 #define DEV_RX_OFFLOAD_TIMESTAMP 0x00004000
969 #define DEV_RX_OFFLOAD_SECURITY 0x00008000
970 #define DEV_RX_OFFLOAD_CHECKSUM (DEV_RX_OFFLOAD_IPV4_CKSUM | \
971 DEV_RX_OFFLOAD_UDP_CKSUM | \
972 DEV_RX_OFFLOAD_TCP_CKSUM)
973 #define DEV_RX_OFFLOAD_VLAN (DEV_RX_OFFLOAD_VLAN_STRIP | \
974 DEV_RX_OFFLOAD_VLAN_FILTER | \
975 DEV_RX_OFFLOAD_VLAN_EXTEND)
978 * TX offload capabilities of a device.
980 #define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001
981 #define DEV_TX_OFFLOAD_IPV4_CKSUM 0x00000002
982 #define DEV_TX_OFFLOAD_UDP_CKSUM 0x00000004
983 #define DEV_TX_OFFLOAD_TCP_CKSUM 0x00000008
984 #define DEV_TX_OFFLOAD_SCTP_CKSUM 0x00000010
985 #define DEV_TX_OFFLOAD_TCP_TSO 0x00000020
986 #define DEV_TX_OFFLOAD_UDP_TSO 0x00000040
987 #define DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000080 /**< Used for tunneling packet. */
988 #define DEV_TX_OFFLOAD_QINQ_INSERT 0x00000100
989 #define DEV_TX_OFFLOAD_VXLAN_TNL_TSO 0x00000200 /**< Used for tunneling packet. */
990 #define DEV_TX_OFFLOAD_GRE_TNL_TSO 0x00000400 /**< Used for tunneling packet. */
991 #define DEV_TX_OFFLOAD_IPIP_TNL_TSO 0x00000800 /**< Used for tunneling packet. */
992 #define DEV_TX_OFFLOAD_GENEVE_TNL_TSO 0x00001000 /**< Used for tunneling packet. */
993 #define DEV_TX_OFFLOAD_MACSEC_INSERT 0x00002000
994 #define DEV_TX_OFFLOAD_MT_LOCKFREE 0x00004000
995 /**< Multiple threads can invoke rte_eth_tx_burst() concurrently on the same
996 * tx queue without SW lock.
998 #define DEV_TX_OFFLOAD_MULTI_SEGS 0x00008000
999 /**< Device supports multi segment send. */
1000 #define DEV_TX_OFFLOAD_MBUF_FAST_FREE 0x00010000
1001 /**< Device supports optimization for fast release of mbufs.
1002 * When set application must guarantee that per-queue all mbufs comes from
1003 * the same mempool and has refcnt = 1.
1005 #define DEV_TX_OFFLOAD_SECURITY 0x00020000
1007 struct rte_pci_device;
1010 * Ethernet device information
1012 struct rte_eth_dev_info {
1013 struct rte_pci_device *pci_dev; /**< Device PCI information. */
1014 const char *driver_name; /**< Device Driver name. */
1015 unsigned int if_index; /**< Index to bound host interface, or 0 if none.
1016 Use if_indextoname() to translate into an interface name. */
1017 uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
1018 uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
1019 uint16_t max_rx_queues; /**< Maximum number of RX queues. */
1020 uint16_t max_tx_queues; /**< Maximum number of TX queues. */
1021 uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
1022 uint32_t max_hash_mac_addrs;
1023 /** Maximum number of hash MAC addresses for MTA and UTA. */
1024 uint16_t max_vfs; /**< Maximum number of VFs. */
1025 uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
1026 uint64_t rx_offload_capa;
1027 /**< Device per port RX offload capabilities. */
1028 uint64_t tx_offload_capa;
1029 /**< Device per port TX offload capabilities. */
1030 uint64_t rx_queue_offload_capa;
1031 /**< Device per queue RX offload capabilities. */
1032 uint64_t tx_queue_offload_capa;
1033 /**< Device per queue TX offload capabilities. */
1035 /**< Device redirection table size, the total number of entries. */
1036 uint8_t hash_key_size; /**< Hash key size in bytes */
1037 /** Bit mask of RSS offloads, the bit offset also means flow type */
1038 uint64_t flow_type_rss_offloads;
1039 struct rte_eth_rxconf default_rxconf; /**< Default RX configuration */
1040 struct rte_eth_txconf default_txconf; /**< Default TX configuration */
1041 uint16_t vmdq_queue_base; /**< First queue ID for VMDQ pools. */
1042 uint16_t vmdq_queue_num; /**< Queue number for VMDQ pools. */
1043 uint16_t vmdq_pool_base; /**< First ID of VMDQ pools. */
1044 struct rte_eth_desc_lim rx_desc_lim; /**< RX descriptors limits */
1045 struct rte_eth_desc_lim tx_desc_lim; /**< TX descriptors limits */
1046 uint32_t speed_capa; /**< Supported speeds bitmap (ETH_LINK_SPEED_). */
1047 /** Configured number of rx/tx queues */
1048 uint16_t nb_rx_queues; /**< Number of RX queues. */
1049 uint16_t nb_tx_queues; /**< Number of TX queues. */
1053 * Ethernet device RX queue information structure.
1054 * Used to retieve information about configured queue.
1056 struct rte_eth_rxq_info {
1057 struct rte_mempool *mp; /**< mempool used by that queue. */
1058 struct rte_eth_rxconf conf; /**< queue config parameters. */
1059 uint8_t scattered_rx; /**< scattered packets RX supported. */
1060 uint16_t nb_desc; /**< configured number of RXDs. */
1061 } __rte_cache_min_aligned;
1064 * Ethernet device TX queue information structure.
1065 * Used to retrieve information about configured queue.
1067 struct rte_eth_txq_info {
1068 struct rte_eth_txconf conf; /**< queue config parameters. */
1069 uint16_t nb_desc; /**< configured number of TXDs. */
1070 } __rte_cache_min_aligned;
1072 /** Maximum name length for extended statistics counters */
1073 #define RTE_ETH_XSTATS_NAME_SIZE 64
1076 * An Ethernet device extended statistic structure
1078 * This structure is used by rte_eth_xstats_get() to provide
1079 * statistics that are not provided in the generic *rte_eth_stats*
1081 * It maps a name id, corresponding to an index in the array returned
1082 * by rte_eth_xstats_get_names(), to a statistic value.
1084 struct rte_eth_xstat {
1085 uint64_t id; /**< The index in xstats name array. */
1086 uint64_t value; /**< The statistic counter value. */
1090 * A name element for extended statistics.
1092 * An array of this structure is returned by rte_eth_xstats_get_names().
1093 * It lists the names of extended statistics for a PMD. The *rte_eth_xstat*
1094 * structure references these names by their array index.
1096 struct rte_eth_xstat_name {
1097 char name[RTE_ETH_XSTATS_NAME_SIZE]; /**< The statistic name. */
1100 #define ETH_DCB_NUM_TCS 8
1101 #define ETH_MAX_VMDQ_POOL 64
1104 * A structure used to get the information of queue and
1105 * TC mapping on both TX and RX paths.
1107 struct rte_eth_dcb_tc_queue_mapping {
1108 /** rx queues assigned to tc per Pool */
1112 } tc_rxq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
1113 /** rx queues assigned to tc per Pool */
1117 } tc_txq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
1121 * A structure used to get the information of DCB.
1122 * It includes TC UP mapping and queue TC mapping.
1124 struct rte_eth_dcb_info {
1125 uint8_t nb_tcs; /**< number of TCs */
1126 uint8_t prio_tc[ETH_DCB_NUM_USER_PRIORITIES]; /**< Priority to tc */
1127 uint8_t tc_bws[ETH_DCB_NUM_TCS]; /**< TX BW percentage for each TC */
1128 /** rx queues assigned to tc */
1129 struct rte_eth_dcb_tc_queue_mapping tc_queue;
1133 * RX/TX queue states
1135 #define RTE_ETH_QUEUE_STATE_STOPPED 0
1136 #define RTE_ETH_QUEUE_STATE_STARTED 1
1140 struct rte_eth_dev_callback;
1141 /** @internal Structure to keep track of registered callbacks */
1142 TAILQ_HEAD(rte_eth_dev_cb_list, rte_eth_dev_callback);
1144 /* Macros to check for valid port */
1145 #define RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, retval) do { \
1146 if (!rte_eth_dev_is_valid_port(port_id)) { \
1147 RTE_PMD_DEBUG_TRACE("Invalid port_id=%d\n", port_id); \
1152 #define RTE_ETH_VALID_PORTID_OR_RET(port_id) do { \
1153 if (!rte_eth_dev_is_valid_port(port_id)) { \
1154 RTE_PMD_DEBUG_TRACE("Invalid port_id=%d\n", port_id); \
1160 * l2 tunnel configuration.
1163 /**< l2 tunnel enable mask */
1164 #define ETH_L2_TUNNEL_ENABLE_MASK 0x00000001
1165 /**< l2 tunnel insertion mask */
1166 #define ETH_L2_TUNNEL_INSERTION_MASK 0x00000002
1167 /**< l2 tunnel stripping mask */
1168 #define ETH_L2_TUNNEL_STRIPPING_MASK 0x00000004
1169 /**< l2 tunnel forwarding mask */
1170 #define ETH_L2_TUNNEL_FORWARDING_MASK 0x00000008
1173 * Definitions of all functions exported by an Ethernet driver through the
1174 * the generic structure of type *eth_dev_ops* supplied in the *rte_eth_dev*
1175 * structure associated with an Ethernet device.
1178 typedef int (*eth_dev_configure_t)(struct rte_eth_dev *dev);
1179 /**< @internal Ethernet device configuration. */
1181 typedef int (*eth_dev_start_t)(struct rte_eth_dev *dev);
1182 /**< @internal Function used to start a configured Ethernet device. */
1184 typedef void (*eth_dev_stop_t)(struct rte_eth_dev *dev);
1185 /**< @internal Function used to stop a configured Ethernet device. */
1187 typedef int (*eth_dev_set_link_up_t)(struct rte_eth_dev *dev);
1188 /**< @internal Function used to link up a configured Ethernet device. */
1190 typedef int (*eth_dev_set_link_down_t)(struct rte_eth_dev *dev);
1191 /**< @internal Function used to link down a configured Ethernet device. */
1193 typedef void (*eth_dev_close_t)(struct rte_eth_dev *dev);
1194 /**< @internal Function used to close a configured Ethernet device. */
1196 typedef int (*eth_dev_reset_t)(struct rte_eth_dev *dev);
1197 /** <@internal Function used to reset a configured Ethernet device. */
1199 typedef void (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev);
1200 /**< @internal Function used to enable the RX promiscuous mode of an Ethernet device. */
1202 typedef void (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev);
1203 /**< @internal Function used to disable the RX promiscuous mode of an Ethernet device. */
1205 typedef void (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
1206 /**< @internal Enable the receipt of all multicast packets by an Ethernet device. */
1208 typedef void (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
1209 /**< @internal Disable the receipt of all multicast packets by an Ethernet device. */
1211 typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
1212 int wait_to_complete);
1213 /**< @internal Get link speed, duplex mode and state (up/down) of an Ethernet device. */
1215 typedef int (*eth_stats_get_t)(struct rte_eth_dev *dev,
1216 struct rte_eth_stats *igb_stats);
1217 /**< @internal Get global I/O statistics of an Ethernet device. */
1219 typedef void (*eth_stats_reset_t)(struct rte_eth_dev *dev);
1220 /**< @internal Reset global I/O statistics of an Ethernet device to 0. */
1222 typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev,
1223 struct rte_eth_xstat *stats, unsigned n);
1224 /**< @internal Get extended stats of an Ethernet device. */
1226 typedef int (*eth_xstats_get_by_id_t)(struct rte_eth_dev *dev,
1227 const uint64_t *ids,
1230 /**< @internal Get extended stats of an Ethernet device. */
1232 typedef void (*eth_xstats_reset_t)(struct rte_eth_dev *dev);
1233 /**< @internal Reset extended stats of an Ethernet device. */
1235 typedef int (*eth_xstats_get_names_t)(struct rte_eth_dev *dev,
1236 struct rte_eth_xstat_name *xstats_names, unsigned size);
1237 /**< @internal Get names of extended stats of an Ethernet device. */
1239 typedef int (*eth_xstats_get_names_by_id_t)(struct rte_eth_dev *dev,
1240 struct rte_eth_xstat_name *xstats_names, const uint64_t *ids,
1242 /**< @internal Get names of extended stats of an Ethernet device. */
1244 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
1248 /**< @internal Set a queue statistics mapping for a tx/rx queue of an Ethernet device. */
1250 typedef void (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
1251 struct rte_eth_dev_info *dev_info);
1252 /**< @internal Get specific informations of an Ethernet device. */
1254 typedef const uint32_t *(*eth_dev_supported_ptypes_get_t)(struct rte_eth_dev *dev);
1255 /**< @internal Get supported ptypes of an Ethernet device. */
1257 typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
1259 /**< @internal Start rx and tx of a queue of an Ethernet device. */
1261 typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
1263 /**< @internal Stop rx and tx of a queue of an Ethernet device. */
1265 typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
1266 uint16_t rx_queue_id,
1267 uint16_t nb_rx_desc,
1268 unsigned int socket_id,
1269 const struct rte_eth_rxconf *rx_conf,
1270 struct rte_mempool *mb_pool);
1271 /**< @internal Set up a receive queue of an Ethernet device. */
1273 typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
1274 uint16_t tx_queue_id,
1275 uint16_t nb_tx_desc,
1276 unsigned int socket_id,
1277 const struct rte_eth_txconf *tx_conf);
1278 /**< @internal Setup a transmit queue of an Ethernet device. */
1280 typedef int (*eth_rx_enable_intr_t)(struct rte_eth_dev *dev,
1281 uint16_t rx_queue_id);
1282 /**< @internal Enable interrupt of a receive queue of an Ethernet device. */
1284 typedef int (*eth_rx_disable_intr_t)(struct rte_eth_dev *dev,
1285 uint16_t rx_queue_id);
1286 /**< @internal Disable interrupt of a receive queue of an Ethernet device. */
1288 typedef void (*eth_queue_release_t)(void *queue);
1289 /**< @internal Release memory resources allocated by given RX/TX queue. */
1291 typedef uint32_t (*eth_rx_queue_count_t)(struct rte_eth_dev *dev,
1292 uint16_t rx_queue_id);
1293 /**< @internal Get number of used descriptors on a receive queue. */
1295 typedef int (*eth_rx_descriptor_done_t)(void *rxq, uint16_t offset);
1296 /**< @internal Check DD bit of specific RX descriptor */
1298 typedef int (*eth_rx_descriptor_status_t)(void *rxq, uint16_t offset);
1299 /**< @internal Check the status of a Rx descriptor */
1301 typedef int (*eth_tx_descriptor_status_t)(void *txq, uint16_t offset);
1302 /**< @internal Check the status of a Tx descriptor */
1304 typedef int (*eth_fw_version_get_t)(struct rte_eth_dev *dev,
1305 char *fw_version, size_t fw_size);
1306 /**< @internal Get firmware information of an Ethernet device. */
1308 typedef int (*eth_tx_done_cleanup_t)(void *txq, uint32_t free_cnt);
1309 /**< @internal Force mbufs to be from TX ring. */
1311 typedef void (*eth_rxq_info_get_t)(struct rte_eth_dev *dev,
1312 uint16_t rx_queue_id, struct rte_eth_rxq_info *qinfo);
1314 typedef void (*eth_txq_info_get_t)(struct rte_eth_dev *dev,
1315 uint16_t tx_queue_id, struct rte_eth_txq_info *qinfo);
1317 typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);
1318 /**< @internal Set MTU. */
1320 typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
1323 /**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */
1325 typedef int (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
1326 enum rte_vlan_type type, uint16_t tpid);
1327 /**< @internal set the outer/inner VLAN-TPID by an Ethernet device. */
1329 typedef int (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
1330 /**< @internal set VLAN offload function by an Ethernet device. */
1332 typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
1335 /**< @internal set port based TX VLAN insertion by an Ethernet device. */
1337 typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
1338 uint16_t rx_queue_id,
1340 /**< @internal VLAN stripping enable/disable by an queue of Ethernet device. */
1342 typedef uint16_t (*eth_rx_burst_t)(void *rxq,
1343 struct rte_mbuf **rx_pkts,
1345 /**< @internal Retrieve input packets from a receive queue of an Ethernet device. */
1347 typedef uint16_t (*eth_tx_burst_t)(void *txq,
1348 struct rte_mbuf **tx_pkts,
1350 /**< @internal Send output packets on a transmit queue of an Ethernet device. */
1352 typedef uint16_t (*eth_tx_prep_t)(void *txq,
1353 struct rte_mbuf **tx_pkts,
1355 /**< @internal Prepare output packets on a transmit queue of an Ethernet device. */
1357 typedef int (*flow_ctrl_get_t)(struct rte_eth_dev *dev,
1358 struct rte_eth_fc_conf *fc_conf);
1359 /**< @internal Get current flow control parameter on an Ethernet device */
1361 typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
1362 struct rte_eth_fc_conf *fc_conf);
1363 /**< @internal Setup flow control parameter on an Ethernet device */
1365 typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
1366 struct rte_eth_pfc_conf *pfc_conf);
1367 /**< @internal Setup priority flow control parameter on an Ethernet device */
1369 typedef int (*reta_update_t)(struct rte_eth_dev *dev,
1370 struct rte_eth_rss_reta_entry64 *reta_conf,
1371 uint16_t reta_size);
1372 /**< @internal Update RSS redirection table on an Ethernet device */
1374 typedef int (*reta_query_t)(struct rte_eth_dev *dev,
1375 struct rte_eth_rss_reta_entry64 *reta_conf,
1376 uint16_t reta_size);
1377 /**< @internal Query RSS redirection table on an Ethernet device */
1379 typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
1380 struct rte_eth_rss_conf *rss_conf);
1381 /**< @internal Update RSS hash configuration of an Ethernet device */
1383 typedef int (*rss_hash_conf_get_t)(struct rte_eth_dev *dev,
1384 struct rte_eth_rss_conf *rss_conf);
1385 /**< @internal Get current RSS hash configuration of an Ethernet device */
1387 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
1388 /**< @internal Turn on SW controllable LED on an Ethernet device */
1390 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
1391 /**< @internal Turn off SW controllable LED on an Ethernet device */
1393 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
1394 /**< @internal Remove MAC address from receive address register */
1396 typedef int (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
1397 struct ether_addr *mac_addr,
1400 /**< @internal Set a MAC address into Receive Address Address Register */
1402 typedef void (*eth_mac_addr_set_t)(struct rte_eth_dev *dev,
1403 struct ether_addr *mac_addr);
1404 /**< @internal Set a MAC address into Receive Address Address Register */
1406 typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
1407 struct ether_addr *mac_addr,
1409 /**< @internal Set a Unicast Hash bitmap */
1411 typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
1413 /**< @internal Set all Unicast Hash bitmap */
1415 typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
1418 /**< @internal Set queue TX rate */
1420 typedef int (*eth_mirror_rule_set_t)(struct rte_eth_dev *dev,
1421 struct rte_eth_mirror_conf *mirror_conf,
1424 /**< @internal Add a traffic mirroring rule on an Ethernet device */
1426 typedef int (*eth_mirror_rule_reset_t)(struct rte_eth_dev *dev,
1428 /**< @internal Remove a traffic mirroring rule on an Ethernet device */
1430 typedef int (*eth_udp_tunnel_port_add_t)(struct rte_eth_dev *dev,
1431 struct rte_eth_udp_tunnel *tunnel_udp);
1432 /**< @internal Add tunneling UDP port */
1434 typedef int (*eth_udp_tunnel_port_del_t)(struct rte_eth_dev *dev,
1435 struct rte_eth_udp_tunnel *tunnel_udp);
1436 /**< @internal Delete tunneling UDP port */
1438 typedef int (*eth_set_mc_addr_list_t)(struct rte_eth_dev *dev,
1439 struct ether_addr *mc_addr_set,
1440 uint32_t nb_mc_addr);
1441 /**< @internal set the list of multicast addresses on an Ethernet device */
1443 typedef int (*eth_timesync_enable_t)(struct rte_eth_dev *dev);
1444 /**< @internal Function used to enable IEEE1588/802.1AS timestamping. */
1446 typedef int (*eth_timesync_disable_t)(struct rte_eth_dev *dev);
1447 /**< @internal Function used to disable IEEE1588/802.1AS timestamping. */
1449 typedef int (*eth_timesync_read_rx_timestamp_t)(struct rte_eth_dev *dev,
1450 struct timespec *timestamp,
1452 /**< @internal Function used to read an RX IEEE1588/802.1AS timestamp. */
1454 typedef int (*eth_timesync_read_tx_timestamp_t)(struct rte_eth_dev *dev,
1455 struct timespec *timestamp);
1456 /**< @internal Function used to read a TX IEEE1588/802.1AS timestamp. */
1458 typedef int (*eth_timesync_adjust_time)(struct rte_eth_dev *dev, int64_t);
1459 /**< @internal Function used to adjust the device clock */
1461 typedef int (*eth_timesync_read_time)(struct rte_eth_dev *dev,
1462 struct timespec *timestamp);
1463 /**< @internal Function used to get time from the device clock. */
1465 typedef int (*eth_timesync_write_time)(struct rte_eth_dev *dev,
1466 const struct timespec *timestamp);
1467 /**< @internal Function used to get time from the device clock */
1469 typedef int (*eth_get_reg_t)(struct rte_eth_dev *dev,
1470 struct rte_dev_reg_info *info);
1471 /**< @internal Retrieve registers */
1473 typedef int (*eth_get_eeprom_length_t)(struct rte_eth_dev *dev);
1474 /**< @internal Retrieve eeprom size */
1476 typedef int (*eth_get_eeprom_t)(struct rte_eth_dev *dev,
1477 struct rte_dev_eeprom_info *info);
1478 /**< @internal Retrieve eeprom data */
1480 typedef int (*eth_set_eeprom_t)(struct rte_eth_dev *dev,
1481 struct rte_dev_eeprom_info *info);
1482 /**< @internal Program eeprom data */
1484 typedef int (*eth_l2_tunnel_eth_type_conf_t)
1485 (struct rte_eth_dev *dev, struct rte_eth_l2_tunnel_conf *l2_tunnel);
1486 /**< @internal config l2 tunnel ether type */
1488 typedef int (*eth_l2_tunnel_offload_set_t)
1489 (struct rte_eth_dev *dev,
1490 struct rte_eth_l2_tunnel_conf *l2_tunnel,
1493 /**< @internal enable/disable the l2 tunnel offload functions */
1496 typedef int (*eth_filter_ctrl_t)(struct rte_eth_dev *dev,
1497 enum rte_filter_type filter_type,
1498 enum rte_filter_op filter_op,
1500 /**< @internal Take operations to assigned filter type on an Ethernet device */
1502 typedef int (*eth_tm_ops_get_t)(struct rte_eth_dev *dev, void *ops);
1503 /**< @internal Get Traffic Management (TM) operations on an Ethernet device */
1505 typedef int (*eth_mtr_ops_get_t)(struct rte_eth_dev *dev, void *ops);
1506 /**< @internal Get Trafffic Metering and Policing (MTR) operations */
1508 typedef int (*eth_get_dcb_info)(struct rte_eth_dev *dev,
1509 struct rte_eth_dcb_info *dcb_info);
1510 /**< @internal Get dcb information on an Ethernet device */
1512 typedef int (*eth_pool_ops_supported_t)(struct rte_eth_dev *dev,
1514 /**< @internal Test if a port supports specific mempool ops */
1517 * @internal A structure containing the functions exported by an Ethernet driver.
1519 struct eth_dev_ops {
1520 eth_dev_configure_t dev_configure; /**< Configure device. */
1521 eth_dev_start_t dev_start; /**< Start device. */
1522 eth_dev_stop_t dev_stop; /**< Stop device. */
1523 eth_dev_set_link_up_t dev_set_link_up; /**< Device link up. */
1524 eth_dev_set_link_down_t dev_set_link_down; /**< Device link down. */
1525 eth_dev_close_t dev_close; /**< Close device. */
1526 eth_dev_reset_t dev_reset; /**< Reset device. */
1527 eth_link_update_t link_update; /**< Get device link state. */
1529 eth_promiscuous_enable_t promiscuous_enable; /**< Promiscuous ON. */
1530 eth_promiscuous_disable_t promiscuous_disable;/**< Promiscuous OFF. */
1531 eth_allmulticast_enable_t allmulticast_enable;/**< RX multicast ON. */
1532 eth_allmulticast_disable_t allmulticast_disable;/**< RX multicast OFF. */
1533 eth_mac_addr_remove_t mac_addr_remove; /**< Remove MAC address. */
1534 eth_mac_addr_add_t mac_addr_add; /**< Add a MAC address. */
1535 eth_mac_addr_set_t mac_addr_set; /**< Set a MAC address. */
1536 eth_set_mc_addr_list_t set_mc_addr_list; /**< set list of mcast addrs. */
1537 mtu_set_t mtu_set; /**< Set MTU. */
1539 eth_stats_get_t stats_get; /**< Get generic device statistics. */
1540 eth_stats_reset_t stats_reset; /**< Reset generic device statistics. */
1541 eth_xstats_get_t xstats_get; /**< Get extended device statistics. */
1542 eth_xstats_reset_t xstats_reset; /**< Reset extended device statistics. */
1543 eth_xstats_get_names_t xstats_get_names;
1544 /**< Get names of extended statistics. */
1545 eth_queue_stats_mapping_set_t queue_stats_mapping_set;
1546 /**< Configure per queue stat counter mapping. */
1548 eth_dev_infos_get_t dev_infos_get; /**< Get device info. */
1549 eth_rxq_info_get_t rxq_info_get; /**< retrieve RX queue information. */
1550 eth_txq_info_get_t txq_info_get; /**< retrieve TX queue information. */
1551 eth_fw_version_get_t fw_version_get; /**< Get firmware version. */
1552 eth_dev_supported_ptypes_get_t dev_supported_ptypes_get;
1553 /**< Get packet types supported and identified by device. */
1555 vlan_filter_set_t vlan_filter_set; /**< Filter VLAN Setup. */
1556 vlan_tpid_set_t vlan_tpid_set; /**< Outer/Inner VLAN TPID Setup. */
1557 vlan_strip_queue_set_t vlan_strip_queue_set; /**< VLAN Stripping on queue. */
1558 vlan_offload_set_t vlan_offload_set; /**< Set VLAN Offload. */
1559 vlan_pvid_set_t vlan_pvid_set; /**< Set port based TX VLAN insertion. */
1561 eth_queue_start_t rx_queue_start;/**< Start RX for a queue. */
1562 eth_queue_stop_t rx_queue_stop; /**< Stop RX for a queue. */
1563 eth_queue_start_t tx_queue_start;/**< Start TX for a queue. */
1564 eth_queue_stop_t tx_queue_stop; /**< Stop TX for a queue. */
1565 eth_rx_queue_setup_t rx_queue_setup;/**< Set up device RX queue. */
1566 eth_queue_release_t rx_queue_release; /**< Release RX queue. */
1567 eth_rx_queue_count_t rx_queue_count;
1568 /**< Get the number of used RX descriptors. */
1569 eth_rx_descriptor_done_t rx_descriptor_done; /**< Check rxd DD bit. */
1570 eth_rx_descriptor_status_t rx_descriptor_status;
1571 /**< Check the status of a Rx descriptor. */
1572 eth_tx_descriptor_status_t tx_descriptor_status;
1573 /**< Check the status of a Tx descriptor. */
1574 eth_rx_enable_intr_t rx_queue_intr_enable; /**< Enable Rx queue interrupt. */
1575 eth_rx_disable_intr_t rx_queue_intr_disable; /**< Disable Rx queue interrupt. */
1576 eth_tx_queue_setup_t tx_queue_setup;/**< Set up device TX queue. */
1577 eth_queue_release_t tx_queue_release; /**< Release TX queue. */
1578 eth_tx_done_cleanup_t tx_done_cleanup;/**< Free tx ring mbufs */
1580 eth_dev_led_on_t dev_led_on; /**< Turn on LED. */
1581 eth_dev_led_off_t dev_led_off; /**< Turn off LED. */
1583 flow_ctrl_get_t flow_ctrl_get; /**< Get flow control. */
1584 flow_ctrl_set_t flow_ctrl_set; /**< Setup flow control. */
1585 priority_flow_ctrl_set_t priority_flow_ctrl_set; /**< Setup priority flow control. */
1587 eth_uc_hash_table_set_t uc_hash_table_set; /**< Set Unicast Table Array. */
1588 eth_uc_all_hash_table_set_t uc_all_hash_table_set; /**< Set Unicast hash bitmap. */
1590 eth_mirror_rule_set_t mirror_rule_set; /**< Add a traffic mirror rule. */
1591 eth_mirror_rule_reset_t mirror_rule_reset; /**< reset a traffic mirror rule. */
1593 eth_udp_tunnel_port_add_t udp_tunnel_port_add; /** Add UDP tunnel port. */
1594 eth_udp_tunnel_port_del_t udp_tunnel_port_del; /** Del UDP tunnel port. */
1595 eth_l2_tunnel_eth_type_conf_t l2_tunnel_eth_type_conf;
1596 /** Config ether type of l2 tunnel. */
1597 eth_l2_tunnel_offload_set_t l2_tunnel_offload_set;
1598 /** Enable/disable l2 tunnel offload functions. */
1600 eth_set_queue_rate_limit_t set_queue_rate_limit; /**< Set queue rate limit. */
1602 rss_hash_update_t rss_hash_update; /** Configure RSS hash protocols. */
1603 rss_hash_conf_get_t rss_hash_conf_get; /** Get current RSS hash configuration. */
1604 reta_update_t reta_update; /** Update redirection table. */
1605 reta_query_t reta_query; /** Query redirection table. */
1607 eth_get_reg_t get_reg; /**< Get registers. */
1608 eth_get_eeprom_length_t get_eeprom_length; /**< Get eeprom length. */
1609 eth_get_eeprom_t get_eeprom; /**< Get eeprom data. */
1610 eth_set_eeprom_t set_eeprom; /**< Set eeprom. */
1613 eth_filter_ctrl_t filter_ctrl; /**< common filter control. */
1615 eth_get_dcb_info get_dcb_info; /** Get DCB information. */
1617 eth_timesync_enable_t timesync_enable;
1618 /** Turn IEEE1588/802.1AS timestamping on. */
1619 eth_timesync_disable_t timesync_disable;
1620 /** Turn IEEE1588/802.1AS timestamping off. */
1621 eth_timesync_read_rx_timestamp_t timesync_read_rx_timestamp;
1622 /** Read the IEEE1588/802.1AS RX timestamp. */
1623 eth_timesync_read_tx_timestamp_t timesync_read_tx_timestamp;
1624 /** Read the IEEE1588/802.1AS TX timestamp. */
1625 eth_timesync_adjust_time timesync_adjust_time; /** Adjust the device clock. */
1626 eth_timesync_read_time timesync_read_time; /** Get the device clock time. */
1627 eth_timesync_write_time timesync_write_time; /** Set the device clock time. */
1629 eth_xstats_get_by_id_t xstats_get_by_id;
1630 /**< Get extended device statistic values by ID. */
1631 eth_xstats_get_names_by_id_t xstats_get_names_by_id;
1632 /**< Get name of extended device statistics by ID. */
1634 eth_tm_ops_get_t tm_ops_get;
1635 /**< Get Traffic Management (TM) operations. */
1637 eth_mtr_ops_get_t mtr_ops_get;
1638 /**< Get Traffic Metering and Policing (MTR) operations. */
1640 eth_pool_ops_supported_t pool_ops_supported;
1641 /**< Test if a port supports specific mempool ops */
1645 * Function type used for RX packet processing packet callbacks.
1647 * The callback function is called on RX with a burst of packets that have
1648 * been received on the given port and queue.
1651 * The Ethernet port on which RX is being performed.
1653 * The queue on the Ethernet port which is being used to receive the packets.
1655 * The burst of packets that have just been received.
1657 * The number of packets in the burst pointed to by "pkts".
1659 * The max number of packets that can be stored in the "pkts" array.
1661 * The arbitrary user parameter passed in by the application when the callback
1662 * was originally configured.
1664 * The number of packets returned to the user.
1666 typedef uint16_t (*rte_rx_callback_fn)(uint16_t port, uint16_t queue,
1667 struct rte_mbuf *pkts[], uint16_t nb_pkts, uint16_t max_pkts,
1671 * Function type used for TX packet processing packet callbacks.
1673 * The callback function is called on TX with a burst of packets immediately
1674 * before the packets are put onto the hardware queue for transmission.
1677 * The Ethernet port on which TX is being performed.
1679 * The queue on the Ethernet port which is being used to transmit the packets.
1681 * The burst of packets that are about to be transmitted.
1683 * The number of packets in the burst pointed to by "pkts".
1685 * The arbitrary user parameter passed in by the application when the callback
1686 * was originally configured.
1688 * The number of packets to be written to the NIC.
1690 typedef uint16_t (*rte_tx_callback_fn)(uint16_t port, uint16_t queue,
1691 struct rte_mbuf *pkts[], uint16_t nb_pkts, void *user_param);
1695 * Structure used to hold information about the callbacks to be called for a
1696 * queue on RX and TX.
1698 struct rte_eth_rxtx_callback {
1699 struct rte_eth_rxtx_callback *next;
1701 rte_rx_callback_fn rx;
1702 rte_tx_callback_fn tx;
1708 * A set of values to describe the possible states of an eth device.
1710 enum rte_eth_dev_state {
1711 RTE_ETH_DEV_UNUSED = 0,
1712 RTE_ETH_DEV_ATTACHED,
1713 RTE_ETH_DEV_DEFERRED,
1718 * The generic data structure associated with each ethernet device.
1720 * Pointers to burst-oriented packet receive and transmit functions are
1721 * located at the beginning of the structure, along with the pointer to
1722 * where all the data elements for the particular device are stored in shared
1723 * memory. This split allows the function pointer and driver data to be per-
1724 * process, while the actual configuration data for the device is shared.
1726 struct rte_eth_dev {
1727 eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
1728 eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
1729 eth_tx_prep_t tx_pkt_prepare; /**< Pointer to PMD transmit prepare function. */
1730 struct rte_eth_dev_data *data; /**< Pointer to device data */
1731 const struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
1732 struct rte_device *device; /**< Backing device */
1733 struct rte_intr_handle *intr_handle; /**< Device interrupt handle */
1734 /** User application callbacks for NIC interrupts */
1735 struct rte_eth_dev_cb_list link_intr_cbs;
1737 * User-supplied functions called from rx_burst to post-process
1738 * received packets before passing them to the user
1740 struct rte_eth_rxtx_callback *post_rx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
1742 * User-supplied functions called from tx_burst to pre-process
1743 * received packets before passing them to the driver for transmission.
1745 struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
1746 enum rte_eth_dev_state state; /**< Flag indicating the port state */
1747 void *security_ctx; /**< Context for security ops */
1748 } __rte_cache_aligned;
1751 rte_eth_dev_get_sec_ctx(uint8_t port_id);
1753 struct rte_eth_dev_sriov {
1754 uint8_t active; /**< SRIOV is active with 16, 32 or 64 pools */
1755 uint8_t nb_q_per_pool; /**< rx queue number per pool */
1756 uint16_t def_vmdq_idx; /**< Default pool num used for PF */
1757 uint16_t def_pool_q_idx; /**< Default pool queue start reg index */
1759 #define RTE_ETH_DEV_SRIOV(dev) ((dev)->data->sriov)
1761 #define RTE_ETH_NAME_MAX_LEN RTE_DEV_NAME_MAX_LEN
1765 * The data part, with no function pointers, associated with each ethernet device.
1767 * This structure is safe to place in shared memory to be common among different
1768 * processes in a multi-process configuration.
1770 struct rte_eth_dev_data {
1771 char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
1773 void **rx_queues; /**< Array of pointers to RX queues. */
1774 void **tx_queues; /**< Array of pointers to TX queues. */
1775 uint16_t nb_rx_queues; /**< Number of RX queues. */
1776 uint16_t nb_tx_queues; /**< Number of TX queues. */
1778 struct rte_eth_dev_sriov sriov; /**< SRIOV data */
1780 void *dev_private; /**< PMD-specific private data */
1782 struct rte_eth_link dev_link;
1783 /**< Link-level information & status */
1785 struct rte_eth_conf dev_conf; /**< Configuration applied to device. */
1786 uint16_t mtu; /**< Maximum Transmission Unit. */
1788 uint32_t min_rx_buf_size;
1789 /**< Common rx buffer size handled by all queues */
1791 uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
1792 struct ether_addr* mac_addrs;/**< Device Ethernet Link address. */
1793 uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
1794 /** bitmap array of associating Ethernet MAC addresses to pools */
1795 struct ether_addr* hash_mac_addrs;
1796 /** Device Ethernet MAC addresses of hash filtering. */
1797 uint16_t port_id; /**< Device [external] port identifier. */
1799 uint8_t promiscuous : 1, /**< RX promiscuous mode ON(1) / OFF(0). */
1800 scattered_rx : 1, /**< RX of scattered packets is ON(1) / OFF(0) */
1801 all_multicast : 1, /**< RX all multicast mode ON(1) / OFF(0). */
1802 dev_started : 1, /**< Device state: STARTED(1) / STOPPED(0). */
1803 lro : 1; /**< RX LRO is ON(1) / OFF(0) */
1804 uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT];
1805 /** Queues state: STARTED(1) / STOPPED(0) */
1806 uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
1807 /** Queues state: STARTED(1) / STOPPED(0) */
1808 uint32_t dev_flags; /**< Capabilities */
1809 enum rte_kernel_driver kdrv; /**< Kernel driver passthrough */
1810 int numa_node; /**< NUMA node connection */
1811 struct rte_vlan_filter_conf vlan_filter_conf;
1812 /**< VLAN filter configuration. */
1815 /** Device supports link state interrupt */
1816 #define RTE_ETH_DEV_INTR_LSC 0x0002
1817 /** Device is a bonded slave */
1818 #define RTE_ETH_DEV_BONDED_SLAVE 0x0004
1819 /** Device supports device removal interrupt */
1820 #define RTE_ETH_DEV_INTR_RMV 0x0008
1824 * The pool of *rte_eth_dev* structures. The size of the pool
1825 * is configured at compile-time in the <rte_ethdev.c> file.
1827 extern struct rte_eth_dev rte_eth_devices[];
1830 * Iterates over valid ethdev ports.
1833 * The id of the next possible valid port.
1835 * Next valid port id, RTE_MAX_ETHPORTS if there is none.
1837 uint16_t rte_eth_find_next(uint16_t port_id);
1840 * Macro to iterate over all enabled ethdev ports.
1842 #define RTE_ETH_FOREACH_DEV(p) \
1843 for (p = rte_eth_find_next(0); \
1844 (unsigned int)p < (unsigned int)RTE_MAX_ETHPORTS; \
1845 p = rte_eth_find_next(p + 1))
1849 * Get the total number of Ethernet devices that have been successfully
1850 * initialized by the matching Ethernet driver during the PCI probing phase
1851 * and that are available for applications to use. These devices must be
1852 * accessed by using the ``RTE_ETH_FOREACH_DEV()`` macro to deal with
1853 * non-contiguous ranges of devices.
1854 * These non-contiguous ranges can be created by calls to hotplug functions or
1858 * - The total number of usable Ethernet devices.
1860 uint16_t rte_eth_dev_count(void);
1864 * Returns a ethdev slot specified by the unique identifier name.
1867 * The pointer to the Unique identifier name for each Ethernet device
1869 * - The pointer to the ethdev slot, on success. NULL on error
1871 struct rte_eth_dev *rte_eth_dev_allocated(const char *name);
1875 * Allocates a new ethdev slot for an ethernet device and returns the pointer
1876 * to that slot for the driver to use.
1878 * @param name Unique identifier name for each Ethernet device
1879 * @param type Device type of this Ethernet device
1881 * - Slot in the rte_dev_devices array for a new device;
1883 struct rte_eth_dev *rte_eth_dev_allocate(const char *name);
1887 * Attach to the ethdev already initialized by the primary
1890 * @param name Ethernet device's name.
1892 * - Success: Slot in the rte_dev_devices array for attached
1894 * - Error: Null pointer.
1896 struct rte_eth_dev *rte_eth_dev_attach_secondary(const char *name);
1900 * Release the specified ethdev port.
1903 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure.
1905 * - 0 on success, negative on error
1907 int rte_eth_dev_release_port(struct rte_eth_dev *eth_dev);
1910 * Attach a new Ethernet device specified by arguments.
1913 * A pointer to a strings array describing the new device
1914 * to be attached. The strings should be a pci address like
1915 * '0000:01:00.0' or virtual device name like 'net_pcap0'.
1917 * A pointer to a port identifier actually attached.
1919 * 0 on success and port_id is filled, negative on error
1921 int rte_eth_dev_attach(const char *devargs, uint16_t *port_id);
1924 * Detach a Ethernet device specified by port identifier.
1925 * This function must be called when the device is in the
1929 * The port identifier of the device to detach.
1931 * A pointer to a buffer that will be filled with the device name.
1932 * This buffer must be at least RTE_DEV_NAME_MAX_LEN long.
1934 * 0 on success and devname is filled, negative on error
1936 int rte_eth_dev_detach(uint16_t port_id, char *devname);
1939 * Convert a numerical speed in Mbps to a bitmap flag that can be used in
1940 * the bitmap link_speeds of the struct rte_eth_conf
1943 * Numerical speed value in Mbps
1945 * ETH_LINK_[HALF/FULL]_DUPLEX (only for 10/100M speeds)
1947 * 0 if the speed cannot be mapped
1949 uint32_t rte_eth_speed_bitflag(uint32_t speed, int duplex);
1952 * Configure an Ethernet device.
1953 * This function must be invoked first before any other function in the
1954 * Ethernet API. This function can also be re-invoked when a device is in the
1958 * The port identifier of the Ethernet device to configure.
1959 * @param nb_rx_queue
1960 * The number of receive queues to set up for the Ethernet device.
1961 * @param nb_tx_queue
1962 * The number of transmit queues to set up for the Ethernet device.
1964 * The pointer to the configuration data to be used for the Ethernet device.
1965 * The *rte_eth_conf* structure includes:
1966 * - the hardware offload features to activate, with dedicated fields for
1967 * each statically configurable offload hardware feature provided by
1968 * Ethernet devices, such as IP checksum or VLAN tag stripping for
1970 * The Rx offload bitfield API is obsolete and will be deprecated.
1971 * Applications should set the ignore_bitfield_offloads bit on *rxmode*
1972 * structure and use offloads field to set per-port offloads instead.
1973 * - the Receive Side Scaling (RSS) configuration when using multiple RX
1976 * Embedding all configuration information in a single data structure
1977 * is the more flexible method that allows the addition of new features
1978 * without changing the syntax of the API.
1980 * - 0: Success, device configured.
1981 * - <0: Error code returned by the driver configuration function.
1983 int rte_eth_dev_configure(uint16_t port_id, uint16_t nb_rx_queue,
1984 uint16_t nb_tx_queue, const struct rte_eth_conf *eth_conf);
1988 * Release device queues and clear its configuration to force the user
1989 * application to reconfigure it. It is for internal use only.
1992 * Pointer to struct rte_eth_dev.
1997 void _rte_eth_dev_reset(struct rte_eth_dev *dev);
2000 * Allocate and set up a receive queue for an Ethernet device.
2002 * The function allocates a contiguous block of memory for *nb_rx_desc*
2003 * receive descriptors from a memory zone associated with *socket_id*
2004 * and initializes each receive descriptor with a network buffer allocated
2005 * from the memory pool *mb_pool*.
2008 * The port identifier of the Ethernet device.
2009 * @param rx_queue_id
2010 * The index of the receive queue to set up.
2011 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2012 * to rte_eth_dev_configure().
2014 * The number of receive descriptors to allocate for the receive ring.
2016 * The *socket_id* argument is the socket identifier in case of NUMA.
2017 * The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
2018 * the DMA memory allocated for the receive descriptors of the ring.
2020 * The pointer to the configuration data to be used for the receive queue.
2021 * NULL value is allowed, in which case default RX configuration
2023 * The *rx_conf* structure contains an *rx_thresh* structure with the values
2024 * of the Prefetch, Host, and Write-Back threshold registers of the receive
2026 * In addition it contains the hardware offloads features to activate using
2027 * the DEV_RX_OFFLOAD_* flags.
2029 * The pointer to the memory pool from which to allocate *rte_mbuf* network
2030 * memory buffers to populate each descriptor of the receive ring.
2032 * - 0: Success, receive queue correctly set up.
2033 * - -EINVAL: The size of network buffers which can be allocated from the
2034 * memory pool does not fit the various buffer sizes allowed by the
2035 * device controller.
2036 * - -ENOMEM: Unable to allocate the receive ring descriptors or to
2037 * allocate network memory buffers from the memory pool when
2038 * initializing receive descriptors.
2040 int rte_eth_rx_queue_setup(uint16_t port_id, uint16_t rx_queue_id,
2041 uint16_t nb_rx_desc, unsigned int socket_id,
2042 const struct rte_eth_rxconf *rx_conf,
2043 struct rte_mempool *mb_pool);
2046 * Allocate and set up a transmit queue for an Ethernet device.
2049 * The port identifier of the Ethernet device.
2050 * @param tx_queue_id
2051 * The index of the transmit queue to set up.
2052 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2053 * to rte_eth_dev_configure().
2055 * The number of transmit descriptors to allocate for the transmit ring.
2057 * The *socket_id* argument is the socket identifier in case of NUMA.
2058 * Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
2059 * the DMA memory allocated for the transmit descriptors of the ring.
2061 * The pointer to the configuration data to be used for the transmit queue.
2062 * NULL value is allowed, in which case default RX configuration
2064 * The *tx_conf* structure contains the following data:
2065 * - The *tx_thresh* structure with the values of the Prefetch, Host, and
2066 * Write-Back threshold registers of the transmit ring.
2067 * When setting Write-Back threshold to the value greater then zero,
2068 * *tx_rs_thresh* value should be explicitly set to one.
2069 * - The *tx_free_thresh* value indicates the [minimum] number of network
2070 * buffers that must be pending in the transmit ring to trigger their
2071 * [implicit] freeing by the driver transmit function.
2072 * - The *tx_rs_thresh* value indicates the [minimum] number of transmit
2073 * descriptors that must be pending in the transmit ring before setting the
2074 * RS bit on a descriptor by the driver transmit function.
2075 * The *tx_rs_thresh* value should be less or equal then
2076 * *tx_free_thresh* value, and both of them should be less then
2078 * - The *txq_flags* member contains flags to pass to the TX queue setup
2079 * function to configure the behavior of the TX queue. This should be set
2080 * to 0 if no special configuration is required.
2081 * This API is obsolete and will be deprecated. Applications
2082 * should set it to ETH_TXQ_FLAGS_IGNORE and use
2083 * the offloads field below.
2084 * - The *offloads* member contains Tx offloads to be enabled.
2085 * Offloads which are not set cannot be used on the datapath.
2087 * Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces
2088 * the transmit function to use default values.
2090 * - 0: Success, the transmit queue is correctly set up.
2091 * - -ENOMEM: Unable to allocate the transmit ring descriptors.
2093 int rte_eth_tx_queue_setup(uint16_t port_id, uint16_t tx_queue_id,
2094 uint16_t nb_tx_desc, unsigned int socket_id,
2095 const struct rte_eth_txconf *tx_conf);
2098 * Return the NUMA socket to which an Ethernet device is connected
2101 * The port identifier of the Ethernet device
2103 * The NUMA socket id to which the Ethernet device is connected or
2104 * a default of zero if the socket could not be determined.
2105 * -1 is returned is the port_id value is out of range.
2107 int rte_eth_dev_socket_id(uint16_t port_id);
2110 * Check if port_id of device is attached
2113 * The port identifier of the Ethernet device
2115 * - 0 if port is out of range or not attached
2116 * - 1 if device is attached
2118 int rte_eth_dev_is_valid_port(uint16_t port_id);
2121 * Start specified RX queue of a port. It is used when rx_deferred_start
2122 * flag of the specified queue is true.
2125 * The port identifier of the Ethernet device
2126 * @param rx_queue_id
2127 * The index of the rx queue to update the ring.
2128 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2129 * to rte_eth_dev_configure().
2131 * - 0: Success, the receive queue is started.
2132 * - -EINVAL: The port_id or the queue_id out of range.
2133 * - -ENOTSUP: The function not supported in PMD driver.
2135 int rte_eth_dev_rx_queue_start(uint16_t port_id, uint16_t rx_queue_id);
2138 * Stop specified RX queue of a port
2141 * The port identifier of the Ethernet device
2142 * @param rx_queue_id
2143 * The index of the rx queue to update the ring.
2144 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2145 * to rte_eth_dev_configure().
2147 * - 0: Success, the receive queue is stopped.
2148 * - -EINVAL: The port_id or the queue_id out of range.
2149 * - -ENOTSUP: The function not supported in PMD driver.
2151 int rte_eth_dev_rx_queue_stop(uint16_t port_id, uint16_t rx_queue_id);
2154 * Start TX for specified queue of a port. It is used when tx_deferred_start
2155 * flag of the specified queue is true.
2158 * The port identifier of the Ethernet device
2159 * @param tx_queue_id
2160 * The index of the tx queue to update the ring.
2161 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2162 * to rte_eth_dev_configure().
2164 * - 0: Success, the transmit queue is started.
2165 * - -EINVAL: The port_id or the queue_id out of range.
2166 * - -ENOTSUP: The function not supported in PMD driver.
2168 int rte_eth_dev_tx_queue_start(uint16_t port_id, uint16_t tx_queue_id);
2171 * Stop specified TX queue of a port
2174 * The port identifier of the Ethernet device
2175 * @param tx_queue_id
2176 * The index of the tx queue to update the ring.
2177 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2178 * to rte_eth_dev_configure().
2180 * - 0: Success, the transmit queue is stopped.
2181 * - -EINVAL: The port_id or the queue_id out of range.
2182 * - -ENOTSUP: The function not supported in PMD driver.
2184 int rte_eth_dev_tx_queue_stop(uint16_t port_id, uint16_t tx_queue_id);
2189 * Start an Ethernet device.
2191 * The device start step is the last one and consists of setting the configured
2192 * offload features and in starting the transmit and the receive units of the
2194 * On success, all basic functions exported by the Ethernet API (link status,
2195 * receive/transmit, and so on) can be invoked.
2198 * The port identifier of the Ethernet device.
2200 * - 0: Success, Ethernet device started.
2201 * - <0: Error code of the driver device start function.
2203 int rte_eth_dev_start(uint16_t port_id);
2206 * Stop an Ethernet device. The device can be restarted with a call to
2207 * rte_eth_dev_start()
2210 * The port identifier of the Ethernet device.
2212 void rte_eth_dev_stop(uint16_t port_id);
2216 * Link up an Ethernet device.
2218 * Set device link up will re-enable the device rx/tx
2219 * functionality after it is previously set device linked down.
2222 * The port identifier of the Ethernet device.
2224 * - 0: Success, Ethernet device linked up.
2225 * - <0: Error code of the driver device link up function.
2227 int rte_eth_dev_set_link_up(uint16_t port_id);
2230 * Link down an Ethernet device.
2231 * The device rx/tx functionality will be disabled if success,
2232 * and it can be re-enabled with a call to
2233 * rte_eth_dev_set_link_up()
2236 * The port identifier of the Ethernet device.
2238 int rte_eth_dev_set_link_down(uint16_t port_id);
2241 * Close a stopped Ethernet device. The device cannot be restarted!
2242 * The function frees all resources except for needed by the
2243 * closed state. To free these resources, call rte_eth_dev_detach().
2246 * The port identifier of the Ethernet device.
2248 void rte_eth_dev_close(uint16_t port_id);
2251 * Reset a Ethernet device and keep its port id.
2253 * When a port has to be reset passively, the DPDK application can invoke
2254 * this function. For example when a PF is reset, all its VFs should also
2255 * be reset. Normally a DPDK application can invoke this function when
2256 * RTE_ETH_EVENT_INTR_RESET event is detected, but can also use it to start
2257 * a port reset in other circumstances.
2259 * When this function is called, it first stops the port and then calls the
2260 * PMD specific dev_uninit( ) and dev_init( ) to return the port to initial
2261 * state, in which no Tx and Rx queues are setup, as if the port has been
2262 * reset and not started. The port keeps the port id it had before the
2265 * After calling rte_eth_dev_reset( ), the application should use
2266 * rte_eth_dev_configure( ), rte_eth_rx_queue_setup( ),
2267 * rte_eth_tx_queue_setup( ), and rte_eth_dev_start( )
2268 * to reconfigure the device as appropriate.
2270 * Note: To avoid unexpected behavior, the application should stop calling
2271 * Tx and Rx functions before calling rte_eth_dev_reset( ). For thread
2272 * safety, all these controlling functions should be called from the same
2276 * The port identifier of the Ethernet device.
2279 * - (0) if successful.
2280 * - (-EINVAL) if port identifier is invalid.
2281 * - (-ENOTSUP) if hardware doesn't support this function.
2282 * - (-EPERM) if not ran from the primary process.
2283 * - (-EIO) if re-initialisation failed.
2284 * - (-ENOMEM) if the reset failed due to OOM.
2285 * - (-EAGAIN) if the reset temporarily failed and should be retried later.
2287 int rte_eth_dev_reset(uint16_t port_id);
2290 * Enable receipt in promiscuous mode for an Ethernet device.
2293 * The port identifier of the Ethernet device.
2295 void rte_eth_promiscuous_enable(uint16_t port_id);
2298 * Disable receipt in promiscuous mode for an Ethernet device.
2301 * The port identifier of the Ethernet device.
2303 void rte_eth_promiscuous_disable(uint16_t port_id);
2306 * Return the value of promiscuous mode for an Ethernet device.
2309 * The port identifier of the Ethernet device.
2311 * - (1) if promiscuous is enabled
2312 * - (0) if promiscuous is disabled.
2315 int rte_eth_promiscuous_get(uint16_t port_id);
2318 * Enable the receipt of any multicast frame by an Ethernet device.
2321 * The port identifier of the Ethernet device.
2323 void rte_eth_allmulticast_enable(uint16_t port_id);
2326 * Disable the receipt of all multicast frames by an Ethernet device.
2329 * The port identifier of the Ethernet device.
2331 void rte_eth_allmulticast_disable(uint16_t port_id);
2334 * Return the value of allmulticast mode for an Ethernet device.
2337 * The port identifier of the Ethernet device.
2339 * - (1) if allmulticast is enabled
2340 * - (0) if allmulticast is disabled.
2343 int rte_eth_allmulticast_get(uint16_t port_id);
2346 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2347 * or FULL-DUPLEX) of the physical link of an Ethernet device. It might need
2348 * to wait up to 9 seconds in it.
2351 * The port identifier of the Ethernet device.
2353 * A pointer to an *rte_eth_link* structure to be filled with
2354 * the status, the speed and the mode of the Ethernet device link.
2356 void rte_eth_link_get(uint16_t port_id, struct rte_eth_link *link);
2359 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2360 * or FULL-DUPLEX) of the physical link of an Ethernet device. It is a no-wait
2361 * version of rte_eth_link_get().
2364 * The port identifier of the Ethernet device.
2366 * A pointer to an *rte_eth_link* structure to be filled with
2367 * the status, the speed and the mode of the Ethernet device link.
2369 void rte_eth_link_get_nowait(uint16_t port_id, struct rte_eth_link *link);
2372 * Retrieve the general I/O statistics of an Ethernet device.
2375 * The port identifier of the Ethernet device.
2377 * A pointer to a structure of type *rte_eth_stats* to be filled with
2378 * the values of device counters for the following set of statistics:
2379 * - *ipackets* with the total of successfully received packets.
2380 * - *opackets* with the total of successfully transmitted packets.
2381 * - *ibytes* with the total of successfully received bytes.
2382 * - *obytes* with the total of successfully transmitted bytes.
2383 * - *ierrors* with the total of erroneous received packets.
2384 * - *oerrors* with the total of failed transmitted packets.
2386 * Zero if successful. Non-zero otherwise.
2388 int rte_eth_stats_get(uint16_t port_id, struct rte_eth_stats *stats);
2391 * Reset the general I/O statistics of an Ethernet device.
2394 * The port identifier of the Ethernet device.
2396 * - (0) if device notified to reset stats.
2397 * - (-ENOTSUP) if hardware doesn't support.
2398 * - (-ENODEV) if *port_id* invalid.
2400 int rte_eth_stats_reset(uint16_t port_id);
2403 * Retrieve names of extended statistics of an Ethernet device.
2406 * The port identifier of the Ethernet device.
2407 * @param xstats_names
2408 * An rte_eth_xstat_name array of at least *size* elements to
2409 * be filled. If set to NULL, the function returns the required number
2412 * The size of the xstats_names array (number of elements).
2414 * - A positive value lower or equal to size: success. The return value
2415 * is the number of entries filled in the stats table.
2416 * - A positive value higher than size: error, the given statistics table
2417 * is too small. The return value corresponds to the size that should
2418 * be given to succeed. The entries in the table are not valid and
2419 * shall not be used by the caller.
2420 * - A negative value on error (invalid port id).
2422 int rte_eth_xstats_get_names(uint16_t port_id,
2423 struct rte_eth_xstat_name *xstats_names,
2427 * Retrieve extended statistics of an Ethernet device.
2430 * The port identifier of the Ethernet device.
2432 * A pointer to a table of structure of type *rte_eth_xstat*
2433 * to be filled with device statistics ids and values: id is the
2434 * index of the name string in xstats_names (see rte_eth_xstats_get_names()),
2435 * and value is the statistic counter.
2436 * This parameter can be set to NULL if n is 0.
2438 * The size of the xstats array (number of elements).
2440 * - A positive value lower or equal to n: success. The return value
2441 * is the number of entries filled in the stats table.
2442 * - A positive value higher than n: error, the given statistics table
2443 * is too small. The return value corresponds to the size that should
2444 * be given to succeed. The entries in the table are not valid and
2445 * shall not be used by the caller.
2446 * - A negative value on error (invalid port id).
2448 int rte_eth_xstats_get(uint16_t port_id, struct rte_eth_xstat *xstats,
2452 * Retrieve names of extended statistics of an Ethernet device.
2455 * The port identifier of the Ethernet device.
2456 * @param xstats_names
2457 * An rte_eth_xstat_name array of at least *size* elements to
2458 * be filled. If set to NULL, the function returns the required number
2461 * IDs array given by app to retrieve specific statistics
2463 * The size of the xstats_names array (number of elements).
2465 * - A positive value lower or equal to size: success. The return value
2466 * is the number of entries filled in the stats table.
2467 * - A positive value higher than size: error, the given statistics table
2468 * is too small. The return value corresponds to the size that should
2469 * be given to succeed. The entries in the table are not valid and
2470 * shall not be used by the caller.
2471 * - A negative value on error (invalid port id).
2474 rte_eth_xstats_get_names_by_id(uint16_t port_id,
2475 struct rte_eth_xstat_name *xstats_names, unsigned int size,
2479 * Retrieve extended statistics of an Ethernet device.
2482 * The port identifier of the Ethernet device.
2484 * A pointer to an ids array passed by application. This tells which
2485 * statistics values function should retrieve. This parameter
2486 * can be set to NULL if size is 0. In this case function will retrieve
2487 * all avalible statistics.
2489 * A pointer to a table to be filled with device statistics values.
2491 * The size of the ids array (number of elements).
2493 * - A positive value lower or equal to size: success. The return value
2494 * is the number of entries filled in the stats table.
2495 * - A positive value higher than size: error, the given statistics table
2496 * is too small. The return value corresponds to the size that should
2497 * be given to succeed. The entries in the table are not valid and
2498 * shall not be used by the caller.
2499 * - A negative value on error (invalid port id).
2501 int rte_eth_xstats_get_by_id(uint16_t port_id, const uint64_t *ids,
2502 uint64_t *values, unsigned int size);
2505 * Gets the ID of a statistic from its name.
2507 * This function searches for the statistics using string compares, and
2508 * as such should not be used on the fast-path. For fast-path retrieval of
2509 * specific statistics, store the ID as provided in *id* from this function,
2510 * and pass the ID to rte_eth_xstats_get()
2512 * @param port_id The port to look up statistics from
2513 * @param xstat_name The name of the statistic to return
2514 * @param[out] id A pointer to an app-supplied uint64_t which should be
2515 * set to the ID of the stat if the stat exists.
2518 * -ENODEV for invalid port_id,
2519 * -EINVAL if the xstat_name doesn't exist in port_id
2521 int rte_eth_xstats_get_id_by_name(uint16_t port_id, const char *xstat_name,
2525 * Reset extended statistics of an Ethernet device.
2528 * The port identifier of the Ethernet device.
2530 void rte_eth_xstats_reset(uint16_t port_id);
2533 * Set a mapping for the specified transmit queue to the specified per-queue
2534 * statistics counter.
2537 * The port identifier of the Ethernet device.
2538 * @param tx_queue_id
2539 * The index of the transmit queue for which a queue stats mapping is required.
2540 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2541 * to rte_eth_dev_configure().
2543 * The per-queue packet statistics functionality number that the transmit
2544 * queue is to be assigned.
2545 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2547 * Zero if successful. Non-zero otherwise.
2549 int rte_eth_dev_set_tx_queue_stats_mapping(uint16_t port_id,
2550 uint16_t tx_queue_id, uint8_t stat_idx);
2553 * Set a mapping for the specified receive queue to the specified per-queue
2554 * statistics counter.
2557 * The port identifier of the Ethernet device.
2558 * @param rx_queue_id
2559 * The index of the receive queue for which a queue stats mapping is required.
2560 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2561 * to rte_eth_dev_configure().
2563 * The per-queue packet statistics functionality number that the receive
2564 * queue is to be assigned.
2565 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2567 * Zero if successful. Non-zero otherwise.
2569 int rte_eth_dev_set_rx_queue_stats_mapping(uint16_t port_id,
2570 uint16_t rx_queue_id,
2574 * Retrieve the Ethernet address of an Ethernet device.
2577 * The port identifier of the Ethernet device.
2579 * A pointer to a structure of type *ether_addr* to be filled with
2580 * the Ethernet address of the Ethernet device.
2582 void rte_eth_macaddr_get(uint16_t port_id, struct ether_addr *mac_addr);
2585 * Retrieve the contextual information of an Ethernet device.
2588 * The port identifier of the Ethernet device.
2590 * A pointer to a structure of type *rte_eth_dev_info* to be filled with
2591 * the contextual information of the Ethernet device.
2593 void rte_eth_dev_info_get(uint16_t port_id, struct rte_eth_dev_info *dev_info);
2596 * Retrieve the firmware version of a device.
2599 * The port identifier of the device.
2601 * A pointer to a string array storing the firmware version of a device,
2602 * the string includes terminating null. This pointer is allocated by caller.
2604 * The size of the string array pointed by fw_version, which should be
2605 * large enough to store firmware version of the device.
2607 * - (0) if successful.
2608 * - (-ENOTSUP) if operation is not supported.
2609 * - (-ENODEV) if *port_id* invalid.
2610 * - (>0) if *fw_size* is not enough to store firmware version, return
2611 * the size of the non truncated string.
2613 int rte_eth_dev_fw_version_get(uint16_t port_id,
2614 char *fw_version, size_t fw_size);
2617 * Retrieve the supported packet types of an Ethernet device.
2619 * When a packet type is announced as supported, it *must* be recognized by
2620 * the PMD. For instance, if RTE_PTYPE_L2_ETHER, RTE_PTYPE_L2_ETHER_VLAN
2621 * and RTE_PTYPE_L3_IPV4 are announced, the PMD must return the following
2622 * packet types for these packets:
2623 * - Ether/IPv4 -> RTE_PTYPE_L2_ETHER | RTE_PTYPE_L3_IPV4
2624 * - Ether/Vlan/IPv4 -> RTE_PTYPE_L2_ETHER_VLAN | RTE_PTYPE_L3_IPV4
2625 * - Ether/[anything else] -> RTE_PTYPE_L2_ETHER
2626 * - Ether/Vlan/[anything else] -> RTE_PTYPE_L2_ETHER_VLAN
2628 * When a packet is received by a PMD, the most precise type must be
2629 * returned among the ones supported. However a PMD is allowed to set
2630 * packet type that is not in the supported list, at the condition that it
2631 * is more precise. Therefore, a PMD announcing no supported packet types
2632 * can still set a matching packet type in a received packet.
2635 * Better to invoke this API after the device is already started or rx burst
2636 * function is decided, to obtain correct supported ptypes.
2638 * if a given PMD does not report what ptypes it supports, then the supported
2639 * ptype count is reported as 0.
2641 * The port identifier of the Ethernet device.
2643 * A hint of what kind of packet type which the caller is interested in.
2645 * An array pointer to store adequate packet types, allocated by caller.
2647 * Size of the array pointed by param ptypes.
2649 * - (>=0) Number of supported ptypes. If the number of types exceeds num,
2650 * only num entries will be filled into the ptypes array, but the full
2651 * count of supported ptypes will be returned.
2652 * - (-ENODEV) if *port_id* invalid.
2654 int rte_eth_dev_get_supported_ptypes(uint16_t port_id, uint32_t ptype_mask,
2655 uint32_t *ptypes, int num);
2658 * Retrieve the MTU of an Ethernet device.
2661 * The port identifier of the Ethernet device.
2663 * A pointer to a uint16_t where the retrieved MTU is to be stored.
2665 * - (0) if successful.
2666 * - (-ENODEV) if *port_id* invalid.
2668 int rte_eth_dev_get_mtu(uint16_t port_id, uint16_t *mtu);
2671 * Change the MTU of an Ethernet device.
2674 * The port identifier of the Ethernet device.
2676 * A uint16_t for the MTU to be applied.
2678 * - (0) if successful.
2679 * - (-ENOTSUP) if operation is not supported.
2680 * - (-ENODEV) if *port_id* invalid.
2681 * - (-EINVAL) if *mtu* invalid.
2682 * - (-EBUSY) if operation is not allowed when the port is running
2684 int rte_eth_dev_set_mtu(uint16_t port_id, uint16_t mtu);
2687 * Enable/Disable hardware filtering by an Ethernet device of received
2688 * VLAN packets tagged with a given VLAN Tag Identifier.
2691 * The port identifier of the Ethernet device.
2693 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
2695 * If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*.
2696 * Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*.
2698 * - (0) if successful.
2699 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2700 * - (-ENODEV) if *port_id* invalid.
2701 * - (-ENOSYS) if VLAN filtering on *port_id* disabled.
2702 * - (-EINVAL) if *vlan_id* > 4095.
2704 int rte_eth_dev_vlan_filter(uint16_t port_id, uint16_t vlan_id, int on);
2707 * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
2708 * 82599/X540/X550 can support VLAN stripping at the rx queue level
2711 * The port identifier of the Ethernet device.
2712 * @param rx_queue_id
2713 * The index of the receive queue for which a queue stats mapping is required.
2714 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2715 * to rte_eth_dev_configure().
2717 * If 1, Enable VLAN Stripping of the receive queue of the Ethernet port.
2718 * If 0, Disable VLAN Stripping of the receive queue of the Ethernet port.
2720 * - (0) if successful.
2721 * - (-ENOSUP) if hardware-assisted VLAN stripping not configured.
2722 * - (-ENODEV) if *port_id* invalid.
2723 * - (-EINVAL) if *rx_queue_id* invalid.
2725 int rte_eth_dev_set_vlan_strip_on_queue(uint16_t port_id, uint16_t rx_queue_id,
2729 * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
2730 * the VLAN Header. This is a register setup available on some Intel NIC, not
2731 * but all, please check the data sheet for availability.
2734 * The port identifier of the Ethernet device.
2738 * The Tag Protocol ID
2740 * - (0) if successful.
2741 * - (-ENOSUP) if hardware-assisted VLAN TPID setup is not supported.
2742 * - (-ENODEV) if *port_id* invalid.
2744 int rte_eth_dev_set_vlan_ether_type(uint16_t port_id,
2745 enum rte_vlan_type vlan_type,
2749 * Set VLAN offload configuration on an Ethernet device
2750 * Enable/Disable Extended VLAN by an Ethernet device, This is a register setup
2751 * available on some Intel NIC, not but all, please check the data sheet for
2753 * Enable/Disable VLAN Strip can be done on rx queue for certain NIC, but here
2754 * the configuration is applied on the port level.
2757 * The port identifier of the Ethernet device.
2758 * @param offload_mask
2759 * The VLAN Offload bit mask can be mixed use with "OR"
2760 * ETH_VLAN_STRIP_OFFLOAD
2761 * ETH_VLAN_FILTER_OFFLOAD
2762 * ETH_VLAN_EXTEND_OFFLOAD
2764 * - (0) if successful.
2765 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2766 * - (-ENODEV) if *port_id* invalid.
2768 int rte_eth_dev_set_vlan_offload(uint16_t port_id, int offload_mask);
2771 * Read VLAN Offload configuration from an Ethernet device
2774 * The port identifier of the Ethernet device.
2776 * - (>0) if successful. Bit mask to indicate
2777 * ETH_VLAN_STRIP_OFFLOAD
2778 * ETH_VLAN_FILTER_OFFLOAD
2779 * ETH_VLAN_EXTEND_OFFLOAD
2780 * - (-ENODEV) if *port_id* invalid.
2782 int rte_eth_dev_get_vlan_offload(uint16_t port_id);
2785 * Set port based TX VLAN insertion on or off.
2788 * The port identifier of the Ethernet device.
2790 * Port based TX VLAN identifier together with user priority.
2792 * Turn on or off the port based TX VLAN insertion.
2795 * - (0) if successful.
2796 * - negative if failed.
2798 int rte_eth_dev_set_vlan_pvid(uint16_t port_id, uint16_t pvid, int on);
2802 * Retrieve a burst of input packets from a receive queue of an Ethernet
2803 * device. The retrieved packets are stored in *rte_mbuf* structures whose
2804 * pointers are supplied in the *rx_pkts* array.
2806 * The rte_eth_rx_burst() function loops, parsing the RX ring of the
2807 * receive queue, up to *nb_pkts* packets, and for each completed RX
2808 * descriptor in the ring, it performs the following operations:
2810 * - Initialize the *rte_mbuf* data structure associated with the
2811 * RX descriptor according to the information provided by the NIC into
2812 * that RX descriptor.
2814 * - Store the *rte_mbuf* data structure into the next entry of the
2817 * - Replenish the RX descriptor with a new *rte_mbuf* buffer
2818 * allocated from the memory pool associated with the receive queue at
2819 * initialization time.
2821 * When retrieving an input packet that was scattered by the controller
2822 * into multiple receive descriptors, the rte_eth_rx_burst() function
2823 * appends the associated *rte_mbuf* buffers to the first buffer of the
2826 * The rte_eth_rx_burst() function returns the number of packets
2827 * actually retrieved, which is the number of *rte_mbuf* data structures
2828 * effectively supplied into the *rx_pkts* array.
2829 * A return value equal to *nb_pkts* indicates that the RX queue contained
2830 * at least *rx_pkts* packets, and this is likely to signify that other
2831 * received packets remain in the input queue. Applications implementing
2832 * a "retrieve as much received packets as possible" policy can check this
2833 * specific case and keep invoking the rte_eth_rx_burst() function until
2834 * a value less than *nb_pkts* is returned.
2836 * This receive method has the following advantages:
2838 * - It allows a run-to-completion network stack engine to retrieve and
2839 * to immediately process received packets in a fast burst-oriented
2840 * approach, avoiding the overhead of unnecessary intermediate packet
2841 * queue/dequeue operations.
2843 * - Conversely, it also allows an asynchronous-oriented processing
2844 * method to retrieve bursts of received packets and to immediately
2845 * queue them for further parallel processing by another logical core,
2846 * for instance. However, instead of having received packets being
2847 * individually queued by the driver, this approach allows the caller
2848 * of the rte_eth_rx_burst() function to queue a burst of retrieved
2849 * packets at a time and therefore dramatically reduce the cost of
2850 * enqueue/dequeue operations per packet.
2852 * - It allows the rte_eth_rx_burst() function of the driver to take
2853 * advantage of burst-oriented hardware features (CPU cache,
2854 * prefetch instructions, and so on) to minimize the number of CPU
2855 * cycles per packet.
2857 * To summarize, the proposed receive API enables many
2858 * burst-oriented optimizations in both synchronous and asynchronous
2859 * packet processing environments with no overhead in both cases.
2861 * The rte_eth_rx_burst() function does not provide any error
2862 * notification to avoid the corresponding overhead. As a hint, the
2863 * upper-level application might check the status of the device link once
2864 * being systematically returned a 0 value for a given number of tries.
2867 * The port identifier of the Ethernet device.
2869 * The index of the receive queue from which to retrieve input packets.
2870 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2871 * to rte_eth_dev_configure().
2873 * The address of an array of pointers to *rte_mbuf* structures that
2874 * must be large enough to store *nb_pkts* pointers in it.
2876 * The maximum number of packets to retrieve.
2878 * The number of packets actually retrieved, which is the number
2879 * of pointers to *rte_mbuf* structures effectively supplied to the
2882 static inline uint16_t
2883 rte_eth_rx_burst(uint16_t port_id, uint16_t queue_id,
2884 struct rte_mbuf **rx_pkts, const uint16_t nb_pkts)
2886 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2888 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2889 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
2890 RTE_FUNC_PTR_OR_ERR_RET(*dev->rx_pkt_burst, 0);
2892 if (queue_id >= dev->data->nb_rx_queues) {
2893 RTE_PMD_DEBUG_TRACE("Invalid RX queue_id=%d\n", queue_id);
2897 int16_t nb_rx = (*dev->rx_pkt_burst)(dev->data->rx_queues[queue_id],
2900 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
2901 struct rte_eth_rxtx_callback *cb = dev->post_rx_burst_cbs[queue_id];
2903 if (unlikely(cb != NULL)) {
2905 nb_rx = cb->fn.rx(port_id, queue_id, rx_pkts, nb_rx,
2906 nb_pkts, cb->param);
2908 } while (cb != NULL);
2916 * Get the number of used descriptors of a rx queue
2919 * The port identifier of the Ethernet device.
2921 * The queue id on the specific port.
2923 * The number of used descriptors in the specific queue, or:
2924 * (-EINVAL) if *port_id* or *queue_id* is invalid
2925 * (-ENOTSUP) if the device does not support this function
2928 rte_eth_rx_queue_count(uint16_t port_id, uint16_t queue_id)
2930 struct rte_eth_dev *dev;
2932 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -EINVAL);
2933 dev = &rte_eth_devices[port_id];
2934 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_queue_count, -ENOTSUP);
2935 if (queue_id >= dev->data->nb_rx_queues)
2938 return (*dev->dev_ops->rx_queue_count)(dev, queue_id);
2942 * Check if the DD bit of the specific RX descriptor in the queue has been set
2945 * The port identifier of the Ethernet device.
2947 * The queue id on the specific port.
2949 * The offset of the descriptor ID from tail.
2951 * - (1) if the specific DD bit is set.
2952 * - (0) if the specific DD bit is not set.
2953 * - (-ENODEV) if *port_id* invalid.
2954 * - (-ENOTSUP) if the device does not support this function
2957 rte_eth_rx_descriptor_done(uint16_t port_id, uint16_t queue_id, uint16_t offset)
2959 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2960 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
2961 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_descriptor_done, -ENOTSUP);
2962 return (*dev->dev_ops->rx_descriptor_done)( \
2963 dev->data->rx_queues[queue_id], offset);
2966 #define RTE_ETH_RX_DESC_AVAIL 0 /**< Desc available for hw. */
2967 #define RTE_ETH_RX_DESC_DONE 1 /**< Desc done, filled by hw. */
2968 #define RTE_ETH_RX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */
2971 * Check the status of a Rx descriptor in the queue
2973 * It should be called in a similar context than the Rx function:
2974 * - on a dataplane core
2975 * - not concurrently on the same queue
2977 * Since it's a dataplane function, no check is performed on port_id and
2978 * queue_id. The caller must therefore ensure that the port is enabled
2979 * and the queue is configured and running.
2981 * Note: accessing to a random descriptor in the ring may trigger cache
2982 * misses and have a performance impact.
2985 * A valid port identifier of the Ethernet device which.
2987 * A valid Rx queue identifier on this port.
2989 * The offset of the descriptor starting from tail (0 is the next
2990 * packet to be received by the driver).
2993 * - (RTE_ETH_RX_DESC_AVAIL): Descriptor is available for the hardware to
2995 * - (RTE_ETH_RX_DESC_DONE): Descriptor is done, it is filled by hw, but
2996 * not yet processed by the driver (i.e. in the receive queue).
2997 * - (RTE_ETH_RX_DESC_UNAVAIL): Descriptor is unavailable, either hold by
2998 * the driver and not yet returned to hw, or reserved by the hw.
2999 * - (-EINVAL) bad descriptor offset.
3000 * - (-ENOTSUP) if the device does not support this function.
3001 * - (-ENODEV) bad port or queue (only if compiled with debug).
3004 rte_eth_rx_descriptor_status(uint16_t port_id, uint16_t queue_id,
3007 struct rte_eth_dev *dev;
3010 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3011 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
3013 dev = &rte_eth_devices[port_id];
3014 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3015 if (queue_id >= dev->data->nb_rx_queues)
3018 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_descriptor_status, -ENOTSUP);
3019 rxq = dev->data->rx_queues[queue_id];
3021 return (*dev->dev_ops->rx_descriptor_status)(rxq, offset);
3024 #define RTE_ETH_TX_DESC_FULL 0 /**< Desc filled for hw, waiting xmit. */
3025 #define RTE_ETH_TX_DESC_DONE 1 /**< Desc done, packet is transmitted. */
3026 #define RTE_ETH_TX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */
3029 * Check the status of a Tx descriptor in the queue.
3031 * It should be called in a similar context than the Tx function:
3032 * - on a dataplane core
3033 * - not concurrently on the same queue
3035 * Since it's a dataplane function, no check is performed on port_id and
3036 * queue_id. The caller must therefore ensure that the port is enabled
3037 * and the queue is configured and running.
3039 * Note: accessing to a random descriptor in the ring may trigger cache
3040 * misses and have a performance impact.
3043 * A valid port identifier of the Ethernet device which.
3045 * A valid Tx queue identifier on this port.
3047 * The offset of the descriptor starting from tail (0 is the place where
3048 * the next packet will be send).
3051 * - (RTE_ETH_TX_DESC_FULL) Descriptor is being processed by the hw, i.e.
3052 * in the transmit queue.
3053 * - (RTE_ETH_TX_DESC_DONE) Hardware is done with this descriptor, it can
3054 * be reused by the driver.
3055 * - (RTE_ETH_TX_DESC_UNAVAIL): Descriptor is unavailable, reserved by the
3056 * driver or the hardware.
3057 * - (-EINVAL) bad descriptor offset.
3058 * - (-ENOTSUP) if the device does not support this function.
3059 * - (-ENODEV) bad port or queue (only if compiled with debug).
3061 static inline int rte_eth_tx_descriptor_status(uint16_t port_id,
3062 uint16_t queue_id, uint16_t offset)
3064 struct rte_eth_dev *dev;
3067 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3068 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
3070 dev = &rte_eth_devices[port_id];
3071 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3072 if (queue_id >= dev->data->nb_tx_queues)
3075 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->tx_descriptor_status, -ENOTSUP);
3076 txq = dev->data->tx_queues[queue_id];
3078 return (*dev->dev_ops->tx_descriptor_status)(txq, offset);
3082 * Send a burst of output packets on a transmit queue of an Ethernet device.
3084 * The rte_eth_tx_burst() function is invoked to transmit output packets
3085 * on the output queue *queue_id* of the Ethernet device designated by its
3087 * The *nb_pkts* parameter is the number of packets to send which are
3088 * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
3089 * allocated from a pool created with rte_pktmbuf_pool_create().
3090 * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
3091 * up to the number of transmit descriptors available in the TX ring of the
3093 * For each packet to send, the rte_eth_tx_burst() function performs
3094 * the following operations:
3096 * - Pick up the next available descriptor in the transmit ring.
3098 * - Free the network buffer previously sent with that descriptor, if any.
3100 * - Initialize the transmit descriptor with the information provided
3101 * in the *rte_mbuf data structure.
3103 * In the case of a segmented packet composed of a list of *rte_mbuf* buffers,
3104 * the rte_eth_tx_burst() function uses several transmit descriptors
3107 * The rte_eth_tx_burst() function returns the number of packets it
3108 * actually sent. A return value equal to *nb_pkts* means that all packets
3109 * have been sent, and this is likely to signify that other output packets
3110 * could be immediately transmitted again. Applications that implement a
3111 * "send as many packets to transmit as possible" policy can check this
3112 * specific case and keep invoking the rte_eth_tx_burst() function until
3113 * a value less than *nb_pkts* is returned.
3115 * It is the responsibility of the rte_eth_tx_burst() function to
3116 * transparently free the memory buffers of packets previously sent.
3117 * This feature is driven by the *tx_free_thresh* value supplied to the
3118 * rte_eth_dev_configure() function at device configuration time.
3119 * When the number of free TX descriptors drops below this threshold, the
3120 * rte_eth_tx_burst() function must [attempt to] free the *rte_mbuf* buffers
3121 * of those packets whose transmission was effectively completed.
3123 * If the PMD is DEV_TX_OFFLOAD_MT_LOCKFREE capable, multiple threads can
3124 * invoke this function concurrently on the same tx queue without SW lock.
3125 * @see rte_eth_dev_info_get, struct rte_eth_txconf::txq_flags
3128 * The port identifier of the Ethernet device.
3130 * The index of the transmit queue through which output packets must be
3132 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3133 * to rte_eth_dev_configure().
3135 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
3136 * which contain the output packets.
3138 * The maximum number of packets to transmit.
3140 * The number of output packets actually stored in transmit descriptors of
3141 * the transmit ring. The return value can be less than the value of the
3142 * *tx_pkts* parameter when the transmit ring is full or has been filled up.
3144 static inline uint16_t
3145 rte_eth_tx_burst(uint16_t port_id, uint16_t queue_id,
3146 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
3148 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
3150 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3151 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
3152 RTE_FUNC_PTR_OR_ERR_RET(*dev->tx_pkt_burst, 0);
3154 if (queue_id >= dev->data->nb_tx_queues) {
3155 RTE_PMD_DEBUG_TRACE("Invalid TX queue_id=%d\n", queue_id);
3160 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
3161 struct rte_eth_rxtx_callback *cb = dev->pre_tx_burst_cbs[queue_id];
3163 if (unlikely(cb != NULL)) {
3165 nb_pkts = cb->fn.tx(port_id, queue_id, tx_pkts, nb_pkts,
3168 } while (cb != NULL);
3172 return (*dev->tx_pkt_burst)(dev->data->tx_queues[queue_id], tx_pkts, nb_pkts);
3177 * @b EXPERIMENTAL: this API may change without prior notice
3179 * Process a burst of output packets on a transmit queue of an Ethernet device.
3181 * The rte_eth_tx_prepare() function is invoked to prepare output packets to be
3182 * transmitted on the output queue *queue_id* of the Ethernet device designated
3184 * The *nb_pkts* parameter is the number of packets to be prepared which are
3185 * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
3186 * allocated from a pool created with rte_pktmbuf_pool_create().
3187 * For each packet to send, the rte_eth_tx_prepare() function performs
3188 * the following operations:
3190 * - Check if packet meets devices requirements for tx offloads.
3192 * - Check limitations about number of segments.
3194 * - Check additional requirements when debug is enabled.
3196 * - Update and/or reset required checksums when tx offload is set for packet.
3198 * Since this function can modify packet data, provided mbufs must be safely
3199 * writable (e.g. modified data cannot be in shared segment).
3201 * The rte_eth_tx_prepare() function returns the number of packets ready to be
3202 * sent. A return value equal to *nb_pkts* means that all packets are valid and
3203 * ready to be sent, otherwise stops processing on the first invalid packet and
3204 * leaves the rest packets untouched.
3206 * When this functionality is not implemented in the driver, all packets are
3207 * are returned untouched.
3210 * The port identifier of the Ethernet device.
3211 * The value must be a valid port id.
3213 * The index of the transmit queue through which output packets must be
3215 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3216 * to rte_eth_dev_configure().
3218 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
3219 * which contain the output packets.
3221 * The maximum number of packets to process.
3223 * The number of packets correct and ready to be sent. The return value can be
3224 * less than the value of the *tx_pkts* parameter when some packet doesn't
3225 * meet devices requirements with rte_errno set appropriately:
3226 * - -EINVAL: offload flags are not correctly set
3227 * - -ENOTSUP: the offload feature is not supported by the hardware
3231 #ifndef RTE_ETHDEV_TX_PREPARE_NOOP
3233 static inline uint16_t
3234 rte_eth_tx_prepare(uint16_t port_id, uint16_t queue_id,
3235 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
3237 struct rte_eth_dev *dev;
3239 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3240 if (!rte_eth_dev_is_valid_port(port_id)) {
3241 RTE_PMD_DEBUG_TRACE("Invalid TX port_id=%d\n", port_id);
3242 rte_errno = -EINVAL;
3247 dev = &rte_eth_devices[port_id];
3249 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3250 if (queue_id >= dev->data->nb_tx_queues) {
3251 RTE_PMD_DEBUG_TRACE("Invalid TX queue_id=%d\n", queue_id);
3252 rte_errno = -EINVAL;
3257 if (!dev->tx_pkt_prepare)
3260 return (*dev->tx_pkt_prepare)(dev->data->tx_queues[queue_id],
3267 * Native NOOP operation for compilation targets which doesn't require any
3268 * preparations steps, and functional NOOP may introduce unnecessary performance
3271 * Generally this is not a good idea to turn it on globally and didn't should
3272 * be used if behavior of tx_preparation can change.
3275 static inline uint16_t
3276 rte_eth_tx_prepare(__rte_unused uint16_t port_id,
3277 __rte_unused uint16_t queue_id,
3278 __rte_unused struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
3285 typedef void (*buffer_tx_error_fn)(struct rte_mbuf **unsent, uint16_t count,
3289 * Structure used to buffer packets for future TX
3290 * Used by APIs rte_eth_tx_buffer and rte_eth_tx_buffer_flush
3292 struct rte_eth_dev_tx_buffer {
3293 buffer_tx_error_fn error_callback;
3294 void *error_userdata;
3295 uint16_t size; /**< Size of buffer for buffered tx */
3296 uint16_t length; /**< Number of packets in the array */
3297 struct rte_mbuf *pkts[];
3298 /**< Pending packets to be sent on explicit flush or when full */
3302 * Calculate the size of the tx buffer.
3305 * Number of stored packets.
3307 #define RTE_ETH_TX_BUFFER_SIZE(sz) \
3308 (sizeof(struct rte_eth_dev_tx_buffer) + (sz) * sizeof(struct rte_mbuf *))
3311 * Initialize default values for buffered transmitting
3314 * Tx buffer to be initialized.
3321 rte_eth_tx_buffer_init(struct rte_eth_dev_tx_buffer *buffer, uint16_t size);
3324 * Send any packets queued up for transmission on a port and HW queue
3326 * This causes an explicit flush of packets previously buffered via the
3327 * rte_eth_tx_buffer() function. It returns the number of packets successfully
3328 * sent to the NIC, and calls the error callback for any unsent packets. Unless
3329 * explicitly set up otherwise, the default callback simply frees the unsent
3330 * packets back to the owning mempool.
3333 * The port identifier of the Ethernet device.
3335 * The index of the transmit queue through which output packets must be
3337 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3338 * to rte_eth_dev_configure().
3340 * Buffer of packets to be transmit.
3342 * The number of packets successfully sent to the Ethernet device. The error
3343 * callback is called for any packets which could not be sent.
3345 static inline uint16_t
3346 rte_eth_tx_buffer_flush(uint16_t port_id, uint16_t queue_id,
3347 struct rte_eth_dev_tx_buffer *buffer)
3350 uint16_t to_send = buffer->length;
3355 sent = rte_eth_tx_burst(port_id, queue_id, buffer->pkts, to_send);
3359 /* All packets sent, or to be dealt with by callback below */
3360 if (unlikely(sent != to_send))
3361 buffer->error_callback(&buffer->pkts[sent], to_send - sent,
3362 buffer->error_userdata);
3368 * Buffer a single packet for future transmission on a port and queue
3370 * This function takes a single mbuf/packet and buffers it for later
3371 * transmission on the particular port and queue specified. Once the buffer is
3372 * full of packets, an attempt will be made to transmit all the buffered
3373 * packets. In case of error, where not all packets can be transmitted, a
3374 * callback is called with the unsent packets as a parameter. If no callback
3375 * is explicitly set up, the unsent packets are just freed back to the owning
3376 * mempool. The function returns the number of packets actually sent i.e.
3377 * 0 if no buffer flush occurred, otherwise the number of packets successfully
3381 * The port identifier of the Ethernet device.
3383 * The index of the transmit queue through which output packets must be
3385 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3386 * to rte_eth_dev_configure().
3388 * Buffer used to collect packets to be sent.
3390 * Pointer to the packet mbuf to be sent.
3392 * 0 = packet has been buffered for later transmission
3393 * N > 0 = packet has been buffered, and the buffer was subsequently flushed,
3394 * causing N packets to be sent, and the error callback to be called for
3397 static __rte_always_inline uint16_t
3398 rte_eth_tx_buffer(uint16_t port_id, uint16_t queue_id,
3399 struct rte_eth_dev_tx_buffer *buffer, struct rte_mbuf *tx_pkt)
3401 buffer->pkts[buffer->length++] = tx_pkt;
3402 if (buffer->length < buffer->size)
3405 return rte_eth_tx_buffer_flush(port_id, queue_id, buffer);
3409 * Configure a callback for buffered packets which cannot be sent
3411 * Register a specific callback to be called when an attempt is made to send
3412 * all packets buffered on an ethernet port, but not all packets can
3413 * successfully be sent. The callback registered here will be called only
3414 * from calls to rte_eth_tx_buffer() and rte_eth_tx_buffer_flush() APIs.
3415 * The default callback configured for each queue by default just frees the
3416 * packets back to the calling mempool. If additional behaviour is required,
3417 * for example, to count dropped packets, or to retry transmission of packets
3418 * which cannot be sent, this function should be used to register a suitable
3419 * callback function to implement the desired behaviour.
3420 * The example callback "rte_eth_count_unsent_packet_callback()" is also
3421 * provided as reference.
3424 * The port identifier of the Ethernet device.
3426 * The function to be used as the callback.
3428 * Arbitrary parameter to be passed to the callback function
3430 * 0 on success, or -1 on error with rte_errno set appropriately
3433 rte_eth_tx_buffer_set_err_callback(struct rte_eth_dev_tx_buffer *buffer,
3434 buffer_tx_error_fn callback, void *userdata);
3437 * Callback function for silently dropping unsent buffered packets.
3439 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
3440 * adjust the default behavior when buffered packets cannot be sent. This
3441 * function drops any unsent packets silently and is used by tx buffered
3442 * operations as default behavior.
3444 * NOTE: this function should not be called directly, instead it should be used
3445 * as a callback for packet buffering.
3447 * NOTE: when configuring this function as a callback with
3448 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
3449 * should point to an uint64_t value.
3452 * The previously buffered packets which could not be sent
3454 * The number of unsent packets in the pkts array
3459 rte_eth_tx_buffer_drop_callback(struct rte_mbuf **pkts, uint16_t unsent,
3463 * Callback function for tracking unsent buffered packets.
3465 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
3466 * adjust the default behavior when buffered packets cannot be sent. This
3467 * function drops any unsent packets, but also updates a user-supplied counter
3468 * to track the overall number of packets dropped. The counter should be an
3469 * uint64_t variable.
3471 * NOTE: this function should not be called directly, instead it should be used
3472 * as a callback for packet buffering.
3474 * NOTE: when configuring this function as a callback with
3475 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
3476 * should point to an uint64_t value.
3479 * The previously buffered packets which could not be sent
3481 * The number of unsent packets in the pkts array
3483 * Pointer to an uint64_t value, which will be incremented by unsent
3486 rte_eth_tx_buffer_count_callback(struct rte_mbuf **pkts, uint16_t unsent,
3490 * Request the driver to free mbufs currently cached by the driver. The
3491 * driver will only free the mbuf if it is no longer in use. It is the
3492 * application's responsibity to ensure rte_eth_tx_buffer_flush(..) is
3496 * The port identifier of the Ethernet device.
3498 * The index of the transmit queue through which output packets must be
3500 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3501 * to rte_eth_dev_configure().
3503 * Maximum number of packets to free. Use 0 to indicate all possible packets
3504 * should be freed. Note that a packet may be using multiple mbufs.
3507 * -ENODEV: Invalid interface
3508 * -ENOTSUP: Driver does not support function
3510 * 0-n: Number of packets freed. More packets may still remain in ring that
3514 rte_eth_tx_done_cleanup(uint16_t port_id, uint16_t queue_id, uint32_t free_cnt);
3517 * The eth device event type for interrupt, and maybe others in the future.
3519 enum rte_eth_event_type {
3520 RTE_ETH_EVENT_UNKNOWN, /**< unknown event type */
3521 RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
3522 RTE_ETH_EVENT_QUEUE_STATE,
3523 /**< queue state event (enabled/disabled) */
3524 RTE_ETH_EVENT_INTR_RESET,
3525 /**< reset interrupt event, sent to VF on PF reset */
3526 RTE_ETH_EVENT_VF_MBOX, /**< message from the VF received by PF */
3527 RTE_ETH_EVENT_MACSEC, /**< MACsec offload related event */
3528 RTE_ETH_EVENT_INTR_RMV, /**< device removal event */
3529 RTE_ETH_EVENT_MAX /**< max value of this enum */
3532 typedef int (*rte_eth_dev_cb_fn)(uint16_t port_id,
3533 enum rte_eth_event_type event, void *cb_arg, void *ret_param);
3534 /**< user application callback to be registered for interrupts */
3539 * Register a callback function for specific port id.
3546 * User supplied callback function to be called.
3548 * Pointer to the parameters for the registered callback.
3551 * - On success, zero.
3552 * - On failure, a negative value.
3554 int rte_eth_dev_callback_register(uint16_t port_id,
3555 enum rte_eth_event_type event,
3556 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
3559 * Unregister a callback function for specific port id.
3566 * User supplied callback function to be called.
3568 * Pointer to the parameters for the registered callback. -1 means to
3569 * remove all for the same callback address and same event.
3572 * - On success, zero.
3573 * - On failure, a negative value.
3575 int rte_eth_dev_callback_unregister(uint16_t port_id,
3576 enum rte_eth_event_type event,
3577 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
3580 * @internal Executes all the user application registered callbacks for
3581 * the specific device. It is for DPDK internal user only. User
3582 * application should not call it directly.
3585 * Pointer to struct rte_eth_dev.
3587 * Eth device interrupt event type.
3589 * callback parameter.
3591 * To pass data back to user application.
3592 * This allows the user application to decide if a particular function
3593 * is permitted or not.
3598 int _rte_eth_dev_callback_process(struct rte_eth_dev *dev,
3599 enum rte_eth_event_type event, void *cb_arg, void *ret_param);
3602 * When there is no rx packet coming in Rx Queue for a long time, we can
3603 * sleep lcore related to RX Queue for power saving, and enable rx interrupt
3604 * to be triggered when Rx packet arrives.
3606 * The rte_eth_dev_rx_intr_enable() function enables rx queue
3607 * interrupt on specific rx queue of a port.
3610 * The port identifier of the Ethernet device.
3612 * The index of the receive queue from which to retrieve input packets.
3613 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3614 * to rte_eth_dev_configure().
3616 * - (0) if successful.
3617 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3619 * - (-ENODEV) if *port_id* invalid.
3621 int rte_eth_dev_rx_intr_enable(uint16_t port_id, uint16_t queue_id);
3624 * When lcore wakes up from rx interrupt indicating packet coming, disable rx
3625 * interrupt and returns to polling mode.
3627 * The rte_eth_dev_rx_intr_disable() function disables rx queue
3628 * interrupt on specific rx queue of a port.
3631 * The port identifier of the Ethernet device.
3633 * The index of the receive queue from which to retrieve input packets.
3634 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3635 * to rte_eth_dev_configure().
3637 * - (0) if successful.
3638 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3640 * - (-ENODEV) if *port_id* invalid.
3642 int rte_eth_dev_rx_intr_disable(uint16_t port_id, uint16_t queue_id);
3645 * RX Interrupt control per port.
3648 * The port identifier of the Ethernet device.
3650 * Epoll instance fd which the intr vector associated to.
3651 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
3653 * The operation be performed for the vector.
3654 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
3658 * - On success, zero.
3659 * - On failure, a negative value.
3661 int rte_eth_dev_rx_intr_ctl(uint16_t port_id, int epfd, int op, void *data);
3664 * RX Interrupt control per queue.
3667 * The port identifier of the Ethernet device.
3669 * The index of the receive queue from which to retrieve input packets.
3670 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3671 * to rte_eth_dev_configure().
3673 * Epoll instance fd which the intr vector associated to.
3674 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
3676 * The operation be performed for the vector.
3677 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
3681 * - On success, zero.
3682 * - On failure, a negative value.
3684 int rte_eth_dev_rx_intr_ctl_q(uint16_t port_id, uint16_t queue_id,
3685 int epfd, int op, void *data);
3688 * Turn on the LED on the Ethernet device.
3689 * This function turns on the LED on the Ethernet device.
3692 * The port identifier of the Ethernet device.
3694 * - (0) if successful.
3695 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3697 * - (-ENODEV) if *port_id* invalid.
3699 int rte_eth_led_on(uint16_t port_id);
3702 * Turn off the LED on the Ethernet device.
3703 * This function turns off the LED on the Ethernet device.
3706 * The port identifier of the Ethernet device.
3708 * - (0) if successful.
3709 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3711 * - (-ENODEV) if *port_id* invalid.
3713 int rte_eth_led_off(uint16_t port_id);
3716 * Get current status of the Ethernet link flow control for Ethernet device
3719 * The port identifier of the Ethernet device.
3721 * The pointer to the structure where to store the flow control parameters.
3723 * - (0) if successful.
3724 * - (-ENOTSUP) if hardware doesn't support flow control.
3725 * - (-ENODEV) if *port_id* invalid.
3727 int rte_eth_dev_flow_ctrl_get(uint16_t port_id,
3728 struct rte_eth_fc_conf *fc_conf);
3731 * Configure the Ethernet link flow control for Ethernet device
3734 * The port identifier of the Ethernet device.
3736 * The pointer to the structure of the flow control parameters.
3738 * - (0) if successful.
3739 * - (-ENOTSUP) if hardware doesn't support flow control mode.
3740 * - (-ENODEV) if *port_id* invalid.
3741 * - (-EINVAL) if bad parameter
3742 * - (-EIO) if flow control setup failure
3744 int rte_eth_dev_flow_ctrl_set(uint16_t port_id,
3745 struct rte_eth_fc_conf *fc_conf);
3748 * Configure the Ethernet priority flow control under DCB environment
3749 * for Ethernet device.
3752 * The port identifier of the Ethernet device.
3754 * The pointer to the structure of the priority flow control parameters.
3756 * - (0) if successful.
3757 * - (-ENOTSUP) if hardware doesn't support priority flow control mode.
3758 * - (-ENODEV) if *port_id* invalid.
3759 * - (-EINVAL) if bad parameter
3760 * - (-EIO) if flow control setup failure
3762 int rte_eth_dev_priority_flow_ctrl_set(uint16_t port_id,
3763 struct rte_eth_pfc_conf *pfc_conf);
3766 * Add a MAC address to an internal array of addresses used to enable whitelist
3767 * filtering to accept packets only if the destination MAC address matches.
3770 * The port identifier of the Ethernet device.
3772 * The MAC address to add.
3774 * VMDq pool index to associate address with (if VMDq is enabled). If VMDq is
3775 * not enabled, this should be set to 0.
3777 * - (0) if successfully added or *mac_addr" was already added.
3778 * - (-ENOTSUP) if hardware doesn't support this feature.
3779 * - (-ENODEV) if *port* is invalid.
3780 * - (-ENOSPC) if no more MAC addresses can be added.
3781 * - (-EINVAL) if MAC address is invalid.
3783 int rte_eth_dev_mac_addr_add(uint16_t port, struct ether_addr *mac_addr,
3787 * Remove a MAC address from the internal array of addresses.
3790 * The port identifier of the Ethernet device.
3792 * MAC address to remove.
3794 * - (0) if successful, or *mac_addr* didn't exist.
3795 * - (-ENOTSUP) if hardware doesn't support.
3796 * - (-ENODEV) if *port* invalid.
3797 * - (-EADDRINUSE) if attempting to remove the default MAC address
3799 int rte_eth_dev_mac_addr_remove(uint16_t port, struct ether_addr *mac_addr);
3802 * Set the default MAC address.
3805 * The port identifier of the Ethernet device.
3807 * New default MAC address.
3809 * - (0) if successful, or *mac_addr* didn't exist.
3810 * - (-ENOTSUP) if hardware doesn't support.
3811 * - (-ENODEV) if *port* invalid.
3812 * - (-EINVAL) if MAC address is invalid.
3814 int rte_eth_dev_default_mac_addr_set(uint16_t port,
3815 struct ether_addr *mac_addr);
3818 * Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3821 * The port identifier of the Ethernet device.
3825 * Redirection table size. The table size can be queried by
3826 * rte_eth_dev_info_get().
3828 * - (0) if successful.
3829 * - (-ENOTSUP) if hardware doesn't support.
3830 * - (-EINVAL) if bad parameter.
3832 int rte_eth_dev_rss_reta_update(uint16_t port,
3833 struct rte_eth_rss_reta_entry64 *reta_conf,
3834 uint16_t reta_size);
3837 * Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3840 * The port identifier of the Ethernet device.
3844 * Redirection table size. The table size can be queried by
3845 * rte_eth_dev_info_get().
3847 * - (0) if successful.
3848 * - (-ENOTSUP) if hardware doesn't support.
3849 * - (-EINVAL) if bad parameter.
3851 int rte_eth_dev_rss_reta_query(uint16_t port,
3852 struct rte_eth_rss_reta_entry64 *reta_conf,
3853 uint16_t reta_size);
3856 * Updates unicast hash table for receiving packet with the given destination
3857 * MAC address, and the packet is routed to all VFs for which the RX mode is
3858 * accept packets that match the unicast hash table.
3861 * The port identifier of the Ethernet device.
3863 * Unicast MAC address.
3865 * 1 - Set an unicast hash bit for receiving packets with the MAC address.
3866 * 0 - Clear an unicast hash bit.
3868 * - (0) if successful.
3869 * - (-ENOTSUP) if hardware doesn't support.
3870 * - (-ENODEV) if *port_id* invalid.
3871 * - (-EINVAL) if bad parameter.
3873 int rte_eth_dev_uc_hash_table_set(uint16_t port, struct ether_addr *addr,
3877 * Updates all unicast hash bitmaps for receiving packet with any Unicast
3878 * Ethernet MAC addresses,the packet is routed to all VFs for which the RX
3879 * mode is accept packets that match the unicast hash table.
3882 * The port identifier of the Ethernet device.
3884 * 1 - Set all unicast hash bitmaps for receiving all the Ethernet
3886 * 0 - Clear all unicast hash bitmaps
3888 * - (0) if successful.
3889 * - (-ENOTSUP) if hardware doesn't support.
3890 * - (-ENODEV) if *port_id* invalid.
3891 * - (-EINVAL) if bad parameter.
3893 int rte_eth_dev_uc_all_hash_table_set(uint16_t port, uint8_t on);
3896 * Set a traffic mirroring rule on an Ethernet device
3899 * The port identifier of the Ethernet device.
3900 * @param mirror_conf
3901 * The pointer to the traffic mirroring structure describing the mirroring rule.
3902 * The *rte_eth_vm_mirror_conf* structure includes the type of mirroring rule,
3903 * destination pool and the value of rule if enable vlan or pool mirroring.
3906 * The index of traffic mirroring rule, we support four separated rules.
3908 * 1 - Enable a mirroring rule.
3909 * 0 - Disable a mirroring rule.
3911 * - (0) if successful.
3912 * - (-ENOTSUP) if hardware doesn't support this feature.
3913 * - (-ENODEV) if *port_id* invalid.
3914 * - (-EINVAL) if the mr_conf information is not correct.
3916 int rte_eth_mirror_rule_set(uint16_t port_id,
3917 struct rte_eth_mirror_conf *mirror_conf,
3922 * Reset a traffic mirroring rule on an Ethernet device.
3925 * The port identifier of the Ethernet device.
3927 * The index of traffic mirroring rule, we support four separated rules.
3929 * - (0) if successful.
3930 * - (-ENOTSUP) if hardware doesn't support this feature.
3931 * - (-ENODEV) if *port_id* invalid.
3932 * - (-EINVAL) if bad parameter.
3934 int rte_eth_mirror_rule_reset(uint16_t port_id,
3938 * Set the rate limitation for a queue on an Ethernet device.
3941 * The port identifier of the Ethernet device.
3945 * The tx rate in Mbps. Allocated from the total port link speed.
3947 * - (0) if successful.
3948 * - (-ENOTSUP) if hardware doesn't support this feature.
3949 * - (-ENODEV) if *port_id* invalid.
3950 * - (-EINVAL) if bad parameter.
3952 int rte_eth_set_queue_rate_limit(uint16_t port_id, uint16_t queue_idx,
3956 * Configuration of Receive Side Scaling hash computation of Ethernet device.
3959 * The port identifier of the Ethernet device.
3961 * The new configuration to use for RSS hash computation on the port.
3963 * - (0) if successful.
3964 * - (-ENODEV) if port identifier is invalid.
3965 * - (-ENOTSUP) if hardware doesn't support.
3966 * - (-EINVAL) if bad parameter.
3968 int rte_eth_dev_rss_hash_update(uint16_t port_id,
3969 struct rte_eth_rss_conf *rss_conf);
3972 * Retrieve current configuration of Receive Side Scaling hash computation
3973 * of Ethernet device.
3976 * The port identifier of the Ethernet device.
3978 * Where to store the current RSS hash configuration of the Ethernet device.
3980 * - (0) if successful.
3981 * - (-ENODEV) if port identifier is invalid.
3982 * - (-ENOTSUP) if hardware doesn't support RSS.
3985 rte_eth_dev_rss_hash_conf_get(uint16_t port_id,
3986 struct rte_eth_rss_conf *rss_conf);
3989 * Add UDP tunneling port for a specific type of tunnel.
3990 * The packets with this UDP port will be identified as this type of tunnel.
3991 * Before enabling any offloading function for a tunnel, users can call this API
3992 * to change or add more UDP port for the tunnel. So the offloading function
3993 * can take effect on the packets with the specific UDP port.
3996 * The port identifier of the Ethernet device.
3998 * UDP tunneling configuration.
4001 * - (0) if successful.
4002 * - (-ENODEV) if port identifier is invalid.
4003 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4006 rte_eth_dev_udp_tunnel_port_add(uint16_t port_id,
4007 struct rte_eth_udp_tunnel *tunnel_udp);
4010 * Delete UDP tunneling port a specific type of tunnel.
4011 * The packets with this UDP port will not be identified as this type of tunnel
4013 * Before enabling any offloading function for a tunnel, users can call this API
4014 * to delete a UDP port for the tunnel. So the offloading function will not take
4015 * effect on the packets with the specific UDP port.
4018 * The port identifier of the Ethernet device.
4020 * UDP tunneling configuration.
4023 * - (0) if successful.
4024 * - (-ENODEV) if port identifier is invalid.
4025 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4028 rte_eth_dev_udp_tunnel_port_delete(uint16_t port_id,
4029 struct rte_eth_udp_tunnel *tunnel_udp);
4032 * Check whether the filter type is supported on an Ethernet device.
4033 * All the supported filter types are defined in 'rte_eth_ctrl.h'.
4036 * The port identifier of the Ethernet device.
4037 * @param filter_type
4040 * - (0) if successful.
4041 * - (-ENOTSUP) if hardware doesn't support this filter type.
4042 * - (-ENODEV) if *port_id* invalid.
4044 int rte_eth_dev_filter_supported(uint16_t port_id,
4045 enum rte_filter_type filter_type);
4048 * Take operations to assigned filter type on an Ethernet device.
4049 * All the supported operations and filter types are defined in 'rte_eth_ctrl.h'.
4052 * The port identifier of the Ethernet device.
4053 * @param filter_type
4056 * Type of operation.
4058 * A pointer to arguments defined specifically for the operation.
4060 * - (0) if successful.
4061 * - (-ENOTSUP) if hardware doesn't support.
4062 * - (-ENODEV) if *port_id* invalid.
4063 * - others depends on the specific operations implementation.
4065 int rte_eth_dev_filter_ctrl(uint16_t port_id, enum rte_filter_type filter_type,
4066 enum rte_filter_op filter_op, void *arg);
4069 * Get DCB information on an Ethernet device.
4072 * The port identifier of the Ethernet device.
4076 * - (0) if successful.
4077 * - (-ENODEV) if port identifier is invalid.
4078 * - (-ENOTSUP) if hardware doesn't support.
4080 int rte_eth_dev_get_dcb_info(uint16_t port_id,
4081 struct rte_eth_dcb_info *dcb_info);
4084 * Add a callback to be called on packet RX on a given port and queue.
4086 * This API configures a function to be called for each burst of
4087 * packets received on a given NIC port queue. The return value is a pointer
4088 * that can be used to later remove the callback using
4089 * rte_eth_remove_rx_callback().
4091 * Multiple functions are called in the order that they are added.
4094 * The port identifier of the Ethernet device.
4096 * The queue on the Ethernet device on which the callback is to be added.
4098 * The callback function
4100 * A generic pointer parameter which will be passed to each invocation of the
4101 * callback function on this port and queue.
4105 * On success, a pointer value which can later be used to remove the callback.
4107 void *rte_eth_add_rx_callback(uint16_t port_id, uint16_t queue_id,
4108 rte_rx_callback_fn fn, void *user_param);
4111 * Add a callback that must be called first on packet RX on a given port
4114 * This API configures a first function to be called for each burst of
4115 * packets received on a given NIC port queue. The return value is a pointer
4116 * that can be used to later remove the callback using
4117 * rte_eth_remove_rx_callback().
4119 * Multiple functions are called in the order that they are added.
4122 * The port identifier of the Ethernet device.
4124 * The queue on the Ethernet device on which the callback is to be added.
4126 * The callback function
4128 * A generic pointer parameter which will be passed to each invocation of the
4129 * callback function on this port and queue.
4133 * On success, a pointer value which can later be used to remove the callback.
4135 void *rte_eth_add_first_rx_callback(uint16_t port_id, uint16_t queue_id,
4136 rte_rx_callback_fn fn, void *user_param);
4139 * Add a callback to be called on packet TX on a given port and queue.
4141 * This API configures a function to be called for each burst of
4142 * packets sent on a given NIC port queue. The return value is a pointer
4143 * that can be used to later remove the callback using
4144 * rte_eth_remove_tx_callback().
4146 * Multiple functions are called in the order that they are added.
4149 * The port identifier of the Ethernet device.
4151 * The queue on the Ethernet device on which the callback is to be added.
4153 * The callback function
4155 * A generic pointer parameter which will be passed to each invocation of the
4156 * callback function on this port and queue.
4160 * On success, a pointer value which can later be used to remove the callback.
4162 void *rte_eth_add_tx_callback(uint16_t port_id, uint16_t queue_id,
4163 rte_tx_callback_fn fn, void *user_param);
4166 * Remove an RX packet callback from a given port and queue.
4168 * This function is used to removed callbacks that were added to a NIC port
4169 * queue using rte_eth_add_rx_callback().
4171 * Note: the callback is removed from the callback list but it isn't freed
4172 * since the it may still be in use. The memory for the callback can be
4173 * subsequently freed back by the application by calling rte_free():
4175 * - Immediately - if the port is stopped, or the user knows that no
4176 * callbacks are in flight e.g. if called from the thread doing RX/TX
4179 * - After a short delay - where the delay is sufficient to allow any
4180 * in-flight callbacks to complete.
4183 * The port identifier of the Ethernet device.
4185 * The queue on the Ethernet device from which the callback is to be removed.
4187 * User supplied callback created via rte_eth_add_rx_callback().
4190 * - 0: Success. Callback was removed.
4191 * - -ENOTSUP: Callback support is not available.
4192 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
4193 * is NULL or not found for the port/queue.
4195 int rte_eth_remove_rx_callback(uint16_t port_id, uint16_t queue_id,
4196 struct rte_eth_rxtx_callback *user_cb);
4199 * Remove a TX packet callback from a given port and queue.
4201 * This function is used to removed callbacks that were added to a NIC port
4202 * queue using rte_eth_add_tx_callback().
4204 * Note: the callback is removed from the callback list but it isn't freed
4205 * since the it may still be in use. The memory for the callback can be
4206 * subsequently freed back by the application by calling rte_free():
4208 * - Immediately - if the port is stopped, or the user knows that no
4209 * callbacks are in flight e.g. if called from the thread doing RX/TX
4212 * - After a short delay - where the delay is sufficient to allow any
4213 * in-flight callbacks to complete.
4216 * The port identifier of the Ethernet device.
4218 * The queue on the Ethernet device from which the callback is to be removed.
4220 * User supplied callback created via rte_eth_add_tx_callback().
4223 * - 0: Success. Callback was removed.
4224 * - -ENOTSUP: Callback support is not available.
4225 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
4226 * is NULL or not found for the port/queue.
4228 int rte_eth_remove_tx_callback(uint16_t port_id, uint16_t queue_id,
4229 struct rte_eth_rxtx_callback *user_cb);
4232 * Retrieve information about given port's RX queue.
4235 * The port identifier of the Ethernet device.
4237 * The RX queue on the Ethernet device for which information
4238 * will be retrieved.
4240 * A pointer to a structure of type *rte_eth_rxq_info_info* to be filled with
4241 * the information of the Ethernet device.
4245 * - -ENOTSUP: routine is not supported by the device PMD.
4246 * - -EINVAL: The port_id or the queue_id is out of range.
4248 int rte_eth_rx_queue_info_get(uint16_t port_id, uint16_t queue_id,
4249 struct rte_eth_rxq_info *qinfo);
4252 * Retrieve information about given port's TX queue.
4255 * The port identifier of the Ethernet device.
4257 * The TX queue on the Ethernet device for which information
4258 * will be retrieved.
4260 * A pointer to a structure of type *rte_eth_txq_info_info* to be filled with
4261 * the information of the Ethernet device.
4265 * - -ENOTSUP: routine is not supported by the device PMD.
4266 * - -EINVAL: The port_id or the queue_id is out of range.
4268 int rte_eth_tx_queue_info_get(uint16_t port_id, uint16_t queue_id,
4269 struct rte_eth_txq_info *qinfo);
4272 * Retrieve device registers and register attributes (number of registers and
4276 * The port identifier of the Ethernet device.
4278 * Pointer to rte_dev_reg_info structure to fill in. If info->data is
4279 * NULL the function fills in the width and length fields. If non-NULL
4280 * the registers are put into the buffer pointed at by the data field.
4282 * - (0) if successful.
4283 * - (-ENOTSUP) if hardware doesn't support.
4284 * - (-ENODEV) if *port_id* invalid.
4285 * - others depends on the specific operations implementation.
4287 int rte_eth_dev_get_reg_info(uint16_t port_id, struct rte_dev_reg_info *info);
4290 * Retrieve size of device EEPROM
4293 * The port identifier of the Ethernet device.
4295 * - (>=0) EEPROM size if successful.
4296 * - (-ENOTSUP) if hardware doesn't support.
4297 * - (-ENODEV) if *port_id* invalid.
4298 * - others depends on the specific operations implementation.
4300 int rte_eth_dev_get_eeprom_length(uint16_t port_id);
4303 * Retrieve EEPROM and EEPROM attribute
4306 * The port identifier of the Ethernet device.
4308 * The template includes buffer for return EEPROM data and
4309 * EEPROM attributes to be filled.
4311 * - (0) if successful.
4312 * - (-ENOTSUP) if hardware doesn't support.
4313 * - (-ENODEV) if *port_id* invalid.
4314 * - others depends on the specific operations implementation.
4316 int rte_eth_dev_get_eeprom(uint16_t port_id, struct rte_dev_eeprom_info *info);
4319 * Program EEPROM with provided data
4322 * The port identifier of the Ethernet device.
4324 * The template includes EEPROM data for programming and
4325 * EEPROM attributes to be filled
4327 * - (0) if successful.
4328 * - (-ENOTSUP) if hardware doesn't support.
4329 * - (-ENODEV) if *port_id* invalid.
4330 * - others depends on the specific operations implementation.
4332 int rte_eth_dev_set_eeprom(uint16_t port_id, struct rte_dev_eeprom_info *info);
4335 * Set the list of multicast addresses to filter on an Ethernet device.
4338 * The port identifier of the Ethernet device.
4339 * @param mc_addr_set
4340 * The array of multicast addresses to set. Equal to NULL when the function
4341 * is invoked to flush the set of filtered addresses.
4343 * The number of multicast addresses in the *mc_addr_set* array. Equal to 0
4344 * when the function is invoked to flush the set of filtered addresses.
4346 * - (0) if successful.
4347 * - (-ENODEV) if *port_id* invalid.
4348 * - (-ENOTSUP) if PMD of *port_id* doesn't support multicast filtering.
4349 * - (-ENOSPC) if *port_id* has not enough multicast filtering resources.
4351 int rte_eth_dev_set_mc_addr_list(uint16_t port_id,
4352 struct ether_addr *mc_addr_set,
4353 uint32_t nb_mc_addr);
4356 * Enable IEEE1588/802.1AS timestamping for an Ethernet device.
4359 * The port identifier of the Ethernet device.
4363 * - -ENODEV: The port ID is invalid.
4364 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4366 int rte_eth_timesync_enable(uint16_t port_id);
4369 * Disable IEEE1588/802.1AS timestamping for an Ethernet device.
4372 * The port identifier of the Ethernet device.
4376 * - -ENODEV: The port ID is invalid.
4377 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4379 int rte_eth_timesync_disable(uint16_t port_id);
4382 * Read an IEEE1588/802.1AS RX timestamp from an Ethernet device.
4385 * The port identifier of the Ethernet device.
4387 * Pointer to the timestamp struct.
4389 * Device specific flags. Used to pass the RX timesync register index to
4390 * i40e. Unused in igb/ixgbe, pass 0 instead.
4394 * - -EINVAL: No timestamp is available.
4395 * - -ENODEV: The port ID is invalid.
4396 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4398 int rte_eth_timesync_read_rx_timestamp(uint16_t port_id,
4399 struct timespec *timestamp, uint32_t flags);
4402 * Read an IEEE1588/802.1AS TX timestamp from an Ethernet device.
4405 * The port identifier of the Ethernet device.
4407 * Pointer to the timestamp struct.
4411 * - -EINVAL: No timestamp is available.
4412 * - -ENODEV: The port ID is invalid.
4413 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4415 int rte_eth_timesync_read_tx_timestamp(uint16_t port_id,
4416 struct timespec *timestamp);
4419 * Adjust the timesync clock on an Ethernet device.
4421 * This is usually used in conjunction with other Ethdev timesync functions to
4422 * synchronize the device time using the IEEE1588/802.1AS protocol.
4425 * The port identifier of the Ethernet device.
4427 * The adjustment in nanoseconds.
4431 * - -ENODEV: The port ID is invalid.
4432 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4434 int rte_eth_timesync_adjust_time(uint16_t port_id, int64_t delta);
4437 * Read the time from the timesync clock on an Ethernet device.
4439 * This is usually used in conjunction with other Ethdev timesync functions to
4440 * synchronize the device time using the IEEE1588/802.1AS protocol.
4443 * The port identifier of the Ethernet device.
4445 * Pointer to the timespec struct that holds the time.
4450 int rte_eth_timesync_read_time(uint16_t port_id, struct timespec *time);
4453 * Set the time of the timesync clock on an Ethernet device.
4455 * This is usually used in conjunction with other Ethdev timesync functions to
4456 * synchronize the device time using the IEEE1588/802.1AS protocol.
4459 * The port identifier of the Ethernet device.
4461 * Pointer to the timespec struct that holds the time.
4465 * - -EINVAL: No timestamp is available.
4466 * - -ENODEV: The port ID is invalid.
4467 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4469 int rte_eth_timesync_write_time(uint16_t port_id, const struct timespec *time);
4472 * Create memzone for HW rings.
4473 * malloc can't be used as the physical address is needed.
4474 * If the memzone is already created, then this function returns a ptr
4478 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
4480 * The name of the memory zone
4482 * The index of the queue to add to name
4484 * The sizeof of the memory area
4486 * Alignment for resulting memzone. Must be a power of 2.
4488 * The *socket_id* argument is the socket identifier in case of NUMA.
4490 const struct rte_memzone *
4491 rte_eth_dma_zone_reserve(const struct rte_eth_dev *eth_dev, const char *name,
4492 uint16_t queue_id, size_t size,
4493 unsigned align, int socket_id);
4496 * Config l2 tunnel ether type of an Ethernet device for filtering specific
4497 * tunnel packets by ether type.
4500 * The port identifier of the Ethernet device.
4502 * l2 tunnel configuration.
4505 * - (0) if successful.
4506 * - (-ENODEV) if port identifier is invalid.
4507 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4510 rte_eth_dev_l2_tunnel_eth_type_conf(uint16_t port_id,
4511 struct rte_eth_l2_tunnel_conf *l2_tunnel);
4514 * Enable/disable l2 tunnel offload functions. Include,
4515 * 1, The ability of parsing a type of l2 tunnel of an Ethernet device.
4516 * Filtering, forwarding and offloading this type of tunnel packets depend on
4518 * 2, Stripping the l2 tunnel tag.
4519 * 3, Insertion of the l2 tunnel tag.
4520 * 4, Forwarding the packets based on the l2 tunnel tag.
4523 * The port identifier of the Ethernet device.
4525 * l2 tunnel parameters.
4527 * Indicate the offload function.
4529 * Enable or disable this function.
4532 * - (0) if successful.
4533 * - (-ENODEV) if port identifier is invalid.
4534 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4537 rte_eth_dev_l2_tunnel_offload_set(uint16_t port_id,
4538 struct rte_eth_l2_tunnel_conf *l2_tunnel,
4543 * Get the port id from pci address or device name
4544 * Ex: 0000:2:00.0 or vdev name net_pcap0
4547 * pci address or name of the device
4549 * pointer to port identifier of the device
4551 * - (0) if successful and port_id is filled.
4552 * - (-ENODEV or -EINVAL) on failure.
4555 rte_eth_dev_get_port_by_name(const char *name, uint16_t *port_id);
4558 * Get the device name from port id
4561 * pointer to port identifier of the device
4563 * pci address or name of the device
4565 * - (0) if successful.
4566 * - (-EINVAL) on failure.
4569 rte_eth_dev_get_name_by_port(uint16_t port_id, char *name);
4572 * Check that numbers of Rx and Tx descriptors satisfy descriptors limits from
4573 * the ethernet device information, otherwise adjust them to boundaries.
4576 * The port identifier of the Ethernet device.
4578 * A pointer to a uint16_t where the number of receive
4579 * descriptors stored.
4581 * A pointer to a uint16_t where the number of transmit
4582 * descriptors stored.
4584 * - (0) if successful.
4585 * - (-ENOTSUP, -ENODEV or -EINVAL) on failure.
4587 int rte_eth_dev_adjust_nb_rx_tx_desc(uint16_t port_id,
4588 uint16_t *nb_rx_desc,
4589 uint16_t *nb_tx_desc);
4593 * Test if a port supports specific mempool ops.
4596 * Port identifier of the Ethernet device.
4598 * The name of the pool operations to test.
4600 * - 0: best mempool ops choice for this port.
4601 * - 1: mempool ops are supported for this port.
4602 * - -ENOTSUP: mempool ops not supported for this port.
4603 * - -ENODEV: Invalid port Identifier.
4604 * - -EINVAL: Pool param is null.
4607 rte_eth_dev_pool_ops_supported(uint16_t port_id, const char *pool);
4613 #endif /* _RTE_ETHDEV_H_ */