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_ether.h"
184 #include "rte_eth_ctrl.h"
185 #include "rte_dev_info.h"
190 * A structure used to retrieve statistics for an Ethernet port.
191 * Not all statistics fields in struct rte_eth_stats are supported
192 * by any type of network interface card (NIC). If any statistics
193 * field is not supported, its value is 0.
195 struct rte_eth_stats {
196 uint64_t ipackets; /**< Total number of successfully received packets. */
197 uint64_t opackets; /**< Total number of successfully transmitted packets.*/
198 uint64_t ibytes; /**< Total number of successfully received bytes. */
199 uint64_t obytes; /**< Total number of successfully transmitted bytes. */
201 /**< Total of RX packets dropped by the HW,
202 * because there are no available buffer (i.e. RX queues are full).
204 uint64_t ierrors; /**< Total number of erroneous received packets. */
205 uint64_t oerrors; /**< Total number of failed transmitted packets. */
206 uint64_t rx_nombuf; /**< Total number of RX mbuf allocation failures. */
207 uint64_t q_ipackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
208 /**< Total number of queue RX packets. */
209 uint64_t q_opackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
210 /**< Total number of queue TX packets. */
211 uint64_t q_ibytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
212 /**< Total number of successfully received queue bytes. */
213 uint64_t q_obytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
214 /**< Total number of successfully transmitted queue bytes. */
215 uint64_t q_errors[RTE_ETHDEV_QUEUE_STAT_CNTRS];
216 /**< Total number of queue packets received that are dropped. */
220 * Device supported speeds bitmap flags
222 #define ETH_LINK_SPEED_AUTONEG (0 << 0) /**< Autonegotiate (all speeds) */
223 #define ETH_LINK_SPEED_FIXED (1 << 0) /**< Disable autoneg (fixed speed) */
224 #define ETH_LINK_SPEED_10M_HD (1 << 1) /**< 10 Mbps half-duplex */
225 #define ETH_LINK_SPEED_10M (1 << 2) /**< 10 Mbps full-duplex */
226 #define ETH_LINK_SPEED_100M_HD (1 << 3) /**< 100 Mbps half-duplex */
227 #define ETH_LINK_SPEED_100M (1 << 4) /**< 100 Mbps full-duplex */
228 #define ETH_LINK_SPEED_1G (1 << 5) /**< 1 Gbps */
229 #define ETH_LINK_SPEED_2_5G (1 << 6) /**< 2.5 Gbps */
230 #define ETH_LINK_SPEED_5G (1 << 7) /**< 5 Gbps */
231 #define ETH_LINK_SPEED_10G (1 << 8) /**< 10 Gbps */
232 #define ETH_LINK_SPEED_20G (1 << 9) /**< 20 Gbps */
233 #define ETH_LINK_SPEED_25G (1 << 10) /**< 25 Gbps */
234 #define ETH_LINK_SPEED_40G (1 << 11) /**< 40 Gbps */
235 #define ETH_LINK_SPEED_50G (1 << 12) /**< 50 Gbps */
236 #define ETH_LINK_SPEED_56G (1 << 13) /**< 56 Gbps */
237 #define ETH_LINK_SPEED_100G (1 << 14) /**< 100 Gbps */
240 * Ethernet numeric link speeds in Mbps
242 #define ETH_SPEED_NUM_NONE 0 /**< Not defined */
243 #define ETH_SPEED_NUM_10M 10 /**< 10 Mbps */
244 #define ETH_SPEED_NUM_100M 100 /**< 100 Mbps */
245 #define ETH_SPEED_NUM_1G 1000 /**< 1 Gbps */
246 #define ETH_SPEED_NUM_2_5G 2500 /**< 2.5 Gbps */
247 #define ETH_SPEED_NUM_5G 5000 /**< 5 Gbps */
248 #define ETH_SPEED_NUM_10G 10000 /**< 10 Gbps */
249 #define ETH_SPEED_NUM_20G 20000 /**< 20 Gbps */
250 #define ETH_SPEED_NUM_25G 25000 /**< 25 Gbps */
251 #define ETH_SPEED_NUM_40G 40000 /**< 40 Gbps */
252 #define ETH_SPEED_NUM_50G 50000 /**< 50 Gbps */
253 #define ETH_SPEED_NUM_56G 56000 /**< 56 Gbps */
254 #define ETH_SPEED_NUM_100G 100000 /**< 100 Gbps */
257 * A structure used to retrieve link-level information of an Ethernet port.
260 struct rte_eth_link {
261 uint32_t link_speed; /**< ETH_SPEED_NUM_ */
262 uint16_t link_duplex : 1; /**< ETH_LINK_[HALF/FULL]_DUPLEX */
263 uint16_t link_autoneg : 1; /**< ETH_LINK_SPEED_[AUTONEG/FIXED] */
264 uint16_t link_status : 1; /**< ETH_LINK_[DOWN/UP] */
265 } __attribute__((aligned(8))); /**< aligned for atomic64 read/write */
267 /* Utility constants */
268 #define ETH_LINK_HALF_DUPLEX 0 /**< Half-duplex connection. */
269 #define ETH_LINK_FULL_DUPLEX 1 /**< Full-duplex connection. */
270 #define ETH_LINK_DOWN 0 /**< Link is down. */
271 #define ETH_LINK_UP 1 /**< Link is up. */
272 #define ETH_LINK_FIXED 0 /**< No autonegotiation. */
273 #define ETH_LINK_AUTONEG 1 /**< Autonegotiated. */
276 * A structure used to configure the ring threshold registers of an RX/TX
277 * queue for an Ethernet port.
279 struct rte_eth_thresh {
280 uint8_t pthresh; /**< Ring prefetch threshold. */
281 uint8_t hthresh; /**< Ring host threshold. */
282 uint8_t wthresh; /**< Ring writeback threshold. */
286 * Simple flags are used for rte_eth_conf.rxmode.mq_mode.
288 #define ETH_MQ_RX_RSS_FLAG 0x1
289 #define ETH_MQ_RX_DCB_FLAG 0x2
290 #define ETH_MQ_RX_VMDQ_FLAG 0x4
293 * A set of values to identify what method is to be used to route
294 * packets to multiple queues.
296 enum rte_eth_rx_mq_mode {
297 /** None of DCB,RSS or VMDQ mode */
300 /** For RX side, only RSS is on */
301 ETH_MQ_RX_RSS = ETH_MQ_RX_RSS_FLAG,
302 /** For RX side,only DCB is on. */
303 ETH_MQ_RX_DCB = ETH_MQ_RX_DCB_FLAG,
304 /** Both DCB and RSS enable */
305 ETH_MQ_RX_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG,
307 /** Only VMDQ, no RSS nor DCB */
308 ETH_MQ_RX_VMDQ_ONLY = ETH_MQ_RX_VMDQ_FLAG,
309 /** RSS mode with VMDQ */
310 ETH_MQ_RX_VMDQ_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_VMDQ_FLAG,
311 /** Use VMDQ+DCB to route traffic to queues */
312 ETH_MQ_RX_VMDQ_DCB = ETH_MQ_RX_VMDQ_FLAG | ETH_MQ_RX_DCB_FLAG,
313 /** Enable both VMDQ and DCB in VMDq */
314 ETH_MQ_RX_VMDQ_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG |
319 * for rx mq mode backward compatible
321 #define ETH_RSS ETH_MQ_RX_RSS
322 #define VMDQ_DCB ETH_MQ_RX_VMDQ_DCB
323 #define ETH_DCB_RX ETH_MQ_RX_DCB
326 * A set of values to identify what method is to be used to transmit
327 * packets using multi-TCs.
329 enum rte_eth_tx_mq_mode {
330 ETH_MQ_TX_NONE = 0, /**< It is in neither DCB nor VT mode. */
331 ETH_MQ_TX_DCB, /**< For TX side,only DCB is on. */
332 ETH_MQ_TX_VMDQ_DCB, /**< For TX side,both DCB and VT is on. */
333 ETH_MQ_TX_VMDQ_ONLY, /**< Only VT on, no DCB */
337 * for tx mq mode backward compatible
339 #define ETH_DCB_NONE ETH_MQ_TX_NONE
340 #define ETH_VMDQ_DCB_TX ETH_MQ_TX_VMDQ_DCB
341 #define ETH_DCB_TX ETH_MQ_TX_DCB
344 * A structure used to configure the RX features of an Ethernet port.
346 struct rte_eth_rxmode {
347 /** The multi-queue packet distribution mode to be used, e.g. RSS. */
348 enum rte_eth_rx_mq_mode mq_mode;
349 uint32_t max_rx_pkt_len; /**< Only used if jumbo_frame enabled. */
350 uint16_t split_hdr_size; /**< hdr buf size (header_split enabled).*/
352 * Per-port Rx offloads to be set using DEV_RX_OFFLOAD_* flags.
353 * Only offloads set on rx_offload_capa field on rte_eth_dev_info
354 * structure are allowed to be set.
359 * Below bitfield API is obsolete. Application should
360 * enable per-port offloads using the offload field
363 uint16_t header_split : 1, /**< Header Split enable. */
364 hw_ip_checksum : 1, /**< IP/UDP/TCP checksum offload enable. */
365 hw_vlan_filter : 1, /**< VLAN filter enable. */
366 hw_vlan_strip : 1, /**< VLAN strip enable. */
367 hw_vlan_extend : 1, /**< Extended VLAN enable. */
368 jumbo_frame : 1, /**< Jumbo Frame Receipt enable. */
369 hw_strip_crc : 1, /**< Enable CRC stripping by hardware. */
370 enable_scatter : 1, /**< Enable scatter packets rx handler */
371 enable_lro : 1, /**< Enable LRO */
372 hw_timestamp : 1, /**< Enable HW timestamp */
374 * When set the offload bitfield should be ignored.
375 * Instead per-port Rx offloads should be set on offloads
377 * Per-queue offloads shuold be set on rte_eth_rxq_conf
379 * This bit is temporary till rxmode bitfield offloads API will
382 ignore_offload_bitfield : 1;
386 * VLAN types to indicate if it is for single VLAN, inner VLAN or outer VLAN.
387 * Note that single VLAN is treated the same as inner VLAN.
390 ETH_VLAN_TYPE_UNKNOWN = 0,
391 ETH_VLAN_TYPE_INNER, /**< Inner VLAN. */
392 ETH_VLAN_TYPE_OUTER, /**< Single VLAN, or outer VLAN. */
397 * A structure used to describe a vlan filter.
398 * If the bit corresponding to a VID is set, such VID is on.
400 struct rte_vlan_filter_conf {
405 * A structure used to configure the Receive Side Scaling (RSS) feature
406 * of an Ethernet port.
407 * If not NULL, the *rss_key* pointer of the *rss_conf* structure points
408 * to an array holding the RSS key to use for hashing specific header
409 * fields of received packets. The length of this array should be indicated
410 * by *rss_key_len* below. Otherwise, a default random hash key is used by
413 * The *rss_key_len* field of the *rss_conf* structure indicates the length
414 * in bytes of the array pointed by *rss_key*. To be compatible, this length
415 * will be checked in i40e only. Others assume 40 bytes to be used as before.
417 * The *rss_hf* field of the *rss_conf* structure indicates the different
418 * types of IPv4/IPv6 packets to which the RSS hashing must be applied.
419 * Supplying an *rss_hf* equal to zero disables the RSS feature.
421 struct rte_eth_rss_conf {
422 uint8_t *rss_key; /**< If not NULL, 40-byte hash key. */
423 uint8_t rss_key_len; /**< hash key length in bytes. */
424 uint64_t rss_hf; /**< Hash functions to apply - see below. */
428 * The RSS offload types are defined based on flow types which are defined
429 * in rte_eth_ctrl.h. Different NIC hardwares may support different RSS offload
430 * types. The supported flow types or RSS offload types can be queried by
431 * rte_eth_dev_info_get().
433 #define ETH_RSS_IPV4 (1ULL << RTE_ETH_FLOW_IPV4)
434 #define ETH_RSS_FRAG_IPV4 (1ULL << RTE_ETH_FLOW_FRAG_IPV4)
435 #define ETH_RSS_NONFRAG_IPV4_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_TCP)
436 #define ETH_RSS_NONFRAG_IPV4_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_UDP)
437 #define ETH_RSS_NONFRAG_IPV4_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_SCTP)
438 #define ETH_RSS_NONFRAG_IPV4_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_OTHER)
439 #define ETH_RSS_IPV6 (1ULL << RTE_ETH_FLOW_IPV6)
440 #define ETH_RSS_FRAG_IPV6 (1ULL << RTE_ETH_FLOW_FRAG_IPV6)
441 #define ETH_RSS_NONFRAG_IPV6_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_TCP)
442 #define ETH_RSS_NONFRAG_IPV6_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_UDP)
443 #define ETH_RSS_NONFRAG_IPV6_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_SCTP)
444 #define ETH_RSS_NONFRAG_IPV6_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_OTHER)
445 #define ETH_RSS_L2_PAYLOAD (1ULL << RTE_ETH_FLOW_L2_PAYLOAD)
446 #define ETH_RSS_IPV6_EX (1ULL << RTE_ETH_FLOW_IPV6_EX)
447 #define ETH_RSS_IPV6_TCP_EX (1ULL << RTE_ETH_FLOW_IPV6_TCP_EX)
448 #define ETH_RSS_IPV6_UDP_EX (1ULL << RTE_ETH_FLOW_IPV6_UDP_EX)
449 #define ETH_RSS_PORT (1ULL << RTE_ETH_FLOW_PORT)
450 #define ETH_RSS_VXLAN (1ULL << RTE_ETH_FLOW_VXLAN)
451 #define ETH_RSS_GENEVE (1ULL << RTE_ETH_FLOW_GENEVE)
452 #define ETH_RSS_NVGRE (1ULL << RTE_ETH_FLOW_NVGRE)
454 #define ETH_RSS_IP ( \
456 ETH_RSS_FRAG_IPV4 | \
457 ETH_RSS_NONFRAG_IPV4_OTHER | \
459 ETH_RSS_FRAG_IPV6 | \
460 ETH_RSS_NONFRAG_IPV6_OTHER | \
463 #define ETH_RSS_UDP ( \
464 ETH_RSS_NONFRAG_IPV4_UDP | \
465 ETH_RSS_NONFRAG_IPV6_UDP | \
468 #define ETH_RSS_TCP ( \
469 ETH_RSS_NONFRAG_IPV4_TCP | \
470 ETH_RSS_NONFRAG_IPV6_TCP | \
473 #define ETH_RSS_SCTP ( \
474 ETH_RSS_NONFRAG_IPV4_SCTP | \
475 ETH_RSS_NONFRAG_IPV6_SCTP)
477 #define ETH_RSS_TUNNEL ( \
483 /**< Mask of valid RSS hash protocols */
484 #define ETH_RSS_PROTO_MASK ( \
486 ETH_RSS_FRAG_IPV4 | \
487 ETH_RSS_NONFRAG_IPV4_TCP | \
488 ETH_RSS_NONFRAG_IPV4_UDP | \
489 ETH_RSS_NONFRAG_IPV4_SCTP | \
490 ETH_RSS_NONFRAG_IPV4_OTHER | \
492 ETH_RSS_FRAG_IPV6 | \
493 ETH_RSS_NONFRAG_IPV6_TCP | \
494 ETH_RSS_NONFRAG_IPV6_UDP | \
495 ETH_RSS_NONFRAG_IPV6_SCTP | \
496 ETH_RSS_NONFRAG_IPV6_OTHER | \
497 ETH_RSS_L2_PAYLOAD | \
499 ETH_RSS_IPV6_TCP_EX | \
500 ETH_RSS_IPV6_UDP_EX | \
507 * Definitions used for redirection table entry size.
508 * Some RSS RETA sizes may not be supported by some drivers, check the
509 * documentation or the description of relevant functions for more details.
511 #define ETH_RSS_RETA_SIZE_64 64
512 #define ETH_RSS_RETA_SIZE_128 128
513 #define ETH_RSS_RETA_SIZE_256 256
514 #define ETH_RSS_RETA_SIZE_512 512
515 #define RTE_RETA_GROUP_SIZE 64
517 /* Definitions used for VMDQ and DCB functionality */
518 #define ETH_VMDQ_MAX_VLAN_FILTERS 64 /**< Maximum nb. of VMDQ vlan filters. */
519 #define ETH_DCB_NUM_USER_PRIORITIES 8 /**< Maximum nb. of DCB priorities. */
520 #define ETH_VMDQ_DCB_NUM_QUEUES 128 /**< Maximum nb. of VMDQ DCB queues. */
521 #define ETH_DCB_NUM_QUEUES 128 /**< Maximum nb. of DCB queues. */
523 /* DCB capability defines */
524 #define ETH_DCB_PG_SUPPORT 0x00000001 /**< Priority Group(ETS) support. */
525 #define ETH_DCB_PFC_SUPPORT 0x00000002 /**< Priority Flow Control support. */
527 /* Definitions used for VLAN Offload functionality */
528 #define ETH_VLAN_STRIP_OFFLOAD 0x0001 /**< VLAN Strip On/Off */
529 #define ETH_VLAN_FILTER_OFFLOAD 0x0002 /**< VLAN Filter On/Off */
530 #define ETH_VLAN_EXTEND_OFFLOAD 0x0004 /**< VLAN Extend On/Off */
532 /* Definitions used for mask VLAN setting */
533 #define ETH_VLAN_STRIP_MASK 0x0001 /**< VLAN Strip setting mask */
534 #define ETH_VLAN_FILTER_MASK 0x0002 /**< VLAN Filter setting mask*/
535 #define ETH_VLAN_EXTEND_MASK 0x0004 /**< VLAN Extend setting mask*/
536 #define ETH_VLAN_ID_MAX 0x0FFF /**< VLAN ID is in lower 12 bits*/
538 /* Definitions used for receive MAC address */
539 #define ETH_NUM_RECEIVE_MAC_ADDR 128 /**< Maximum nb. of receive mac addr. */
541 /* Definitions used for unicast hash */
542 #define ETH_VMDQ_NUM_UC_HASH_ARRAY 128 /**< Maximum nb. of UC hash array. */
544 /* Definitions used for VMDQ pool rx mode setting */
545 #define ETH_VMDQ_ACCEPT_UNTAG 0x0001 /**< accept untagged packets. */
546 #define ETH_VMDQ_ACCEPT_HASH_MC 0x0002 /**< accept packets in multicast table . */
547 #define ETH_VMDQ_ACCEPT_HASH_UC 0x0004 /**< accept packets in unicast table. */
548 #define ETH_VMDQ_ACCEPT_BROADCAST 0x0008 /**< accept broadcast packets. */
549 #define ETH_VMDQ_ACCEPT_MULTICAST 0x0010 /**< multicast promiscuous. */
551 /** Maximum nb. of vlan per mirror rule */
552 #define ETH_MIRROR_MAX_VLANS 64
554 #define ETH_MIRROR_VIRTUAL_POOL_UP 0x01 /**< Virtual Pool uplink Mirroring. */
555 #define ETH_MIRROR_UPLINK_PORT 0x02 /**< Uplink Port Mirroring. */
556 #define ETH_MIRROR_DOWNLINK_PORT 0x04 /**< Downlink Port Mirroring. */
557 #define ETH_MIRROR_VLAN 0x08 /**< VLAN Mirroring. */
558 #define ETH_MIRROR_VIRTUAL_POOL_DOWN 0x10 /**< Virtual Pool downlink Mirroring. */
561 * A structure used to configure VLAN traffic mirror of an Ethernet port.
563 struct rte_eth_vlan_mirror {
564 uint64_t vlan_mask; /**< mask for valid VLAN ID. */
565 /** VLAN ID list for vlan mirroring. */
566 uint16_t vlan_id[ETH_MIRROR_MAX_VLANS];
570 * A structure used to configure traffic mirror of an Ethernet port.
572 struct rte_eth_mirror_conf {
573 uint8_t rule_type; /**< Mirroring rule type */
574 uint8_t dst_pool; /**< Destination pool for this mirror rule. */
575 uint64_t pool_mask; /**< Bitmap of pool for pool mirroring */
576 /** VLAN ID setting for VLAN mirroring. */
577 struct rte_eth_vlan_mirror vlan;
581 * A structure used to configure 64 entries of Redirection Table of the
582 * Receive Side Scaling (RSS) feature of an Ethernet port. To configure
583 * more than 64 entries supported by hardware, an array of this structure
586 struct rte_eth_rss_reta_entry64 {
588 /**< Mask bits indicate which entries need to be updated/queried. */
589 uint16_t reta[RTE_RETA_GROUP_SIZE];
590 /**< Group of 64 redirection table entries. */
594 * This enum indicates the possible number of traffic classes
595 * in DCB configurations
597 enum rte_eth_nb_tcs {
598 ETH_4_TCS = 4, /**< 4 TCs with DCB. */
599 ETH_8_TCS = 8 /**< 8 TCs with DCB. */
603 * This enum indicates the possible number of queue pools
604 * in VMDQ configurations.
606 enum rte_eth_nb_pools {
607 ETH_8_POOLS = 8, /**< 8 VMDq pools. */
608 ETH_16_POOLS = 16, /**< 16 VMDq pools. */
609 ETH_32_POOLS = 32, /**< 32 VMDq pools. */
610 ETH_64_POOLS = 64 /**< 64 VMDq pools. */
613 /* This structure may be extended in future. */
614 struct rte_eth_dcb_rx_conf {
615 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs */
616 /** Traffic class each UP mapped to. */
617 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
620 struct rte_eth_vmdq_dcb_tx_conf {
621 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools. */
622 /** Traffic class each UP mapped to. */
623 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
626 struct rte_eth_dcb_tx_conf {
627 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs. */
628 /** Traffic class each UP mapped to. */
629 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
632 struct rte_eth_vmdq_tx_conf {
633 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq mode, 64 pools. */
637 * A structure used to configure the VMDQ+DCB feature
638 * of an Ethernet port.
640 * Using this feature, packets are routed to a pool of queues, based
641 * on the vlan id in the vlan tag, and then to a specific queue within
642 * that pool, using the user priority vlan tag field.
644 * A default pool may be used, if desired, to route all traffic which
645 * does not match the vlan filter rules.
647 struct rte_eth_vmdq_dcb_conf {
648 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools */
649 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
650 uint8_t default_pool; /**< The default pool, if applicable */
651 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
653 uint16_t vlan_id; /**< The vlan id of the received frame */
654 uint64_t pools; /**< Bitmask of pools for packet rx */
655 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
656 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
657 /**< Selects a queue in a pool */
661 * A structure used to configure the VMDQ feature of an Ethernet port when
662 * not combined with the DCB feature.
664 * Using this feature, packets are routed to a pool of queues. By default,
665 * the pool selection is based on the MAC address, the vlan id in the
666 * vlan tag as specified in the pool_map array.
667 * Passing the ETH_VMDQ_ACCEPT_UNTAG in the rx_mode field allows pool
668 * selection using only the MAC address. MAC address to pool mapping is done
669 * using the rte_eth_dev_mac_addr_add function, with the pool parameter
670 * corresponding to the pool id.
672 * Queue selection within the selected pool will be done using RSS when
673 * it is enabled or revert to the first queue of the pool if not.
675 * A default pool may be used, if desired, to route all traffic which
676 * does not match the vlan filter rules or any pool MAC address.
678 struct rte_eth_vmdq_rx_conf {
679 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq only mode, 8 or 64 pools */
680 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
681 uint8_t default_pool; /**< The default pool, if applicable */
682 uint8_t enable_loop_back; /**< Enable VT loop back */
683 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
684 uint32_t rx_mode; /**< Flags from ETH_VMDQ_ACCEPT_* */
686 uint16_t vlan_id; /**< The vlan id of the received frame */
687 uint64_t pools; /**< Bitmask of pools for packet rx */
688 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
692 * A structure used to configure the TX features of an Ethernet port.
694 struct rte_eth_txmode {
695 enum rte_eth_tx_mq_mode mq_mode; /**< TX multi-queues mode. */
697 * Per-port Tx offloads to be set using DEV_TX_OFFLOAD_* flags.
698 * Only offloads set on tx_offload_capa field on rte_eth_dev_info
699 * structure are allowed to be set.
703 /* For i40e specifically */
706 uint8_t hw_vlan_reject_tagged : 1,
707 /**< If set, reject sending out tagged pkts */
708 hw_vlan_reject_untagged : 1,
709 /**< If set, reject sending out untagged pkts */
710 hw_vlan_insert_pvid : 1;
711 /**< If set, enable port based VLAN insertion */
715 * A structure used to configure an RX ring of an Ethernet port.
717 struct rte_eth_rxconf {
718 struct rte_eth_thresh rx_thresh; /**< RX ring threshold registers. */
719 uint16_t rx_free_thresh; /**< Drives the freeing of RX descriptors. */
720 uint8_t rx_drop_en; /**< Drop packets if no descriptors are available. */
721 uint8_t rx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
723 * Per-queue Rx offloads to be set using DEV_RX_OFFLOAD_* flags.
724 * Only offloads set on rx_queue_offload_capa or rx_offload_capa
725 * fields on rte_eth_dev_info structure are allowed to be set.
730 #define ETH_TXQ_FLAGS_NOMULTSEGS 0x0001 /**< nb_segs=1 for all mbufs */
731 #define ETH_TXQ_FLAGS_NOREFCOUNT 0x0002 /**< refcnt can be ignored */
732 #define ETH_TXQ_FLAGS_NOMULTMEMP 0x0004 /**< all bufs come from same mempool */
733 #define ETH_TXQ_FLAGS_NOVLANOFFL 0x0100 /**< disable VLAN offload */
734 #define ETH_TXQ_FLAGS_NOXSUMSCTP 0x0200 /**< disable SCTP checksum offload */
735 #define ETH_TXQ_FLAGS_NOXSUMUDP 0x0400 /**< disable UDP checksum offload */
736 #define ETH_TXQ_FLAGS_NOXSUMTCP 0x0800 /**< disable TCP checksum offload */
737 #define ETH_TXQ_FLAGS_NOOFFLOADS \
738 (ETH_TXQ_FLAGS_NOVLANOFFL | ETH_TXQ_FLAGS_NOXSUMSCTP | \
739 ETH_TXQ_FLAGS_NOXSUMUDP | ETH_TXQ_FLAGS_NOXSUMTCP)
740 #define ETH_TXQ_FLAGS_NOXSUMS \
741 (ETH_TXQ_FLAGS_NOXSUMSCTP | ETH_TXQ_FLAGS_NOXSUMUDP | \
742 ETH_TXQ_FLAGS_NOXSUMTCP)
744 * When set the txq_flags should be ignored,
745 * instead per-queue Tx offloads will be set on offloads field
746 * located on rte_eth_txq_conf struct.
747 * This flag is temporary till the rte_eth_txq_conf.txq_flags
748 * API will be deprecated.
750 #define ETH_TXQ_FLAGS_IGNORE 0x8000
753 * A structure used to configure a TX ring of an Ethernet port.
755 struct rte_eth_txconf {
756 struct rte_eth_thresh tx_thresh; /**< TX ring threshold registers. */
757 uint16_t tx_rs_thresh; /**< Drives the setting of RS bit on TXDs. */
758 uint16_t tx_free_thresh; /**< Start freeing TX buffers if there are
759 less free descriptors than this value. */
761 uint32_t txq_flags; /**< Set flags for the Tx queue */
762 uint8_t tx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
764 * Per-queue Tx offloads to be set using DEV_TX_OFFLOAD_* flags.
765 * Only offloads set on tx_queue_offload_capa or tx_offload_capa
766 * fields on rte_eth_dev_info structure are allowed to be set.
772 * A structure contains information about HW descriptor ring limitations.
774 struct rte_eth_desc_lim {
775 uint16_t nb_max; /**< Max allowed number of descriptors. */
776 uint16_t nb_min; /**< Min allowed number of descriptors. */
777 uint16_t nb_align; /**< Number of descriptors should be aligned to. */
780 * Max allowed number of segments per whole packet.
782 * - For TSO packet this is the total number of data descriptors allowed
785 * @see nb_mtu_seg_max
790 * Max number of segments per one MTU.
792 * - For non-TSO packet, this is the maximum allowed number of segments
793 * in a single transmit packet.
795 * - For TSO packet each segment within the TSO may span up to this
800 uint16_t nb_mtu_seg_max;
804 * This enum indicates the flow control mode
806 enum rte_eth_fc_mode {
807 RTE_FC_NONE = 0, /**< Disable flow control. */
808 RTE_FC_RX_PAUSE, /**< RX pause frame, enable flowctrl on TX side. */
809 RTE_FC_TX_PAUSE, /**< TX pause frame, enable flowctrl on RX side. */
810 RTE_FC_FULL /**< Enable flow control on both side. */
814 * A structure used to configure Ethernet flow control parameter.
815 * These parameters will be configured into the register of the NIC.
816 * Please refer to the corresponding data sheet for proper value.
818 struct rte_eth_fc_conf {
819 uint32_t high_water; /**< High threshold value to trigger XOFF */
820 uint32_t low_water; /**< Low threshold value to trigger XON */
821 uint16_t pause_time; /**< Pause quota in the Pause frame */
822 uint16_t send_xon; /**< Is XON frame need be sent */
823 enum rte_eth_fc_mode mode; /**< Link flow control mode */
824 uint8_t mac_ctrl_frame_fwd; /**< Forward MAC control frames */
825 uint8_t autoneg; /**< Use Pause autoneg */
829 * A structure used to configure Ethernet priority flow control parameter.
830 * These parameters will be configured into the register of the NIC.
831 * Please refer to the corresponding data sheet for proper value.
833 struct rte_eth_pfc_conf {
834 struct rte_eth_fc_conf fc; /**< General flow control parameter. */
835 uint8_t priority; /**< VLAN User Priority. */
839 * Memory space that can be configured to store Flow Director filters
840 * in the board memory.
842 enum rte_fdir_pballoc_type {
843 RTE_FDIR_PBALLOC_64K = 0, /**< 64k. */
844 RTE_FDIR_PBALLOC_128K, /**< 128k. */
845 RTE_FDIR_PBALLOC_256K, /**< 256k. */
849 * Select report mode of FDIR hash information in RX descriptors.
851 enum rte_fdir_status_mode {
852 RTE_FDIR_NO_REPORT_STATUS = 0, /**< Never report FDIR hash. */
853 RTE_FDIR_REPORT_STATUS, /**< Only report FDIR hash for matching pkts. */
854 RTE_FDIR_REPORT_STATUS_ALWAYS, /**< Always report FDIR hash. */
858 * A structure used to configure the Flow Director (FDIR) feature
859 * of an Ethernet port.
861 * If mode is RTE_FDIR_DISABLE, the pballoc value is ignored.
863 struct rte_fdir_conf {
864 enum rte_fdir_mode mode; /**< Flow Director mode. */
865 enum rte_fdir_pballoc_type pballoc; /**< Space for FDIR filters. */
866 enum rte_fdir_status_mode status; /**< How to report FDIR hash. */
867 /** RX queue of packets matching a "drop" filter in perfect mode. */
869 struct rte_eth_fdir_masks mask;
870 struct rte_eth_fdir_flex_conf flex_conf;
871 /**< Flex payload configuration. */
875 * UDP tunneling configuration.
876 * Used to config the UDP port for a type of tunnel.
877 * NICs need the UDP port to identify the tunnel type.
878 * Normally a type of tunnel has a default UDP port, this structure can be used
879 * in case if the users want to change or support more UDP port.
881 struct rte_eth_udp_tunnel {
882 uint16_t udp_port; /**< UDP port used for the tunnel. */
883 uint8_t prot_type; /**< Tunnel type. Defined in rte_eth_tunnel_type. */
887 * A structure used to enable/disable specific device interrupts.
889 struct rte_intr_conf {
890 /** enable/disable lsc interrupt. 0 (default) - disable, 1 enable */
892 /** enable/disable rxq interrupt. 0 (default) - disable, 1 enable */
894 /** enable/disable rmv interrupt. 0 (default) - disable, 1 enable */
899 * A structure used to configure an Ethernet port.
900 * Depending upon the RX multi-queue mode, extra advanced
901 * configuration settings may be needed.
903 struct rte_eth_conf {
904 uint32_t link_speeds; /**< bitmap of ETH_LINK_SPEED_XXX of speeds to be
905 used. ETH_LINK_SPEED_FIXED disables link
906 autonegotiation, and a unique speed shall be
907 set. Otherwise, the bitmap defines the set of
908 speeds to be advertised. If the special value
909 ETH_LINK_SPEED_AUTONEG (0) is used, all speeds
910 supported are advertised. */
911 struct rte_eth_rxmode rxmode; /**< Port RX configuration. */
912 struct rte_eth_txmode txmode; /**< Port TX configuration. */
913 uint32_t lpbk_mode; /**< Loopback operation mode. By default the value
914 is 0, meaning the loopback mode is disabled.
915 Read the datasheet of given ethernet controller
916 for details. The possible values of this field
917 are defined in implementation of each driver. */
919 struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
920 struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
921 /**< Port vmdq+dcb configuration. */
922 struct rte_eth_dcb_rx_conf dcb_rx_conf;
923 /**< Port dcb RX configuration. */
924 struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
925 /**< Port vmdq RX configuration. */
926 } rx_adv_conf; /**< Port RX filtering configuration. */
928 struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
929 /**< Port vmdq+dcb TX configuration. */
930 struct rte_eth_dcb_tx_conf dcb_tx_conf;
931 /**< Port dcb TX configuration. */
932 struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
933 /**< Port vmdq TX configuration. */
934 } tx_adv_conf; /**< Port TX DCB configuration (union). */
935 /** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
936 is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
937 uint32_t dcb_capability_en;
938 struct rte_fdir_conf fdir_conf; /**< FDIR configuration. */
939 struct rte_intr_conf intr_conf; /**< Interrupt mode configuration. */
943 * A structure used to retrieve the contextual information of
944 * an Ethernet device, such as the controlling driver of the device,
945 * its PCI context, etc...
949 * RX offload capabilities of a device.
951 #define DEV_RX_OFFLOAD_VLAN_STRIP 0x00000001
952 #define DEV_RX_OFFLOAD_IPV4_CKSUM 0x00000002
953 #define DEV_RX_OFFLOAD_UDP_CKSUM 0x00000004
954 #define DEV_RX_OFFLOAD_TCP_CKSUM 0x00000008
955 #define DEV_RX_OFFLOAD_TCP_LRO 0x00000010
956 #define DEV_RX_OFFLOAD_QINQ_STRIP 0x00000020
957 #define DEV_RX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000040
958 #define DEV_RX_OFFLOAD_MACSEC_STRIP 0x00000080
959 #define DEV_RX_OFFLOAD_HEADER_SPLIT 0x00000100
960 #define DEV_RX_OFFLOAD_VLAN_FILTER 0x00000200
961 #define DEV_RX_OFFLOAD_VLAN_EXTEND 0x00000400
962 #define DEV_RX_OFFLOAD_JUMBO_FRAME 0x00000800
963 #define DEV_RX_OFFLOAD_CRC_STRIP 0x00001000
964 #define DEV_RX_OFFLOAD_SCATTER 0x00002000
965 #define DEV_RX_OFFLOAD_TIMESTAMP 0x00004000
966 #define DEV_RX_OFFLOAD_CHECKSUM (DEV_RX_OFFLOAD_IPV4_CKSUM | \
967 DEV_RX_OFFLOAD_UDP_CKSUM | \
968 DEV_RX_OFFLOAD_TCP_CKSUM)
969 #define DEV_RX_OFFLOAD_VLAN (DEV_RX_OFFLOAD_VLAN_STRIP | \
970 DEV_RX_OFFLOAD_VLAN_FILTER | \
971 DEV_RX_OFFLOAD_VLAN_EXTEND)
974 * TX offload capabilities of a device.
976 #define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001
977 #define DEV_TX_OFFLOAD_IPV4_CKSUM 0x00000002
978 #define DEV_TX_OFFLOAD_UDP_CKSUM 0x00000004
979 #define DEV_TX_OFFLOAD_TCP_CKSUM 0x00000008
980 #define DEV_TX_OFFLOAD_SCTP_CKSUM 0x00000010
981 #define DEV_TX_OFFLOAD_TCP_TSO 0x00000020
982 #define DEV_TX_OFFLOAD_UDP_TSO 0x00000040
983 #define DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000080 /**< Used for tunneling packet. */
984 #define DEV_TX_OFFLOAD_QINQ_INSERT 0x00000100
985 #define DEV_TX_OFFLOAD_VXLAN_TNL_TSO 0x00000200 /**< Used for tunneling packet. */
986 #define DEV_TX_OFFLOAD_GRE_TNL_TSO 0x00000400 /**< Used for tunneling packet. */
987 #define DEV_TX_OFFLOAD_IPIP_TNL_TSO 0x00000800 /**< Used for tunneling packet. */
988 #define DEV_TX_OFFLOAD_GENEVE_TNL_TSO 0x00001000 /**< Used for tunneling packet. */
989 #define DEV_TX_OFFLOAD_MACSEC_INSERT 0x00002000
990 #define DEV_TX_OFFLOAD_MT_LOCKFREE 0x00004000
991 /**< Multiple threads can invoke rte_eth_tx_burst() concurrently on the same
992 * tx queue without SW lock.
994 #define DEV_TX_OFFLOAD_MULTI_SEGS 0x00008000
995 /**< Device supports multi segment send. */
996 #define DEV_TX_OFFLOAD_MBUF_FAST_FREE 0x00010000
997 /**< Device supports optimization for fast release of mbufs.
998 * When set application must guarantee that per-queue all mbufs comes from
999 * the same mempool and has refcnt = 1.
1002 struct rte_pci_device;
1005 * Ethernet device information
1007 struct rte_eth_dev_info {
1008 struct rte_pci_device *pci_dev; /**< Device PCI information. */
1009 const char *driver_name; /**< Device Driver name. */
1010 unsigned int if_index; /**< Index to bound host interface, or 0 if none.
1011 Use if_indextoname() to translate into an interface name. */
1012 uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
1013 uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
1014 uint16_t max_rx_queues; /**< Maximum number of RX queues. */
1015 uint16_t max_tx_queues; /**< Maximum number of TX queues. */
1016 uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
1017 uint32_t max_hash_mac_addrs;
1018 /** Maximum number of hash MAC addresses for MTA and UTA. */
1019 uint16_t max_vfs; /**< Maximum number of VFs. */
1020 uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
1021 uint64_t rx_offload_capa;
1022 /**< Device per port RX offload capabilities. */
1023 uint64_t tx_offload_capa;
1024 /**< Device per port TX offload capabilities. */
1025 uint64_t rx_queue_offload_capa;
1026 /**< Device per queue RX offload capabilities. */
1027 uint64_t tx_queue_offload_capa;
1028 /**< Device per queue TX offload capabilities. */
1030 /**< Device redirection table size, the total number of entries. */
1031 uint8_t hash_key_size; /**< Hash key size in bytes */
1032 /** Bit mask of RSS offloads, the bit offset also means flow type */
1033 uint64_t flow_type_rss_offloads;
1034 struct rte_eth_rxconf default_rxconf; /**< Default RX configuration */
1035 struct rte_eth_txconf default_txconf; /**< Default TX configuration */
1036 uint16_t vmdq_queue_base; /**< First queue ID for VMDQ pools. */
1037 uint16_t vmdq_queue_num; /**< Queue number for VMDQ pools. */
1038 uint16_t vmdq_pool_base; /**< First ID of VMDQ pools. */
1039 struct rte_eth_desc_lim rx_desc_lim; /**< RX descriptors limits */
1040 struct rte_eth_desc_lim tx_desc_lim; /**< TX descriptors limits */
1041 uint32_t speed_capa; /**< Supported speeds bitmap (ETH_LINK_SPEED_). */
1042 /** Configured number of rx/tx queues */
1043 uint16_t nb_rx_queues; /**< Number of RX queues. */
1044 uint16_t nb_tx_queues; /**< Number of TX queues. */
1048 * Ethernet device RX queue information structure.
1049 * Used to retieve information about configured queue.
1051 struct rte_eth_rxq_info {
1052 struct rte_mempool *mp; /**< mempool used by that queue. */
1053 struct rte_eth_rxconf conf; /**< queue config parameters. */
1054 uint8_t scattered_rx; /**< scattered packets RX supported. */
1055 uint16_t nb_desc; /**< configured number of RXDs. */
1056 } __rte_cache_min_aligned;
1059 * Ethernet device TX queue information structure.
1060 * Used to retieve information about configured queue.
1062 struct rte_eth_txq_info {
1063 struct rte_eth_txconf conf; /**< queue config parameters. */
1064 uint16_t nb_desc; /**< configured number of TXDs. */
1065 } __rte_cache_min_aligned;
1067 /** Maximum name length for extended statistics counters */
1068 #define RTE_ETH_XSTATS_NAME_SIZE 64
1071 * An Ethernet device extended statistic structure
1073 * This structure is used by rte_eth_xstats_get() to provide
1074 * statistics that are not provided in the generic *rte_eth_stats*
1076 * It maps a name id, corresponding to an index in the array returned
1077 * by rte_eth_xstats_get_names(), to a statistic value.
1079 struct rte_eth_xstat {
1080 uint64_t id; /**< The index in xstats name array. */
1081 uint64_t value; /**< The statistic counter value. */
1085 * A name element for extended statistics.
1087 * An array of this structure is returned by rte_eth_xstats_get_names().
1088 * It lists the names of extended statistics for a PMD. The *rte_eth_xstat*
1089 * structure references these names by their array index.
1091 struct rte_eth_xstat_name {
1092 char name[RTE_ETH_XSTATS_NAME_SIZE]; /**< The statistic name. */
1095 #define ETH_DCB_NUM_TCS 8
1096 #define ETH_MAX_VMDQ_POOL 64
1099 * A structure used to get the information of queue and
1100 * TC mapping on both TX and RX paths.
1102 struct rte_eth_dcb_tc_queue_mapping {
1103 /** rx queues assigned to tc per Pool */
1107 } tc_rxq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
1108 /** rx queues assigned to tc per Pool */
1112 } tc_txq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
1116 * A structure used to get the information of DCB.
1117 * It includes TC UP mapping and queue TC mapping.
1119 struct rte_eth_dcb_info {
1120 uint8_t nb_tcs; /**< number of TCs */
1121 uint8_t prio_tc[ETH_DCB_NUM_USER_PRIORITIES]; /**< Priority to tc */
1122 uint8_t tc_bws[ETH_DCB_NUM_TCS]; /**< TX BW percentage for each TC */
1123 /** rx queues assigned to tc */
1124 struct rte_eth_dcb_tc_queue_mapping tc_queue;
1128 * RX/TX queue states
1130 #define RTE_ETH_QUEUE_STATE_STOPPED 0
1131 #define RTE_ETH_QUEUE_STATE_STARTED 1
1135 struct rte_eth_dev_callback;
1136 /** @internal Structure to keep track of registered callbacks */
1137 TAILQ_HEAD(rte_eth_dev_cb_list, rte_eth_dev_callback);
1139 /* Macros to check for valid port */
1140 #define RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, retval) do { \
1141 if (!rte_eth_dev_is_valid_port(port_id)) { \
1142 RTE_PMD_DEBUG_TRACE("Invalid port_id=%d\n", port_id); \
1147 #define RTE_ETH_VALID_PORTID_OR_RET(port_id) do { \
1148 if (!rte_eth_dev_is_valid_port(port_id)) { \
1149 RTE_PMD_DEBUG_TRACE("Invalid port_id=%d\n", port_id); \
1154 #define RTE_ETH_DEV_TO_PCI(eth_dev) RTE_DEV_TO_PCI((eth_dev)->device)
1157 * l2 tunnel configuration.
1160 /**< l2 tunnel enable mask */
1161 #define ETH_L2_TUNNEL_ENABLE_MASK 0x00000001
1162 /**< l2 tunnel insertion mask */
1163 #define ETH_L2_TUNNEL_INSERTION_MASK 0x00000002
1164 /**< l2 tunnel stripping mask */
1165 #define ETH_L2_TUNNEL_STRIPPING_MASK 0x00000004
1166 /**< l2 tunnel forwarding mask */
1167 #define ETH_L2_TUNNEL_FORWARDING_MASK 0x00000008
1170 * Definitions of all functions exported by an Ethernet driver through the
1171 * the generic structure of type *eth_dev_ops* supplied in the *rte_eth_dev*
1172 * structure associated with an Ethernet device.
1175 typedef int (*eth_dev_configure_t)(struct rte_eth_dev *dev);
1176 /**< @internal Ethernet device configuration. */
1178 typedef int (*eth_dev_start_t)(struct rte_eth_dev *dev);
1179 /**< @internal Function used to start a configured Ethernet device. */
1181 typedef void (*eth_dev_stop_t)(struct rte_eth_dev *dev);
1182 /**< @internal Function used to stop a configured Ethernet device. */
1184 typedef int (*eth_dev_set_link_up_t)(struct rte_eth_dev *dev);
1185 /**< @internal Function used to link up a configured Ethernet device. */
1187 typedef int (*eth_dev_set_link_down_t)(struct rte_eth_dev *dev);
1188 /**< @internal Function used to link down a configured Ethernet device. */
1190 typedef void (*eth_dev_close_t)(struct rte_eth_dev *dev);
1191 /**< @internal Function used to close a configured Ethernet device. */
1193 typedef int (*eth_dev_reset_t)(struct rte_eth_dev *dev);
1194 /** <@internal Function used to reset a configured Ethernet device. */
1196 typedef void (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev);
1197 /**< @internal Function used to enable the RX promiscuous mode of an Ethernet device. */
1199 typedef void (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev);
1200 /**< @internal Function used to disable the RX promiscuous mode of an Ethernet device. */
1202 typedef void (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
1203 /**< @internal Enable the receipt of all multicast packets by an Ethernet device. */
1205 typedef void (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
1206 /**< @internal Disable the receipt of all multicast packets by an Ethernet device. */
1208 typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
1209 int wait_to_complete);
1210 /**< @internal Get link speed, duplex mode and state (up/down) of an Ethernet device. */
1212 typedef int (*eth_stats_get_t)(struct rte_eth_dev *dev,
1213 struct rte_eth_stats *igb_stats);
1214 /**< @internal Get global I/O statistics of an Ethernet device. */
1216 typedef void (*eth_stats_reset_t)(struct rte_eth_dev *dev);
1217 /**< @internal Reset global I/O statistics of an Ethernet device to 0. */
1219 typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev,
1220 struct rte_eth_xstat *stats, unsigned n);
1221 /**< @internal Get extended stats of an Ethernet device. */
1223 typedef int (*eth_xstats_get_by_id_t)(struct rte_eth_dev *dev,
1224 const uint64_t *ids,
1227 /**< @internal Get extended stats of an Ethernet device. */
1229 typedef void (*eth_xstats_reset_t)(struct rte_eth_dev *dev);
1230 /**< @internal Reset extended stats of an Ethernet device. */
1232 typedef int (*eth_xstats_get_names_t)(struct rte_eth_dev *dev,
1233 struct rte_eth_xstat_name *xstats_names, unsigned size);
1234 /**< @internal Get names of extended stats of an Ethernet device. */
1236 typedef int (*eth_xstats_get_names_by_id_t)(struct rte_eth_dev *dev,
1237 struct rte_eth_xstat_name *xstats_names, const uint64_t *ids,
1239 /**< @internal Get names of extended stats of an Ethernet device. */
1241 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
1245 /**< @internal Set a queue statistics mapping for a tx/rx queue of an Ethernet device. */
1247 typedef void (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
1248 struct rte_eth_dev_info *dev_info);
1249 /**< @internal Get specific informations of an Ethernet device. */
1251 typedef const uint32_t *(*eth_dev_supported_ptypes_get_t)(struct rte_eth_dev *dev);
1252 /**< @internal Get supported ptypes of an Ethernet device. */
1254 typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
1256 /**< @internal Start rx and tx of a queue of an Ethernet device. */
1258 typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
1260 /**< @internal Stop rx and tx of a queue of an Ethernet device. */
1262 typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
1263 uint16_t rx_queue_id,
1264 uint16_t nb_rx_desc,
1265 unsigned int socket_id,
1266 const struct rte_eth_rxconf *rx_conf,
1267 struct rte_mempool *mb_pool);
1268 /**< @internal Set up a receive queue of an Ethernet device. */
1270 typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
1271 uint16_t tx_queue_id,
1272 uint16_t nb_tx_desc,
1273 unsigned int socket_id,
1274 const struct rte_eth_txconf *tx_conf);
1275 /**< @internal Setup a transmit queue of an Ethernet device. */
1277 typedef int (*eth_rx_enable_intr_t)(struct rte_eth_dev *dev,
1278 uint16_t rx_queue_id);
1279 /**< @internal Enable interrupt of a receive queue of an Ethernet device. */
1281 typedef int (*eth_rx_disable_intr_t)(struct rte_eth_dev *dev,
1282 uint16_t rx_queue_id);
1283 /**< @internal Disable interrupt of a receive queue of an Ethernet device. */
1285 typedef void (*eth_queue_release_t)(void *queue);
1286 /**< @internal Release memory resources allocated by given RX/TX queue. */
1288 typedef uint32_t (*eth_rx_queue_count_t)(struct rte_eth_dev *dev,
1289 uint16_t rx_queue_id);
1290 /**< @internal Get number of used descriptors on a receive queue. */
1292 typedef int (*eth_rx_descriptor_done_t)(void *rxq, uint16_t offset);
1293 /**< @internal Check DD bit of specific RX descriptor */
1295 typedef int (*eth_rx_descriptor_status_t)(void *rxq, uint16_t offset);
1296 /**< @internal Check the status of a Rx descriptor */
1298 typedef int (*eth_tx_descriptor_status_t)(void *txq, uint16_t offset);
1299 /**< @internal Check the status of a Tx descriptor */
1301 typedef int (*eth_fw_version_get_t)(struct rte_eth_dev *dev,
1302 char *fw_version, size_t fw_size);
1303 /**< @internal Get firmware information of an Ethernet device. */
1305 typedef int (*eth_tx_done_cleanup_t)(void *txq, uint32_t free_cnt);
1306 /**< @internal Force mbufs to be from TX ring. */
1308 typedef void (*eth_rxq_info_get_t)(struct rte_eth_dev *dev,
1309 uint16_t rx_queue_id, struct rte_eth_rxq_info *qinfo);
1311 typedef void (*eth_txq_info_get_t)(struct rte_eth_dev *dev,
1312 uint16_t tx_queue_id, struct rte_eth_txq_info *qinfo);
1314 typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);
1315 /**< @internal Set MTU. */
1317 typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
1320 /**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */
1322 typedef int (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
1323 enum rte_vlan_type type, uint16_t tpid);
1324 /**< @internal set the outer/inner VLAN-TPID by an Ethernet device. */
1326 typedef void (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
1327 /**< @internal set VLAN offload function by an Ethernet device. */
1329 typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
1332 /**< @internal set port based TX VLAN insertion by an Ethernet device. */
1334 typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
1335 uint16_t rx_queue_id,
1337 /**< @internal VLAN stripping enable/disable by an queue of Ethernet device. */
1339 typedef uint16_t (*eth_rx_burst_t)(void *rxq,
1340 struct rte_mbuf **rx_pkts,
1342 /**< @internal Retrieve input packets from a receive queue of an Ethernet device. */
1344 typedef uint16_t (*eth_tx_burst_t)(void *txq,
1345 struct rte_mbuf **tx_pkts,
1347 /**< @internal Send output packets on a transmit queue of an Ethernet device. */
1349 typedef uint16_t (*eth_tx_prep_t)(void *txq,
1350 struct rte_mbuf **tx_pkts,
1352 /**< @internal Prepare output packets on a transmit queue of an Ethernet device. */
1354 typedef int (*flow_ctrl_get_t)(struct rte_eth_dev *dev,
1355 struct rte_eth_fc_conf *fc_conf);
1356 /**< @internal Get current flow control parameter on an Ethernet device */
1358 typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
1359 struct rte_eth_fc_conf *fc_conf);
1360 /**< @internal Setup flow control parameter on an Ethernet device */
1362 typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
1363 struct rte_eth_pfc_conf *pfc_conf);
1364 /**< @internal Setup priority flow control parameter on an Ethernet device */
1366 typedef int (*reta_update_t)(struct rte_eth_dev *dev,
1367 struct rte_eth_rss_reta_entry64 *reta_conf,
1368 uint16_t reta_size);
1369 /**< @internal Update RSS redirection table on an Ethernet device */
1371 typedef int (*reta_query_t)(struct rte_eth_dev *dev,
1372 struct rte_eth_rss_reta_entry64 *reta_conf,
1373 uint16_t reta_size);
1374 /**< @internal Query RSS redirection table on an Ethernet device */
1376 typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
1377 struct rte_eth_rss_conf *rss_conf);
1378 /**< @internal Update RSS hash configuration of an Ethernet device */
1380 typedef int (*rss_hash_conf_get_t)(struct rte_eth_dev *dev,
1381 struct rte_eth_rss_conf *rss_conf);
1382 /**< @internal Get current RSS hash configuration of an Ethernet device */
1384 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
1385 /**< @internal Turn on SW controllable LED on an Ethernet device */
1387 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
1388 /**< @internal Turn off SW controllable LED on an Ethernet device */
1390 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
1391 /**< @internal Remove MAC address from receive address register */
1393 typedef int (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
1394 struct ether_addr *mac_addr,
1397 /**< @internal Set a MAC address into Receive Address Address Register */
1399 typedef void (*eth_mac_addr_set_t)(struct rte_eth_dev *dev,
1400 struct ether_addr *mac_addr);
1401 /**< @internal Set a MAC address into Receive Address Address Register */
1403 typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
1404 struct ether_addr *mac_addr,
1406 /**< @internal Set a Unicast Hash bitmap */
1408 typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
1410 /**< @internal Set all Unicast Hash bitmap */
1412 typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
1415 /**< @internal Set queue TX rate */
1417 typedef int (*eth_mirror_rule_set_t)(struct rte_eth_dev *dev,
1418 struct rte_eth_mirror_conf *mirror_conf,
1421 /**< @internal Add a traffic mirroring rule on an Ethernet device */
1423 typedef int (*eth_mirror_rule_reset_t)(struct rte_eth_dev *dev,
1425 /**< @internal Remove a traffic mirroring rule on an Ethernet device */
1427 typedef int (*eth_udp_tunnel_port_add_t)(struct rte_eth_dev *dev,
1428 struct rte_eth_udp_tunnel *tunnel_udp);
1429 /**< @internal Add tunneling UDP port */
1431 typedef int (*eth_udp_tunnel_port_del_t)(struct rte_eth_dev *dev,
1432 struct rte_eth_udp_tunnel *tunnel_udp);
1433 /**< @internal Delete tunneling UDP port */
1435 typedef int (*eth_set_mc_addr_list_t)(struct rte_eth_dev *dev,
1436 struct ether_addr *mc_addr_set,
1437 uint32_t nb_mc_addr);
1438 /**< @internal set the list of multicast addresses on an Ethernet device */
1440 typedef int (*eth_timesync_enable_t)(struct rte_eth_dev *dev);
1441 /**< @internal Function used to enable IEEE1588/802.1AS timestamping. */
1443 typedef int (*eth_timesync_disable_t)(struct rte_eth_dev *dev);
1444 /**< @internal Function used to disable IEEE1588/802.1AS timestamping. */
1446 typedef int (*eth_timesync_read_rx_timestamp_t)(struct rte_eth_dev *dev,
1447 struct timespec *timestamp,
1449 /**< @internal Function used to read an RX IEEE1588/802.1AS timestamp. */
1451 typedef int (*eth_timesync_read_tx_timestamp_t)(struct rte_eth_dev *dev,
1452 struct timespec *timestamp);
1453 /**< @internal Function used to read a TX IEEE1588/802.1AS timestamp. */
1455 typedef int (*eth_timesync_adjust_time)(struct rte_eth_dev *dev, int64_t);
1456 /**< @internal Function used to adjust the device clock */
1458 typedef int (*eth_timesync_read_time)(struct rte_eth_dev *dev,
1459 struct timespec *timestamp);
1460 /**< @internal Function used to get time from the device clock. */
1462 typedef int (*eth_timesync_write_time)(struct rte_eth_dev *dev,
1463 const struct timespec *timestamp);
1464 /**< @internal Function used to get time from the device clock */
1466 typedef int (*eth_get_reg_t)(struct rte_eth_dev *dev,
1467 struct rte_dev_reg_info *info);
1468 /**< @internal Retrieve registers */
1470 typedef int (*eth_get_eeprom_length_t)(struct rte_eth_dev *dev);
1471 /**< @internal Retrieve eeprom size */
1473 typedef int (*eth_get_eeprom_t)(struct rte_eth_dev *dev,
1474 struct rte_dev_eeprom_info *info);
1475 /**< @internal Retrieve eeprom data */
1477 typedef int (*eth_set_eeprom_t)(struct rte_eth_dev *dev,
1478 struct rte_dev_eeprom_info *info);
1479 /**< @internal Program eeprom data */
1481 typedef int (*eth_l2_tunnel_eth_type_conf_t)
1482 (struct rte_eth_dev *dev, struct rte_eth_l2_tunnel_conf *l2_tunnel);
1483 /**< @internal config l2 tunnel ether type */
1485 typedef int (*eth_l2_tunnel_offload_set_t)
1486 (struct rte_eth_dev *dev,
1487 struct rte_eth_l2_tunnel_conf *l2_tunnel,
1490 /**< @internal enable/disable the l2 tunnel offload functions */
1493 typedef int (*eth_filter_ctrl_t)(struct rte_eth_dev *dev,
1494 enum rte_filter_type filter_type,
1495 enum rte_filter_op filter_op,
1497 /**< @internal Take operations to assigned filter type on an Ethernet device */
1499 typedef int (*eth_tm_ops_get_t)(struct rte_eth_dev *dev, void *ops);
1500 /**< @internal Get Traffic Management (TM) operations on an Ethernet device */
1502 typedef int (*eth_get_dcb_info)(struct rte_eth_dev *dev,
1503 struct rte_eth_dcb_info *dcb_info);
1504 /**< @internal Get dcb information on an Ethernet device */
1506 typedef int (*eth_pool_ops_supported_t)(struct rte_eth_dev *dev,
1508 /**< @internal Test if a port supports specific mempool ops */
1511 * @internal A structure containing the functions exported by an Ethernet driver.
1513 struct eth_dev_ops {
1514 eth_dev_configure_t dev_configure; /**< Configure device. */
1515 eth_dev_start_t dev_start; /**< Start device. */
1516 eth_dev_stop_t dev_stop; /**< Stop device. */
1517 eth_dev_set_link_up_t dev_set_link_up; /**< Device link up. */
1518 eth_dev_set_link_down_t dev_set_link_down; /**< Device link down. */
1519 eth_dev_close_t dev_close; /**< Close device. */
1520 eth_dev_reset_t dev_reset; /**< Reset device. */
1521 eth_link_update_t link_update; /**< Get device link state. */
1523 eth_promiscuous_enable_t promiscuous_enable; /**< Promiscuous ON. */
1524 eth_promiscuous_disable_t promiscuous_disable;/**< Promiscuous OFF. */
1525 eth_allmulticast_enable_t allmulticast_enable;/**< RX multicast ON. */
1526 eth_allmulticast_disable_t allmulticast_disable;/**< RX multicast OFF. */
1527 eth_mac_addr_remove_t mac_addr_remove; /**< Remove MAC address. */
1528 eth_mac_addr_add_t mac_addr_add; /**< Add a MAC address. */
1529 eth_mac_addr_set_t mac_addr_set; /**< Set a MAC address. */
1530 eth_set_mc_addr_list_t set_mc_addr_list; /**< set list of mcast addrs. */
1531 mtu_set_t mtu_set; /**< Set MTU. */
1533 eth_stats_get_t stats_get; /**< Get generic device statistics. */
1534 eth_stats_reset_t stats_reset; /**< Reset generic device statistics. */
1535 eth_xstats_get_t xstats_get; /**< Get extended device statistics. */
1536 eth_xstats_reset_t xstats_reset; /**< Reset extended device statistics. */
1537 eth_xstats_get_names_t xstats_get_names;
1538 /**< Get names of extended statistics. */
1539 eth_queue_stats_mapping_set_t queue_stats_mapping_set;
1540 /**< Configure per queue stat counter mapping. */
1542 eth_dev_infos_get_t dev_infos_get; /**< Get device info. */
1543 eth_rxq_info_get_t rxq_info_get; /**< retrieve RX queue information. */
1544 eth_txq_info_get_t txq_info_get; /**< retrieve TX queue information. */
1545 eth_fw_version_get_t fw_version_get; /**< Get firmware version. */
1546 eth_dev_supported_ptypes_get_t dev_supported_ptypes_get;
1547 /**< Get packet types supported and identified by device. */
1549 vlan_filter_set_t vlan_filter_set; /**< Filter VLAN Setup. */
1550 vlan_tpid_set_t vlan_tpid_set; /**< Outer/Inner VLAN TPID Setup. */
1551 vlan_strip_queue_set_t vlan_strip_queue_set; /**< VLAN Stripping on queue. */
1552 vlan_offload_set_t vlan_offload_set; /**< Set VLAN Offload. */
1553 vlan_pvid_set_t vlan_pvid_set; /**< Set port based TX VLAN insertion. */
1555 eth_queue_start_t rx_queue_start;/**< Start RX for a queue. */
1556 eth_queue_stop_t rx_queue_stop; /**< Stop RX for a queue. */
1557 eth_queue_start_t tx_queue_start;/**< Start TX for a queue. */
1558 eth_queue_stop_t tx_queue_stop; /**< Stop TX for a queue. */
1559 eth_rx_queue_setup_t rx_queue_setup;/**< Set up device RX queue. */
1560 eth_queue_release_t rx_queue_release; /**< Release RX queue. */
1561 eth_rx_queue_count_t rx_queue_count;
1562 /**< Get the number of used RX descriptors. */
1563 eth_rx_descriptor_done_t rx_descriptor_done; /**< Check rxd DD bit. */
1564 eth_rx_descriptor_status_t rx_descriptor_status;
1565 /**< Check the status of a Rx descriptor. */
1566 eth_tx_descriptor_status_t tx_descriptor_status;
1567 /**< Check the status of a Tx descriptor. */
1568 eth_rx_enable_intr_t rx_queue_intr_enable; /**< Enable Rx queue interrupt. */
1569 eth_rx_disable_intr_t rx_queue_intr_disable; /**< Disable Rx queue interrupt. */
1570 eth_tx_queue_setup_t tx_queue_setup;/**< Set up device TX queue. */
1571 eth_queue_release_t tx_queue_release; /**< Release TX queue. */
1572 eth_tx_done_cleanup_t tx_done_cleanup;/**< Free tx ring mbufs */
1574 eth_dev_led_on_t dev_led_on; /**< Turn on LED. */
1575 eth_dev_led_off_t dev_led_off; /**< Turn off LED. */
1577 flow_ctrl_get_t flow_ctrl_get; /**< Get flow control. */
1578 flow_ctrl_set_t flow_ctrl_set; /**< Setup flow control. */
1579 priority_flow_ctrl_set_t priority_flow_ctrl_set; /**< Setup priority flow control. */
1581 eth_uc_hash_table_set_t uc_hash_table_set; /**< Set Unicast Table Array. */
1582 eth_uc_all_hash_table_set_t uc_all_hash_table_set; /**< Set Unicast hash bitmap. */
1584 eth_mirror_rule_set_t mirror_rule_set; /**< Add a traffic mirror rule. */
1585 eth_mirror_rule_reset_t mirror_rule_reset; /**< reset a traffic mirror rule. */
1587 eth_udp_tunnel_port_add_t udp_tunnel_port_add; /** Add UDP tunnel port. */
1588 eth_udp_tunnel_port_del_t udp_tunnel_port_del; /** Del UDP tunnel port. */
1589 eth_l2_tunnel_eth_type_conf_t l2_tunnel_eth_type_conf;
1590 /** Config ether type of l2 tunnel. */
1591 eth_l2_tunnel_offload_set_t l2_tunnel_offload_set;
1592 /** Enable/disable l2 tunnel offload functions. */
1594 eth_set_queue_rate_limit_t set_queue_rate_limit; /**< Set queue rate limit. */
1596 rss_hash_update_t rss_hash_update; /** Configure RSS hash protocols. */
1597 rss_hash_conf_get_t rss_hash_conf_get; /** Get current RSS hash configuration. */
1598 reta_update_t reta_update; /** Update redirection table. */
1599 reta_query_t reta_query; /** Query redirection table. */
1601 eth_get_reg_t get_reg; /**< Get registers. */
1602 eth_get_eeprom_length_t get_eeprom_length; /**< Get eeprom length. */
1603 eth_get_eeprom_t get_eeprom; /**< Get eeprom data. */
1604 eth_set_eeprom_t set_eeprom; /**< Set eeprom. */
1607 eth_filter_ctrl_t filter_ctrl; /**< common filter control. */
1609 eth_get_dcb_info get_dcb_info; /** Get DCB information. */
1611 eth_timesync_enable_t timesync_enable;
1612 /** Turn IEEE1588/802.1AS timestamping on. */
1613 eth_timesync_disable_t timesync_disable;
1614 /** Turn IEEE1588/802.1AS timestamping off. */
1615 eth_timesync_read_rx_timestamp_t timesync_read_rx_timestamp;
1616 /** Read the IEEE1588/802.1AS RX timestamp. */
1617 eth_timesync_read_tx_timestamp_t timesync_read_tx_timestamp;
1618 /** Read the IEEE1588/802.1AS TX timestamp. */
1619 eth_timesync_adjust_time timesync_adjust_time; /** Adjust the device clock. */
1620 eth_timesync_read_time timesync_read_time; /** Get the device clock time. */
1621 eth_timesync_write_time timesync_write_time; /** Set the device clock time. */
1623 eth_xstats_get_by_id_t xstats_get_by_id;
1624 /**< Get extended device statistic values by ID. */
1625 eth_xstats_get_names_by_id_t xstats_get_names_by_id;
1626 /**< Get name of extended device statistics by ID. */
1628 eth_tm_ops_get_t tm_ops_get;
1629 /**< Get Traffic Management (TM) operations. */
1630 eth_pool_ops_supported_t pool_ops_supported;
1631 /**< Test if a port supports specific mempool ops */
1635 * Function type used for RX packet processing packet callbacks.
1637 * The callback function is called on RX with a burst of packets that have
1638 * been received on the given port and queue.
1641 * The Ethernet port on which RX is being performed.
1643 * The queue on the Ethernet port which is being used to receive the packets.
1645 * The burst of packets that have just been received.
1647 * The number of packets in the burst pointed to by "pkts".
1649 * The max number of packets that can be stored in the "pkts" array.
1651 * The arbitrary user parameter passed in by the application when the callback
1652 * was originally configured.
1654 * The number of packets returned to the user.
1656 typedef uint16_t (*rte_rx_callback_fn)(uint16_t port, uint16_t queue,
1657 struct rte_mbuf *pkts[], uint16_t nb_pkts, uint16_t max_pkts,
1661 * Function type used for TX packet processing packet callbacks.
1663 * The callback function is called on TX with a burst of packets immediately
1664 * before the packets are put onto the hardware queue for transmission.
1667 * The Ethernet port on which TX is being performed.
1669 * The queue on the Ethernet port which is being used to transmit the packets.
1671 * The burst of packets that are about to be transmitted.
1673 * The number of packets in the burst pointed to by "pkts".
1675 * The arbitrary user parameter passed in by the application when the callback
1676 * was originally configured.
1678 * The number of packets to be written to the NIC.
1680 typedef uint16_t (*rte_tx_callback_fn)(uint16_t port, uint16_t queue,
1681 struct rte_mbuf *pkts[], uint16_t nb_pkts, void *user_param);
1685 * Structure used to hold information about the callbacks to be called for a
1686 * queue on RX and TX.
1688 struct rte_eth_rxtx_callback {
1689 struct rte_eth_rxtx_callback *next;
1691 rte_rx_callback_fn rx;
1692 rte_tx_callback_fn tx;
1698 * A set of values to describe the possible states of an eth device.
1700 enum rte_eth_dev_state {
1701 RTE_ETH_DEV_UNUSED = 0,
1702 RTE_ETH_DEV_ATTACHED,
1703 RTE_ETH_DEV_DEFERRED,
1708 * The generic data structure associated with each ethernet device.
1710 * Pointers to burst-oriented packet receive and transmit functions are
1711 * located at the beginning of the structure, along with the pointer to
1712 * where all the data elements for the particular device are stored in shared
1713 * memory. This split allows the function pointer and driver data to be per-
1714 * process, while the actual configuration data for the device is shared.
1716 struct rte_eth_dev {
1717 eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
1718 eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
1719 eth_tx_prep_t tx_pkt_prepare; /**< Pointer to PMD transmit prepare function. */
1720 struct rte_eth_dev_data *data; /**< Pointer to device data */
1721 const struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
1722 struct rte_device *device; /**< Backing device */
1723 struct rte_intr_handle *intr_handle; /**< Device interrupt handle */
1724 /** User application callbacks for NIC interrupts */
1725 struct rte_eth_dev_cb_list link_intr_cbs;
1727 * User-supplied functions called from rx_burst to post-process
1728 * received packets before passing them to the user
1730 struct rte_eth_rxtx_callback *post_rx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
1732 * User-supplied functions called from tx_burst to pre-process
1733 * received packets before passing them to the driver for transmission.
1735 struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
1736 enum rte_eth_dev_state state; /**< Flag indicating the port state */
1737 } __rte_cache_aligned;
1739 struct rte_eth_dev_sriov {
1740 uint8_t active; /**< SRIOV is active with 16, 32 or 64 pools */
1741 uint8_t nb_q_per_pool; /**< rx queue number per pool */
1742 uint16_t def_vmdq_idx; /**< Default pool num used for PF */
1743 uint16_t def_pool_q_idx; /**< Default pool queue start reg index */
1745 #define RTE_ETH_DEV_SRIOV(dev) ((dev)->data->sriov)
1747 #define RTE_ETH_NAME_MAX_LEN RTE_DEV_NAME_MAX_LEN
1751 * The data part, with no function pointers, associated with each ethernet device.
1753 * This structure is safe to place in shared memory to be common among different
1754 * processes in a multi-process configuration.
1756 struct rte_eth_dev_data {
1757 char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
1759 void **rx_queues; /**< Array of pointers to RX queues. */
1760 void **tx_queues; /**< Array of pointers to TX queues. */
1761 uint16_t nb_rx_queues; /**< Number of RX queues. */
1762 uint16_t nb_tx_queues; /**< Number of TX queues. */
1764 struct rte_eth_dev_sriov sriov; /**< SRIOV data */
1766 void *dev_private; /**< PMD-specific private data */
1768 struct rte_eth_link dev_link;
1769 /**< Link-level information & status */
1771 struct rte_eth_conf dev_conf; /**< Configuration applied to device. */
1772 uint16_t mtu; /**< Maximum Transmission Unit. */
1774 uint32_t min_rx_buf_size;
1775 /**< Common rx buffer size handled by all queues */
1777 uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
1778 struct ether_addr* mac_addrs;/**< Device Ethernet Link address. */
1779 uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
1780 /** bitmap array of associating Ethernet MAC addresses to pools */
1781 struct ether_addr* hash_mac_addrs;
1782 /** Device Ethernet MAC addresses of hash filtering. */
1783 uint16_t port_id; /**< Device [external] port identifier. */
1785 uint8_t promiscuous : 1, /**< RX promiscuous mode ON(1) / OFF(0). */
1786 scattered_rx : 1, /**< RX of scattered packets is ON(1) / OFF(0) */
1787 all_multicast : 1, /**< RX all multicast mode ON(1) / OFF(0). */
1788 dev_started : 1, /**< Device state: STARTED(1) / STOPPED(0). */
1789 lro : 1; /**< RX LRO is ON(1) / OFF(0) */
1790 uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT];
1791 /** Queues state: STARTED(1) / STOPPED(0) */
1792 uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
1793 /** Queues state: STARTED(1) / STOPPED(0) */
1794 uint32_t dev_flags; /**< Capabilities */
1795 enum rte_kernel_driver kdrv; /**< Kernel driver passthrough */
1796 int numa_node; /**< NUMA node connection */
1797 struct rte_vlan_filter_conf vlan_filter_conf;
1798 /**< VLAN filter configuration. */
1801 /** Device supports hotplug detach */
1802 #define RTE_ETH_DEV_DETACHABLE 0x0001
1803 /** Device supports link state interrupt */
1804 #define RTE_ETH_DEV_INTR_LSC 0x0002
1805 /** Device is a bonded slave */
1806 #define RTE_ETH_DEV_BONDED_SLAVE 0x0004
1807 /** Device supports device removal interrupt */
1808 #define RTE_ETH_DEV_INTR_RMV 0x0008
1812 * The pool of *rte_eth_dev* structures. The size of the pool
1813 * is configured at compile-time in the <rte_ethdev.c> file.
1815 extern struct rte_eth_dev rte_eth_devices[];
1818 * Iterates over valid ethdev ports.
1821 * The id of the next possible valid port.
1823 * Next valid port id, RTE_MAX_ETHPORTS if there is none.
1825 uint16_t rte_eth_find_next(uint16_t port_id);
1828 * Macro to iterate over all enabled ethdev ports.
1830 #define RTE_ETH_FOREACH_DEV(p) \
1831 for (p = rte_eth_find_next(0); \
1832 (unsigned int)p < (unsigned int)RTE_MAX_ETHPORTS; \
1833 p = rte_eth_find_next(p + 1))
1837 * Get the total number of Ethernet devices that have been successfully
1838 * initialized by the matching Ethernet driver during the PCI probing phase
1839 * and that are available for applications to use. These devices must be
1840 * accessed by using the ``RTE_ETH_FOREACH_DEV()`` macro to deal with
1841 * non-contiguous ranges of devices.
1842 * These non-contiguous ranges can be created by calls to hotplug functions or
1846 * - The total number of usable Ethernet devices.
1848 uint16_t rte_eth_dev_count(void);
1852 * Returns a ethdev slot specified by the unique identifier name.
1855 * The pointer to the Unique identifier name for each Ethernet device
1857 * - The pointer to the ethdev slot, on success. NULL on error
1859 struct rte_eth_dev *rte_eth_dev_allocated(const char *name);
1863 * Allocates a new ethdev slot for an ethernet device and returns the pointer
1864 * to that slot for the driver to use.
1866 * @param name Unique identifier name for each Ethernet device
1867 * @param type Device type of this Ethernet device
1869 * - Slot in the rte_dev_devices array for a new device;
1871 struct rte_eth_dev *rte_eth_dev_allocate(const char *name);
1875 * Attach to the ethdev already initialized by the primary
1878 * @param name Ethernet device's name.
1880 * - Success: Slot in the rte_dev_devices array for attached
1882 * - Error: Null pointer.
1884 struct rte_eth_dev *rte_eth_dev_attach_secondary(const char *name);
1888 * Release the specified ethdev port.
1891 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure.
1893 * - 0 on success, negative on error
1895 int rte_eth_dev_release_port(struct rte_eth_dev *eth_dev);
1898 * Attach a new Ethernet device specified by arguments.
1901 * A pointer to a strings array describing the new device
1902 * to be attached. The strings should be a pci address like
1903 * '0000:01:00.0' or virtual device name like 'net_pcap0'.
1905 * A pointer to a port identifier actually attached.
1907 * 0 on success and port_id is filled, negative on error
1909 int rte_eth_dev_attach(const char *devargs, uint16_t *port_id);
1912 * Detach a Ethernet device specified by port identifier.
1913 * This function must be called when the device is in the
1917 * The port identifier of the device to detach.
1919 * A pointer to a buffer that will be filled with the device name.
1920 * This buffer must be at least RTE_DEV_NAME_MAX_LEN long.
1922 * 0 on success and devname is filled, negative on error
1924 int rte_eth_dev_detach(uint16_t port_id, char *devname);
1927 * Convert a numerical speed in Mbps to a bitmap flag that can be used in
1928 * the bitmap link_speeds of the struct rte_eth_conf
1931 * Numerical speed value in Mbps
1933 * ETH_LINK_[HALF/FULL]_DUPLEX (only for 10/100M speeds)
1935 * 0 if the speed cannot be mapped
1937 uint32_t rte_eth_speed_bitflag(uint32_t speed, int duplex);
1940 * Configure an Ethernet device.
1941 * This function must be invoked first before any other function in the
1942 * Ethernet API. This function can also be re-invoked when a device is in the
1946 * The port identifier of the Ethernet device to configure.
1947 * @param nb_rx_queue
1948 * The number of receive queues to set up for the Ethernet device.
1949 * @param nb_tx_queue
1950 * The number of transmit queues to set up for the Ethernet device.
1952 * The pointer to the configuration data to be used for the Ethernet device.
1953 * The *rte_eth_conf* structure includes:
1954 * - the hardware offload features to activate, with dedicated fields for
1955 * each statically configurable offload hardware feature provided by
1956 * Ethernet devices, such as IP checksum or VLAN tag stripping for
1958 * The Rx offload bitfield API is obsolete and will be deprecated.
1959 * Applications should set the ignore_bitfield_offloads bit on *rxmode*
1960 * structure and use offloads field to set per-port offloads instead.
1961 * - the Receive Side Scaling (RSS) configuration when using multiple RX
1964 * Embedding all configuration information in a single data structure
1965 * is the more flexible method that allows the addition of new features
1966 * without changing the syntax of the API.
1968 * - 0: Success, device configured.
1969 * - <0: Error code returned by the driver configuration function.
1971 int rte_eth_dev_configure(uint16_t port_id, uint16_t nb_rx_queue,
1972 uint16_t nb_tx_queue, const struct rte_eth_conf *eth_conf);
1976 * Release device queues and clear its configuration to force the user
1977 * application to reconfigure it. It is for internal use only.
1980 * Pointer to struct rte_eth_dev.
1985 void _rte_eth_dev_reset(struct rte_eth_dev *dev);
1988 * Allocate and set up a receive queue for an Ethernet device.
1990 * The function allocates a contiguous block of memory for *nb_rx_desc*
1991 * receive descriptors from a memory zone associated with *socket_id*
1992 * and initializes each receive descriptor with a network buffer allocated
1993 * from the memory pool *mb_pool*.
1996 * The port identifier of the Ethernet device.
1997 * @param rx_queue_id
1998 * The index of the receive queue to set up.
1999 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2000 * to rte_eth_dev_configure().
2002 * The number of receive descriptors to allocate for the receive ring.
2004 * The *socket_id* argument is the socket identifier in case of NUMA.
2005 * The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
2006 * the DMA memory allocated for the receive descriptors of the ring.
2008 * The pointer to the configuration data to be used for the receive queue.
2009 * NULL value is allowed, in which case default RX configuration
2011 * The *rx_conf* structure contains an *rx_thresh* structure with the values
2012 * of the Prefetch, Host, and Write-Back threshold registers of the receive
2014 * In addition it contains the hardware offloads features to activate using
2015 * the DEV_RX_OFFLOAD_* flags.
2017 * The pointer to the memory pool from which to allocate *rte_mbuf* network
2018 * memory buffers to populate each descriptor of the receive ring.
2020 * - 0: Success, receive queue correctly set up.
2021 * - -EINVAL: The size of network buffers which can be allocated from the
2022 * memory pool does not fit the various buffer sizes allowed by the
2023 * device controller.
2024 * - -ENOMEM: Unable to allocate the receive ring descriptors or to
2025 * allocate network memory buffers from the memory pool when
2026 * initializing receive descriptors.
2028 int rte_eth_rx_queue_setup(uint16_t port_id, uint16_t rx_queue_id,
2029 uint16_t nb_rx_desc, unsigned int socket_id,
2030 const struct rte_eth_rxconf *rx_conf,
2031 struct rte_mempool *mb_pool);
2034 * Allocate and set up a transmit queue for an Ethernet device.
2037 * The port identifier of the Ethernet device.
2038 * @param tx_queue_id
2039 * The index of the transmit queue to set up.
2040 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2041 * to rte_eth_dev_configure().
2043 * The number of transmit descriptors to allocate for the transmit ring.
2045 * The *socket_id* argument is the socket identifier in case of NUMA.
2046 * Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
2047 * the DMA memory allocated for the transmit descriptors of the ring.
2049 * The pointer to the configuration data to be used for the transmit queue.
2050 * NULL value is allowed, in which case default RX configuration
2052 * The *tx_conf* structure contains the following data:
2053 * - The *tx_thresh* structure with the values of the Prefetch, Host, and
2054 * Write-Back threshold registers of the transmit ring.
2055 * When setting Write-Back threshold to the value greater then zero,
2056 * *tx_rs_thresh* value should be explicitly set to one.
2057 * - The *tx_free_thresh* value indicates the [minimum] number of network
2058 * buffers that must be pending in the transmit ring to trigger their
2059 * [implicit] freeing by the driver transmit function.
2060 * - The *tx_rs_thresh* value indicates the [minimum] number of transmit
2061 * descriptors that must be pending in the transmit ring before setting the
2062 * RS bit on a descriptor by the driver transmit function.
2063 * The *tx_rs_thresh* value should be less or equal then
2064 * *tx_free_thresh* value, and both of them should be less then
2066 * - The *txq_flags* member contains flags to pass to the TX queue setup
2067 * function to configure the behavior of the TX queue. This should be set
2068 * to 0 if no special configuration is required.
2069 * This API is obsolete and will be deprecated. Applications
2070 * should set it to ETH_TXQ_FLAGS_IGNORE and use
2071 * the offloads field below.
2072 * - The *offloads* member contains Tx offloads to be enabled.
2073 * Offloads which are not set cannot be used on the datapath.
2075 * Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces
2076 * the transmit function to use default values.
2078 * - 0: Success, the transmit queue is correctly set up.
2079 * - -ENOMEM: Unable to allocate the transmit ring descriptors.
2081 int rte_eth_tx_queue_setup(uint16_t port_id, uint16_t tx_queue_id,
2082 uint16_t nb_tx_desc, unsigned int socket_id,
2083 const struct rte_eth_txconf *tx_conf);
2086 * Return the NUMA socket to which an Ethernet device is connected
2089 * The port identifier of the Ethernet device
2091 * The NUMA socket id to which the Ethernet device is connected or
2092 * a default of zero if the socket could not be determined.
2093 * -1 is returned is the port_id value is out of range.
2095 int rte_eth_dev_socket_id(uint16_t port_id);
2098 * Check if port_id of device is attached
2101 * The port identifier of the Ethernet device
2103 * - 0 if port is out of range or not attached
2104 * - 1 if device is attached
2106 int rte_eth_dev_is_valid_port(uint16_t port_id);
2109 * Start specified RX queue of a port. It is used when rx_deferred_start
2110 * flag of the specified queue is true.
2113 * The port identifier of the Ethernet device
2114 * @param rx_queue_id
2115 * The index of the rx queue to update the ring.
2116 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2117 * to rte_eth_dev_configure().
2119 * - 0: Success, the receive queue is started.
2120 * - -EINVAL: The port_id or the queue_id out of range.
2121 * - -ENOTSUP: The function not supported in PMD driver.
2123 int rte_eth_dev_rx_queue_start(uint16_t port_id, uint16_t rx_queue_id);
2126 * Stop specified RX queue of a port
2129 * The port identifier of the Ethernet device
2130 * @param rx_queue_id
2131 * The index of the rx queue to update the ring.
2132 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2133 * to rte_eth_dev_configure().
2135 * - 0: Success, the receive queue is stopped.
2136 * - -EINVAL: The port_id or the queue_id out of range.
2137 * - -ENOTSUP: The function not supported in PMD driver.
2139 int rte_eth_dev_rx_queue_stop(uint16_t port_id, uint16_t rx_queue_id);
2142 * Start TX for specified queue of a port. It is used when tx_deferred_start
2143 * flag of the specified queue is true.
2146 * The port identifier of the Ethernet device
2147 * @param tx_queue_id
2148 * The index of the tx queue to update the ring.
2149 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2150 * to rte_eth_dev_configure().
2152 * - 0: Success, the transmit queue is started.
2153 * - -EINVAL: The port_id or the queue_id out of range.
2154 * - -ENOTSUP: The function not supported in PMD driver.
2156 int rte_eth_dev_tx_queue_start(uint16_t port_id, uint16_t tx_queue_id);
2159 * Stop specified TX queue of a port
2162 * The port identifier of the Ethernet device
2163 * @param tx_queue_id
2164 * The index of the tx queue to update the ring.
2165 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2166 * to rte_eth_dev_configure().
2168 * - 0: Success, the transmit queue is stopped.
2169 * - -EINVAL: The port_id or the queue_id out of range.
2170 * - -ENOTSUP: The function not supported in PMD driver.
2172 int rte_eth_dev_tx_queue_stop(uint16_t port_id, uint16_t tx_queue_id);
2177 * Start an Ethernet device.
2179 * The device start step is the last one and consists of setting the configured
2180 * offload features and in starting the transmit and the receive units of the
2182 * On success, all basic functions exported by the Ethernet API (link status,
2183 * receive/transmit, and so on) can be invoked.
2186 * The port identifier of the Ethernet device.
2188 * - 0: Success, Ethernet device started.
2189 * - <0: Error code of the driver device start function.
2191 int rte_eth_dev_start(uint16_t port_id);
2194 * Stop an Ethernet device. The device can be restarted with a call to
2195 * rte_eth_dev_start()
2198 * The port identifier of the Ethernet device.
2200 void rte_eth_dev_stop(uint16_t port_id);
2204 * Link up an Ethernet device.
2206 * Set device link up will re-enable the device rx/tx
2207 * functionality after it is previously set device linked down.
2210 * The port identifier of the Ethernet device.
2212 * - 0: Success, Ethernet device linked up.
2213 * - <0: Error code of the driver device link up function.
2215 int rte_eth_dev_set_link_up(uint16_t port_id);
2218 * Link down an Ethernet device.
2219 * The device rx/tx functionality will be disabled if success,
2220 * and it can be re-enabled with a call to
2221 * rte_eth_dev_set_link_up()
2224 * The port identifier of the Ethernet device.
2226 int rte_eth_dev_set_link_down(uint16_t port_id);
2229 * Close a stopped Ethernet device. The device cannot be restarted!
2230 * The function frees all resources except for needed by the
2231 * closed state. To free these resources, call rte_eth_dev_detach().
2234 * The port identifier of the Ethernet device.
2236 void rte_eth_dev_close(uint16_t port_id);
2239 * Reset a Ethernet device and keep its port id.
2241 * When a port has to be reset passively, the DPDK application can invoke
2242 * this function. For example when a PF is reset, all its VFs should also
2243 * be reset. Normally a DPDK application can invoke this function when
2244 * RTE_ETH_EVENT_INTR_RESET event is detected, but can also use it to start
2245 * a port reset in other circumstances.
2247 * When this function is called, it first stops the port and then calls the
2248 * PMD specific dev_uninit( ) and dev_init( ) to return the port to initial
2249 * state, in which no Tx and Rx queues are setup, as if the port has been
2250 * reset and not started. The port keeps the port id it had before the
2253 * After calling rte_eth_dev_reset( ), the application should use
2254 * rte_eth_dev_configure( ), rte_eth_rx_queue_setup( ),
2255 * rte_eth_tx_queue_setup( ), and rte_eth_dev_start( )
2256 * to reconfigure the device as appropriate.
2258 * Note: To avoid unexpected behavior, the application should stop calling
2259 * Tx and Rx functions before calling rte_eth_dev_reset( ). For thread
2260 * safety, all these controlling functions should be called from the same
2264 * The port identifier of the Ethernet device.
2266 int rte_eth_dev_reset(uint16_t port_id);
2269 * Enable receipt in promiscuous mode for an Ethernet device.
2272 * The port identifier of the Ethernet device.
2274 void rte_eth_promiscuous_enable(uint16_t port_id);
2277 * Disable receipt in promiscuous mode for an Ethernet device.
2280 * The port identifier of the Ethernet device.
2282 void rte_eth_promiscuous_disable(uint16_t port_id);
2285 * Return the value of promiscuous mode for an Ethernet device.
2288 * The port identifier of the Ethernet device.
2290 * - (1) if promiscuous is enabled
2291 * - (0) if promiscuous is disabled.
2294 int rte_eth_promiscuous_get(uint16_t port_id);
2297 * Enable the receipt of any multicast frame by an Ethernet device.
2300 * The port identifier of the Ethernet device.
2302 void rte_eth_allmulticast_enable(uint16_t port_id);
2305 * Disable the receipt of all multicast frames by an Ethernet device.
2308 * The port identifier of the Ethernet device.
2310 void rte_eth_allmulticast_disable(uint16_t port_id);
2313 * Return the value of allmulticast mode for an Ethernet device.
2316 * The port identifier of the Ethernet device.
2318 * - (1) if allmulticast is enabled
2319 * - (0) if allmulticast is disabled.
2322 int rte_eth_allmulticast_get(uint16_t port_id);
2325 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2326 * or FULL-DUPLEX) of the physical link of an Ethernet device. It might need
2327 * to wait up to 9 seconds in it.
2330 * The port identifier of the Ethernet device.
2332 * A pointer to an *rte_eth_link* structure to be filled with
2333 * the status, the speed and the mode of the Ethernet device link.
2335 void rte_eth_link_get(uint16_t port_id, struct rte_eth_link *link);
2338 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2339 * or FULL-DUPLEX) of the physical link of an Ethernet device. It is a no-wait
2340 * version of rte_eth_link_get().
2343 * The port identifier of the Ethernet device.
2345 * A pointer to an *rte_eth_link* structure to be filled with
2346 * the status, the speed and the mode of the Ethernet device link.
2348 void rte_eth_link_get_nowait(uint16_t port_id, struct rte_eth_link *link);
2351 * Retrieve the general I/O statistics of an Ethernet device.
2354 * The port identifier of the Ethernet device.
2356 * A pointer to a structure of type *rte_eth_stats* to be filled with
2357 * the values of device counters for the following set of statistics:
2358 * - *ipackets* with the total of successfully received packets.
2359 * - *opackets* with the total of successfully transmitted packets.
2360 * - *ibytes* with the total of successfully received bytes.
2361 * - *obytes* with the total of successfully transmitted bytes.
2362 * - *ierrors* with the total of erroneous received packets.
2363 * - *oerrors* with the total of failed transmitted packets.
2365 * Zero if successful. Non-zero otherwise.
2367 int rte_eth_stats_get(uint16_t port_id, struct rte_eth_stats *stats);
2370 * Reset the general I/O statistics of an Ethernet device.
2373 * The port identifier of the Ethernet device.
2375 * - (0) if device notified to reset stats.
2376 * - (-ENOTSUP) if hardware doesn't support.
2377 * - (-ENODEV) if *port_id* invalid.
2379 int rte_eth_stats_reset(uint16_t port_id);
2382 * Retrieve names of extended statistics of an Ethernet device.
2385 * The port identifier of the Ethernet device.
2386 * @param xstats_names
2387 * An rte_eth_xstat_name array of at least *size* elements to
2388 * be filled. If set to NULL, the function returns the required number
2391 * The size of the xstats_names array (number of elements).
2393 * - A positive value lower or equal to size: success. The return value
2394 * is the number of entries filled in the stats table.
2395 * - A positive value higher than size: error, the given statistics table
2396 * is too small. The return value corresponds to the size that should
2397 * be given to succeed. The entries in the table are not valid and
2398 * shall not be used by the caller.
2399 * - A negative value on error (invalid port id).
2401 int rte_eth_xstats_get_names(uint16_t port_id,
2402 struct rte_eth_xstat_name *xstats_names,
2406 * Retrieve extended statistics of an Ethernet device.
2409 * The port identifier of the Ethernet device.
2411 * A pointer to a table of structure of type *rte_eth_xstat*
2412 * to be filled with device statistics ids and values: id is the
2413 * index of the name string in xstats_names (see rte_eth_xstats_get_names()),
2414 * and value is the statistic counter.
2415 * This parameter can be set to NULL if n is 0.
2417 * The size of the xstats array (number of elements).
2419 * - A positive value lower or equal to n: success. The return value
2420 * is the number of entries filled in the stats table.
2421 * - A positive value higher than n: error, the given statistics table
2422 * is too small. The return value corresponds to the size that should
2423 * be given to succeed. The entries in the table are not valid and
2424 * shall not be used by the caller.
2425 * - A negative value on error (invalid port id).
2427 int rte_eth_xstats_get(uint16_t port_id, struct rte_eth_xstat *xstats,
2431 * Retrieve names of extended statistics of an Ethernet device.
2434 * The port identifier of the Ethernet device.
2435 * @param xstats_names
2436 * An rte_eth_xstat_name array of at least *size* elements to
2437 * be filled. If set to NULL, the function returns the required number
2440 * IDs array given by app to retrieve specific statistics
2442 * The size of the xstats_names array (number of elements).
2444 * - A positive value lower or equal to size: success. The return value
2445 * is the number of entries filled in the stats table.
2446 * - A positive value higher than size: error, the given statistics table
2447 * is too small. The return value corresponds to the size that should
2448 * be given to succeed. The entries in the table are not valid and
2449 * shall not be used by the caller.
2450 * - A negative value on error (invalid port id).
2453 rte_eth_xstats_get_names_by_id(uint16_t port_id,
2454 struct rte_eth_xstat_name *xstats_names, unsigned int size,
2458 * Retrieve extended statistics of an Ethernet device.
2461 * The port identifier of the Ethernet device.
2463 * A pointer to an ids array passed by application. This tells which
2464 * statistics values function should retrieve. This parameter
2465 * can be set to NULL if size is 0. In this case function will retrieve
2466 * all avalible statistics.
2468 * A pointer to a table to be filled with device statistics values.
2470 * The size of the ids array (number of elements).
2472 * - A positive value lower or equal to size: success. The return value
2473 * is the number of entries filled in the stats table.
2474 * - A positive value higher than size: error, the given statistics table
2475 * is too small. The return value corresponds to the size that should
2476 * be given to succeed. The entries in the table are not valid and
2477 * shall not be used by the caller.
2478 * - A negative value on error (invalid port id).
2480 int rte_eth_xstats_get_by_id(uint16_t port_id, const uint64_t *ids,
2481 uint64_t *values, unsigned int size);
2484 * Gets the ID of a statistic from its name.
2486 * This function searches for the statistics using string compares, and
2487 * as such should not be used on the fast-path. For fast-path retrieval of
2488 * specific statistics, store the ID as provided in *id* from this function,
2489 * and pass the ID to rte_eth_xstats_get()
2491 * @param port_id The port to look up statistics from
2492 * @param xstat_name The name of the statistic to return
2493 * @param[out] id A pointer to an app-supplied uint64_t which should be
2494 * set to the ID of the stat if the stat exists.
2497 * -ENODEV for invalid port_id,
2498 * -EINVAL if the xstat_name doesn't exist in port_id
2500 int rte_eth_xstats_get_id_by_name(uint16_t port_id, const char *xstat_name,
2504 * Reset extended statistics of an Ethernet device.
2507 * The port identifier of the Ethernet device.
2509 void rte_eth_xstats_reset(uint16_t port_id);
2512 * Set a mapping for the specified transmit queue to the specified per-queue
2513 * statistics counter.
2516 * The port identifier of the Ethernet device.
2517 * @param tx_queue_id
2518 * The index of the transmit queue for which a queue stats mapping is required.
2519 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2520 * to rte_eth_dev_configure().
2522 * The per-queue packet statistics functionality number that the transmit
2523 * queue is to be assigned.
2524 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2526 * Zero if successful. Non-zero otherwise.
2528 int rte_eth_dev_set_tx_queue_stats_mapping(uint16_t port_id,
2529 uint16_t tx_queue_id, uint8_t stat_idx);
2532 * Set a mapping for the specified receive queue to the specified per-queue
2533 * statistics counter.
2536 * The port identifier of the Ethernet device.
2537 * @param rx_queue_id
2538 * The index of the receive queue for which a queue stats mapping is required.
2539 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2540 * to rte_eth_dev_configure().
2542 * The per-queue packet statistics functionality number that the receive
2543 * queue is to be assigned.
2544 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2546 * Zero if successful. Non-zero otherwise.
2548 int rte_eth_dev_set_rx_queue_stats_mapping(uint16_t port_id,
2549 uint16_t rx_queue_id,
2553 * Retrieve the Ethernet address of an Ethernet device.
2556 * The port identifier of the Ethernet device.
2558 * A pointer to a structure of type *ether_addr* to be filled with
2559 * the Ethernet address of the Ethernet device.
2561 void rte_eth_macaddr_get(uint16_t port_id, struct ether_addr *mac_addr);
2564 * Retrieve the contextual information of an Ethernet device.
2567 * The port identifier of the Ethernet device.
2569 * A pointer to a structure of type *rte_eth_dev_info* to be filled with
2570 * the contextual information of the Ethernet device.
2572 void rte_eth_dev_info_get(uint16_t port_id, struct rte_eth_dev_info *dev_info);
2575 * Retrieve the firmware version of a device.
2578 * The port identifier of the device.
2580 * A pointer to a string array storing the firmware version of a device,
2581 * the string includes terminating null. This pointer is allocated by caller.
2583 * The size of the string array pointed by fw_version, which should be
2584 * large enough to store firmware version of the device.
2586 * - (0) if successful.
2587 * - (-ENOTSUP) if operation is not supported.
2588 * - (-ENODEV) if *port_id* invalid.
2589 * - (>0) if *fw_size* is not enough to store firmware version, return
2590 * the size of the non truncated string.
2592 int rte_eth_dev_fw_version_get(uint16_t port_id,
2593 char *fw_version, size_t fw_size);
2596 * Retrieve the supported packet types of an Ethernet device.
2598 * When a packet type is announced as supported, it *must* be recognized by
2599 * the PMD. For instance, if RTE_PTYPE_L2_ETHER, RTE_PTYPE_L2_ETHER_VLAN
2600 * and RTE_PTYPE_L3_IPV4 are announced, the PMD must return the following
2601 * packet types for these packets:
2602 * - Ether/IPv4 -> RTE_PTYPE_L2_ETHER | RTE_PTYPE_L3_IPV4
2603 * - Ether/Vlan/IPv4 -> RTE_PTYPE_L2_ETHER_VLAN | RTE_PTYPE_L3_IPV4
2604 * - Ether/[anything else] -> RTE_PTYPE_L2_ETHER
2605 * - Ether/Vlan/[anything else] -> RTE_PTYPE_L2_ETHER_VLAN
2607 * When a packet is received by a PMD, the most precise type must be
2608 * returned among the ones supported. However a PMD is allowed to set
2609 * packet type that is not in the supported list, at the condition that it
2610 * is more precise. Therefore, a PMD announcing no supported packet types
2611 * can still set a matching packet type in a received packet.
2614 * Better to invoke this API after the device is already started or rx burst
2615 * function is decided, to obtain correct supported ptypes.
2617 * if a given PMD does not report what ptypes it supports, then the supported
2618 * ptype count is reported as 0.
2620 * The port identifier of the Ethernet device.
2622 * A hint of what kind of packet type which the caller is interested in.
2624 * An array pointer to store adequate packet types, allocated by caller.
2626 * Size of the array pointed by param ptypes.
2628 * - (>=0) Number of supported ptypes. If the number of types exceeds num,
2629 * only num entries will be filled into the ptypes array, but the full
2630 * count of supported ptypes will be returned.
2631 * - (-ENODEV) if *port_id* invalid.
2633 int rte_eth_dev_get_supported_ptypes(uint16_t port_id, uint32_t ptype_mask,
2634 uint32_t *ptypes, int num);
2637 * Retrieve the MTU of an Ethernet device.
2640 * The port identifier of the Ethernet device.
2642 * A pointer to a uint16_t where the retrieved MTU is to be stored.
2644 * - (0) if successful.
2645 * - (-ENODEV) if *port_id* invalid.
2647 int rte_eth_dev_get_mtu(uint16_t port_id, uint16_t *mtu);
2650 * Change the MTU of an Ethernet device.
2653 * The port identifier of the Ethernet device.
2655 * A uint16_t for the MTU to be applied.
2657 * - (0) if successful.
2658 * - (-ENOTSUP) if operation is not supported.
2659 * - (-ENODEV) if *port_id* invalid.
2660 * - (-EINVAL) if *mtu* invalid.
2661 * - (-EBUSY) if operation is not allowed when the port is running
2663 int rte_eth_dev_set_mtu(uint16_t port_id, uint16_t mtu);
2666 * Enable/Disable hardware filtering by an Ethernet device of received
2667 * VLAN packets tagged with a given VLAN Tag Identifier.
2670 * The port identifier of the Ethernet device.
2672 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
2674 * If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*.
2675 * Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*.
2677 * - (0) if successful.
2678 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2679 * - (-ENODEV) if *port_id* invalid.
2680 * - (-ENOSYS) if VLAN filtering on *port_id* disabled.
2681 * - (-EINVAL) if *vlan_id* > 4095.
2683 int rte_eth_dev_vlan_filter(uint16_t port_id, uint16_t vlan_id, int on);
2686 * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
2687 * 82599/X540/X550 can support VLAN stripping at the rx queue level
2690 * The port identifier of the Ethernet device.
2691 * @param rx_queue_id
2692 * The index of the receive queue for which a queue stats mapping is required.
2693 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2694 * to rte_eth_dev_configure().
2696 * If 1, Enable VLAN Stripping of the receive queue of the Ethernet port.
2697 * If 0, Disable VLAN Stripping of the receive queue of the Ethernet port.
2699 * - (0) if successful.
2700 * - (-ENOSUP) if hardware-assisted VLAN stripping not configured.
2701 * - (-ENODEV) if *port_id* invalid.
2702 * - (-EINVAL) if *rx_queue_id* invalid.
2704 int rte_eth_dev_set_vlan_strip_on_queue(uint16_t port_id, uint16_t rx_queue_id,
2708 * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
2709 * the VLAN Header. This is a register setup available on some Intel NIC, not
2710 * but all, please check the data sheet for availability.
2713 * The port identifier of the Ethernet device.
2717 * The Tag Protocol ID
2719 * - (0) if successful.
2720 * - (-ENOSUP) if hardware-assisted VLAN TPID setup is not supported.
2721 * - (-ENODEV) if *port_id* invalid.
2723 int rte_eth_dev_set_vlan_ether_type(uint16_t port_id,
2724 enum rte_vlan_type vlan_type,
2728 * Set VLAN offload configuration on an Ethernet device
2729 * Enable/Disable Extended VLAN by an Ethernet device, This is a register setup
2730 * available on some Intel NIC, not but all, please check the data sheet for
2732 * Enable/Disable VLAN Strip can be done on rx queue for certain NIC, but here
2733 * the configuration is applied on the port level.
2736 * The port identifier of the Ethernet device.
2737 * @param offload_mask
2738 * The VLAN Offload bit mask can be mixed use with "OR"
2739 * ETH_VLAN_STRIP_OFFLOAD
2740 * ETH_VLAN_FILTER_OFFLOAD
2741 * ETH_VLAN_EXTEND_OFFLOAD
2743 * - (0) if successful.
2744 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2745 * - (-ENODEV) if *port_id* invalid.
2747 int rte_eth_dev_set_vlan_offload(uint16_t port_id, int offload_mask);
2750 * Read VLAN Offload configuration from an Ethernet device
2753 * The port identifier of the Ethernet device.
2755 * - (>0) if successful. Bit mask to indicate
2756 * ETH_VLAN_STRIP_OFFLOAD
2757 * ETH_VLAN_FILTER_OFFLOAD
2758 * ETH_VLAN_EXTEND_OFFLOAD
2759 * - (-ENODEV) if *port_id* invalid.
2761 int rte_eth_dev_get_vlan_offload(uint16_t port_id);
2764 * Set port based TX VLAN insertion on or off.
2767 * The port identifier of the Ethernet device.
2769 * Port based TX VLAN identifier together with user priority.
2771 * Turn on or off the port based TX VLAN insertion.
2774 * - (0) if successful.
2775 * - negative if failed.
2777 int rte_eth_dev_set_vlan_pvid(uint16_t port_id, uint16_t pvid, int on);
2781 * Retrieve a burst of input packets from a receive queue of an Ethernet
2782 * device. The retrieved packets are stored in *rte_mbuf* structures whose
2783 * pointers are supplied in the *rx_pkts* array.
2785 * The rte_eth_rx_burst() function loops, parsing the RX ring of the
2786 * receive queue, up to *nb_pkts* packets, and for each completed RX
2787 * descriptor in the ring, it performs the following operations:
2789 * - Initialize the *rte_mbuf* data structure associated with the
2790 * RX descriptor according to the information provided by the NIC into
2791 * that RX descriptor.
2793 * - Store the *rte_mbuf* data structure into the next entry of the
2796 * - Replenish the RX descriptor with a new *rte_mbuf* buffer
2797 * allocated from the memory pool associated with the receive queue at
2798 * initialization time.
2800 * When retrieving an input packet that was scattered by the controller
2801 * into multiple receive descriptors, the rte_eth_rx_burst() function
2802 * appends the associated *rte_mbuf* buffers to the first buffer of the
2805 * The rte_eth_rx_burst() function returns the number of packets
2806 * actually retrieved, which is the number of *rte_mbuf* data structures
2807 * effectively supplied into the *rx_pkts* array.
2808 * A return value equal to *nb_pkts* indicates that the RX queue contained
2809 * at least *rx_pkts* packets, and this is likely to signify that other
2810 * received packets remain in the input queue. Applications implementing
2811 * a "retrieve as much received packets as possible" policy can check this
2812 * specific case and keep invoking the rte_eth_rx_burst() function until
2813 * a value less than *nb_pkts* is returned.
2815 * This receive method has the following advantages:
2817 * - It allows a run-to-completion network stack engine to retrieve and
2818 * to immediately process received packets in a fast burst-oriented
2819 * approach, avoiding the overhead of unnecessary intermediate packet
2820 * queue/dequeue operations.
2822 * - Conversely, it also allows an asynchronous-oriented processing
2823 * method to retrieve bursts of received packets and to immediately
2824 * queue them for further parallel processing by another logical core,
2825 * for instance. However, instead of having received packets being
2826 * individually queued by the driver, this approach allows the caller
2827 * of the rte_eth_rx_burst() function to queue a burst of retrieved
2828 * packets at a time and therefore dramatically reduce the cost of
2829 * enqueue/dequeue operations per packet.
2831 * - It allows the rte_eth_rx_burst() function of the driver to take
2832 * advantage of burst-oriented hardware features (CPU cache,
2833 * prefetch instructions, and so on) to minimize the number of CPU
2834 * cycles per packet.
2836 * To summarize, the proposed receive API enables many
2837 * burst-oriented optimizations in both synchronous and asynchronous
2838 * packet processing environments with no overhead in both cases.
2840 * The rte_eth_rx_burst() function does not provide any error
2841 * notification to avoid the corresponding overhead. As a hint, the
2842 * upper-level application might check the status of the device link once
2843 * being systematically returned a 0 value for a given number of tries.
2846 * The port identifier of the Ethernet device.
2848 * The index of the receive queue from which to retrieve input packets.
2849 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2850 * to rte_eth_dev_configure().
2852 * The address of an array of pointers to *rte_mbuf* structures that
2853 * must be large enough to store *nb_pkts* pointers in it.
2855 * The maximum number of packets to retrieve.
2857 * The number of packets actually retrieved, which is the number
2858 * of pointers to *rte_mbuf* structures effectively supplied to the
2861 static inline uint16_t
2862 rte_eth_rx_burst(uint16_t port_id, uint16_t queue_id,
2863 struct rte_mbuf **rx_pkts, const uint16_t nb_pkts)
2865 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2867 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2868 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
2869 RTE_FUNC_PTR_OR_ERR_RET(*dev->rx_pkt_burst, 0);
2871 if (queue_id >= dev->data->nb_rx_queues) {
2872 RTE_PMD_DEBUG_TRACE("Invalid RX queue_id=%d\n", queue_id);
2876 int16_t nb_rx = (*dev->rx_pkt_burst)(dev->data->rx_queues[queue_id],
2879 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
2880 struct rte_eth_rxtx_callback *cb = dev->post_rx_burst_cbs[queue_id];
2882 if (unlikely(cb != NULL)) {
2884 nb_rx = cb->fn.rx(port_id, queue_id, rx_pkts, nb_rx,
2885 nb_pkts, cb->param);
2887 } while (cb != NULL);
2895 * Get the number of used descriptors of a rx queue
2898 * The port identifier of the Ethernet device.
2900 * The queue id on the specific port.
2902 * The number of used descriptors in the specific queue, or:
2903 * (-EINVAL) if *port_id* or *queue_id* is invalid
2904 * (-ENOTSUP) if the device does not support this function
2907 rte_eth_rx_queue_count(uint16_t port_id, uint16_t queue_id)
2909 struct rte_eth_dev *dev;
2911 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -EINVAL);
2912 dev = &rte_eth_devices[port_id];
2913 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_queue_count, -ENOTSUP);
2914 if (queue_id >= dev->data->nb_rx_queues)
2917 return (*dev->dev_ops->rx_queue_count)(dev, queue_id);
2921 * Check if the DD bit of the specific RX descriptor in the queue has been set
2924 * The port identifier of the Ethernet device.
2926 * The queue id on the specific port.
2928 * The offset of the descriptor ID from tail.
2930 * - (1) if the specific DD bit is set.
2931 * - (0) if the specific DD bit is not set.
2932 * - (-ENODEV) if *port_id* invalid.
2933 * - (-ENOTSUP) if the device does not support this function
2936 rte_eth_rx_descriptor_done(uint16_t port_id, uint16_t queue_id, uint16_t offset)
2938 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2939 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
2940 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_descriptor_done, -ENOTSUP);
2941 return (*dev->dev_ops->rx_descriptor_done)( \
2942 dev->data->rx_queues[queue_id], offset);
2945 #define RTE_ETH_RX_DESC_AVAIL 0 /**< Desc available for hw. */
2946 #define RTE_ETH_RX_DESC_DONE 1 /**< Desc done, filled by hw. */
2947 #define RTE_ETH_RX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */
2950 * Check the status of a Rx descriptor in the queue
2952 * It should be called in a similar context than the Rx function:
2953 * - on a dataplane core
2954 * - not concurrently on the same queue
2956 * Since it's a dataplane function, no check is performed on port_id and
2957 * queue_id. The caller must therefore ensure that the port is enabled
2958 * and the queue is configured and running.
2960 * Note: accessing to a random descriptor in the ring may trigger cache
2961 * misses and have a performance impact.
2964 * A valid port identifier of the Ethernet device which.
2966 * A valid Rx queue identifier on this port.
2968 * The offset of the descriptor starting from tail (0 is the next
2969 * packet to be received by the driver).
2972 * - (RTE_ETH_RX_DESC_AVAIL): Descriptor is available for the hardware to
2974 * - (RTE_ETH_RX_DESC_DONE): Descriptor is done, it is filled by hw, but
2975 * not yet processed by the driver (i.e. in the receive queue).
2976 * - (RTE_ETH_RX_DESC_UNAVAIL): Descriptor is unavailable, either hold by
2977 * the driver and not yet returned to hw, or reserved by the hw.
2978 * - (-EINVAL) bad descriptor offset.
2979 * - (-ENOTSUP) if the device does not support this function.
2980 * - (-ENODEV) bad port or queue (only if compiled with debug).
2983 rte_eth_rx_descriptor_status(uint16_t port_id, uint16_t queue_id,
2986 struct rte_eth_dev *dev;
2989 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2990 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
2992 dev = &rte_eth_devices[port_id];
2993 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2994 if (queue_id >= dev->data->nb_rx_queues)
2997 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_descriptor_status, -ENOTSUP);
2998 rxq = dev->data->rx_queues[queue_id];
3000 return (*dev->dev_ops->rx_descriptor_status)(rxq, offset);
3003 #define RTE_ETH_TX_DESC_FULL 0 /**< Desc filled for hw, waiting xmit. */
3004 #define RTE_ETH_TX_DESC_DONE 1 /**< Desc done, packet is transmitted. */
3005 #define RTE_ETH_TX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */
3008 * Check the status of a Tx descriptor in the queue.
3010 * It should be called in a similar context than the Tx function:
3011 * - on a dataplane core
3012 * - not concurrently on the same queue
3014 * Since it's a dataplane function, no check is performed on port_id and
3015 * queue_id. The caller must therefore ensure that the port is enabled
3016 * and the queue is configured and running.
3018 * Note: accessing to a random descriptor in the ring may trigger cache
3019 * misses and have a performance impact.
3022 * A valid port identifier of the Ethernet device which.
3024 * A valid Tx queue identifier on this port.
3026 * The offset of the descriptor starting from tail (0 is the place where
3027 * the next packet will be send).
3030 * - (RTE_ETH_TX_DESC_FULL) Descriptor is being processed by the hw, i.e.
3031 * in the transmit queue.
3032 * - (RTE_ETH_TX_DESC_DONE) Hardware is done with this descriptor, it can
3033 * be reused by the driver.
3034 * - (RTE_ETH_TX_DESC_UNAVAIL): Descriptor is unavailable, reserved by the
3035 * driver or the hardware.
3036 * - (-EINVAL) bad descriptor offset.
3037 * - (-ENOTSUP) if the device does not support this function.
3038 * - (-ENODEV) bad port or queue (only if compiled with debug).
3040 static inline int rte_eth_tx_descriptor_status(uint16_t port_id,
3041 uint16_t queue_id, uint16_t offset)
3043 struct rte_eth_dev *dev;
3046 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3047 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
3049 dev = &rte_eth_devices[port_id];
3050 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3051 if (queue_id >= dev->data->nb_tx_queues)
3054 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->tx_descriptor_status, -ENOTSUP);
3055 txq = dev->data->tx_queues[queue_id];
3057 return (*dev->dev_ops->tx_descriptor_status)(txq, offset);
3061 * Send a burst of output packets on a transmit queue of an Ethernet device.
3063 * The rte_eth_tx_burst() function is invoked to transmit output packets
3064 * on the output queue *queue_id* of the Ethernet device designated by its
3066 * The *nb_pkts* parameter is the number of packets to send which are
3067 * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
3068 * allocated from a pool created with rte_pktmbuf_pool_create().
3069 * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
3070 * up to the number of transmit descriptors available in the TX ring of the
3072 * For each packet to send, the rte_eth_tx_burst() function performs
3073 * the following operations:
3075 * - Pick up the next available descriptor in the transmit ring.
3077 * - Free the network buffer previously sent with that descriptor, if any.
3079 * - Initialize the transmit descriptor with the information provided
3080 * in the *rte_mbuf data structure.
3082 * In the case of a segmented packet composed of a list of *rte_mbuf* buffers,
3083 * the rte_eth_tx_burst() function uses several transmit descriptors
3086 * The rte_eth_tx_burst() function returns the number of packets it
3087 * actually sent. A return value equal to *nb_pkts* means that all packets
3088 * have been sent, and this is likely to signify that other output packets
3089 * could be immediately transmitted again. Applications that implement a
3090 * "send as many packets to transmit as possible" policy can check this
3091 * specific case and keep invoking the rte_eth_tx_burst() function until
3092 * a value less than *nb_pkts* is returned.
3094 * It is the responsibility of the rte_eth_tx_burst() function to
3095 * transparently free the memory buffers of packets previously sent.
3096 * This feature is driven by the *tx_free_thresh* value supplied to the
3097 * rte_eth_dev_configure() function at device configuration time.
3098 * When the number of free TX descriptors drops below this threshold, the
3099 * rte_eth_tx_burst() function must [attempt to] free the *rte_mbuf* buffers
3100 * of those packets whose transmission was effectively completed.
3102 * If the PMD is DEV_TX_OFFLOAD_MT_LOCKFREE capable, multiple threads can
3103 * invoke this function concurrently on the same tx queue without SW lock.
3104 * @see rte_eth_dev_info_get, struct rte_eth_txconf::txq_flags
3107 * The port identifier of the Ethernet device.
3109 * The index of the transmit queue through which output packets must be
3111 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3112 * to rte_eth_dev_configure().
3114 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
3115 * which contain the output packets.
3117 * The maximum number of packets to transmit.
3119 * The number of output packets actually stored in transmit descriptors of
3120 * the transmit ring. The return value can be less than the value of the
3121 * *tx_pkts* parameter when the transmit ring is full or has been filled up.
3123 static inline uint16_t
3124 rte_eth_tx_burst(uint16_t port_id, uint16_t queue_id,
3125 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
3127 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
3129 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3130 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
3131 RTE_FUNC_PTR_OR_ERR_RET(*dev->tx_pkt_burst, 0);
3133 if (queue_id >= dev->data->nb_tx_queues) {
3134 RTE_PMD_DEBUG_TRACE("Invalid TX queue_id=%d\n", queue_id);
3139 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
3140 struct rte_eth_rxtx_callback *cb = dev->pre_tx_burst_cbs[queue_id];
3142 if (unlikely(cb != NULL)) {
3144 nb_pkts = cb->fn.tx(port_id, queue_id, tx_pkts, nb_pkts,
3147 } while (cb != NULL);
3151 return (*dev->tx_pkt_burst)(dev->data->tx_queues[queue_id], tx_pkts, nb_pkts);
3156 * @b EXPERIMENTAL: this API may change without prior notice
3158 * Process a burst of output packets on a transmit queue of an Ethernet device.
3160 * The rte_eth_tx_prepare() function is invoked to prepare output packets to be
3161 * transmitted on the output queue *queue_id* of the Ethernet device designated
3163 * The *nb_pkts* parameter is the number of packets to be prepared which are
3164 * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
3165 * allocated from a pool created with rte_pktmbuf_pool_create().
3166 * For each packet to send, the rte_eth_tx_prepare() function performs
3167 * the following operations:
3169 * - Check if packet meets devices requirements for tx offloads.
3171 * - Check limitations about number of segments.
3173 * - Check additional requirements when debug is enabled.
3175 * - Update and/or reset required checksums when tx offload is set for packet.
3177 * Since this function can modify packet data, provided mbufs must be safely
3178 * writable (e.g. modified data cannot be in shared segment).
3180 * The rte_eth_tx_prepare() function returns the number of packets ready to be
3181 * sent. A return value equal to *nb_pkts* means that all packets are valid and
3182 * ready to be sent, otherwise stops processing on the first invalid packet and
3183 * leaves the rest packets untouched.
3185 * When this functionality is not implemented in the driver, all packets are
3186 * are returned untouched.
3189 * The port identifier of the Ethernet device.
3190 * The value must be a valid port id.
3192 * The index of the transmit queue through which output packets must be
3194 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3195 * to rte_eth_dev_configure().
3197 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
3198 * which contain the output packets.
3200 * The maximum number of packets to process.
3202 * The number of packets correct and ready to be sent. The return value can be
3203 * less than the value of the *tx_pkts* parameter when some packet doesn't
3204 * meet devices requirements with rte_errno set appropriately:
3205 * - -EINVAL: offload flags are not correctly set
3206 * - -ENOTSUP: the offload feature is not supported by the hardware
3210 #ifndef RTE_ETHDEV_TX_PREPARE_NOOP
3212 static inline uint16_t
3213 rte_eth_tx_prepare(uint16_t port_id, uint16_t queue_id,
3214 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
3216 struct rte_eth_dev *dev;
3218 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3219 if (!rte_eth_dev_is_valid_port(port_id)) {
3220 RTE_PMD_DEBUG_TRACE("Invalid TX port_id=%d\n", port_id);
3221 rte_errno = -EINVAL;
3226 dev = &rte_eth_devices[port_id];
3228 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3229 if (queue_id >= dev->data->nb_tx_queues) {
3230 RTE_PMD_DEBUG_TRACE("Invalid TX queue_id=%d\n", queue_id);
3231 rte_errno = -EINVAL;
3236 if (!dev->tx_pkt_prepare)
3239 return (*dev->tx_pkt_prepare)(dev->data->tx_queues[queue_id],
3246 * Native NOOP operation for compilation targets which doesn't require any
3247 * preparations steps, and functional NOOP may introduce unnecessary performance
3250 * Generally this is not a good idea to turn it on globally and didn't should
3251 * be used if behavior of tx_preparation can change.
3254 static inline uint16_t
3255 rte_eth_tx_prepare(__rte_unused uint16_t port_id,
3256 __rte_unused uint16_t queue_id,
3257 __rte_unused struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
3264 typedef void (*buffer_tx_error_fn)(struct rte_mbuf **unsent, uint16_t count,
3268 * Structure used to buffer packets for future TX
3269 * Used by APIs rte_eth_tx_buffer and rte_eth_tx_buffer_flush
3271 struct rte_eth_dev_tx_buffer {
3272 buffer_tx_error_fn error_callback;
3273 void *error_userdata;
3274 uint16_t size; /**< Size of buffer for buffered tx */
3275 uint16_t length; /**< Number of packets in the array */
3276 struct rte_mbuf *pkts[];
3277 /**< Pending packets to be sent on explicit flush or when full */
3281 * Calculate the size of the tx buffer.
3284 * Number of stored packets.
3286 #define RTE_ETH_TX_BUFFER_SIZE(sz) \
3287 (sizeof(struct rte_eth_dev_tx_buffer) + (sz) * sizeof(struct rte_mbuf *))
3290 * Initialize default values for buffered transmitting
3293 * Tx buffer to be initialized.
3300 rte_eth_tx_buffer_init(struct rte_eth_dev_tx_buffer *buffer, uint16_t size);
3303 * Send any packets queued up for transmission on a port and HW queue
3305 * This causes an explicit flush of packets previously buffered via the
3306 * rte_eth_tx_buffer() function. It returns the number of packets successfully
3307 * sent to the NIC, and calls the error callback for any unsent packets. Unless
3308 * explicitly set up otherwise, the default callback simply frees the unsent
3309 * packets back to the owning mempool.
3312 * The port identifier of the Ethernet device.
3314 * The index of the transmit queue through which output packets must be
3316 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3317 * to rte_eth_dev_configure().
3319 * Buffer of packets to be transmit.
3321 * The number of packets successfully sent to the Ethernet device. The error
3322 * callback is called for any packets which could not be sent.
3324 static inline uint16_t
3325 rte_eth_tx_buffer_flush(uint16_t port_id, uint16_t queue_id,
3326 struct rte_eth_dev_tx_buffer *buffer)
3329 uint16_t to_send = buffer->length;
3334 sent = rte_eth_tx_burst(port_id, queue_id, buffer->pkts, to_send);
3338 /* All packets sent, or to be dealt with by callback below */
3339 if (unlikely(sent != to_send))
3340 buffer->error_callback(&buffer->pkts[sent], to_send - sent,
3341 buffer->error_userdata);
3347 * Buffer a single packet for future transmission on a port and queue
3349 * This function takes a single mbuf/packet and buffers it for later
3350 * transmission on the particular port and queue specified. Once the buffer is
3351 * full of packets, an attempt will be made to transmit all the buffered
3352 * packets. In case of error, where not all packets can be transmitted, a
3353 * callback is called with the unsent packets as a parameter. If no callback
3354 * is explicitly set up, the unsent packets are just freed back to the owning
3355 * mempool. The function returns the number of packets actually sent i.e.
3356 * 0 if no buffer flush occurred, otherwise the number of packets successfully
3360 * The port identifier of the Ethernet device.
3362 * The index of the transmit queue through which output packets must be
3364 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3365 * to rte_eth_dev_configure().
3367 * Buffer used to collect packets to be sent.
3369 * Pointer to the packet mbuf to be sent.
3371 * 0 = packet has been buffered for later transmission
3372 * N > 0 = packet has been buffered, and the buffer was subsequently flushed,
3373 * causing N packets to be sent, and the error callback to be called for
3376 static __rte_always_inline uint16_t
3377 rte_eth_tx_buffer(uint16_t port_id, uint16_t queue_id,
3378 struct rte_eth_dev_tx_buffer *buffer, struct rte_mbuf *tx_pkt)
3380 buffer->pkts[buffer->length++] = tx_pkt;
3381 if (buffer->length < buffer->size)
3384 return rte_eth_tx_buffer_flush(port_id, queue_id, buffer);
3388 * Configure a callback for buffered packets which cannot be sent
3390 * Register a specific callback to be called when an attempt is made to send
3391 * all packets buffered on an ethernet port, but not all packets can
3392 * successfully be sent. The callback registered here will be called only
3393 * from calls to rte_eth_tx_buffer() and rte_eth_tx_buffer_flush() APIs.
3394 * The default callback configured for each queue by default just frees the
3395 * packets back to the calling mempool. If additional behaviour is required,
3396 * for example, to count dropped packets, or to retry transmission of packets
3397 * which cannot be sent, this function should be used to register a suitable
3398 * callback function to implement the desired behaviour.
3399 * The example callback "rte_eth_count_unsent_packet_callback()" is also
3400 * provided as reference.
3403 * The port identifier of the Ethernet device.
3405 * The function to be used as the callback.
3407 * Arbitrary parameter to be passed to the callback function
3409 * 0 on success, or -1 on error with rte_errno set appropriately
3412 rte_eth_tx_buffer_set_err_callback(struct rte_eth_dev_tx_buffer *buffer,
3413 buffer_tx_error_fn callback, void *userdata);
3416 * Callback function for silently dropping unsent buffered packets.
3418 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
3419 * adjust the default behavior when buffered packets cannot be sent. This
3420 * function drops any unsent packets silently and is used by tx buffered
3421 * operations as default behavior.
3423 * NOTE: this function should not be called directly, instead it should be used
3424 * as a callback for packet buffering.
3426 * NOTE: when configuring this function as a callback with
3427 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
3428 * should point to an uint64_t value.
3431 * The previously buffered packets which could not be sent
3433 * The number of unsent packets in the pkts array
3438 rte_eth_tx_buffer_drop_callback(struct rte_mbuf **pkts, uint16_t unsent,
3442 * Callback function for tracking unsent buffered packets.
3444 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
3445 * adjust the default behavior when buffered packets cannot be sent. This
3446 * function drops any unsent packets, but also updates a user-supplied counter
3447 * to track the overall number of packets dropped. The counter should be an
3448 * uint64_t variable.
3450 * NOTE: this function should not be called directly, instead it should be used
3451 * as a callback for packet buffering.
3453 * NOTE: when configuring this function as a callback with
3454 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
3455 * should point to an uint64_t value.
3458 * The previously buffered packets which could not be sent
3460 * The number of unsent packets in the pkts array
3462 * Pointer to an uint64_t value, which will be incremented by unsent
3465 rte_eth_tx_buffer_count_callback(struct rte_mbuf **pkts, uint16_t unsent,
3469 * Request the driver to free mbufs currently cached by the driver. The
3470 * driver will only free the mbuf if it is no longer in use. It is the
3471 * application's responsibity to ensure rte_eth_tx_buffer_flush(..) is
3475 * The port identifier of the Ethernet device.
3477 * The index of the transmit queue through which output packets must be
3479 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3480 * to rte_eth_dev_configure().
3482 * Maximum number of packets to free. Use 0 to indicate all possible packets
3483 * should be freed. Note that a packet may be using multiple mbufs.
3486 * -ENODEV: Invalid interface
3487 * -ENOTSUP: Driver does not support function
3489 * 0-n: Number of packets freed. More packets may still remain in ring that
3493 rte_eth_tx_done_cleanup(uint16_t port_id, uint16_t queue_id, uint32_t free_cnt);
3496 * The eth device event type for interrupt, and maybe others in the future.
3498 enum rte_eth_event_type {
3499 RTE_ETH_EVENT_UNKNOWN, /**< unknown event type */
3500 RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
3501 RTE_ETH_EVENT_QUEUE_STATE,
3502 /**< queue state event (enabled/disabled) */
3503 RTE_ETH_EVENT_INTR_RESET,
3504 /**< reset interrupt event, sent to VF on PF reset */
3505 RTE_ETH_EVENT_VF_MBOX, /**< message from the VF received by PF */
3506 RTE_ETH_EVENT_MACSEC, /**< MACsec offload related event */
3507 RTE_ETH_EVENT_INTR_RMV, /**< device removal event */
3508 RTE_ETH_EVENT_MAX /**< max value of this enum */
3511 typedef int (*rte_eth_dev_cb_fn)(uint16_t port_id,
3512 enum rte_eth_event_type event, void *cb_arg, void *ret_param);
3513 /**< user application callback to be registered for interrupts */
3518 * Register a callback function for specific port id.
3525 * User supplied callback function to be called.
3527 * Pointer to the parameters for the registered callback.
3530 * - On success, zero.
3531 * - On failure, a negative value.
3533 int rte_eth_dev_callback_register(uint16_t port_id,
3534 enum rte_eth_event_type event,
3535 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
3538 * Unregister a callback function for specific port id.
3545 * User supplied callback function to be called.
3547 * Pointer to the parameters for the registered callback. -1 means to
3548 * remove all for the same callback address and same event.
3551 * - On success, zero.
3552 * - On failure, a negative value.
3554 int rte_eth_dev_callback_unregister(uint16_t port_id,
3555 enum rte_eth_event_type event,
3556 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
3559 * @internal Executes all the user application registered callbacks for
3560 * the specific device. It is for DPDK internal user only. User
3561 * application should not call it directly.
3564 * Pointer to struct rte_eth_dev.
3566 * Eth device interrupt event type.
3568 * callback parameter.
3570 * To pass data back to user application.
3571 * This allows the user application to decide if a particular function
3572 * is permitted or not.
3577 int _rte_eth_dev_callback_process(struct rte_eth_dev *dev,
3578 enum rte_eth_event_type event, void *cb_arg, void *ret_param);
3581 * When there is no rx packet coming in Rx Queue for a long time, we can
3582 * sleep lcore related to RX Queue for power saving, and enable rx interrupt
3583 * to be triggered when Rx packet arrives.
3585 * The rte_eth_dev_rx_intr_enable() function enables rx queue
3586 * interrupt on specific rx queue of a port.
3589 * The port identifier of the Ethernet device.
3591 * The index of the receive queue from which to retrieve input packets.
3592 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3593 * to rte_eth_dev_configure().
3595 * - (0) if successful.
3596 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3598 * - (-ENODEV) if *port_id* invalid.
3600 int rte_eth_dev_rx_intr_enable(uint16_t port_id, uint16_t queue_id);
3603 * When lcore wakes up from rx interrupt indicating packet coming, disable rx
3604 * interrupt and returns to polling mode.
3606 * The rte_eth_dev_rx_intr_disable() function disables 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_disable(uint16_t port_id, uint16_t queue_id);
3624 * RX Interrupt control per port.
3627 * The port identifier of the Ethernet device.
3629 * Epoll instance fd which the intr vector associated to.
3630 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
3632 * The operation be performed for the vector.
3633 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
3637 * - On success, zero.
3638 * - On failure, a negative value.
3640 int rte_eth_dev_rx_intr_ctl(uint16_t port_id, int epfd, int op, void *data);
3643 * RX Interrupt control per queue.
3646 * The port identifier of the Ethernet device.
3648 * The index of the receive queue from which to retrieve input packets.
3649 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3650 * to rte_eth_dev_configure().
3652 * Epoll instance fd which the intr vector associated to.
3653 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
3655 * The operation be performed for the vector.
3656 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
3660 * - On success, zero.
3661 * - On failure, a negative value.
3663 int rte_eth_dev_rx_intr_ctl_q(uint16_t port_id, uint16_t queue_id,
3664 int epfd, int op, void *data);
3667 * Turn on the LED on the Ethernet device.
3668 * This function turns on the LED on the Ethernet device.
3671 * The port identifier of the Ethernet device.
3673 * - (0) if successful.
3674 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3676 * - (-ENODEV) if *port_id* invalid.
3678 int rte_eth_led_on(uint16_t port_id);
3681 * Turn off the LED on the Ethernet device.
3682 * This function turns off the LED on the Ethernet device.
3685 * The port identifier of the Ethernet device.
3687 * - (0) if successful.
3688 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3690 * - (-ENODEV) if *port_id* invalid.
3692 int rte_eth_led_off(uint16_t port_id);
3695 * Get current status of the Ethernet link flow control for Ethernet device
3698 * The port identifier of the Ethernet device.
3700 * The pointer to the structure where to store the flow control parameters.
3702 * - (0) if successful.
3703 * - (-ENOTSUP) if hardware doesn't support flow control.
3704 * - (-ENODEV) if *port_id* invalid.
3706 int rte_eth_dev_flow_ctrl_get(uint16_t port_id,
3707 struct rte_eth_fc_conf *fc_conf);
3710 * Configure the Ethernet link flow control for Ethernet device
3713 * The port identifier of the Ethernet device.
3715 * The pointer to the structure of the flow control parameters.
3717 * - (0) if successful.
3718 * - (-ENOTSUP) if hardware doesn't support flow control mode.
3719 * - (-ENODEV) if *port_id* invalid.
3720 * - (-EINVAL) if bad parameter
3721 * - (-EIO) if flow control setup failure
3723 int rte_eth_dev_flow_ctrl_set(uint16_t port_id,
3724 struct rte_eth_fc_conf *fc_conf);
3727 * Configure the Ethernet priority flow control under DCB environment
3728 * for Ethernet device.
3731 * The port identifier of the Ethernet device.
3733 * The pointer to the structure of the priority flow control parameters.
3735 * - (0) if successful.
3736 * - (-ENOTSUP) if hardware doesn't support priority flow control mode.
3737 * - (-ENODEV) if *port_id* invalid.
3738 * - (-EINVAL) if bad parameter
3739 * - (-EIO) if flow control setup failure
3741 int rte_eth_dev_priority_flow_ctrl_set(uint16_t port_id,
3742 struct rte_eth_pfc_conf *pfc_conf);
3745 * Add a MAC address to an internal array of addresses used to enable whitelist
3746 * filtering to accept packets only if the destination MAC address matches.
3749 * The port identifier of the Ethernet device.
3751 * The MAC address to add.
3753 * VMDq pool index to associate address with (if VMDq is enabled). If VMDq is
3754 * not enabled, this should be set to 0.
3756 * - (0) if successfully added or *mac_addr" was already added.
3757 * - (-ENOTSUP) if hardware doesn't support this feature.
3758 * - (-ENODEV) if *port* is invalid.
3759 * - (-ENOSPC) if no more MAC addresses can be added.
3760 * - (-EINVAL) if MAC address is invalid.
3762 int rte_eth_dev_mac_addr_add(uint16_t port, struct ether_addr *mac_addr,
3766 * Remove a MAC address from the internal array of addresses.
3769 * The port identifier of the Ethernet device.
3771 * MAC address to remove.
3773 * - (0) if successful, or *mac_addr* didn't exist.
3774 * - (-ENOTSUP) if hardware doesn't support.
3775 * - (-ENODEV) if *port* invalid.
3776 * - (-EADDRINUSE) if attempting to remove the default MAC address
3778 int rte_eth_dev_mac_addr_remove(uint16_t port, struct ether_addr *mac_addr);
3781 * Set the default MAC address.
3784 * The port identifier of the Ethernet device.
3786 * New default MAC address.
3788 * - (0) if successful, or *mac_addr* didn't exist.
3789 * - (-ENOTSUP) if hardware doesn't support.
3790 * - (-ENODEV) if *port* invalid.
3791 * - (-EINVAL) if MAC address is invalid.
3793 int rte_eth_dev_default_mac_addr_set(uint16_t port,
3794 struct ether_addr *mac_addr);
3797 * Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3800 * The port identifier of the Ethernet device.
3804 * Redirection table size. The table size can be queried by
3805 * rte_eth_dev_info_get().
3807 * - (0) if successful.
3808 * - (-ENOTSUP) if hardware doesn't support.
3809 * - (-EINVAL) if bad parameter.
3811 int rte_eth_dev_rss_reta_update(uint16_t port,
3812 struct rte_eth_rss_reta_entry64 *reta_conf,
3813 uint16_t reta_size);
3816 * Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3819 * The port identifier of the Ethernet device.
3823 * Redirection table size. The table size can be queried by
3824 * rte_eth_dev_info_get().
3826 * - (0) if successful.
3827 * - (-ENOTSUP) if hardware doesn't support.
3828 * - (-EINVAL) if bad parameter.
3830 int rte_eth_dev_rss_reta_query(uint16_t port,
3831 struct rte_eth_rss_reta_entry64 *reta_conf,
3832 uint16_t reta_size);
3835 * Updates unicast hash table for receiving packet with the given destination
3836 * MAC address, and the packet is routed to all VFs for which the RX mode is
3837 * accept packets that match the unicast hash table.
3840 * The port identifier of the Ethernet device.
3842 * Unicast MAC address.
3844 * 1 - Set an unicast hash bit for receiving packets with the MAC address.
3845 * 0 - Clear an unicast hash bit.
3847 * - (0) if successful.
3848 * - (-ENOTSUP) if hardware doesn't support.
3849 * - (-ENODEV) if *port_id* invalid.
3850 * - (-EINVAL) if bad parameter.
3852 int rte_eth_dev_uc_hash_table_set(uint16_t port, struct ether_addr *addr,
3856 * Updates all unicast hash bitmaps for receiving packet with any Unicast
3857 * Ethernet MAC addresses,the packet is routed to all VFs for which the RX
3858 * mode is accept packets that match the unicast hash table.
3861 * The port identifier of the Ethernet device.
3863 * 1 - Set all unicast hash bitmaps for receiving all the Ethernet
3865 * 0 - Clear all unicast hash bitmaps
3867 * - (0) if successful.
3868 * - (-ENOTSUP) if hardware doesn't support.
3869 * - (-ENODEV) if *port_id* invalid.
3870 * - (-EINVAL) if bad parameter.
3872 int rte_eth_dev_uc_all_hash_table_set(uint16_t port, uint8_t on);
3875 * Set a traffic mirroring rule on an Ethernet device
3878 * The port identifier of the Ethernet device.
3879 * @param mirror_conf
3880 * The pointer to the traffic mirroring structure describing the mirroring rule.
3881 * The *rte_eth_vm_mirror_conf* structure includes the type of mirroring rule,
3882 * destination pool and the value of rule if enable vlan or pool mirroring.
3885 * The index of traffic mirroring rule, we support four separated rules.
3887 * 1 - Enable a mirroring rule.
3888 * 0 - Disable a mirroring rule.
3890 * - (0) if successful.
3891 * - (-ENOTSUP) if hardware doesn't support this feature.
3892 * - (-ENODEV) if *port_id* invalid.
3893 * - (-EINVAL) if the mr_conf information is not correct.
3895 int rte_eth_mirror_rule_set(uint16_t port_id,
3896 struct rte_eth_mirror_conf *mirror_conf,
3901 * Reset a traffic mirroring rule on an Ethernet device.
3904 * The port identifier of the Ethernet device.
3906 * The index of traffic mirroring rule, we support four separated rules.
3908 * - (0) if successful.
3909 * - (-ENOTSUP) if hardware doesn't support this feature.
3910 * - (-ENODEV) if *port_id* invalid.
3911 * - (-EINVAL) if bad parameter.
3913 int rte_eth_mirror_rule_reset(uint16_t port_id,
3917 * Set the rate limitation for a queue on an Ethernet device.
3920 * The port identifier of the Ethernet device.
3924 * The tx rate in Mbps. Allocated from the total port link speed.
3926 * - (0) if successful.
3927 * - (-ENOTSUP) if hardware doesn't support this feature.
3928 * - (-ENODEV) if *port_id* invalid.
3929 * - (-EINVAL) if bad parameter.
3931 int rte_eth_set_queue_rate_limit(uint16_t port_id, uint16_t queue_idx,
3935 * Configuration of Receive Side Scaling hash computation of Ethernet device.
3938 * The port identifier of the Ethernet device.
3940 * The new configuration to use for RSS hash computation on the port.
3942 * - (0) if successful.
3943 * - (-ENODEV) if port identifier is invalid.
3944 * - (-ENOTSUP) if hardware doesn't support.
3945 * - (-EINVAL) if bad parameter.
3947 int rte_eth_dev_rss_hash_update(uint16_t port_id,
3948 struct rte_eth_rss_conf *rss_conf);
3951 * Retrieve current configuration of Receive Side Scaling hash computation
3952 * of Ethernet device.
3955 * The port identifier of the Ethernet device.
3957 * Where to store the current RSS hash configuration of the Ethernet device.
3959 * - (0) if successful.
3960 * - (-ENODEV) if port identifier is invalid.
3961 * - (-ENOTSUP) if hardware doesn't support RSS.
3964 rte_eth_dev_rss_hash_conf_get(uint16_t port_id,
3965 struct rte_eth_rss_conf *rss_conf);
3968 * Add UDP tunneling port for a specific type of tunnel.
3969 * The packets with this UDP port will be identified as this type of tunnel.
3970 * Before enabling any offloading function for a tunnel, users can call this API
3971 * to change or add more UDP port for the tunnel. So the offloading function
3972 * can take effect on the packets with the specific UDP port.
3975 * The port identifier of the Ethernet device.
3977 * UDP tunneling configuration.
3980 * - (0) if successful.
3981 * - (-ENODEV) if port identifier is invalid.
3982 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3985 rte_eth_dev_udp_tunnel_port_add(uint16_t port_id,
3986 struct rte_eth_udp_tunnel *tunnel_udp);
3989 * Delete UDP tunneling port a specific type of tunnel.
3990 * The packets with this UDP port will not be identified as this type of tunnel
3992 * Before enabling any offloading function for a tunnel, users can call this API
3993 * to delete a UDP port for the tunnel. So the offloading function will not take
3994 * effect on the packets with the specific UDP port.
3997 * The port identifier of the Ethernet device.
3999 * UDP tunneling configuration.
4002 * - (0) if successful.
4003 * - (-ENODEV) if port identifier is invalid.
4004 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4007 rte_eth_dev_udp_tunnel_port_delete(uint16_t port_id,
4008 struct rte_eth_udp_tunnel *tunnel_udp);
4011 * Check whether the filter type is supported on an Ethernet device.
4012 * All the supported filter types are defined in 'rte_eth_ctrl.h'.
4015 * The port identifier of the Ethernet device.
4016 * @param filter_type
4019 * - (0) if successful.
4020 * - (-ENOTSUP) if hardware doesn't support this filter type.
4021 * - (-ENODEV) if *port_id* invalid.
4023 int rte_eth_dev_filter_supported(uint16_t port_id,
4024 enum rte_filter_type filter_type);
4027 * Take operations to assigned filter type on an Ethernet device.
4028 * All the supported operations and filter types are defined in 'rte_eth_ctrl.h'.
4031 * The port identifier of the Ethernet device.
4032 * @param filter_type
4035 * Type of operation.
4037 * A pointer to arguments defined specifically for the operation.
4039 * - (0) if successful.
4040 * - (-ENOTSUP) if hardware doesn't support.
4041 * - (-ENODEV) if *port_id* invalid.
4042 * - others depends on the specific operations implementation.
4044 int rte_eth_dev_filter_ctrl(uint16_t port_id, enum rte_filter_type filter_type,
4045 enum rte_filter_op filter_op, void *arg);
4048 * Get DCB information on an Ethernet device.
4051 * The port identifier of the Ethernet device.
4055 * - (0) if successful.
4056 * - (-ENODEV) if port identifier is invalid.
4057 * - (-ENOTSUP) if hardware doesn't support.
4059 int rte_eth_dev_get_dcb_info(uint16_t port_id,
4060 struct rte_eth_dcb_info *dcb_info);
4063 * Add a callback to be called on packet RX on a given port and queue.
4065 * This API configures a function to be called for each burst of
4066 * packets received on a given NIC port queue. The return value is a pointer
4067 * that can be used to later remove the callback using
4068 * rte_eth_remove_rx_callback().
4070 * Multiple functions are called in the order that they are added.
4073 * The port identifier of the Ethernet device.
4075 * The queue on the Ethernet device on which the callback is to be added.
4077 * The callback function
4079 * A generic pointer parameter which will be passed to each invocation of the
4080 * callback function on this port and queue.
4084 * On success, a pointer value which can later be used to remove the callback.
4086 void *rte_eth_add_rx_callback(uint16_t port_id, uint16_t queue_id,
4087 rte_rx_callback_fn fn, void *user_param);
4090 * Add a callback that must be called first on packet RX on a given port
4093 * This API configures a first function to be called for each burst of
4094 * packets received on a given NIC port queue. The return value is a pointer
4095 * that can be used to later remove the callback using
4096 * rte_eth_remove_rx_callback().
4098 * Multiple functions are called in the order that they are added.
4101 * The port identifier of the Ethernet device.
4103 * The queue on the Ethernet device on which the callback is to be added.
4105 * The callback function
4107 * A generic pointer parameter which will be passed to each invocation of the
4108 * callback function on this port and queue.
4112 * On success, a pointer value which can later be used to remove the callback.
4114 void *rte_eth_add_first_rx_callback(uint16_t port_id, uint16_t queue_id,
4115 rte_rx_callback_fn fn, void *user_param);
4118 * Add a callback to be called on packet TX on a given port and queue.
4120 * This API configures a function to be called for each burst of
4121 * packets sent on a given NIC port queue. The return value is a pointer
4122 * that can be used to later remove the callback using
4123 * rte_eth_remove_tx_callback().
4125 * Multiple functions are called in the order that they are added.
4128 * The port identifier of the Ethernet device.
4130 * The queue on the Ethernet device on which the callback is to be added.
4132 * The callback function
4134 * A generic pointer parameter which will be passed to each invocation of the
4135 * callback function on this port and queue.
4139 * On success, a pointer value which can later be used to remove the callback.
4141 void *rte_eth_add_tx_callback(uint16_t port_id, uint16_t queue_id,
4142 rte_tx_callback_fn fn, void *user_param);
4145 * Remove an RX packet callback from a given port and queue.
4147 * This function is used to removed callbacks that were added to a NIC port
4148 * queue using rte_eth_add_rx_callback().
4150 * Note: the callback is removed from the callback list but it isn't freed
4151 * since the it may still be in use. The memory for the callback can be
4152 * subsequently freed back by the application by calling rte_free():
4154 * - Immediately - if the port is stopped, or the user knows that no
4155 * callbacks are in flight e.g. if called from the thread doing RX/TX
4158 * - After a short delay - where the delay is sufficient to allow any
4159 * in-flight callbacks to complete.
4162 * The port identifier of the Ethernet device.
4164 * The queue on the Ethernet device from which the callback is to be removed.
4166 * User supplied callback created via rte_eth_add_rx_callback().
4169 * - 0: Success. Callback was removed.
4170 * - -ENOTSUP: Callback support is not available.
4171 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
4172 * is NULL or not found for the port/queue.
4174 int rte_eth_remove_rx_callback(uint16_t port_id, uint16_t queue_id,
4175 struct rte_eth_rxtx_callback *user_cb);
4178 * Remove a TX packet callback from a given port and queue.
4180 * This function is used to removed callbacks that were added to a NIC port
4181 * queue using rte_eth_add_tx_callback().
4183 * Note: the callback is removed from the callback list but it isn't freed
4184 * since the it may still be in use. The memory for the callback can be
4185 * subsequently freed back by the application by calling rte_free():
4187 * - Immediately - if the port is stopped, or the user knows that no
4188 * callbacks are in flight e.g. if called from the thread doing RX/TX
4191 * - After a short delay - where the delay is sufficient to allow any
4192 * in-flight callbacks to complete.
4195 * The port identifier of the Ethernet device.
4197 * The queue on the Ethernet device from which the callback is to be removed.
4199 * User supplied callback created via rte_eth_add_tx_callback().
4202 * - 0: Success. Callback was removed.
4203 * - -ENOTSUP: Callback support is not available.
4204 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
4205 * is NULL or not found for the port/queue.
4207 int rte_eth_remove_tx_callback(uint16_t port_id, uint16_t queue_id,
4208 struct rte_eth_rxtx_callback *user_cb);
4211 * Retrieve information about given port's RX queue.
4214 * The port identifier of the Ethernet device.
4216 * The RX queue on the Ethernet device for which information
4217 * will be retrieved.
4219 * A pointer to a structure of type *rte_eth_rxq_info_info* to be filled with
4220 * the information of the Ethernet device.
4224 * - -ENOTSUP: routine is not supported by the device PMD.
4225 * - -EINVAL: The port_id or the queue_id is out of range.
4227 int rte_eth_rx_queue_info_get(uint16_t port_id, uint16_t queue_id,
4228 struct rte_eth_rxq_info *qinfo);
4231 * Retrieve information about given port's TX queue.
4234 * The port identifier of the Ethernet device.
4236 * The TX queue on the Ethernet device for which information
4237 * will be retrieved.
4239 * A pointer to a structure of type *rte_eth_txq_info_info* to be filled with
4240 * the information of the Ethernet device.
4244 * - -ENOTSUP: routine is not supported by the device PMD.
4245 * - -EINVAL: The port_id or the queue_id is out of range.
4247 int rte_eth_tx_queue_info_get(uint16_t port_id, uint16_t queue_id,
4248 struct rte_eth_txq_info *qinfo);
4251 * Retrieve device registers and register attributes (number of registers and
4255 * The port identifier of the Ethernet device.
4257 * Pointer to rte_dev_reg_info structure to fill in. If info->data is
4258 * NULL the function fills in the width and length fields. If non-NULL
4259 * the registers are put into the buffer pointed at by the data field.
4261 * - (0) if successful.
4262 * - (-ENOTSUP) if hardware doesn't support.
4263 * - (-ENODEV) if *port_id* invalid.
4264 * - others depends on the specific operations implementation.
4266 int rte_eth_dev_get_reg_info(uint16_t port_id, struct rte_dev_reg_info *info);
4269 * Retrieve size of device EEPROM
4272 * The port identifier of the Ethernet device.
4274 * - (>=0) EEPROM size if successful.
4275 * - (-ENOTSUP) if hardware doesn't support.
4276 * - (-ENODEV) if *port_id* invalid.
4277 * - others depends on the specific operations implementation.
4279 int rte_eth_dev_get_eeprom_length(uint16_t port_id);
4282 * Retrieve EEPROM and EEPROM attribute
4285 * The port identifier of the Ethernet device.
4287 * The template includes buffer for return EEPROM data and
4288 * EEPROM attributes to be filled.
4290 * - (0) if successful.
4291 * - (-ENOTSUP) if hardware doesn't support.
4292 * - (-ENODEV) if *port_id* invalid.
4293 * - others depends on the specific operations implementation.
4295 int rte_eth_dev_get_eeprom(uint16_t port_id, struct rte_dev_eeprom_info *info);
4298 * Program EEPROM with provided data
4301 * The port identifier of the Ethernet device.
4303 * The template includes EEPROM data for programming and
4304 * EEPROM attributes to be filled
4306 * - (0) if successful.
4307 * - (-ENOTSUP) if hardware doesn't support.
4308 * - (-ENODEV) if *port_id* invalid.
4309 * - others depends on the specific operations implementation.
4311 int rte_eth_dev_set_eeprom(uint16_t port_id, struct rte_dev_eeprom_info *info);
4314 * Set the list of multicast addresses to filter on an Ethernet device.
4317 * The port identifier of the Ethernet device.
4318 * @param mc_addr_set
4319 * The array of multicast addresses to set. Equal to NULL when the function
4320 * is invoked to flush the set of filtered addresses.
4322 * The number of multicast addresses in the *mc_addr_set* array. Equal to 0
4323 * when the function is invoked to flush the set of filtered addresses.
4325 * - (0) if successful.
4326 * - (-ENODEV) if *port_id* invalid.
4327 * - (-ENOTSUP) if PMD of *port_id* doesn't support multicast filtering.
4328 * - (-ENOSPC) if *port_id* has not enough multicast filtering resources.
4330 int rte_eth_dev_set_mc_addr_list(uint16_t port_id,
4331 struct ether_addr *mc_addr_set,
4332 uint32_t nb_mc_addr);
4335 * Enable IEEE1588/802.1AS timestamping for an Ethernet device.
4338 * The port identifier of the Ethernet device.
4342 * - -ENODEV: The port ID is invalid.
4343 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4345 int rte_eth_timesync_enable(uint16_t port_id);
4348 * Disable IEEE1588/802.1AS timestamping for an Ethernet device.
4351 * The port identifier of the Ethernet device.
4355 * - -ENODEV: The port ID is invalid.
4356 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4358 int rte_eth_timesync_disable(uint16_t port_id);
4361 * Read an IEEE1588/802.1AS RX timestamp from an Ethernet device.
4364 * The port identifier of the Ethernet device.
4366 * Pointer to the timestamp struct.
4368 * Device specific flags. Used to pass the RX timesync register index to
4369 * i40e. Unused in igb/ixgbe, pass 0 instead.
4373 * - -EINVAL: No timestamp is available.
4374 * - -ENODEV: The port ID is invalid.
4375 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4377 int rte_eth_timesync_read_rx_timestamp(uint16_t port_id,
4378 struct timespec *timestamp, uint32_t flags);
4381 * Read an IEEE1588/802.1AS TX timestamp from an Ethernet device.
4384 * The port identifier of the Ethernet device.
4386 * Pointer to the timestamp struct.
4390 * - -EINVAL: No timestamp is available.
4391 * - -ENODEV: The port ID is invalid.
4392 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4394 int rte_eth_timesync_read_tx_timestamp(uint16_t port_id,
4395 struct timespec *timestamp);
4398 * Adjust the timesync clock on an Ethernet device.
4400 * This is usually used in conjunction with other Ethdev timesync functions to
4401 * synchronize the device time using the IEEE1588/802.1AS protocol.
4404 * The port identifier of the Ethernet device.
4406 * The adjustment in nanoseconds.
4410 * - -ENODEV: The port ID is invalid.
4411 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4413 int rte_eth_timesync_adjust_time(uint16_t port_id, int64_t delta);
4416 * Read the time from the timesync clock on an Ethernet device.
4418 * This is usually used in conjunction with other Ethdev timesync functions to
4419 * synchronize the device time using the IEEE1588/802.1AS protocol.
4422 * The port identifier of the Ethernet device.
4424 * Pointer to the timespec struct that holds the time.
4429 int rte_eth_timesync_read_time(uint16_t port_id, struct timespec *time);
4432 * Set the time of the timesync clock on an Ethernet device.
4434 * This is usually used in conjunction with other Ethdev timesync functions to
4435 * synchronize the device time using the IEEE1588/802.1AS protocol.
4438 * The port identifier of the Ethernet device.
4440 * Pointer to the timespec struct that holds the time.
4444 * - -EINVAL: No timestamp is available.
4445 * - -ENODEV: The port ID is invalid.
4446 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4448 int rte_eth_timesync_write_time(uint16_t port_id, const struct timespec *time);
4451 * Create memzone for HW rings.
4452 * malloc can't be used as the physical address is needed.
4453 * If the memzone is already created, then this function returns a ptr
4457 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
4459 * The name of the memory zone
4461 * The index of the queue to add to name
4463 * The sizeof of the memory area
4465 * Alignment for resulting memzone. Must be a power of 2.
4467 * The *socket_id* argument is the socket identifier in case of NUMA.
4469 const struct rte_memzone *
4470 rte_eth_dma_zone_reserve(const struct rte_eth_dev *eth_dev, const char *name,
4471 uint16_t queue_id, size_t size,
4472 unsigned align, int socket_id);
4475 * Config l2 tunnel ether type of an Ethernet device for filtering specific
4476 * tunnel packets by ether type.
4479 * The port identifier of the Ethernet device.
4481 * l2 tunnel configuration.
4484 * - (0) if successful.
4485 * - (-ENODEV) if port identifier is invalid.
4486 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4489 rte_eth_dev_l2_tunnel_eth_type_conf(uint16_t port_id,
4490 struct rte_eth_l2_tunnel_conf *l2_tunnel);
4493 * Enable/disable l2 tunnel offload functions. Include,
4494 * 1, The ability of parsing a type of l2 tunnel of an Ethernet device.
4495 * Filtering, forwarding and offloading this type of tunnel packets depend on
4497 * 2, Stripping the l2 tunnel tag.
4498 * 3, Insertion of the l2 tunnel tag.
4499 * 4, Forwarding the packets based on the l2 tunnel tag.
4502 * The port identifier of the Ethernet device.
4504 * l2 tunnel parameters.
4506 * Indicate the offload function.
4508 * Enable or disable this function.
4511 * - (0) if successful.
4512 * - (-ENODEV) if port identifier is invalid.
4513 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4516 rte_eth_dev_l2_tunnel_offload_set(uint16_t port_id,
4517 struct rte_eth_l2_tunnel_conf *l2_tunnel,
4522 * Get the port id from pci address or device name
4523 * Ex: 0000:2:00.0 or vdev name net_pcap0
4526 * pci address or name of the device
4528 * pointer to port identifier of the device
4530 * - (0) if successful and port_id is filled.
4531 * - (-ENODEV or -EINVAL) on failure.
4534 rte_eth_dev_get_port_by_name(const char *name, uint16_t *port_id);
4537 * Get the device name from port id
4540 * pointer to port identifier of the device
4542 * pci address or name of the device
4544 * - (0) if successful.
4545 * - (-EINVAL) on failure.
4548 rte_eth_dev_get_name_by_port(uint16_t port_id, char *name);
4551 * Check that numbers of Rx and Tx descriptors satisfy descriptors limits from
4552 * the ethernet device information, otherwise adjust them to boundaries.
4555 * The port identifier of the Ethernet device.
4557 * A pointer to a uint16_t where the number of receive
4558 * descriptors stored.
4560 * A pointer to a uint16_t where the number of transmit
4561 * descriptors stored.
4563 * - (0) if successful.
4564 * - (-ENOTSUP, -ENODEV or -EINVAL) on failure.
4566 int rte_eth_dev_adjust_nb_rx_tx_desc(uint16_t port_id,
4567 uint16_t *nb_rx_desc,
4568 uint16_t *nb_tx_desc);
4572 * Test if a port supports specific mempool ops.
4575 * Port identifier of the Ethernet device.
4577 * The name of the pool operations to test.
4579 * - 0: best mempool ops choice for this port.
4580 * - 1: mempool ops are supported for this port.
4581 * - -ENOTSUP: mempool ops not supported for this port.
4582 * - -ENODEV: Invalid port Identifier.
4583 * - -EINVAL: Pool param is null.
4586 rte_eth_dev_pool_ops_supported(uint16_t port_id, const char *pool);
4592 #endif /* _RTE_ETHDEV_H_ */