4 * Copyright(c) 2010-2016 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 tramsit 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 * after 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.
177 /* Use this macro to check if LRO API is supported */
178 #define RTE_ETHDEV_HAS_LRO_SUPPORT
181 #include <rte_interrupts.h>
184 #include <rte_devargs.h>
185 #include "rte_ether.h"
186 #include "rte_eth_ctrl.h"
187 #include "rte_dev_info.h"
192 * A structure used to retrieve statistics for an Ethernet port.
194 struct rte_eth_stats {
195 uint64_t ipackets; /**< Total number of successfully received packets. */
196 uint64_t opackets; /**< Total number of successfully transmitted packets.*/
197 uint64_t ibytes; /**< Total number of successfully received bytes. */
198 uint64_t obytes; /**< Total number of successfully transmitted bytes. */
200 /**< Total of RX packets dropped by the HW,
201 * because there are no available mbufs (i.e. RX queues are full).
203 uint64_t ibadcrc __rte_deprecated;
204 /**< Deprecated; Total of RX packets with CRC error. */
205 uint64_t ibadlen __rte_deprecated;
206 /**< Deprecated; Total of RX packets with bad length. */
207 uint64_t ierrors; /**< Total number of erroneous received packets. */
208 uint64_t oerrors; /**< Total number of failed transmitted packets. */
210 /**< Deprecated; Total number of multicast received packets. */
211 uint64_t rx_nombuf; /**< Total number of RX mbuf allocation failures. */
212 uint64_t fdirmatch __rte_deprecated;
213 /**< Deprecated; Total number of RX packets matching a filter. */
214 uint64_t fdirmiss __rte_deprecated;
215 /**< Deprecated; Total number of RX packets not matching any filter. */
216 uint64_t tx_pause_xon __rte_deprecated;
217 /**< Deprecated; Total nb. of XON pause frame sent. */
218 uint64_t rx_pause_xon __rte_deprecated;
219 /**< Deprecated; Total nb. of XON pause frame received. */
220 uint64_t tx_pause_xoff __rte_deprecated;
221 /**< Deprecated; Total nb. of XOFF pause frame sent. */
222 uint64_t rx_pause_xoff __rte_deprecated;
223 /**< Deprecated; Total nb. of XOFF pause frame received. */
224 uint64_t q_ipackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
225 /**< Total number of queue RX packets. */
226 uint64_t q_opackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
227 /**< Total number of queue TX packets. */
228 uint64_t q_ibytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
229 /**< Total number of successfully received queue bytes. */
230 uint64_t q_obytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
231 /**< Total number of successfully transmitted queue bytes. */
232 uint64_t q_errors[RTE_ETHDEV_QUEUE_STAT_CNTRS];
233 /**< Total number of queue packets received that are dropped. */
235 /**< Total number of good packets received from loopback,VF Only */
237 /**< Total number of good packets transmitted to loopback,VF Only */
239 /**< Total number of good bytes received from loopback,VF Only */
241 /**< Total number of good bytes transmitted to loopback,VF Only */
245 * A structure used to retrieve link-level information of an Ethernet port.
247 struct rte_eth_link {
248 uint16_t link_speed; /**< ETH_LINK_SPEED_[10, 100, 1000, 10000] */
249 uint16_t link_duplex; /**< ETH_LINK_[HALF_DUPLEX, FULL_DUPLEX] */
250 uint8_t link_status : 1; /**< 1 -> link up, 0 -> link down */
251 }__attribute__((aligned(8))); /**< aligned for atomic64 read/write */
253 #define ETH_LINK_SPEED_AUTONEG 0 /**< Auto-negotiate link speed. */
254 #define ETH_LINK_SPEED_10 10 /**< 10 megabits/second. */
255 #define ETH_LINK_SPEED_100 100 /**< 100 megabits/second. */
256 #define ETH_LINK_SPEED_1000 1000 /**< 1 gigabits/second. */
257 #define ETH_LINK_SPEED_10000 10000 /**< 10 gigabits/second. */
258 #define ETH_LINK_SPEED_10G 10000 /**< alias of 10 gigabits/second. */
259 #define ETH_LINK_SPEED_20G 20000 /**< 20 gigabits/second. */
260 #define ETH_LINK_SPEED_40G 40000 /**< 40 gigabits/second. */
262 #define ETH_LINK_AUTONEG_DUPLEX 0 /**< Auto-negotiate duplex. */
263 #define ETH_LINK_HALF_DUPLEX 1 /**< Half-duplex connection. */
264 #define ETH_LINK_FULL_DUPLEX 2 /**< Full-duplex connection. */
267 * A structure used to configure the ring threshold registers of an RX/TX
268 * queue for an Ethernet port.
270 struct rte_eth_thresh {
271 uint8_t pthresh; /**< Ring prefetch threshold. */
272 uint8_t hthresh; /**< Ring host threshold. */
273 uint8_t wthresh; /**< Ring writeback threshold. */
277 * Simple flags are used for rte_eth_conf.rxmode.mq_mode.
279 #define ETH_MQ_RX_RSS_FLAG 0x1
280 #define ETH_MQ_RX_DCB_FLAG 0x2
281 #define ETH_MQ_RX_VMDQ_FLAG 0x4
284 * A set of values to identify what method is to be used to route
285 * packets to multiple queues.
287 enum rte_eth_rx_mq_mode {
288 /** None of DCB,RSS or VMDQ mode */
291 /** For RX side, only RSS is on */
292 ETH_MQ_RX_RSS = ETH_MQ_RX_RSS_FLAG,
293 /** For RX side,only DCB is on. */
294 ETH_MQ_RX_DCB = ETH_MQ_RX_DCB_FLAG,
295 /** Both DCB and RSS enable */
296 ETH_MQ_RX_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG,
298 /** Only VMDQ, no RSS nor DCB */
299 ETH_MQ_RX_VMDQ_ONLY = ETH_MQ_RX_VMDQ_FLAG,
300 /** RSS mode with VMDQ */
301 ETH_MQ_RX_VMDQ_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_VMDQ_FLAG,
302 /** Use VMDQ+DCB to route traffic to queues */
303 ETH_MQ_RX_VMDQ_DCB = ETH_MQ_RX_VMDQ_FLAG | ETH_MQ_RX_DCB_FLAG,
304 /** Enable both VMDQ and DCB in VMDq */
305 ETH_MQ_RX_VMDQ_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG |
310 * for rx mq mode backward compatible
312 #define ETH_RSS ETH_MQ_RX_RSS
313 #define VMDQ_DCB ETH_MQ_RX_VMDQ_DCB
314 #define ETH_DCB_RX ETH_MQ_RX_DCB
317 * A set of values to identify what method is to be used to transmit
318 * packets using multi-TCs.
320 enum rte_eth_tx_mq_mode {
321 ETH_MQ_TX_NONE = 0, /**< It is in neither DCB nor VT mode. */
322 ETH_MQ_TX_DCB, /**< For TX side,only DCB is on. */
323 ETH_MQ_TX_VMDQ_DCB, /**< For TX side,both DCB and VT is on. */
324 ETH_MQ_TX_VMDQ_ONLY, /**< Only VT on, no DCB */
328 * for tx mq mode backward compatible
330 #define ETH_DCB_NONE ETH_MQ_TX_NONE
331 #define ETH_VMDQ_DCB_TX ETH_MQ_TX_VMDQ_DCB
332 #define ETH_DCB_TX ETH_MQ_TX_DCB
335 * A structure used to configure the RX features of an Ethernet port.
337 struct rte_eth_rxmode {
338 /** The multi-queue packet distribution mode to be used, e.g. RSS. */
339 enum rte_eth_rx_mq_mode mq_mode;
340 uint32_t max_rx_pkt_len; /**< Only used if jumbo_frame enabled. */
341 uint16_t split_hdr_size; /**< hdr buf size (header_split enabled).*/
342 uint16_t header_split : 1, /**< Header Split enable. */
343 hw_ip_checksum : 1, /**< IP/UDP/TCP checksum offload enable. */
344 hw_vlan_filter : 1, /**< VLAN filter enable. */
345 hw_vlan_strip : 1, /**< VLAN strip enable. */
346 hw_vlan_extend : 1, /**< Extended VLAN enable. */
347 jumbo_frame : 1, /**< Jumbo Frame Receipt enable. */
348 hw_strip_crc : 1, /**< Enable CRC stripping by hardware. */
349 enable_scatter : 1, /**< Enable scatter packets rx handler */
350 enable_lro : 1; /**< Enable LRO */
354 * VLAN types to indicate if it is for single VLAN, inner VLAN or outer VLAN.
355 * Note that single VLAN is treated the same as inner VLAN.
358 ETH_VLAN_TYPE_UNKNOWN = 0,
359 ETH_VLAN_TYPE_INNER, /**< Single VLAN, or inner VLAN. */
360 ETH_VLAN_TYPE_OUTER, /**< Outer VLAN. */
365 * A structure used to configure the Receive Side Scaling (RSS) feature
366 * of an Ethernet port.
367 * If not NULL, the *rss_key* pointer of the *rss_conf* structure points
368 * to an array holding the RSS key to use for hashing specific header
369 * fields of received packets. The length of this array should be indicated
370 * by *rss_key_len* below. Otherwise, a default random hash key is used by
373 * The *rss_key_len* field of the *rss_conf* structure indicates the length
374 * in bytes of the array pointed by *rss_key*. To be compatible, this length
375 * will be checked in i40e only. Others assume 40 bytes to be used as before.
377 * The *rss_hf* field of the *rss_conf* structure indicates the different
378 * types of IPv4/IPv6 packets to which the RSS hashing must be applied.
379 * Supplying an *rss_hf* equal to zero disables the RSS feature.
381 struct rte_eth_rss_conf {
382 uint8_t *rss_key; /**< If not NULL, 40-byte hash key. */
383 uint8_t rss_key_len; /**< hash key length in bytes. */
384 uint64_t rss_hf; /**< Hash functions to apply - see below. */
388 * The RSS offload types are defined based on flow types which are defined
389 * in rte_eth_ctrl.h. Different NIC hardwares may support different RSS offload
390 * types. The supported flow types or RSS offload types can be queried by
391 * rte_eth_dev_info_get().
393 #define ETH_RSS_IPV4 (1ULL << RTE_ETH_FLOW_IPV4)
394 #define ETH_RSS_FRAG_IPV4 (1ULL << RTE_ETH_FLOW_FRAG_IPV4)
395 #define ETH_RSS_NONFRAG_IPV4_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_TCP)
396 #define ETH_RSS_NONFRAG_IPV4_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_UDP)
397 #define ETH_RSS_NONFRAG_IPV4_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_SCTP)
398 #define ETH_RSS_NONFRAG_IPV4_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_OTHER)
399 #define ETH_RSS_IPV6 (1ULL << RTE_ETH_FLOW_IPV6)
400 #define ETH_RSS_FRAG_IPV6 (1ULL << RTE_ETH_FLOW_FRAG_IPV6)
401 #define ETH_RSS_NONFRAG_IPV6_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_TCP)
402 #define ETH_RSS_NONFRAG_IPV6_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_UDP)
403 #define ETH_RSS_NONFRAG_IPV6_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_SCTP)
404 #define ETH_RSS_NONFRAG_IPV6_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_OTHER)
405 #define ETH_RSS_L2_PAYLOAD (1ULL << RTE_ETH_FLOW_L2_PAYLOAD)
406 #define ETH_RSS_IPV6_EX (1ULL << RTE_ETH_FLOW_IPV6_EX)
407 #define ETH_RSS_IPV6_TCP_EX (1ULL << RTE_ETH_FLOW_IPV6_TCP_EX)
408 #define ETH_RSS_IPV6_UDP_EX (1ULL << RTE_ETH_FLOW_IPV6_UDP_EX)
410 #define ETH_RSS_IP ( \
412 ETH_RSS_FRAG_IPV4 | \
413 ETH_RSS_NONFRAG_IPV4_OTHER | \
415 ETH_RSS_FRAG_IPV6 | \
416 ETH_RSS_NONFRAG_IPV6_OTHER | \
419 #define ETH_RSS_UDP ( \
420 ETH_RSS_NONFRAG_IPV4_UDP | \
421 ETH_RSS_NONFRAG_IPV6_UDP | \
424 #define ETH_RSS_TCP ( \
425 ETH_RSS_NONFRAG_IPV4_TCP | \
426 ETH_RSS_NONFRAG_IPV6_TCP | \
429 #define ETH_RSS_SCTP ( \
430 ETH_RSS_NONFRAG_IPV4_SCTP | \
431 ETH_RSS_NONFRAG_IPV6_SCTP)
433 /**< Mask of valid RSS hash protocols */
434 #define ETH_RSS_PROTO_MASK ( \
436 ETH_RSS_FRAG_IPV4 | \
437 ETH_RSS_NONFRAG_IPV4_TCP | \
438 ETH_RSS_NONFRAG_IPV4_UDP | \
439 ETH_RSS_NONFRAG_IPV4_SCTP | \
440 ETH_RSS_NONFRAG_IPV4_OTHER | \
442 ETH_RSS_FRAG_IPV6 | \
443 ETH_RSS_NONFRAG_IPV6_TCP | \
444 ETH_RSS_NONFRAG_IPV6_UDP | \
445 ETH_RSS_NONFRAG_IPV6_SCTP | \
446 ETH_RSS_NONFRAG_IPV6_OTHER | \
447 ETH_RSS_L2_PAYLOAD | \
449 ETH_RSS_IPV6_TCP_EX | \
453 * Definitions used for redirection table entry size.
454 * Some RSS RETA sizes may not be supported by some drivers, check the
455 * documentation or the description of relevant functions for more details.
457 #define ETH_RSS_RETA_SIZE_64 64
458 #define ETH_RSS_RETA_SIZE_128 128
459 #define ETH_RSS_RETA_SIZE_512 512
460 #define RTE_RETA_GROUP_SIZE 64
462 /* Definitions used for VMDQ and DCB functionality */
463 #define ETH_VMDQ_MAX_VLAN_FILTERS 64 /**< Maximum nb. of VMDQ vlan filters. */
464 #define ETH_DCB_NUM_USER_PRIORITIES 8 /**< Maximum nb. of DCB priorities. */
465 #define ETH_VMDQ_DCB_NUM_QUEUES 128 /**< Maximum nb. of VMDQ DCB queues. */
466 #define ETH_DCB_NUM_QUEUES 128 /**< Maximum nb. of DCB queues. */
468 /* DCB capability defines */
469 #define ETH_DCB_PG_SUPPORT 0x00000001 /**< Priority Group(ETS) support. */
470 #define ETH_DCB_PFC_SUPPORT 0x00000002 /**< Priority Flow Control support. */
472 /* Definitions used for VLAN Offload functionality */
473 #define ETH_VLAN_STRIP_OFFLOAD 0x0001 /**< VLAN Strip On/Off */
474 #define ETH_VLAN_FILTER_OFFLOAD 0x0002 /**< VLAN Filter On/Off */
475 #define ETH_VLAN_EXTEND_OFFLOAD 0x0004 /**< VLAN Extend On/Off */
477 /* Definitions used for mask VLAN setting */
478 #define ETH_VLAN_STRIP_MASK 0x0001 /**< VLAN Strip setting mask */
479 #define ETH_VLAN_FILTER_MASK 0x0002 /**< VLAN Filter setting mask*/
480 #define ETH_VLAN_EXTEND_MASK 0x0004 /**< VLAN Extend setting mask*/
481 #define ETH_VLAN_ID_MAX 0x0FFF /**< VLAN ID is in lower 12 bits*/
483 /* Definitions used for receive MAC address */
484 #define ETH_NUM_RECEIVE_MAC_ADDR 128 /**< Maximum nb. of receive mac addr. */
486 /* Definitions used for unicast hash */
487 #define ETH_VMDQ_NUM_UC_HASH_ARRAY 128 /**< Maximum nb. of UC hash array. */
489 /* Definitions used for VMDQ pool rx mode setting */
490 #define ETH_VMDQ_ACCEPT_UNTAG 0x0001 /**< accept untagged packets. */
491 #define ETH_VMDQ_ACCEPT_HASH_MC 0x0002 /**< accept packets in multicast table . */
492 #define ETH_VMDQ_ACCEPT_HASH_UC 0x0004 /**< accept packets in unicast table. */
493 #define ETH_VMDQ_ACCEPT_BROADCAST 0x0008 /**< accept broadcast packets. */
494 #define ETH_VMDQ_ACCEPT_MULTICAST 0x0010 /**< multicast promiscuous. */
496 /** Maximum nb. of vlan per mirror rule */
497 #define ETH_MIRROR_MAX_VLANS 64
499 #define ETH_MIRROR_VIRTUAL_POOL_UP 0x01 /**< Virtual Pool uplink Mirroring. */
500 #define ETH_MIRROR_UPLINK_PORT 0x02 /**< Uplink Port Mirroring. */
501 #define ETH_MIRROR_DOWNLINK_PORT 0x04 /**< Downlink Port Mirroring. */
502 #define ETH_MIRROR_VLAN 0x08 /**< VLAN Mirroring. */
503 #define ETH_MIRROR_VIRTUAL_POOL_DOWN 0x10 /**< Virtual Pool downlink Mirroring. */
506 * A structure used to configure VLAN traffic mirror of an Ethernet port.
508 struct rte_eth_vlan_mirror {
509 uint64_t vlan_mask; /**< mask for valid VLAN ID. */
510 /** VLAN ID list for vlan mirroring. */
511 uint16_t vlan_id[ETH_MIRROR_MAX_VLANS];
515 * A structure used to configure traffic mirror of an Ethernet port.
517 struct rte_eth_mirror_conf {
518 uint8_t rule_type; /**< Mirroring rule type */
519 uint8_t dst_pool; /**< Destination pool for this mirror rule. */
520 uint64_t pool_mask; /**< Bitmap of pool for pool mirroring */
521 /** VLAN ID setting for VLAN mirroring. */
522 struct rte_eth_vlan_mirror vlan;
526 * A structure used to configure 64 entries of Redirection Table of the
527 * Receive Side Scaling (RSS) feature of an Ethernet port. To configure
528 * more than 64 entries supported by hardware, an array of this structure
531 struct rte_eth_rss_reta_entry64 {
533 /**< Mask bits indicate which entries need to be updated/queried. */
534 uint16_t reta[RTE_RETA_GROUP_SIZE];
535 /**< Group of 64 redirection table entries. */
539 * This enum indicates the possible number of traffic classes
540 * in DCB configratioins
542 enum rte_eth_nb_tcs {
543 ETH_4_TCS = 4, /**< 4 TCs with DCB. */
544 ETH_8_TCS = 8 /**< 8 TCs with DCB. */
548 * This enum indicates the possible number of queue pools
549 * in VMDQ configurations.
551 enum rte_eth_nb_pools {
552 ETH_8_POOLS = 8, /**< 8 VMDq pools. */
553 ETH_16_POOLS = 16, /**< 16 VMDq pools. */
554 ETH_32_POOLS = 32, /**< 32 VMDq pools. */
555 ETH_64_POOLS = 64 /**< 64 VMDq pools. */
558 /* This structure may be extended in future. */
559 struct rte_eth_dcb_rx_conf {
560 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs */
561 /** Traffic class each UP mapped to. */
562 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
565 struct rte_eth_vmdq_dcb_tx_conf {
566 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools. */
567 /** Traffic class each UP mapped to. */
568 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
571 struct rte_eth_dcb_tx_conf {
572 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs. */
573 /** Traffic class each UP mapped to. */
574 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
577 struct rte_eth_vmdq_tx_conf {
578 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq mode, 64 pools. */
582 * A structure used to configure the VMDQ+DCB feature
583 * of an Ethernet port.
585 * Using this feature, packets are routed to a pool of queues, based
586 * on the vlan id in the vlan tag, and then to a specific queue within
587 * that pool, using the user priority vlan tag field.
589 * A default pool may be used, if desired, to route all traffic which
590 * does not match the vlan filter rules.
592 struct rte_eth_vmdq_dcb_conf {
593 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools */
594 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
595 uint8_t default_pool; /**< The default pool, if applicable */
596 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
598 uint16_t vlan_id; /**< The vlan id of the received frame */
599 uint64_t pools; /**< Bitmask of pools for packet rx */
600 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
601 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
602 /**< Selects a queue in a pool */
605 struct rte_eth_vmdq_rx_conf {
606 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq only mode, 8 or 64 pools */
607 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
608 uint8_t default_pool; /**< The default pool, if applicable */
609 uint8_t enable_loop_back; /**< Enable VT loop back */
610 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
611 uint32_t rx_mode; /**< Flags from ETH_VMDQ_ACCEPT_* */
613 uint16_t vlan_id; /**< The vlan id of the received frame */
614 uint64_t pools; /**< Bitmask of pools for packet rx */
615 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
619 * A structure used to configure the TX features of an Ethernet port.
621 struct rte_eth_txmode {
622 enum rte_eth_tx_mq_mode mq_mode; /**< TX multi-queues mode. */
624 /* For i40e specifically */
626 uint8_t hw_vlan_reject_tagged : 1,
627 /**< If set, reject sending out tagged pkts */
628 hw_vlan_reject_untagged : 1,
629 /**< If set, reject sending out untagged pkts */
630 hw_vlan_insert_pvid : 1;
631 /**< If set, enable port based VLAN insertion */
635 * A structure used to configure an RX ring of an Ethernet port.
637 struct rte_eth_rxconf {
638 struct rte_eth_thresh rx_thresh; /**< RX ring threshold registers. */
639 uint16_t rx_free_thresh; /**< Drives the freeing of RX descriptors. */
640 uint8_t rx_drop_en; /**< Drop packets if no descriptors are available. */
641 uint8_t rx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
644 #define ETH_TXQ_FLAGS_NOMULTSEGS 0x0001 /**< nb_segs=1 for all mbufs */
645 #define ETH_TXQ_FLAGS_NOREFCOUNT 0x0002 /**< refcnt can be ignored */
646 #define ETH_TXQ_FLAGS_NOMULTMEMP 0x0004 /**< all bufs come from same mempool */
647 #define ETH_TXQ_FLAGS_NOVLANOFFL 0x0100 /**< disable VLAN offload */
648 #define ETH_TXQ_FLAGS_NOXSUMSCTP 0x0200 /**< disable SCTP checksum offload */
649 #define ETH_TXQ_FLAGS_NOXSUMUDP 0x0400 /**< disable UDP checksum offload */
650 #define ETH_TXQ_FLAGS_NOXSUMTCP 0x0800 /**< disable TCP checksum offload */
651 #define ETH_TXQ_FLAGS_NOOFFLOADS \
652 (ETH_TXQ_FLAGS_NOVLANOFFL | ETH_TXQ_FLAGS_NOXSUMSCTP | \
653 ETH_TXQ_FLAGS_NOXSUMUDP | ETH_TXQ_FLAGS_NOXSUMTCP)
654 #define ETH_TXQ_FLAGS_NOXSUMS \
655 (ETH_TXQ_FLAGS_NOXSUMSCTP | ETH_TXQ_FLAGS_NOXSUMUDP | \
656 ETH_TXQ_FLAGS_NOXSUMTCP)
658 * A structure used to configure a TX ring of an Ethernet port.
660 struct rte_eth_txconf {
661 struct rte_eth_thresh tx_thresh; /**< TX ring threshold registers. */
662 uint16_t tx_rs_thresh; /**< Drives the setting of RS bit on TXDs. */
663 uint16_t tx_free_thresh; /**< Start freeing TX buffers if there are
664 less free descriptors than this value. */
666 uint32_t txq_flags; /**< Set flags for the Tx queue */
667 uint8_t tx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
671 * A structure contains information about HW descriptor ring limitations.
673 struct rte_eth_desc_lim {
674 uint16_t nb_max; /**< Max allowed number of descriptors. */
675 uint16_t nb_min; /**< Min allowed number of descriptors. */
676 uint16_t nb_align; /**< Number of descriptors should be aligned to. */
680 * This enum indicates the flow control mode
682 enum rte_eth_fc_mode {
683 RTE_FC_NONE = 0, /**< Disable flow control. */
684 RTE_FC_RX_PAUSE, /**< RX pause frame, enable flowctrl on TX side. */
685 RTE_FC_TX_PAUSE, /**< TX pause frame, enable flowctrl on RX side. */
686 RTE_FC_FULL /**< Enable flow control on both side. */
690 * A structure used to configure Ethernet flow control parameter.
691 * These parameters will be configured into the register of the NIC.
692 * Please refer to the corresponding data sheet for proper value.
694 struct rte_eth_fc_conf {
695 uint32_t high_water; /**< High threshold value to trigger XOFF */
696 uint32_t low_water; /**< Low threshold value to trigger XON */
697 uint16_t pause_time; /**< Pause quota in the Pause frame */
698 uint16_t send_xon; /**< Is XON frame need be sent */
699 enum rte_eth_fc_mode mode; /**< Link flow control mode */
700 uint8_t mac_ctrl_frame_fwd; /**< Forward MAC control frames */
701 uint8_t autoneg; /**< Use Pause autoneg */
705 * A structure used to configure Ethernet priority flow control parameter.
706 * These parameters will be configured into the register of the NIC.
707 * Please refer to the corresponding data sheet for proper value.
709 struct rte_eth_pfc_conf {
710 struct rte_eth_fc_conf fc; /**< General flow control parameter. */
711 uint8_t priority; /**< VLAN User Priority. */
715 * Memory space that can be configured to store Flow Director filters
716 * in the board memory.
718 enum rte_fdir_pballoc_type {
719 RTE_FDIR_PBALLOC_64K = 0, /**< 64k. */
720 RTE_FDIR_PBALLOC_128K, /**< 128k. */
721 RTE_FDIR_PBALLOC_256K, /**< 256k. */
725 * Select report mode of FDIR hash information in RX descriptors.
727 enum rte_fdir_status_mode {
728 RTE_FDIR_NO_REPORT_STATUS = 0, /**< Never report FDIR hash. */
729 RTE_FDIR_REPORT_STATUS, /**< Only report FDIR hash for matching pkts. */
730 RTE_FDIR_REPORT_STATUS_ALWAYS, /**< Always report FDIR hash. */
734 * A structure used to configure the Flow Director (FDIR) feature
735 * of an Ethernet port.
737 * If mode is RTE_FDIR_DISABLE, the pballoc value is ignored.
739 struct rte_fdir_conf {
740 enum rte_fdir_mode mode; /**< Flow Director mode. */
741 enum rte_fdir_pballoc_type pballoc; /**< Space for FDIR filters. */
742 enum rte_fdir_status_mode status; /**< How to report FDIR hash. */
743 /** RX queue of packets matching a "drop" filter in perfect mode. */
745 struct rte_eth_fdir_masks mask;
746 struct rte_eth_fdir_flex_conf flex_conf;
747 /**< Flex payload configuration. */
751 * UDP tunneling configuration.
752 * Used to config the UDP port for a type of tunnel.
753 * NICs need the UDP port to identify the tunnel type.
754 * Normally a type of tunnel has a default UDP port, this structure can be used
755 * in case if the users want to change or support more UDP port.
757 struct rte_eth_udp_tunnel {
758 uint16_t udp_port; /**< UDP port used for the tunnel. */
759 uint8_t prot_type; /**< Tunnel type. Defined in rte_eth_tunnel_type. */
763 * A structure used to enable/disable specific device interrupts.
765 struct rte_intr_conf {
766 /** enable/disable lsc interrupt. 0 (default) - disable, 1 enable */
768 /** enable/disable rxq interrupt. 0 (default) - disable, 1 enable */
773 * A structure used to configure an Ethernet port.
774 * Depending upon the RX multi-queue mode, extra advanced
775 * configuration settings may be needed.
777 struct rte_eth_conf {
779 /**< ETH_LINK_SPEED_10[0|00|000], or 0 for autonegotation */
780 uint16_t link_duplex;
781 /**< ETH_LINK_[HALF_DUPLEX|FULL_DUPLEX], or 0 for autonegotation */
782 struct rte_eth_rxmode rxmode; /**< Port RX configuration. */
783 struct rte_eth_txmode txmode; /**< Port TX configuration. */
784 uint32_t lpbk_mode; /**< Loopback operation mode. By default the value
785 is 0, meaning the loopback mode is disabled.
786 Read the datasheet of given ethernet controller
787 for details. The possible values of this field
788 are defined in implementation of each driver. */
790 struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
791 struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
792 /**< Port vmdq+dcb configuration. */
793 struct rte_eth_dcb_rx_conf dcb_rx_conf;
794 /**< Port dcb RX configuration. */
795 struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
796 /**< Port vmdq RX configuration. */
797 } rx_adv_conf; /**< Port RX filtering configuration (union). */
799 struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
800 /**< Port vmdq+dcb TX configuration. */
801 struct rte_eth_dcb_tx_conf dcb_tx_conf;
802 /**< Port dcb TX configuration. */
803 struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
804 /**< Port vmdq TX configuration. */
805 } tx_adv_conf; /**< Port TX DCB configuration (union). */
806 /** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
807 is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
808 uint32_t dcb_capability_en;
809 struct rte_fdir_conf fdir_conf; /**< FDIR configuration. */
810 struct rte_intr_conf intr_conf; /**< Interrupt mode configuration. */
814 * A structure used to retrieve the contextual information of
815 * an Ethernet device, such as the controlling driver of the device,
816 * its PCI context, etc...
820 * RX offload capabilities of a device.
822 #define DEV_RX_OFFLOAD_VLAN_STRIP 0x00000001
823 #define DEV_RX_OFFLOAD_IPV4_CKSUM 0x00000002
824 #define DEV_RX_OFFLOAD_UDP_CKSUM 0x00000004
825 #define DEV_RX_OFFLOAD_TCP_CKSUM 0x00000008
826 #define DEV_RX_OFFLOAD_TCP_LRO 0x00000010
827 #define DEV_RX_OFFLOAD_QINQ_STRIP 0x00000020
828 #define DEV_RX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000040
831 * TX offload capabilities of a device.
833 #define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001
834 #define DEV_TX_OFFLOAD_IPV4_CKSUM 0x00000002
835 #define DEV_TX_OFFLOAD_UDP_CKSUM 0x00000004
836 #define DEV_TX_OFFLOAD_TCP_CKSUM 0x00000008
837 #define DEV_TX_OFFLOAD_SCTP_CKSUM 0x00000010
838 #define DEV_TX_OFFLOAD_TCP_TSO 0x00000020
839 #define DEV_TX_OFFLOAD_UDP_TSO 0x00000040
840 #define DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000080 /**< Used for tunneling packet. */
841 #define DEV_TX_OFFLOAD_QINQ_INSERT 0x00000100
843 struct rte_eth_dev_info {
844 struct rte_pci_device *pci_dev; /**< Device PCI information. */
845 const char *driver_name; /**< Device Driver name. */
846 unsigned int if_index; /**< Index to bound host interface, or 0 if none.
847 Use if_indextoname() to translate into an interface name. */
848 uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
849 uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
850 uint16_t max_rx_queues; /**< Maximum number of RX queues. */
851 uint16_t max_tx_queues; /**< Maximum number of TX queues. */
852 uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
853 uint32_t max_hash_mac_addrs;
854 /** Maximum number of hash MAC addresses for MTA and UTA. */
855 uint16_t max_vfs; /**< Maximum number of VFs. */
856 uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
857 uint32_t rx_offload_capa; /**< Device RX offload capabilities. */
858 uint32_t tx_offload_capa; /**< Device TX offload capabilities. */
860 /**< Device redirection table size, the total number of entries. */
861 uint8_t hash_key_size; /**< Hash key size in bytes */
862 /** Bit mask of RSS offloads, the bit offset also means flow type */
863 uint64_t flow_type_rss_offloads;
864 struct rte_eth_rxconf default_rxconf; /**< Default RX configuration */
865 struct rte_eth_txconf default_txconf; /**< Default TX configuration */
866 uint16_t vmdq_queue_base; /**< First queue ID for VMDQ pools. */
867 uint16_t vmdq_queue_num; /**< Queue number for VMDQ pools. */
868 uint16_t vmdq_pool_base; /**< First ID of VMDQ pools. */
869 struct rte_eth_desc_lim rx_desc_lim; /**< RX descriptors limits */
870 struct rte_eth_desc_lim tx_desc_lim; /**< TX descriptors limits */
874 * Ethernet device RX queue information structure.
875 * Used to retieve information about configured queue.
877 struct rte_eth_rxq_info {
878 struct rte_mempool *mp; /**< mempool used by that queue. */
879 struct rte_eth_rxconf conf; /**< queue config parameters. */
880 uint8_t scattered_rx; /**< scattered packets RX supported. */
881 uint16_t nb_desc; /**< configured number of RXDs. */
882 } __rte_cache_min_aligned;
885 * Ethernet device TX queue information structure.
886 * Used to retieve information about configured queue.
888 struct rte_eth_txq_info {
889 struct rte_eth_txconf conf; /**< queue config parameters. */
890 uint16_t nb_desc; /**< configured number of TXDs. */
891 } __rte_cache_min_aligned;
893 /** Maximum name length for extended statistics counters */
894 #define RTE_ETH_XSTATS_NAME_SIZE 64
897 * An Ethernet device extended statistic structure
899 * This structure is used by ethdev->eth_xstats_get() to provide
900 * statistics that are not provided in the generic rte_eth_stats
903 struct rte_eth_xstats {
904 char name[RTE_ETH_XSTATS_NAME_SIZE];
908 #define ETH_DCB_NUM_TCS 8
909 #define ETH_MAX_VMDQ_POOL 64
912 * A structure used to get the information of queue and
913 * TC mapping on both TX and RX paths.
915 struct rte_eth_dcb_tc_queue_mapping {
916 /** rx queues assigned to tc per Pool */
920 } tc_rxq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
921 /** rx queues assigned to tc per Pool */
925 } tc_txq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
929 * A structure used to get the information of DCB.
930 * It includes TC UP mapping and queue TC mapping.
932 struct rte_eth_dcb_info {
933 uint8_t nb_tcs; /**< number of TCs */
934 uint8_t prio_tc[ETH_DCB_NUM_USER_PRIORITIES]; /**< Priority to tc */
935 uint8_t tc_bws[ETH_DCB_NUM_TCS]; /**< TX BW percentage for each TC */
936 /** rx queues assigned to tc */
937 struct rte_eth_dcb_tc_queue_mapping tc_queue;
943 #define RTE_ETH_QUEUE_STATE_STOPPED 0
944 #define RTE_ETH_QUEUE_STATE_STARTED 1
948 struct rte_eth_dev_callback;
949 /** @internal Structure to keep track of registered callbacks */
950 TAILQ_HEAD(rte_eth_dev_cb_list, rte_eth_dev_callback);
953 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
954 #define RTE_PMD_DEBUG_TRACE(...) \
955 rte_pmd_debug_trace(__func__, __VA_ARGS__)
957 #define RTE_PMD_DEBUG_TRACE(...)
961 /* Macros to check for valid port */
962 #define RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, retval) do { \
963 if (!rte_eth_dev_is_valid_port(port_id)) { \
964 RTE_PMD_DEBUG_TRACE("Invalid port_id=%d\n", port_id); \
969 #define RTE_ETH_VALID_PORTID_OR_RET(port_id) do { \
970 if (!rte_eth_dev_is_valid_port(port_id)) { \
971 RTE_PMD_DEBUG_TRACE("Invalid port_id=%d\n", port_id); \
977 * l2 tunnel configuration.
980 /**< l2 tunnel enable mask */
981 #define ETH_L2_TUNNEL_ENABLE_MASK 0x00000001
982 /**< l2 tunnel insertion mask */
983 #define ETH_L2_TUNNEL_INSERTION_MASK 0x00000002
984 /**< l2 tunnel stripping mask */
985 #define ETH_L2_TUNNEL_STRIPPING_MASK 0x00000004
986 /**< l2 tunnel forwarding mask */
987 #define ETH_L2_TUNNEL_FORWARDING_MASK 0x00000008
990 * Definitions of all functions exported by an Ethernet driver through the
991 * the generic structure of type *eth_dev_ops* supplied in the *rte_eth_dev*
992 * structure associated with an Ethernet device.
995 typedef int (*eth_dev_configure_t)(struct rte_eth_dev *dev);
996 /**< @internal Ethernet device configuration. */
998 typedef int (*eth_dev_start_t)(struct rte_eth_dev *dev);
999 /**< @internal Function used to start a configured Ethernet device. */
1001 typedef void (*eth_dev_stop_t)(struct rte_eth_dev *dev);
1002 /**< @internal Function used to stop a configured Ethernet device. */
1004 typedef int (*eth_dev_set_link_up_t)(struct rte_eth_dev *dev);
1005 /**< @internal Function used to link up a configured Ethernet device. */
1007 typedef int (*eth_dev_set_link_down_t)(struct rte_eth_dev *dev);
1008 /**< @internal Function used to link down a configured Ethernet device. */
1010 typedef void (*eth_dev_close_t)(struct rte_eth_dev *dev);
1011 /**< @internal Function used to close a configured Ethernet device. */
1013 typedef void (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev);
1014 /**< @internal Function used to enable the RX promiscuous mode of an Ethernet device. */
1016 typedef void (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev);
1017 /**< @internal Function used to disable the RX promiscuous mode of an Ethernet device. */
1019 typedef void (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
1020 /**< @internal Enable the receipt of all multicast packets by an Ethernet device. */
1022 typedef void (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
1023 /**< @internal Disable the receipt of all multicast packets by an Ethernet device. */
1025 typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
1026 int wait_to_complete);
1027 /**< @internal Get link speed, duplex mode and state (up/down) of an Ethernet device. */
1029 typedef void (*eth_stats_get_t)(struct rte_eth_dev *dev,
1030 struct rte_eth_stats *igb_stats);
1031 /**< @internal Get global I/O statistics of an Ethernet device. */
1033 typedef void (*eth_stats_reset_t)(struct rte_eth_dev *dev);
1034 /**< @internal Reset global I/O statistics of an Ethernet device to 0. */
1036 typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev,
1037 struct rte_eth_xstats *stats, unsigned n);
1038 /**< @internal Get extended stats of an Ethernet device. */
1040 typedef void (*eth_xstats_reset_t)(struct rte_eth_dev *dev);
1041 /**< @internal Reset extended stats of an Ethernet device. */
1043 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
1047 /**< @internal Set a queue statistics mapping for a tx/rx queue of an Ethernet device. */
1049 typedef void (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
1050 struct rte_eth_dev_info *dev_info);
1051 /**< @internal Get specific informations of an Ethernet device. */
1053 typedef const uint32_t *(*eth_dev_supported_ptypes_get_t)(struct rte_eth_dev *dev);
1054 /**< @internal Get supported ptypes of an Ethernet device. */
1056 typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
1058 /**< @internal Start rx and tx of a queue of an Ethernet device. */
1060 typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
1062 /**< @internal Stop rx and tx of a queue of an Ethernet device. */
1064 typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
1065 uint16_t rx_queue_id,
1066 uint16_t nb_rx_desc,
1067 unsigned int socket_id,
1068 const struct rte_eth_rxconf *rx_conf,
1069 struct rte_mempool *mb_pool);
1070 /**< @internal Set up a receive queue of an Ethernet device. */
1072 typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
1073 uint16_t tx_queue_id,
1074 uint16_t nb_tx_desc,
1075 unsigned int socket_id,
1076 const struct rte_eth_txconf *tx_conf);
1077 /**< @internal Setup a transmit queue of an Ethernet device. */
1079 typedef int (*eth_rx_enable_intr_t)(struct rte_eth_dev *dev,
1080 uint16_t rx_queue_id);
1081 /**< @internal Enable interrupt of a receive queue of an Ethernet device. */
1083 typedef int (*eth_rx_disable_intr_t)(struct rte_eth_dev *dev,
1084 uint16_t rx_queue_id);
1085 /**< @internal Disable interrupt of a receive queue of an Ethernet device. */
1087 typedef void (*eth_queue_release_t)(void *queue);
1088 /**< @internal Release memory resources allocated by given RX/TX queue. */
1090 typedef uint32_t (*eth_rx_queue_count_t)(struct rte_eth_dev *dev,
1091 uint16_t rx_queue_id);
1092 /**< @internal Get number of available descriptors on a receive queue of an Ethernet device. */
1094 typedef int (*eth_rx_descriptor_done_t)(void *rxq, uint16_t offset);
1095 /**< @internal Check DD bit of specific RX descriptor */
1097 typedef void (*eth_rxq_info_get_t)(struct rte_eth_dev *dev,
1098 uint16_t rx_queue_id, struct rte_eth_rxq_info *qinfo);
1100 typedef void (*eth_txq_info_get_t)(struct rte_eth_dev *dev,
1101 uint16_t tx_queue_id, struct rte_eth_txq_info *qinfo);
1103 typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);
1104 /**< @internal Set MTU. */
1106 typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
1109 /**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */
1111 typedef int (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
1112 enum rte_vlan_type type, uint16_t tpid);
1113 /**< @internal set the outer VLAN-TPID by an Ethernet device. */
1115 typedef void (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
1116 /**< @internal set VLAN offload function by an Ethernet device. */
1118 typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
1121 /**< @internal set port based TX VLAN insertion by an Ethernet device. */
1123 typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
1124 uint16_t rx_queue_id,
1126 /**< @internal VLAN stripping enable/disable by an queue of Ethernet device. */
1128 typedef uint16_t (*eth_rx_burst_t)(void *rxq,
1129 struct rte_mbuf **rx_pkts,
1131 /**< @internal Retrieve input packets from a receive queue of an Ethernet device. */
1133 typedef uint16_t (*eth_tx_burst_t)(void *txq,
1134 struct rte_mbuf **tx_pkts,
1136 /**< @internal Send output packets on a transmit queue of an Ethernet device. */
1138 typedef int (*flow_ctrl_get_t)(struct rte_eth_dev *dev,
1139 struct rte_eth_fc_conf *fc_conf);
1140 /**< @internal Get current flow control parameter on an Ethernet device */
1142 typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
1143 struct rte_eth_fc_conf *fc_conf);
1144 /**< @internal Setup flow control parameter on an Ethernet device */
1146 typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
1147 struct rte_eth_pfc_conf *pfc_conf);
1148 /**< @internal Setup priority flow control parameter on an Ethernet device */
1150 typedef int (*reta_update_t)(struct rte_eth_dev *dev,
1151 struct rte_eth_rss_reta_entry64 *reta_conf,
1152 uint16_t reta_size);
1153 /**< @internal Update RSS redirection table on an Ethernet device */
1155 typedef int (*reta_query_t)(struct rte_eth_dev *dev,
1156 struct rte_eth_rss_reta_entry64 *reta_conf,
1157 uint16_t reta_size);
1158 /**< @internal Query RSS redirection table on an Ethernet device */
1160 typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
1161 struct rte_eth_rss_conf *rss_conf);
1162 /**< @internal Update RSS hash configuration of an Ethernet device */
1164 typedef int (*rss_hash_conf_get_t)(struct rte_eth_dev *dev,
1165 struct rte_eth_rss_conf *rss_conf);
1166 /**< @internal Get current RSS hash configuration of an Ethernet device */
1168 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
1169 /**< @internal Turn on SW controllable LED on an Ethernet device */
1171 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
1172 /**< @internal Turn off SW controllable LED on an Ethernet device */
1174 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
1175 /**< @internal Remove MAC address from receive address register */
1177 typedef void (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
1178 struct ether_addr *mac_addr,
1181 /**< @internal Set a MAC address into Receive Address Address Register */
1183 typedef void (*eth_mac_addr_set_t)(struct rte_eth_dev *dev,
1184 struct ether_addr *mac_addr);
1185 /**< @internal Set a MAC address into Receive Address Address Register */
1187 typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
1188 struct ether_addr *mac_addr,
1190 /**< @internal Set a Unicast Hash bitmap */
1192 typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
1194 /**< @internal Set all Unicast Hash bitmap */
1196 typedef int (*eth_set_vf_rx_mode_t)(struct rte_eth_dev *dev,
1200 /**< @internal Set a VF receive mode */
1202 typedef int (*eth_set_vf_rx_t)(struct rte_eth_dev *dev,
1205 /**< @internal Set a VF receive mode */
1207 typedef int (*eth_set_vf_tx_t)(struct rte_eth_dev *dev,
1210 /**< @internal Enable or disable a VF transmit */
1212 typedef int (*eth_set_vf_vlan_filter_t)(struct rte_eth_dev *dev,
1216 /**< @internal Set VF VLAN pool filter */
1218 typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
1221 /**< @internal Set queue TX rate */
1223 typedef int (*eth_set_vf_rate_limit_t)(struct rte_eth_dev *dev,
1227 /**< @internal Set VF TX rate */
1229 typedef int (*eth_mirror_rule_set_t)(struct rte_eth_dev *dev,
1230 struct rte_eth_mirror_conf *mirror_conf,
1233 /**< @internal Add a traffic mirroring rule on an Ethernet device */
1235 typedef int (*eth_mirror_rule_reset_t)(struct rte_eth_dev *dev,
1237 /**< @internal Remove a traffic mirroring rule on an Ethernet device */
1239 typedef int (*eth_udp_tunnel_port_add_t)(struct rte_eth_dev *dev,
1240 struct rte_eth_udp_tunnel *tunnel_udp);
1241 /**< @internal Add tunneling UDP port */
1243 typedef int (*eth_udp_tunnel_port_del_t)(struct rte_eth_dev *dev,
1244 struct rte_eth_udp_tunnel *tunnel_udp);
1245 /**< @internal Delete tunneling UDP port */
1247 typedef int (*eth_set_mc_addr_list_t)(struct rte_eth_dev *dev,
1248 struct ether_addr *mc_addr_set,
1249 uint32_t nb_mc_addr);
1250 /**< @internal set the list of multicast addresses on an Ethernet device */
1252 typedef int (*eth_timesync_enable_t)(struct rte_eth_dev *dev);
1253 /**< @internal Function used to enable IEEE1588/802.1AS timestamping. */
1255 typedef int (*eth_timesync_disable_t)(struct rte_eth_dev *dev);
1256 /**< @internal Function used to disable IEEE1588/802.1AS timestamping. */
1258 typedef int (*eth_timesync_read_rx_timestamp_t)(struct rte_eth_dev *dev,
1259 struct timespec *timestamp,
1261 /**< @internal Function used to read an RX IEEE1588/802.1AS timestamp. */
1263 typedef int (*eth_timesync_read_tx_timestamp_t)(struct rte_eth_dev *dev,
1264 struct timespec *timestamp);
1265 /**< @internal Function used to read a TX IEEE1588/802.1AS timestamp. */
1267 typedef int (*eth_timesync_adjust_time)(struct rte_eth_dev *dev, int64_t);
1268 /**< @internal Function used to adjust the device clock */
1270 typedef int (*eth_timesync_read_time)(struct rte_eth_dev *dev,
1271 struct timespec *timestamp);
1272 /**< @internal Function used to get time from the device clock. */
1274 typedef int (*eth_timesync_write_time)(struct rte_eth_dev *dev,
1275 const struct timespec *timestamp);
1276 /**< @internal Function used to get time from the device clock */
1278 typedef int (*eth_get_reg_length_t)(struct rte_eth_dev *dev);
1279 /**< @internal Retrieve device register count */
1281 typedef int (*eth_get_reg_t)(struct rte_eth_dev *dev,
1282 struct rte_dev_reg_info *info);
1283 /**< @internal Retrieve registers */
1285 typedef int (*eth_get_eeprom_length_t)(struct rte_eth_dev *dev);
1286 /**< @internal Retrieve eeprom size */
1288 typedef int (*eth_get_eeprom_t)(struct rte_eth_dev *dev,
1289 struct rte_dev_eeprom_info *info);
1290 /**< @internal Retrieve eeprom data */
1292 typedef int (*eth_set_eeprom_t)(struct rte_eth_dev *dev,
1293 struct rte_dev_eeprom_info *info);
1294 /**< @internal Program eeprom data */
1296 typedef int (*eth_l2_tunnel_eth_type_conf_t)
1297 (struct rte_eth_dev *dev, struct rte_eth_l2_tunnel_conf *l2_tunnel);
1298 /**< @internal config l2 tunnel ether type */
1300 typedef int (*eth_l2_tunnel_offload_set_t)
1301 (struct rte_eth_dev *dev,
1302 struct rte_eth_l2_tunnel_conf *l2_tunnel,
1305 /**< @internal enable/disable the l2 tunnel offload functions */
1307 #ifdef RTE_NIC_BYPASS
1310 RTE_BYPASS_MODE_NONE,
1311 RTE_BYPASS_MODE_NORMAL,
1312 RTE_BYPASS_MODE_BYPASS,
1313 RTE_BYPASS_MODE_ISOLATE,
1314 RTE_BYPASS_MODE_NUM,
1317 #define RTE_BYPASS_MODE_VALID(x) \
1318 ((x) > RTE_BYPASS_MODE_NONE && (x) < RTE_BYPASS_MODE_NUM)
1321 RTE_BYPASS_EVENT_NONE,
1322 RTE_BYPASS_EVENT_START,
1323 RTE_BYPASS_EVENT_OS_ON = RTE_BYPASS_EVENT_START,
1324 RTE_BYPASS_EVENT_POWER_ON,
1325 RTE_BYPASS_EVENT_OS_OFF,
1326 RTE_BYPASS_EVENT_POWER_OFF,
1327 RTE_BYPASS_EVENT_TIMEOUT,
1328 RTE_BYPASS_EVENT_NUM
1331 #define RTE_BYPASS_EVENT_VALID(x) \
1332 ((x) > RTE_BYPASS_EVENT_NONE && (x) < RTE_BYPASS_MODE_NUM)
1335 RTE_BYPASS_TMT_OFF, /* timeout disabled. */
1336 RTE_BYPASS_TMT_1_5_SEC, /* timeout for 1.5 seconds */
1337 RTE_BYPASS_TMT_2_SEC, /* timeout for 2 seconds */
1338 RTE_BYPASS_TMT_3_SEC, /* timeout for 3 seconds */
1339 RTE_BYPASS_TMT_4_SEC, /* timeout for 4 seconds */
1340 RTE_BYPASS_TMT_8_SEC, /* timeout for 8 seconds */
1341 RTE_BYPASS_TMT_16_SEC, /* timeout for 16 seconds */
1342 RTE_BYPASS_TMT_32_SEC, /* timeout for 32 seconds */
1346 #define RTE_BYPASS_TMT_VALID(x) \
1347 ((x) == RTE_BYPASS_TMT_OFF || \
1348 ((x) > RTE_BYPASS_TMT_OFF && (x) < RTE_BYPASS_TMT_NUM))
1350 typedef void (*bypass_init_t)(struct rte_eth_dev *dev);
1351 typedef int32_t (*bypass_state_set_t)(struct rte_eth_dev *dev, uint32_t *new_state);
1352 typedef int32_t (*bypass_state_show_t)(struct rte_eth_dev *dev, uint32_t *state);
1353 typedef int32_t (*bypass_event_set_t)(struct rte_eth_dev *dev, uint32_t state, uint32_t event);
1354 typedef int32_t (*bypass_event_show_t)(struct rte_eth_dev *dev, uint32_t event_shift, uint32_t *event);
1355 typedef int32_t (*bypass_wd_timeout_set_t)(struct rte_eth_dev *dev, uint32_t timeout);
1356 typedef int32_t (*bypass_wd_timeout_show_t)(struct rte_eth_dev *dev, uint32_t *wd_timeout);
1357 typedef int32_t (*bypass_ver_show_t)(struct rte_eth_dev *dev, uint32_t *ver);
1358 typedef int32_t (*bypass_wd_reset_t)(struct rte_eth_dev *dev);
1361 typedef int (*eth_filter_ctrl_t)(struct rte_eth_dev *dev,
1362 enum rte_filter_type filter_type,
1363 enum rte_filter_op filter_op,
1365 /**< @internal Take operations to assigned filter type on an Ethernet device */
1367 typedef int (*eth_get_dcb_info)(struct rte_eth_dev *dev,
1368 struct rte_eth_dcb_info *dcb_info);
1369 /**< @internal Get dcb information on an Ethernet device */
1372 * @internal A structure containing the functions exported by an Ethernet driver.
1374 struct eth_dev_ops {
1375 eth_dev_configure_t dev_configure; /**< Configure device. */
1376 eth_dev_start_t dev_start; /**< Start device. */
1377 eth_dev_stop_t dev_stop; /**< Stop device. */
1378 eth_dev_set_link_up_t dev_set_link_up; /**< Device link up. */
1379 eth_dev_set_link_down_t dev_set_link_down; /**< Device link down. */
1380 eth_dev_close_t dev_close; /**< Close device. */
1381 eth_promiscuous_enable_t promiscuous_enable; /**< Promiscuous ON. */
1382 eth_promiscuous_disable_t promiscuous_disable;/**< Promiscuous OFF. */
1383 eth_allmulticast_enable_t allmulticast_enable;/**< RX multicast ON. */
1384 eth_allmulticast_disable_t allmulticast_disable;/**< RX multicast OF. */
1385 eth_link_update_t link_update; /**< Get device link state. */
1386 eth_stats_get_t stats_get; /**< Get generic device statistics. */
1387 eth_stats_reset_t stats_reset; /**< Reset generic device statistics. */
1388 eth_xstats_get_t xstats_get; /**< Get extended device statistics. */
1389 eth_xstats_reset_t xstats_reset; /**< Reset extended device statistics. */
1390 eth_queue_stats_mapping_set_t queue_stats_mapping_set;
1391 /**< Configure per queue stat counter mapping. */
1392 eth_dev_infos_get_t dev_infos_get; /**< Get device info. */
1393 eth_dev_supported_ptypes_get_t dev_supported_ptypes_get;
1394 /**< Get packet types supported and identified by device*/
1395 mtu_set_t mtu_set; /**< Set MTU. */
1396 vlan_filter_set_t vlan_filter_set; /**< Filter VLAN Setup. */
1397 vlan_tpid_set_t vlan_tpid_set; /**< Outer VLAN TPID Setup. */
1398 vlan_strip_queue_set_t vlan_strip_queue_set; /**< VLAN Stripping on queue. */
1399 vlan_offload_set_t vlan_offload_set; /**< Set VLAN Offload. */
1400 vlan_pvid_set_t vlan_pvid_set; /**< Set port based TX VLAN insertion */
1401 eth_queue_start_t rx_queue_start;/**< Start RX for a queue.*/
1402 eth_queue_stop_t rx_queue_stop;/**< Stop RX for a queue.*/
1403 eth_queue_start_t tx_queue_start;/**< Start TX for a queue.*/
1404 eth_queue_stop_t tx_queue_stop;/**< Stop TX for a queue.*/
1405 eth_rx_queue_setup_t rx_queue_setup;/**< Set up device RX queue.*/
1406 eth_queue_release_t rx_queue_release;/**< Release RX queue.*/
1407 eth_rx_queue_count_t rx_queue_count; /**< Get Rx queue count. */
1408 eth_rx_descriptor_done_t rx_descriptor_done; /**< Check rxd DD bit */
1409 /**< Enable Rx queue interrupt. */
1410 eth_rx_enable_intr_t rx_queue_intr_enable;
1411 /**< Disable Rx queue interrupt.*/
1412 eth_rx_disable_intr_t rx_queue_intr_disable;
1413 eth_tx_queue_setup_t tx_queue_setup;/**< Set up device TX queue.*/
1414 eth_queue_release_t tx_queue_release;/**< Release TX queue.*/
1415 eth_dev_led_on_t dev_led_on; /**< Turn on LED. */
1416 eth_dev_led_off_t dev_led_off; /**< Turn off LED. */
1417 flow_ctrl_get_t flow_ctrl_get; /**< Get flow control. */
1418 flow_ctrl_set_t flow_ctrl_set; /**< Setup flow control. */
1419 priority_flow_ctrl_set_t priority_flow_ctrl_set; /**< Setup priority flow control.*/
1420 eth_mac_addr_remove_t mac_addr_remove; /**< Remove MAC address */
1421 eth_mac_addr_add_t mac_addr_add; /**< Add a MAC address */
1422 eth_mac_addr_set_t mac_addr_set; /**< Set a MAC address */
1423 eth_uc_hash_table_set_t uc_hash_table_set; /**< Set Unicast Table Array */
1424 eth_uc_all_hash_table_set_t uc_all_hash_table_set; /**< Set Unicast hash bitmap */
1425 eth_mirror_rule_set_t mirror_rule_set; /**< Add a traffic mirror rule.*/
1426 eth_mirror_rule_reset_t mirror_rule_reset; /**< reset a traffic mirror rule.*/
1427 eth_set_vf_rx_mode_t set_vf_rx_mode; /**< Set VF RX mode */
1428 eth_set_vf_rx_t set_vf_rx; /**< enable/disable a VF receive */
1429 eth_set_vf_tx_t set_vf_tx; /**< enable/disable a VF transmit */
1430 eth_set_vf_vlan_filter_t set_vf_vlan_filter; /**< Set VF VLAN filter */
1431 /** Add UDP tunnel port. */
1432 eth_udp_tunnel_port_add_t udp_tunnel_port_add;
1433 /** Del UDP tunnel port. */
1434 eth_udp_tunnel_port_del_t udp_tunnel_port_del;
1435 eth_set_queue_rate_limit_t set_queue_rate_limit; /**< Set queue rate limit */
1436 eth_set_vf_rate_limit_t set_vf_rate_limit; /**< Set VF rate limit */
1437 /** Update redirection table. */
1438 reta_update_t reta_update;
1439 /** Query redirection table. */
1440 reta_query_t reta_query;
1442 eth_get_reg_length_t get_reg_length;
1443 /**< Get # of registers */
1444 eth_get_reg_t get_reg;
1445 /**< Get registers */
1446 eth_get_eeprom_length_t get_eeprom_length;
1447 /**< Get eeprom length */
1448 eth_get_eeprom_t get_eeprom;
1449 /**< Get eeprom data */
1450 eth_set_eeprom_t set_eeprom;
1452 /* bypass control */
1453 #ifdef RTE_NIC_BYPASS
1454 bypass_init_t bypass_init;
1455 bypass_state_set_t bypass_state_set;
1456 bypass_state_show_t bypass_state_show;
1457 bypass_event_set_t bypass_event_set;
1458 bypass_event_show_t bypass_event_show;
1459 bypass_wd_timeout_set_t bypass_wd_timeout_set;
1460 bypass_wd_timeout_show_t bypass_wd_timeout_show;
1461 bypass_ver_show_t bypass_ver_show;
1462 bypass_wd_reset_t bypass_wd_reset;
1465 /** Configure RSS hash protocols. */
1466 rss_hash_update_t rss_hash_update;
1467 /** Get current RSS hash configuration. */
1468 rss_hash_conf_get_t rss_hash_conf_get;
1469 eth_filter_ctrl_t filter_ctrl;
1470 /**< common filter control. */
1471 eth_set_mc_addr_list_t set_mc_addr_list; /**< set list of mcast addrs */
1472 eth_rxq_info_get_t rxq_info_get;
1473 /**< retrieve RX queue information. */
1474 eth_txq_info_get_t txq_info_get;
1475 /**< retrieve TX queue information. */
1476 /** Turn IEEE1588/802.1AS timestamping on. */
1477 eth_timesync_enable_t timesync_enable;
1478 /** Turn IEEE1588/802.1AS timestamping off. */
1479 eth_timesync_disable_t timesync_disable;
1480 /** Read the IEEE1588/802.1AS RX timestamp. */
1481 eth_timesync_read_rx_timestamp_t timesync_read_rx_timestamp;
1482 /** Read the IEEE1588/802.1AS TX timestamp. */
1483 eth_timesync_read_tx_timestamp_t timesync_read_tx_timestamp;
1485 /** Get DCB information */
1486 eth_get_dcb_info get_dcb_info;
1487 /** Adjust the device clock.*/
1488 eth_timesync_adjust_time timesync_adjust_time;
1489 /** Get the device clock time. */
1490 eth_timesync_read_time timesync_read_time;
1491 /** Set the device clock time. */
1492 eth_timesync_write_time timesync_write_time;
1493 /** Config ether type of l2 tunnel */
1494 eth_l2_tunnel_eth_type_conf_t l2_tunnel_eth_type_conf;
1495 /** Enable/disable l2 tunnel offload functions */
1496 eth_l2_tunnel_offload_set_t l2_tunnel_offload_set;
1500 * Function type used for RX packet processing packet callbacks.
1502 * The callback function is called on RX with a burst of packets that have
1503 * been received on the given port and queue.
1506 * The Ethernet port on which RX is being performed.
1508 * The queue on the Ethernet port which is being used to receive the packets.
1510 * The burst of packets that have just been received.
1512 * The number of packets in the burst pointed to by "pkts".
1514 * The max number of packets that can be stored in the "pkts" array.
1516 * The arbitrary user parameter passed in by the application when the callback
1517 * was originally configured.
1519 * The number of packets returned to the user.
1521 typedef uint16_t (*rte_rx_callback_fn)(uint8_t port, uint16_t queue,
1522 struct rte_mbuf *pkts[], uint16_t nb_pkts, uint16_t max_pkts,
1526 * Function type used for TX packet processing packet callbacks.
1528 * The callback function is called on TX with a burst of packets immediately
1529 * before the packets are put onto the hardware queue for transmission.
1532 * The Ethernet port on which TX is being performed.
1534 * The queue on the Ethernet port which is being used to transmit the packets.
1536 * The burst of packets that are about to be transmitted.
1538 * The number of packets in the burst pointed to by "pkts".
1540 * The arbitrary user parameter passed in by the application when the callback
1541 * was originally configured.
1543 * The number of packets to be written to the NIC.
1545 typedef uint16_t (*rte_tx_callback_fn)(uint8_t port, uint16_t queue,
1546 struct rte_mbuf *pkts[], uint16_t nb_pkts, void *user_param);
1550 * Structure used to hold information about the callbacks to be called for a
1551 * queue on RX and TX.
1553 struct rte_eth_rxtx_callback {
1554 struct rte_eth_rxtx_callback *next;
1556 rte_rx_callback_fn rx;
1557 rte_tx_callback_fn tx;
1563 * The eth device type.
1565 enum rte_eth_dev_type {
1566 RTE_ETH_DEV_UNKNOWN, /**< unknown device type */
1568 /**< Physical function and Virtual function of PCI devices */
1569 RTE_ETH_DEV_VIRTUAL, /**< non hardware device */
1570 RTE_ETH_DEV_MAX /**< max value of this enum */
1575 * The generic data structure associated with each ethernet device.
1577 * Pointers to burst-oriented packet receive and transmit functions are
1578 * located at the beginning of the structure, along with the pointer to
1579 * where all the data elements for the particular device are stored in shared
1580 * memory. This split allows the function pointer and driver data to be per-
1581 * process, while the actual configuration data for the device is shared.
1583 struct rte_eth_dev {
1584 eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
1585 eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
1586 struct rte_eth_dev_data *data; /**< Pointer to device data */
1587 const struct eth_driver *driver;/**< Driver for this device */
1588 const struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
1589 struct rte_pci_device *pci_dev; /**< PCI info. supplied by probing */
1590 /** User application callbacks for NIC interrupts */
1591 struct rte_eth_dev_cb_list link_intr_cbs;
1593 * User-supplied functions called from rx_burst to post-process
1594 * received packets before passing them to the user
1596 struct rte_eth_rxtx_callback *post_rx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
1598 * User-supplied functions called from tx_burst to pre-process
1599 * received packets before passing them to the driver for transmission.
1601 struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
1602 uint8_t attached; /**< Flag indicating the port is attached */
1603 enum rte_eth_dev_type dev_type; /**< Flag indicating the device type */
1606 struct rte_eth_dev_sriov {
1607 uint8_t active; /**< SRIOV is active with 16, 32 or 64 pools */
1608 uint8_t nb_q_per_pool; /**< rx queue number per pool */
1609 uint16_t def_vmdq_idx; /**< Default pool num used for PF */
1610 uint16_t def_pool_q_idx; /**< Default pool queue start reg index */
1612 #define RTE_ETH_DEV_SRIOV(dev) ((dev)->data->sriov)
1614 #define RTE_ETH_NAME_MAX_LEN (32)
1618 * The data part, with no function pointers, associated with each ethernet device.
1620 * This structure is safe to place in shared memory to be common among different
1621 * processes in a multi-process configuration.
1623 struct rte_eth_dev_data {
1624 char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
1626 void **rx_queues; /**< Array of pointers to RX queues. */
1627 void **tx_queues; /**< Array of pointers to TX queues. */
1628 uint16_t nb_rx_queues; /**< Number of RX queues. */
1629 uint16_t nb_tx_queues; /**< Number of TX queues. */
1631 struct rte_eth_dev_sriov sriov; /**< SRIOV data */
1633 void *dev_private; /**< PMD-specific private data */
1635 struct rte_eth_link dev_link;
1636 /**< Link-level information & status */
1638 struct rte_eth_conf dev_conf; /**< Configuration applied to device. */
1639 uint16_t mtu; /**< Maximum Transmission Unit. */
1641 uint32_t min_rx_buf_size;
1642 /**< Common rx buffer size handled by all queues */
1644 uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
1645 struct ether_addr* mac_addrs;/**< Device Ethernet Link address. */
1646 uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
1647 /** bitmap array of associating Ethernet MAC addresses to pools */
1648 struct ether_addr* hash_mac_addrs;
1649 /** Device Ethernet MAC addresses of hash filtering. */
1650 uint8_t port_id; /**< Device [external] port identifier. */
1651 uint8_t promiscuous : 1, /**< RX promiscuous mode ON(1) / OFF(0). */
1652 scattered_rx : 1, /**< RX of scattered packets is ON(1) / OFF(0) */
1653 all_multicast : 1, /**< RX all multicast mode ON(1) / OFF(0). */
1654 dev_started : 1, /**< Device state: STARTED(1) / STOPPED(0). */
1655 lro : 1; /**< RX LRO is ON(1) / OFF(0) */
1656 uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT];
1657 /** Queues state: STARTED(1) / STOPPED(0) */
1658 uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
1659 /** Queues state: STARTED(1) / STOPPED(0) */
1660 uint32_t dev_flags; /**< Capabilities */
1661 enum rte_kernel_driver kdrv; /**< Kernel driver passthrough */
1662 int numa_node; /**< NUMA node connection */
1663 const char *drv_name; /**< Driver name */
1666 /** Device supports hotplug detach */
1667 #define RTE_ETH_DEV_DETACHABLE 0x0001
1668 /** Device supports link state interrupt */
1669 #define RTE_ETH_DEV_INTR_LSC 0x0002
1670 /** Device is a bonded slave */
1671 #define RTE_ETH_DEV_BONDED_SLAVE 0x0004
1675 * The pool of *rte_eth_dev* structures. The size of the pool
1676 * is configured at compile-time in the <rte_ethdev.c> file.
1678 extern struct rte_eth_dev rte_eth_devices[];
1681 * Get the total number of Ethernet devices that have been successfully
1682 * initialized by the [matching] Ethernet driver during the PCI probing phase.
1683 * All devices whose port identifier is in the range
1684 * [0, rte_eth_dev_count() - 1] can be operated on by network applications
1685 * immediately after invoking rte_eal_init().
1686 * If the application unplugs a port using hotplug function, The enabled port
1687 * numbers may be noncontiguous. In the case, the applications need to manage
1688 * enabled port by themselves.
1691 * - The total number of usable Ethernet devices.
1693 uint8_t rte_eth_dev_count(void);
1697 * Returns a ethdev slot specified by the unique identifier name.
1700 * The pointer to the Unique identifier name for each Ethernet device
1702 * - The pointer to the ethdev slot, on success. NULL on error
1704 struct rte_eth_dev *rte_eth_dev_allocated(const char *name);
1708 * Allocates a new ethdev slot for an ethernet device and returns the pointer
1709 * to that slot for the driver to use.
1711 * @param name Unique identifier name for each Ethernet device
1712 * @param type Device type of this Ethernet device
1714 * - Slot in the rte_dev_devices array for a new device;
1716 struct rte_eth_dev *rte_eth_dev_allocate(const char *name,
1717 enum rte_eth_dev_type type);
1721 * Release the specified ethdev port.
1724 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure.
1726 * - 0 on success, negative on error
1728 int rte_eth_dev_release_port(struct rte_eth_dev *eth_dev);
1731 * Attach a new Ethernet device specified by aruguments.
1734 * A pointer to a strings array describing the new device
1735 * to be attached. The strings should be a pci address like
1736 * '0000:01:00.0' or virtual device name like 'eth_pcap0'.
1738 * A pointer to a port identifier actually attached.
1740 * 0 on success and port_id is filled, negative on error
1742 int rte_eth_dev_attach(const char *devargs, uint8_t *port_id);
1745 * Detach a Ethernet device specified by port identifier.
1746 * This function must be called when the device is in the
1750 * The port identifier of the device to detach.
1752 * A pointer to a device name actually detached.
1754 * 0 on success and devname is filled, negative on error
1756 int rte_eth_dev_detach(uint8_t port_id, char *devname);
1761 * Initialization function of an Ethernet driver invoked for each matching
1762 * Ethernet PCI device detected during the PCI probing phase.
1765 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1766 * associated with the matching device and which have been [automatically]
1767 * allocated in the *rte_eth_devices* array.
1768 * The *eth_dev* structure is supplied to the driver initialization function
1769 * with the following fields already initialized:
1771 * - *pci_dev*: Holds the pointers to the *rte_pci_device* structure which
1772 * contains the generic PCI information of the matching device.
1774 * - *driver*: Holds the pointer to the *eth_driver* structure.
1776 * - *dev_private*: Holds a pointer to the device private data structure.
1778 * - *mtu*: Contains the default Ethernet maximum frame length (1500).
1780 * - *port_id*: Contains the port index of the device (actually the index
1781 * of the *eth_dev* structure in the *rte_eth_devices* array).
1784 * - 0: Success, the device is properly initialized by the driver.
1785 * In particular, the driver MUST have set up the *dev_ops* pointer
1786 * of the *eth_dev* structure.
1787 * - <0: Error code of the device initialization failure.
1789 typedef int (*eth_dev_init_t)(struct rte_eth_dev *eth_dev);
1793 * Finalization function of an Ethernet driver invoked for each matching
1794 * Ethernet PCI device detected during the PCI closing phase.
1797 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1798 * associated with the matching device and which have been [automatically]
1799 * allocated in the *rte_eth_devices* array.
1801 * - 0: Success, the device is properly finalized by the driver.
1802 * In particular, the driver MUST free the *dev_ops* pointer
1803 * of the *eth_dev* structure.
1804 * - <0: Error code of the device initialization failure.
1806 typedef int (*eth_dev_uninit_t)(struct rte_eth_dev *eth_dev);
1810 * The structure associated with a PMD Ethernet driver.
1812 * Each Ethernet driver acts as a PCI driver and is represented by a generic
1813 * *eth_driver* structure that holds:
1815 * - An *rte_pci_driver* structure (which must be the first field).
1817 * - The *eth_dev_init* function invoked for each matching PCI device.
1819 * - The *eth_dev_uninit* function invoked for each matching PCI device.
1821 * - The size of the private data to allocate for each matching device.
1824 struct rte_pci_driver pci_drv; /**< The PMD is also a PCI driver. */
1825 eth_dev_init_t eth_dev_init; /**< Device init function. */
1826 eth_dev_uninit_t eth_dev_uninit; /**< Device uninit function. */
1827 unsigned int dev_private_size; /**< Size of device private data. */
1832 * A function invoked by the initialization function of an Ethernet driver
1833 * to simultaneously register itself as a PCI driver and as an Ethernet
1834 * Poll Mode Driver (PMD).
1837 * The pointer to the *eth_driver* structure associated with
1838 * the Ethernet driver.
1840 void rte_eth_driver_register(struct eth_driver *eth_drv);
1843 * Configure an Ethernet device.
1844 * This function must be invoked first before any other function in the
1845 * Ethernet API. This function can also be re-invoked when a device is in the
1849 * The port identifier of the Ethernet device to configure.
1850 * @param nb_rx_queue
1851 * The number of receive queues to set up for the Ethernet device.
1852 * @param nb_tx_queue
1853 * The number of transmit queues to set up for the Ethernet device.
1855 * The pointer to the configuration data to be used for the Ethernet device.
1856 * The *rte_eth_conf* structure includes:
1857 * - the hardware offload features to activate, with dedicated fields for
1858 * each statically configurable offload hardware feature provided by
1859 * Ethernet devices, such as IP checksum or VLAN tag stripping for
1861 * - the Receive Side Scaling (RSS) configuration when using multiple RX
1864 * Embedding all configuration information in a single data structure
1865 * is the more flexible method that allows the addition of new features
1866 * without changing the syntax of the API.
1868 * - 0: Success, device configured.
1869 * - <0: Error code returned by the driver configuration function.
1871 int rte_eth_dev_configure(uint8_t port_id, uint16_t nb_rx_queue,
1872 uint16_t nb_tx_queue, const struct rte_eth_conf *eth_conf);
1875 * Allocate and set up a receive queue for an Ethernet device.
1877 * The function allocates a contiguous block of memory for *nb_rx_desc*
1878 * receive descriptors from a memory zone associated with *socket_id*
1879 * and initializes each receive descriptor with a network buffer allocated
1880 * from the memory pool *mb_pool*.
1883 * The port identifier of the Ethernet device.
1884 * @param rx_queue_id
1885 * The index of the receive queue to set up.
1886 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1887 * to rte_eth_dev_configure().
1889 * The number of receive descriptors to allocate for the receive ring.
1891 * The *socket_id* argument is the socket identifier in case of NUMA.
1892 * The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1893 * the DMA memory allocated for the receive descriptors of the ring.
1895 * The pointer to the configuration data to be used for the receive queue.
1896 * NULL value is allowed, in which case default RX configuration
1898 * The *rx_conf* structure contains an *rx_thresh* structure with the values
1899 * of the Prefetch, Host, and Write-Back threshold registers of the receive
1902 * The pointer to the memory pool from which to allocate *rte_mbuf* network
1903 * memory buffers to populate each descriptor of the receive ring.
1905 * - 0: Success, receive queue correctly set up.
1906 * - -EINVAL: The size of network buffers which can be allocated from the
1907 * memory pool does not fit the various buffer sizes allowed by the
1908 * device controller.
1909 * - -ENOMEM: Unable to allocate the receive ring descriptors or to
1910 * allocate network memory buffers from the memory pool when
1911 * initializing receive descriptors.
1913 int rte_eth_rx_queue_setup(uint8_t port_id, uint16_t rx_queue_id,
1914 uint16_t nb_rx_desc, unsigned int socket_id,
1915 const struct rte_eth_rxconf *rx_conf,
1916 struct rte_mempool *mb_pool);
1919 * Allocate and set up a transmit queue for an Ethernet device.
1922 * The port identifier of the Ethernet device.
1923 * @param tx_queue_id
1924 * The index of the transmit queue to set up.
1925 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1926 * to rte_eth_dev_configure().
1928 * The number of transmit descriptors to allocate for the transmit ring.
1930 * The *socket_id* argument is the socket identifier in case of NUMA.
1931 * Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1932 * the DMA memory allocated for the transmit descriptors of the ring.
1934 * The pointer to the configuration data to be used for the transmit queue.
1935 * NULL value is allowed, in which case default RX configuration
1937 * The *tx_conf* structure contains the following data:
1938 * - The *tx_thresh* structure with the values of the Prefetch, Host, and
1939 * Write-Back threshold registers of the transmit ring.
1940 * When setting Write-Back threshold to the value greater then zero,
1941 * *tx_rs_thresh* value should be explicitly set to one.
1942 * - The *tx_free_thresh* value indicates the [minimum] number of network
1943 * buffers that must be pending in the transmit ring to trigger their
1944 * [implicit] freeing by the driver transmit function.
1945 * - The *tx_rs_thresh* value indicates the [minimum] number of transmit
1946 * descriptors that must be pending in the transmit ring before setting the
1947 * RS bit on a descriptor by the driver transmit function.
1948 * The *tx_rs_thresh* value should be less or equal then
1949 * *tx_free_thresh* value, and both of them should be less then
1951 * - The *txq_flags* member contains flags to pass to the TX queue setup
1952 * function to configure the behavior of the TX queue. This should be set
1953 * to 0 if no special configuration is required.
1955 * Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces
1956 * the transmit function to use default values.
1958 * - 0: Success, the transmit queue is correctly set up.
1959 * - -ENOMEM: Unable to allocate the transmit ring descriptors.
1961 int rte_eth_tx_queue_setup(uint8_t port_id, uint16_t tx_queue_id,
1962 uint16_t nb_tx_desc, unsigned int socket_id,
1963 const struct rte_eth_txconf *tx_conf);
1966 * Return the NUMA socket to which an Ethernet device is connected
1969 * The port identifier of the Ethernet device
1971 * The NUMA socket id to which the Ethernet device is connected or
1972 * a default of zero if the socket could not be determined.
1973 * -1 is returned is the port_id value is out of range.
1975 int rte_eth_dev_socket_id(uint8_t port_id);
1978 * Check if port_id of device is attached
1981 * The port identifier of the Ethernet device
1983 * - 0 if port is out of range or not attached
1984 * - 1 if device is attached
1986 int rte_eth_dev_is_valid_port(uint8_t port_id);
1989 * Allocate mbuf from mempool, setup the DMA physical address
1990 * and then start RX for specified queue of a port. It is used
1991 * when rx_deferred_start flag of the specified queue is true.
1994 * The port identifier of the Ethernet device
1995 * @param rx_queue_id
1996 * The index of the rx queue to update the ring.
1997 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1998 * to rte_eth_dev_configure().
2000 * - 0: Success, the transmit queue is correctly set up.
2001 * - -EINVAL: The port_id or the queue_id out of range.
2002 * - -ENOTSUP: The function not supported in PMD driver.
2004 int rte_eth_dev_rx_queue_start(uint8_t port_id, uint16_t rx_queue_id);
2007 * Stop specified RX queue of a port
2010 * The port identifier of the Ethernet device
2011 * @param rx_queue_id
2012 * The index of the rx queue to update the ring.
2013 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2014 * to rte_eth_dev_configure().
2016 * - 0: Success, the transmit queue is correctly set up.
2017 * - -EINVAL: The port_id or the queue_id out of range.
2018 * - -ENOTSUP: The function not supported in PMD driver.
2020 int rte_eth_dev_rx_queue_stop(uint8_t port_id, uint16_t rx_queue_id);
2023 * Start TX for specified queue of a port. It is used when tx_deferred_start
2024 * flag of the specified queue is true.
2027 * The port identifier of the Ethernet device
2028 * @param tx_queue_id
2029 * The index of the tx queue to update the ring.
2030 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2031 * to rte_eth_dev_configure().
2033 * - 0: Success, the transmit queue is correctly set up.
2034 * - -EINVAL: The port_id or the queue_id out of range.
2035 * - -ENOTSUP: The function not supported in PMD driver.
2037 int rte_eth_dev_tx_queue_start(uint8_t port_id, uint16_t tx_queue_id);
2040 * Stop specified TX queue of a port
2043 * The port identifier of the Ethernet device
2044 * @param tx_queue_id
2045 * The index of the tx queue to update the ring.
2046 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2047 * to rte_eth_dev_configure().
2049 * - 0: Success, the transmit queue is correctly set up.
2050 * - -EINVAL: The port_id or the queue_id out of range.
2051 * - -ENOTSUP: The function not supported in PMD driver.
2053 int rte_eth_dev_tx_queue_stop(uint8_t port_id, uint16_t tx_queue_id);
2058 * Start an Ethernet device.
2060 * The device start step is the last one and consists of setting the configured
2061 * offload features and in starting the transmit and the receive units of the
2063 * On success, all basic functions exported by the Ethernet API (link status,
2064 * receive/transmit, and so on) can be invoked.
2067 * The port identifier of the Ethernet device.
2069 * - 0: Success, Ethernet device started.
2070 * - <0: Error code of the driver device start function.
2072 int rte_eth_dev_start(uint8_t port_id);
2075 * Stop an Ethernet device. The device can be restarted with a call to
2076 * rte_eth_dev_start()
2079 * The port identifier of the Ethernet device.
2081 void rte_eth_dev_stop(uint8_t port_id);
2085 * Link up an Ethernet device.
2087 * Set device link up will re-enable the device rx/tx
2088 * functionality after it is previously set device linked down.
2091 * The port identifier of the Ethernet device.
2093 * - 0: Success, Ethernet device linked up.
2094 * - <0: Error code of the driver device link up function.
2096 int rte_eth_dev_set_link_up(uint8_t port_id);
2099 * Link down an Ethernet device.
2100 * The device rx/tx functionality will be disabled if success,
2101 * and it can be re-enabled with a call to
2102 * rte_eth_dev_set_link_up()
2105 * The port identifier of the Ethernet device.
2107 int rte_eth_dev_set_link_down(uint8_t port_id);
2110 * Close a stopped Ethernet device. The device cannot be restarted!
2111 * The function frees all resources except for needed by the
2112 * closed state. To free these resources, call rte_eth_dev_detach().
2115 * The port identifier of the Ethernet device.
2117 void rte_eth_dev_close(uint8_t port_id);
2120 * Enable receipt in promiscuous mode for an Ethernet device.
2123 * The port identifier of the Ethernet device.
2125 void rte_eth_promiscuous_enable(uint8_t port_id);
2128 * Disable receipt in promiscuous mode for an Ethernet device.
2131 * The port identifier of the Ethernet device.
2133 void rte_eth_promiscuous_disable(uint8_t port_id);
2136 * Return the value of promiscuous mode for an Ethernet device.
2139 * The port identifier of the Ethernet device.
2141 * - (1) if promiscuous is enabled
2142 * - (0) if promiscuous is disabled.
2145 int rte_eth_promiscuous_get(uint8_t port_id);
2148 * Enable the receipt of any multicast frame by an Ethernet device.
2151 * The port identifier of the Ethernet device.
2153 void rte_eth_allmulticast_enable(uint8_t port_id);
2156 * Disable the receipt of all multicast frames by an Ethernet device.
2159 * The port identifier of the Ethernet device.
2161 void rte_eth_allmulticast_disable(uint8_t port_id);
2164 * Return the value of allmulticast mode for an Ethernet device.
2167 * The port identifier of the Ethernet device.
2169 * - (1) if allmulticast is enabled
2170 * - (0) if allmulticast is disabled.
2173 int rte_eth_allmulticast_get(uint8_t port_id);
2176 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2177 * or FULL-DUPLEX) of the physical link of an Ethernet device. It might need
2178 * to wait up to 9 seconds in it.
2181 * The port identifier of the Ethernet device.
2183 * A pointer to an *rte_eth_link* structure to be filled with
2184 * the status, the speed and the mode of the Ethernet device link.
2186 void rte_eth_link_get(uint8_t port_id, struct rte_eth_link *link);
2189 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2190 * or FULL-DUPLEX) of the physical link of an Ethernet device. It is a no-wait
2191 * version of rte_eth_link_get().
2194 * The port identifier of the Ethernet device.
2196 * A pointer to an *rte_eth_link* structure to be filled with
2197 * the status, the speed and the mode of the Ethernet device link.
2199 void rte_eth_link_get_nowait(uint8_t port_id, struct rte_eth_link *link);
2202 * Retrieve the general I/O statistics of an Ethernet device.
2205 * The port identifier of the Ethernet device.
2207 * A pointer to a structure of type *rte_eth_stats* to be filled with
2208 * the values of device counters for the following set of statistics:
2209 * - *ipackets* with the total of successfully received packets.
2210 * - *opackets* with the total of successfully transmitted packets.
2211 * - *ibytes* with the total of successfully received bytes.
2212 * - *obytes* with the total of successfully transmitted bytes.
2213 * - *ierrors* with the total of erroneous received packets.
2214 * - *oerrors* with the total of failed transmitted packets.
2216 * Zero if successful. Non-zero otherwise.
2218 int rte_eth_stats_get(uint8_t port_id, struct rte_eth_stats *stats);
2221 * Reset the general I/O statistics of an Ethernet device.
2224 * The port identifier of the Ethernet device.
2226 void rte_eth_stats_reset(uint8_t port_id);
2229 * Retrieve extended statistics of an Ethernet device.
2232 * The port identifier of the Ethernet device.
2234 * A pointer to a table of structure of type *rte_eth_xstats*
2235 * to be filled with device statistics names and values.
2236 * This parameter can be set to NULL if n is 0.
2238 * The size of the stats table, which should be large enough to store
2239 * all the statistics of the device.
2241 * - positive value lower or equal to n: success. The return value
2242 * is the number of entries filled in the stats table.
2243 * - positive value higher than n: error, the given statistics table
2244 * is too small. The return value corresponds to the size that should
2245 * be given to succeed. The entries in the table are not valid and
2246 * shall not be used by the caller.
2247 * - negative value on error (invalid port id)
2249 int rte_eth_xstats_get(uint8_t port_id, struct rte_eth_xstats *xstats,
2253 * Reset extended statistics of an Ethernet device.
2256 * The port identifier of the Ethernet device.
2258 void rte_eth_xstats_reset(uint8_t port_id);
2261 * Set a mapping for the specified transmit queue to the specified per-queue
2262 * statistics counter.
2265 * The port identifier of the Ethernet device.
2266 * @param tx_queue_id
2267 * The index of the transmit queue for which a queue stats mapping is required.
2268 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2269 * to rte_eth_dev_configure().
2271 * The per-queue packet statistics functionality number that the transmit
2272 * queue is to be assigned.
2273 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2275 * Zero if successful. Non-zero otherwise.
2277 int rte_eth_dev_set_tx_queue_stats_mapping(uint8_t port_id,
2278 uint16_t tx_queue_id, uint8_t stat_idx);
2281 * Set a mapping for the specified receive queue to the specified per-queue
2282 * statistics counter.
2285 * The port identifier of the Ethernet device.
2286 * @param rx_queue_id
2287 * The index of the receive queue for which a queue stats mapping is required.
2288 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2289 * to rte_eth_dev_configure().
2291 * The per-queue packet statistics functionality number that the receive
2292 * queue is to be assigned.
2293 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2295 * Zero if successful. Non-zero otherwise.
2297 int rte_eth_dev_set_rx_queue_stats_mapping(uint8_t port_id,
2298 uint16_t rx_queue_id,
2302 * Retrieve the Ethernet address of an Ethernet device.
2305 * The port identifier of the Ethernet device.
2307 * A pointer to a structure of type *ether_addr* to be filled with
2308 * the Ethernet address of the Ethernet device.
2310 void rte_eth_macaddr_get(uint8_t port_id, struct ether_addr *mac_addr);
2313 * Retrieve the contextual information of an Ethernet device.
2316 * The port identifier of the Ethernet device.
2318 * A pointer to a structure of type *rte_eth_dev_info* to be filled with
2319 * the contextual information of the Ethernet device.
2321 void rte_eth_dev_info_get(uint8_t port_id, struct rte_eth_dev_info *dev_info);
2324 * Retrieve the supported packet types of an Ethernet device.
2327 * Better to invoke this API after the device is already started or rx burst
2328 * function is decided, to obtain correct supported ptypes.
2330 * The port identifier of the Ethernet device.
2332 * A hint of what kind of packet type which the caller is interested in.
2334 * An array pointer to store adequent packet types, allocated by caller.
2336 * Size of the array pointed by param ptypes.
2338 * - (>0) Number of supported ptypes. If it exceeds param num, exceeding
2339 * packet types will not be filled in the given array.
2340 * - (0 or -ENOTSUP) if PMD does not fill the specified ptype.
2341 * - (-ENODEV) if *port_id* invalid.
2343 int rte_eth_dev_get_supported_ptypes(uint8_t port_id, uint32_t ptype_mask,
2344 uint32_t *ptypes, int num);
2347 * Retrieve the MTU of an Ethernet device.
2350 * The port identifier of the Ethernet device.
2352 * A pointer to a uint16_t where the retrieved MTU is to be stored.
2354 * - (0) if successful.
2355 * - (-ENODEV) if *port_id* invalid.
2357 int rte_eth_dev_get_mtu(uint8_t port_id, uint16_t *mtu);
2360 * Change the MTU of an Ethernet device.
2363 * The port identifier of the Ethernet device.
2365 * A uint16_t for the MTU to be applied.
2367 * - (0) if successful.
2368 * - (-ENOTSUP) if operation is not supported.
2369 * - (-ENODEV) if *port_id* invalid.
2370 * - (-EINVAL) if *mtu* invalid.
2372 int rte_eth_dev_set_mtu(uint8_t port_id, uint16_t mtu);
2375 * Enable/Disable hardware filtering by an Ethernet device of received
2376 * VLAN packets tagged with a given VLAN Tag Identifier.
2379 * The port identifier of the Ethernet device.
2381 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
2383 * If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*.
2384 * Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*.
2386 * - (0) if successful.
2387 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2388 * - (-ENODEV) if *port_id* invalid.
2389 * - (-ENOSYS) if VLAN filtering on *port_id* disabled.
2390 * - (-EINVAL) if *vlan_id* > 4095.
2392 int rte_eth_dev_vlan_filter(uint8_t port_id, uint16_t vlan_id, int on);
2395 * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
2396 * 82599/X540/X550 can support VLAN stripping at the rx queue level
2399 * The port identifier of the Ethernet device.
2400 * @param rx_queue_id
2401 * The index of the receive queue for which a queue stats mapping is required.
2402 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2403 * to rte_eth_dev_configure().
2405 * If 1, Enable VLAN Stripping of the receive queue of the Ethernet port.
2406 * If 0, Disable VLAN Stripping of the receive queue of the Ethernet port.
2408 * - (0) if successful.
2409 * - (-ENOSUP) if hardware-assisted VLAN stripping not configured.
2410 * - (-ENODEV) if *port_id* invalid.
2411 * - (-EINVAL) if *rx_queue_id* invalid.
2413 int rte_eth_dev_set_vlan_strip_on_queue(uint8_t port_id, uint16_t rx_queue_id,
2417 * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
2418 * the VLAN Header. This is a register setup available on some Intel NIC, not
2419 * but all, please check the data sheet for availability.
2422 * The port identifier of the Ethernet device.
2426 * The Tag Protocol ID
2428 * - (0) if successful.
2429 * - (-ENOSUP) if hardware-assisted VLAN TPID setup is not supported.
2430 * - (-ENODEV) if *port_id* invalid.
2432 int rte_eth_dev_set_vlan_ether_type(uint8_t port_id,
2433 enum rte_vlan_type vlan_type,
2437 * Set VLAN offload configuration on an Ethernet device
2438 * Enable/Disable Extended VLAN by an Ethernet device, This is a register setup
2439 * available on some Intel NIC, not but all, please check the data sheet for
2441 * Enable/Disable VLAN Strip can be done on rx queue for certain NIC, but here
2442 * the configuration is applied on the port level.
2445 * The port identifier of the Ethernet device.
2446 * @param offload_mask
2447 * The VLAN Offload bit mask can be mixed use with "OR"
2448 * ETH_VLAN_STRIP_OFFLOAD
2449 * ETH_VLAN_FILTER_OFFLOAD
2450 * ETH_VLAN_EXTEND_OFFLOAD
2452 * - (0) if successful.
2453 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2454 * - (-ENODEV) if *port_id* invalid.
2456 int rte_eth_dev_set_vlan_offload(uint8_t port_id, int offload_mask);
2459 * Read VLAN Offload configuration from an Ethernet device
2462 * The port identifier of the Ethernet device.
2464 * - (>0) if successful. Bit mask to indicate
2465 * ETH_VLAN_STRIP_OFFLOAD
2466 * ETH_VLAN_FILTER_OFFLOAD
2467 * ETH_VLAN_EXTEND_OFFLOAD
2468 * - (-ENODEV) if *port_id* invalid.
2470 int rte_eth_dev_get_vlan_offload(uint8_t port_id);
2473 * Set port based TX VLAN insersion on or off.
2476 * The port identifier of the Ethernet device.
2478 * Port based TX VLAN identifier togeth with user priority.
2480 * Turn on or off the port based TX VLAN insertion.
2483 * - (0) if successful.
2484 * - negative if failed.
2486 int rte_eth_dev_set_vlan_pvid(uint8_t port_id, uint16_t pvid, int on);
2490 * Retrieve a burst of input packets from a receive queue of an Ethernet
2491 * device. The retrieved packets are stored in *rte_mbuf* structures whose
2492 * pointers are supplied in the *rx_pkts* array.
2494 * The rte_eth_rx_burst() function loops, parsing the RX ring of the
2495 * receive queue, up to *nb_pkts* packets, and for each completed RX
2496 * descriptor in the ring, it performs the following operations:
2498 * - Initialize the *rte_mbuf* data structure associated with the
2499 * RX descriptor according to the information provided by the NIC into
2500 * that RX descriptor.
2502 * - Store the *rte_mbuf* data structure into the next entry of the
2505 * - Replenish the RX descriptor with a new *rte_mbuf* buffer
2506 * allocated from the memory pool associated with the receive queue at
2507 * initialization time.
2509 * When retrieving an input packet that was scattered by the controller
2510 * into multiple receive descriptors, the rte_eth_rx_burst() function
2511 * appends the associated *rte_mbuf* buffers to the first buffer of the
2514 * The rte_eth_rx_burst() function returns the number of packets
2515 * actually retrieved, which is the number of *rte_mbuf* data structures
2516 * effectively supplied into the *rx_pkts* array.
2517 * A return value equal to *nb_pkts* indicates that the RX queue contained
2518 * at least *rx_pkts* packets, and this is likely to signify that other
2519 * received packets remain in the input queue. Applications implementing
2520 * a "retrieve as much received packets as possible" policy can check this
2521 * specific case and keep invoking the rte_eth_rx_burst() function until
2522 * a value less than *nb_pkts* is returned.
2524 * This receive method has the following advantages:
2526 * - It allows a run-to-completion network stack engine to retrieve and
2527 * to immediately process received packets in a fast burst-oriented
2528 * approach, avoiding the overhead of unnecessary intermediate packet
2529 * queue/dequeue operations.
2531 * - Conversely, it also allows an asynchronous-oriented processing
2532 * method to retrieve bursts of received packets and to immediately
2533 * queue them for further parallel processing by another logical core,
2534 * for instance. However, instead of having received packets being
2535 * individually queued by the driver, this approach allows the invoker
2536 * of the rte_eth_rx_burst() function to queue a burst of retrieved
2537 * packets at a time and therefore dramatically reduce the cost of
2538 * enqueue/dequeue operations per packet.
2540 * - It allows the rte_eth_rx_burst() function of the driver to take
2541 * advantage of burst-oriented hardware features (CPU cache,
2542 * prefetch instructions, and so on) to minimize the number of CPU
2543 * cycles per packet.
2545 * To summarize, the proposed receive API enables many
2546 * burst-oriented optimizations in both synchronous and asynchronous
2547 * packet processing environments with no overhead in both cases.
2549 * The rte_eth_rx_burst() function does not provide any error
2550 * notification to avoid the corresponding overhead. As a hint, the
2551 * upper-level application might check the status of the device link once
2552 * being systematically returned a 0 value for a given number of tries.
2555 * The port identifier of the Ethernet device.
2557 * The index of the receive queue from which to retrieve input packets.
2558 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2559 * to rte_eth_dev_configure().
2561 * The address of an array of pointers to *rte_mbuf* structures that
2562 * must be large enough to store *nb_pkts* pointers in it.
2564 * The maximum number of packets to retrieve.
2566 * The number of packets actually retrieved, which is the number
2567 * of pointers to *rte_mbuf* structures effectively supplied to the
2570 static inline uint16_t
2571 rte_eth_rx_burst(uint8_t port_id, uint16_t queue_id,
2572 struct rte_mbuf **rx_pkts, const uint16_t nb_pkts)
2574 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2576 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2577 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
2578 RTE_FUNC_PTR_OR_ERR_RET(*dev->rx_pkt_burst, 0);
2580 if (queue_id >= dev->data->nb_rx_queues) {
2581 RTE_PMD_DEBUG_TRACE("Invalid RX queue_id=%d\n", queue_id);
2585 int16_t nb_rx = (*dev->rx_pkt_burst)(dev->data->rx_queues[queue_id],
2588 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
2589 struct rte_eth_rxtx_callback *cb = dev->post_rx_burst_cbs[queue_id];
2591 if (unlikely(cb != NULL)) {
2593 nb_rx = cb->fn.rx(port_id, queue_id, rx_pkts, nb_rx,
2594 nb_pkts, cb->param);
2596 } while (cb != NULL);
2604 * Get the number of used descriptors in a specific queue
2607 * The port identifier of the Ethernet device.
2609 * The queue id on the specific port.
2611 * The number of used descriptors in the specific queue, or:
2612 * (-EINVAL) if *port_id* is invalid
2613 * (-ENOTSUP) if the device does not support this function
2616 rte_eth_rx_queue_count(uint8_t port_id, uint16_t queue_id)
2618 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2619 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -EINVAL);
2620 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_queue_count, -ENOTSUP);
2621 return (*dev->dev_ops->rx_queue_count)(dev, queue_id);
2625 * Check if the DD bit of the specific RX descriptor in the queue has been set
2628 * The port identifier of the Ethernet device.
2630 * The queue id on the specific port.
2632 * The offset of the descriptor ID from tail.
2634 * - (1) if the specific DD bit is set.
2635 * - (0) if the specific DD bit is not set.
2636 * - (-ENODEV) if *port_id* invalid.
2637 * - (-ENOTSUP) if the device does not support this function
2640 rte_eth_rx_descriptor_done(uint8_t port_id, uint16_t queue_id, uint16_t offset)
2642 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2643 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
2644 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_descriptor_done, -ENOTSUP);
2645 return (*dev->dev_ops->rx_descriptor_done)( \
2646 dev->data->rx_queues[queue_id], offset);
2650 * Send a burst of output packets on a transmit queue of an Ethernet device.
2652 * The rte_eth_tx_burst() function is invoked to transmit output packets
2653 * on the output queue *queue_id* of the Ethernet device designated by its
2655 * The *nb_pkts* parameter is the number of packets to send which are
2656 * supplied in the *tx_pkts* array of *rte_mbuf* structures.
2657 * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
2658 * up to the number of transmit descriptors available in the TX ring of the
2660 * For each packet to send, the rte_eth_tx_burst() function performs
2661 * the following operations:
2663 * - Pick up the next available descriptor in the transmit ring.
2665 * - Free the network buffer previously sent with that descriptor, if any.
2667 * - Initialize the transmit descriptor with the information provided
2668 * in the *rte_mbuf data structure.
2670 * In the case of a segmented packet composed of a list of *rte_mbuf* buffers,
2671 * the rte_eth_tx_burst() function uses several transmit descriptors
2674 * The rte_eth_tx_burst() function returns the number of packets it
2675 * actually sent. A return value equal to *nb_pkts* means that all packets
2676 * have been sent, and this is likely to signify that other output packets
2677 * could be immediately transmitted again. Applications that implement a
2678 * "send as many packets to transmit as possible" policy can check this
2679 * specific case and keep invoking the rte_eth_tx_burst() function until
2680 * a value less than *nb_pkts* is returned.
2682 * It is the responsibility of the rte_eth_tx_burst() function to
2683 * transparently free the memory buffers of packets previously sent.
2684 * This feature is driven by the *tx_free_thresh* value supplied to the
2685 * rte_eth_dev_configure() function at device configuration time.
2686 * When the number of free TX descriptors drops below this threshold, the
2687 * rte_eth_tx_burst() function must [attempt to] free the *rte_mbuf* buffers
2688 * of those packets whose transmission was effectively completed.
2691 * The port identifier of the Ethernet device.
2693 * The index of the transmit queue through which output packets must be
2695 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2696 * to rte_eth_dev_configure().
2698 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
2699 * which contain the output packets.
2701 * The maximum number of packets to transmit.
2703 * The number of output packets actually stored in transmit descriptors of
2704 * the transmit ring. The return value can be less than the value of the
2705 * *tx_pkts* parameter when the transmit ring is full or has been filled up.
2707 static inline uint16_t
2708 rte_eth_tx_burst(uint8_t port_id, uint16_t queue_id,
2709 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
2711 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2713 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2714 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
2715 RTE_FUNC_PTR_OR_ERR_RET(*dev->tx_pkt_burst, 0);
2717 if (queue_id >= dev->data->nb_tx_queues) {
2718 RTE_PMD_DEBUG_TRACE("Invalid TX queue_id=%d\n", queue_id);
2723 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
2724 struct rte_eth_rxtx_callback *cb = dev->pre_tx_burst_cbs[queue_id];
2726 if (unlikely(cb != NULL)) {
2728 nb_pkts = cb->fn.tx(port_id, queue_id, tx_pkts, nb_pkts,
2731 } while (cb != NULL);
2735 return (*dev->tx_pkt_burst)(dev->data->tx_queues[queue_id], tx_pkts, nb_pkts);
2738 typedef void (*buffer_tx_error_fn)(struct rte_mbuf **unsent, uint16_t count,
2742 * Structure used to buffer packets for future TX
2743 * Used by APIs rte_eth_tx_buffer and rte_eth_tx_buffer_flush
2745 struct rte_eth_dev_tx_buffer {
2746 buffer_tx_error_fn error_callback;
2747 void *error_userdata;
2748 uint16_t size; /**< Size of buffer for buffered tx */
2749 uint16_t length; /**< Number of packets in the array */
2750 struct rte_mbuf *pkts[];
2751 /**< Pending packets to be sent on explicit flush or when full */
2755 * Calculate the size of the tx buffer.
2758 * Number of stored packets.
2760 #define RTE_ETH_TX_BUFFER_SIZE(sz) \
2761 (sizeof(struct rte_eth_dev_tx_buffer) + (sz) * sizeof(struct rte_mbuf *))
2764 * Initialize default values for buffered transmitting
2767 * Tx buffer to be initialized.
2774 rte_eth_tx_buffer_init(struct rte_eth_dev_tx_buffer *buffer, uint16_t size);
2777 * Send any packets queued up for transmission on a port and HW queue
2779 * This causes an explicit flush of packets previously buffered via the
2780 * rte_eth_tx_buffer() function. It returns the number of packets successfully
2781 * sent to the NIC, and calls the error callback for any unsent packets. Unless
2782 * explicitly set up otherwise, the default callback simply frees the unsent
2783 * packets back to the owning mempool.
2786 * The port identifier of the Ethernet device.
2788 * The index of the transmit queue through which output packets must be
2790 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2791 * to rte_eth_dev_configure().
2793 * Buffer of packets to be transmit.
2795 * The number of packets successfully sent to the Ethernet device. The error
2796 * callback is called for any packets which could not be sent.
2798 static inline uint16_t
2799 rte_eth_tx_buffer_flush(uint8_t port_id, uint16_t queue_id,
2800 struct rte_eth_dev_tx_buffer *buffer)
2803 uint16_t to_send = buffer->length;
2808 sent = rte_eth_tx_burst(port_id, queue_id, buffer->pkts, to_send);
2812 /* All packets sent, or to be dealt with by callback below */
2813 if (unlikely(sent != to_send))
2814 buffer->error_callback(&buffer->pkts[sent], to_send - sent,
2815 buffer->error_userdata);
2821 * Buffer a single packet for future transmission on a port and queue
2823 * This function takes a single mbuf/packet and buffers it for later
2824 * transmission on the particular port and queue specified. Once the buffer is
2825 * full of packets, an attempt will be made to transmit all the buffered
2826 * packets. In case of error, where not all packets can be transmitted, a
2827 * callback is called with the unsent packets as a parameter. If no callback
2828 * is explicitly set up, the unsent packets are just freed back to the owning
2829 * mempool. The function returns the number of packets actually sent i.e.
2830 * 0 if no buffer flush occurred, otherwise the number of packets successfully
2834 * The port identifier of the Ethernet device.
2836 * The index of the transmit queue through which output packets must be
2838 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2839 * to rte_eth_dev_configure().
2841 * Buffer used to collect packets to be sent.
2843 * Pointer to the packet mbuf to be sent.
2845 * 0 = packet has been buffered for later transmission
2846 * N > 0 = packet has been buffered, and the buffer was subsequently flushed,
2847 * causing N packets to be sent, and the error callback to be called for
2850 static inline uint16_t __attribute__((always_inline))
2851 rte_eth_tx_buffer(uint8_t port_id, uint16_t queue_id,
2852 struct rte_eth_dev_tx_buffer *buffer, struct rte_mbuf *tx_pkt)
2854 buffer->pkts[buffer->length++] = tx_pkt;
2855 if (buffer->length < buffer->size)
2858 return rte_eth_tx_buffer_flush(port_id, queue_id, buffer);
2862 * Configure a callback for buffered packets which cannot be sent
2864 * Register a specific callback to be called when an attempt is made to send
2865 * all packets buffered on an ethernet port, but not all packets can
2866 * successfully be sent. The callback registered here will be called only
2867 * from calls to rte_eth_tx_buffer() and rte_eth_tx_buffer_flush() APIs.
2868 * The default callback configured for each queue by default just frees the
2869 * packets back to the calling mempool. If additional behaviour is required,
2870 * for example, to count dropped packets, or to retry transmission of packets
2871 * which cannot be sent, this function should be used to register a suitable
2872 * callback function to implement the desired behaviour.
2873 * The example callback "rte_eth_count_unsent_packet_callback()" is also
2874 * provided as reference.
2877 * The port identifier of the Ethernet device.
2879 * The function to be used as the callback.
2881 * Arbitrary parameter to be passed to the callback function
2883 * 0 on success, or -1 on error with rte_errno set appropriately
2886 rte_eth_tx_buffer_set_err_callback(struct rte_eth_dev_tx_buffer *buffer,
2887 buffer_tx_error_fn callback, void *userdata);
2890 * Callback function for silently dropping unsent buffered packets.
2892 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
2893 * adjust the default behavior when buffered packets cannot be sent. This
2894 * function drops any unsent packets silently and is used by tx buffered
2895 * operations as default behavior.
2897 * NOTE: this function should not be called directly, instead it should be used
2898 * as a callback for packet buffering.
2900 * NOTE: when configuring this function as a callback with
2901 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
2902 * should point to an uint64_t value.
2905 * The previously buffered packets which could not be sent
2907 * The number of unsent packets in the pkts array
2912 rte_eth_tx_buffer_drop_callback(struct rte_mbuf **pkts, uint16_t unsent,
2916 * Callback function for tracking unsent buffered packets.
2918 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
2919 * adjust the default behavior when buffered packets cannot be sent. This
2920 * function drops any unsent packets, but also updates a user-supplied counter
2921 * to track the overall number of packets dropped. The counter should be an
2922 * uint64_t variable.
2924 * NOTE: this function should not be called directly, instead it should be used
2925 * as a callback for packet buffering.
2927 * NOTE: when configuring this function as a callback with
2928 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
2929 * should point to an uint64_t value.
2932 * The previously buffered packets which could not be sent
2934 * The number of unsent packets in the pkts array
2936 * Pointer to an uint64_t value, which will be incremented by unsent
2939 rte_eth_tx_buffer_count_callback(struct rte_mbuf **pkts, uint16_t unsent,
2943 * The eth device event type for interrupt, and maybe others in the future.
2945 enum rte_eth_event_type {
2946 RTE_ETH_EVENT_UNKNOWN, /**< unknown event type */
2947 RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
2948 RTE_ETH_EVENT_MAX /**< max value of this enum */
2951 typedef void (*rte_eth_dev_cb_fn)(uint8_t port_id, \
2952 enum rte_eth_event_type event, void *cb_arg);
2953 /**< user application callback to be registered for interrupts */
2958 * Register a callback function for specific port id.
2965 * User supplied callback function to be called.
2967 * Pointer to the parameters for the registered callback.
2970 * - On success, zero.
2971 * - On failure, a negative value.
2973 int rte_eth_dev_callback_register(uint8_t port_id,
2974 enum rte_eth_event_type event,
2975 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
2978 * Unregister a callback function for specific port id.
2985 * User supplied callback function to be called.
2987 * Pointer to the parameters for the registered callback. -1 means to
2988 * remove all for the same callback address and same event.
2991 * - On success, zero.
2992 * - On failure, a negative value.
2994 int rte_eth_dev_callback_unregister(uint8_t port_id,
2995 enum rte_eth_event_type event,
2996 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
2999 * @internal Executes all the user application registered callbacks for
3000 * the specific device. It is for DPDK internal user only. User
3001 * application should not call it directly.
3004 * Pointer to struct rte_eth_dev.
3006 * Eth device interrupt event type.
3011 void _rte_eth_dev_callback_process(struct rte_eth_dev *dev,
3012 enum rte_eth_event_type event);
3015 * When there is no rx packet coming in Rx Queue for a long time, we can
3016 * sleep lcore related to RX Queue for power saving, and enable rx interrupt
3017 * to be triggered when rx packect arrives.
3019 * The rte_eth_dev_rx_intr_enable() function enables rx queue
3020 * interrupt on specific rx queue of a port.
3023 * The port identifier of the Ethernet device.
3025 * The index of the receive queue from which to retrieve input packets.
3026 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3027 * to rte_eth_dev_configure().
3029 * - (0) if successful.
3030 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3032 * - (-ENODEV) if *port_id* invalid.
3034 int rte_eth_dev_rx_intr_enable(uint8_t port_id, uint16_t queue_id);
3037 * When lcore wakes up from rx interrupt indicating packet coming, disable rx
3038 * interrupt and returns to polling mode.
3040 * The rte_eth_dev_rx_intr_disable() function disables rx queue
3041 * interrupt on specific rx queue of a port.
3044 * The port identifier of the Ethernet device.
3046 * The index of the receive queue from which to retrieve input packets.
3047 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3048 * to rte_eth_dev_configure().
3050 * - (0) if successful.
3051 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3053 * - (-ENODEV) if *port_id* invalid.
3055 int rte_eth_dev_rx_intr_disable(uint8_t port_id, uint16_t queue_id);
3058 * RX Interrupt control per port.
3061 * The port identifier of the Ethernet device.
3063 * Epoll instance fd which the intr vector associated to.
3064 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
3066 * The operation be performed for the vector.
3067 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
3071 * - On success, zero.
3072 * - On failure, a negative value.
3074 int rte_eth_dev_rx_intr_ctl(uint8_t port_id, int epfd, int op, void *data);
3077 * RX Interrupt control per queue.
3080 * The port identifier of the Ethernet device.
3082 * The index of the receive queue from which to retrieve input packets.
3083 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3084 * to rte_eth_dev_configure().
3086 * Epoll instance fd which the intr vector associated to.
3087 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
3089 * The operation be performed for the vector.
3090 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
3094 * - On success, zero.
3095 * - On failure, a negative value.
3097 int rte_eth_dev_rx_intr_ctl_q(uint8_t port_id, uint16_t queue_id,
3098 int epfd, int op, void *data);
3101 * Turn on the LED on the Ethernet device.
3102 * This function turns on the LED on the Ethernet device.
3105 * The port identifier of the Ethernet device.
3107 * - (0) if successful.
3108 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3110 * - (-ENODEV) if *port_id* invalid.
3112 int rte_eth_led_on(uint8_t port_id);
3115 * Turn off the LED on the Ethernet device.
3116 * This function turns off the LED on the Ethernet device.
3119 * The port identifier of the Ethernet device.
3121 * - (0) if successful.
3122 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3124 * - (-ENODEV) if *port_id* invalid.
3126 int rte_eth_led_off(uint8_t port_id);
3129 * Get current status of the Ethernet link flow control for Ethernet device
3132 * The port identifier of the Ethernet device.
3134 * The pointer to the structure where to store the flow control parameters.
3136 * - (0) if successful.
3137 * - (-ENOTSUP) if hardware doesn't support flow control.
3138 * - (-ENODEV) if *port_id* invalid.
3140 int rte_eth_dev_flow_ctrl_get(uint8_t port_id,
3141 struct rte_eth_fc_conf *fc_conf);
3144 * Configure the Ethernet link flow control for Ethernet device
3147 * The port identifier of the Ethernet device.
3149 * The pointer to the structure of the flow control parameters.
3151 * - (0) if successful.
3152 * - (-ENOTSUP) if hardware doesn't support flow control mode.
3153 * - (-ENODEV) if *port_id* invalid.
3154 * - (-EINVAL) if bad parameter
3155 * - (-EIO) if flow control setup failure
3157 int rte_eth_dev_flow_ctrl_set(uint8_t port_id,
3158 struct rte_eth_fc_conf *fc_conf);
3161 * Configure the Ethernet priority flow control under DCB environment
3162 * for Ethernet device.
3165 * The port identifier of the Ethernet device.
3167 * The pointer to the structure of the priority flow control parameters.
3169 * - (0) if successful.
3170 * - (-ENOTSUP) if hardware doesn't support priority flow control mode.
3171 * - (-ENODEV) if *port_id* invalid.
3172 * - (-EINVAL) if bad parameter
3173 * - (-EIO) if flow control setup failure
3175 int rte_eth_dev_priority_flow_ctrl_set(uint8_t port_id,
3176 struct rte_eth_pfc_conf *pfc_conf);
3179 * Add a MAC address to an internal array of addresses used to enable whitelist
3180 * filtering to accept packets only if the destination MAC address matches.
3183 * The port identifier of the Ethernet device.
3185 * The MAC address to add.
3187 * VMDq pool index to associate address with (if VMDq is enabled). If VMDq is
3188 * not enabled, this should be set to 0.
3190 * - (0) if successfully added or *mac_addr" was already added.
3191 * - (-ENOTSUP) if hardware doesn't support this feature.
3192 * - (-ENODEV) if *port* is invalid.
3193 * - (-ENOSPC) if no more MAC addresses can be added.
3194 * - (-EINVAL) if MAC address is invalid.
3196 int rte_eth_dev_mac_addr_add(uint8_t port, struct ether_addr *mac_addr,
3200 * Remove a MAC address from the internal array of addresses.
3203 * The port identifier of the Ethernet device.
3205 * MAC address to remove.
3207 * - (0) if successful, or *mac_addr* didn't exist.
3208 * - (-ENOTSUP) if hardware doesn't support.
3209 * - (-ENODEV) if *port* invalid.
3210 * - (-EADDRINUSE) if attempting to remove the default MAC address
3212 int rte_eth_dev_mac_addr_remove(uint8_t port, struct ether_addr *mac_addr);
3215 * Set the default MAC address.
3218 * The port identifier of the Ethernet device.
3220 * New default MAC address.
3222 * - (0) if successful, or *mac_addr* didn't exist.
3223 * - (-ENOTSUP) if hardware doesn't support.
3224 * - (-ENODEV) if *port* invalid.
3225 * - (-EINVAL) if MAC address is invalid.
3227 int rte_eth_dev_default_mac_addr_set(uint8_t port, struct ether_addr *mac_addr);
3231 * Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3234 * The port identifier of the Ethernet device.
3238 * Redirection table size. The table size can be queried by
3239 * rte_eth_dev_info_get().
3241 * - (0) if successful.
3242 * - (-ENOTSUP) if hardware doesn't support.
3243 * - (-EINVAL) if bad parameter.
3245 int rte_eth_dev_rss_reta_update(uint8_t port,
3246 struct rte_eth_rss_reta_entry64 *reta_conf,
3247 uint16_t reta_size);
3250 * Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3253 * The port identifier of the Ethernet device.
3257 * Redirection table size. The table size can be queried by
3258 * rte_eth_dev_info_get().
3260 * - (0) if successful.
3261 * - (-ENOTSUP) if hardware doesn't support.
3262 * - (-EINVAL) if bad parameter.
3264 int rte_eth_dev_rss_reta_query(uint8_t port,
3265 struct rte_eth_rss_reta_entry64 *reta_conf,
3266 uint16_t reta_size);
3269 * Updates unicast hash table for receiving packet with the given destination
3270 * MAC address, and the packet is routed to all VFs for which the RX mode is
3271 * accept packets that match the unicast hash table.
3274 * The port identifier of the Ethernet device.
3276 * Unicast MAC address.
3278 * 1 - Set an unicast hash bit for receiving packets with the MAC address.
3279 * 0 - Clear an unicast hash bit.
3281 * - (0) if successful.
3282 * - (-ENOTSUP) if hardware doesn't support.
3283 * - (-ENODEV) if *port_id* invalid.
3284 * - (-EINVAL) if bad parameter.
3286 int rte_eth_dev_uc_hash_table_set(uint8_t port,struct ether_addr *addr,
3290 * Updates all unicast hash bitmaps for receiving packet with any Unicast
3291 * Ethernet MAC addresses,the packet is routed to all VFs for which the RX
3292 * mode is accept packets that match the unicast hash table.
3295 * The port identifier of the Ethernet device.
3297 * 1 - Set all unicast hash bitmaps for receiving all the Ethernet
3299 * 0 - Clear all unicast hash bitmaps
3301 * - (0) if successful.
3302 * - (-ENOTSUP) if hardware doesn't support.
3303 * - (-ENODEV) if *port_id* invalid.
3304 * - (-EINVAL) if bad parameter.
3306 int rte_eth_dev_uc_all_hash_table_set(uint8_t port,uint8_t on);
3309 * Set RX L2 Filtering mode of a VF of an Ethernet device.
3312 * The port identifier of the Ethernet device.
3316 * The RX mode mask, which is one or more of accepting Untagged Packets,
3317 * packets that match the PFUTA table, Broadcast and Multicast Promiscuous.
3318 * ETH_VMDQ_ACCEPT_UNTAG,ETH_VMDQ_ACCEPT_HASH_UC,
3319 * ETH_VMDQ_ACCEPT_BROADCAST and ETH_VMDQ_ACCEPT_MULTICAST will be used
3322 * 1 - Enable a VF RX mode.
3323 * 0 - Disable a VF RX mode.
3325 * - (0) if successful.
3326 * - (-ENOTSUP) if hardware doesn't support.
3327 * - (-ENOTSUP) if hardware doesn't support.
3328 * - (-EINVAL) if bad parameter.
3330 int rte_eth_dev_set_vf_rxmode(uint8_t port, uint16_t vf, uint16_t rx_mode,
3334 * Enable or disable a VF traffic transmit of the Ethernet device.
3337 * The port identifier of the Ethernet device.
3341 * 1 - Enable a VF traffic transmit.
3342 * 0 - Disable a VF traffic transmit.
3344 * - (0) if successful.
3345 * - (-ENODEV) if *port_id* invalid.
3346 * - (-ENOTSUP) if hardware doesn't support.
3347 * - (-EINVAL) if bad parameter.
3350 rte_eth_dev_set_vf_tx(uint8_t port,uint16_t vf, uint8_t on);
3353 * Enable or disable a VF traffic receive of an Ethernet device.
3356 * The port identifier of the Ethernet device.
3360 * 1 - Enable a VF traffic receive.
3361 * 0 - Disable a VF traffic receive.
3363 * - (0) if successful.
3364 * - (-ENOTSUP) if hardware doesn't support.
3365 * - (-ENODEV) if *port_id* invalid.
3366 * - (-EINVAL) if bad parameter.
3369 rte_eth_dev_set_vf_rx(uint8_t port,uint16_t vf, uint8_t on);
3372 * Enable/Disable hardware VF VLAN filtering by an Ethernet device of
3373 * received VLAN packets tagged with a given VLAN Tag Identifier.
3376 * The port identifier of the Ethernet device.
3378 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
3380 * Bitmap listing which VFs participate in the VLAN filtering.
3382 * 1 - Enable VFs VLAN filtering.
3383 * 0 - Disable VFs VLAN filtering.
3385 * - (0) if successful.
3386 * - (-ENOTSUP) if hardware doesn't support.
3387 * - (-ENODEV) if *port_id* invalid.
3388 * - (-EINVAL) if bad parameter.
3391 rte_eth_dev_set_vf_vlan_filter(uint8_t port, uint16_t vlan_id,
3396 * Set a traffic mirroring rule on an Ethernet device
3399 * The port identifier of the Ethernet device.
3400 * @param mirror_conf
3401 * The pointer to the traffic mirroring structure describing the mirroring rule.
3402 * The *rte_eth_vm_mirror_conf* structure includes the type of mirroring rule,
3403 * destination pool and the value of rule if enable vlan or pool mirroring.
3406 * The index of traffic mirroring rule, we support four separated rules.
3408 * 1 - Enable a mirroring rule.
3409 * 0 - Disable a mirroring rule.
3411 * - (0) if successful.
3412 * - (-ENOTSUP) if hardware doesn't support this feature.
3413 * - (-ENODEV) if *port_id* invalid.
3414 * - (-EINVAL) if the mr_conf information is not correct.
3416 int rte_eth_mirror_rule_set(uint8_t port_id,
3417 struct rte_eth_mirror_conf *mirror_conf,
3422 * Reset a traffic mirroring rule on an Ethernet device.
3425 * The port identifier of the Ethernet device.
3427 * The index of traffic mirroring rule, we support four separated rules.
3429 * - (0) if successful.
3430 * - (-ENOTSUP) if hardware doesn't support this feature.
3431 * - (-ENODEV) if *port_id* invalid.
3432 * - (-EINVAL) if bad parameter.
3434 int rte_eth_mirror_rule_reset(uint8_t port_id,
3438 * Set the rate limitation for a queue on an Ethernet device.
3441 * The port identifier of the Ethernet device.
3445 * The tx rate in Mbps. Allocated from the total port link speed.
3447 * - (0) if successful.
3448 * - (-ENOTSUP) if hardware doesn't support this feature.
3449 * - (-ENODEV) if *port_id* invalid.
3450 * - (-EINVAL) if bad parameter.
3452 int rte_eth_set_queue_rate_limit(uint8_t port_id, uint16_t queue_idx,
3456 * Set the rate limitation for a vf on an Ethernet device.
3459 * The port identifier of the Ethernet device.
3463 * The tx rate allocated from the total link speed for this VF id.
3465 * The queue mask which need to set the rate.
3467 * - (0) if successful.
3468 * - (-ENOTSUP) if hardware doesn't support this feature.
3469 * - (-ENODEV) if *port_id* invalid.
3470 * - (-EINVAL) if bad parameter.
3472 int rte_eth_set_vf_rate_limit(uint8_t port_id, uint16_t vf,
3473 uint16_t tx_rate, uint64_t q_msk);
3476 * Initialize bypass logic. This function needs to be called before
3477 * executing any other bypass API.
3480 * The port identifier of the Ethernet device.
3482 * - (0) if successful.
3483 * - (-ENOTSUP) if hardware doesn't support.
3484 * - (-EINVAL) if bad parameter.
3486 int rte_eth_dev_bypass_init(uint8_t port);
3489 * Return bypass state.
3492 * The port identifier of the Ethernet device.
3494 * The return bypass state.
3497 * - (3) Isolate mode
3499 * - (0) if successful.
3500 * - (-ENOTSUP) if hardware doesn't support.
3501 * - (-EINVAL) if bad parameter.
3503 int rte_eth_dev_bypass_state_show(uint8_t port, uint32_t *state);
3509 * The port identifier of the Ethernet device.
3511 * The current bypass state.
3514 * - (3) Isolate mode
3516 * - (0) if successful.
3517 * - (-ENOTSUP) if hardware doesn't support.
3518 * - (-EINVAL) if bad parameter.
3520 int rte_eth_dev_bypass_state_set(uint8_t port, uint32_t *new_state);
3523 * Return bypass state when given event occurs.
3526 * The port identifier of the Ethernet device.
3529 * - (1) Main power on (power button is pushed)
3530 * - (2) Auxiliary power on (power supply is being plugged)
3531 * - (3) Main power off (system shutdown and power supply is left plugged in)
3532 * - (4) Auxiliary power off (power supply is being unplugged)
3533 * - (5) Display or set the watchdog timer
3535 * The bypass state when given event occurred.
3538 * - (3) Isolate mode
3540 * - (0) if successful.
3541 * - (-ENOTSUP) if hardware doesn't support.
3542 * - (-EINVAL) if bad parameter.
3544 int rte_eth_dev_bypass_event_show(uint8_t port, uint32_t event, uint32_t *state);
3547 * Set bypass state when given event occurs.
3550 * The port identifier of the Ethernet device.
3553 * - (1) Main power on (power button is pushed)
3554 * - (2) Auxiliary power on (power supply is being plugged)
3555 * - (3) Main power off (system shutdown and power supply is left plugged in)
3556 * - (4) Auxiliary power off (power supply is being unplugged)
3557 * - (5) Display or set the watchdog timer
3559 * The assigned state when given event occurs.
3562 * - (3) Isolate mode
3564 * - (0) if successful.
3565 * - (-ENOTSUP) if hardware doesn't support.
3566 * - (-EINVAL) if bad parameter.
3568 int rte_eth_dev_bypass_event_store(uint8_t port, uint32_t event, uint32_t state);
3571 * Set bypass watchdog timeout count.
3574 * The port identifier of the Ethernet device.
3576 * The timeout to be set.
3577 * - (0) 0 seconds (timer is off)
3586 * - (0) if successful.
3587 * - (-ENOTSUP) if hardware doesn't support.
3588 * - (-EINVAL) if bad parameter.
3590 int rte_eth_dev_wd_timeout_store(uint8_t port, uint32_t timeout);
3593 * Get bypass firmware version.
3596 * The port identifier of the Ethernet device.
3598 * The firmware version
3600 * - (0) if successful.
3601 * - (-ENOTSUP) if hardware doesn't support.
3602 * - (-EINVAL) if bad parameter.
3604 int rte_eth_dev_bypass_ver_show(uint8_t port, uint32_t *ver);
3607 * Return bypass watchdog timeout in seconds
3610 * The port identifier of the Ethernet device.
3612 * The return watchdog timeout. "0" represents timer expired
3613 * - (0) 0 seconds (timer is off)
3622 * - (0) if successful.
3623 * - (-ENOTSUP) if hardware doesn't support.
3624 * - (-EINVAL) if bad parameter.
3626 int rte_eth_dev_bypass_wd_timeout_show(uint8_t port, uint32_t *wd_timeout);
3629 * Reset bypass watchdog timer
3632 * The port identifier of the Ethernet device.
3634 * - (0) if successful.
3635 * - (-ENOTSUP) if hardware doesn't support.
3636 * - (-EINVAL) if bad parameter.
3638 int rte_eth_dev_bypass_wd_reset(uint8_t port);
3641 * Configuration of Receive Side Scaling hash computation of Ethernet device.
3644 * The port identifier of the Ethernet device.
3646 * The new configuration to use for RSS hash computation on the port.
3648 * - (0) if successful.
3649 * - (-ENODEV) if port identifier is invalid.
3650 * - (-ENOTSUP) if hardware doesn't support.
3651 * - (-EINVAL) if bad parameter.
3653 int rte_eth_dev_rss_hash_update(uint8_t port_id,
3654 struct rte_eth_rss_conf *rss_conf);
3657 * Retrieve current configuration of Receive Side Scaling hash computation
3658 * of Ethernet device.
3661 * The port identifier of the Ethernet device.
3663 * Where to store the current RSS hash configuration of the Ethernet device.
3665 * - (0) if successful.
3666 * - (-ENODEV) if port identifier is invalid.
3667 * - (-ENOTSUP) if hardware doesn't support RSS.
3670 rte_eth_dev_rss_hash_conf_get(uint8_t port_id,
3671 struct rte_eth_rss_conf *rss_conf);
3674 * Add UDP tunneling port for a specific type of tunnel.
3675 * The packets with this UDP port will be identified as this type of tunnel.
3676 * Before enabling any offloading function for a tunnel, users can call this API
3677 * to change or add more UDP port for the tunnel. So the offloading function
3678 * can take effect on the packets with the sepcific UDP port.
3681 * The port identifier of the Ethernet device.
3683 * UDP tunneling configuration.
3686 * - (0) if successful.
3687 * - (-ENODEV) if port identifier is invalid.
3688 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3691 rte_eth_dev_udp_tunnel_port_add(uint8_t port_id,
3692 struct rte_eth_udp_tunnel *tunnel_udp);
3695 * Delete UDP tunneling port a specific type of tunnel.
3696 * The packets with this UDP port will not be identified as this type of tunnel
3698 * Before enabling any offloading function for a tunnel, users can call this API
3699 * to delete a UDP port for the tunnel. So the offloading function will not take
3700 * effect on the packets with the sepcific UDP port.
3703 * The port identifier of the Ethernet device.
3705 * UDP tunneling configuration.
3708 * - (0) if successful.
3709 * - (-ENODEV) if port identifier is invalid.
3710 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3713 rte_eth_dev_udp_tunnel_port_delete(uint8_t port_id,
3714 struct rte_eth_udp_tunnel *tunnel_udp);
3717 * Check whether the filter type is supported on an Ethernet device.
3718 * All the supported filter types are defined in 'rte_eth_ctrl.h'.
3721 * The port identifier of the Ethernet device.
3722 * @param filter_type
3725 * - (0) if successful.
3726 * - (-ENOTSUP) if hardware doesn't support this filter type.
3727 * - (-ENODEV) if *port_id* invalid.
3729 int rte_eth_dev_filter_supported(uint8_t port_id, enum rte_filter_type filter_type);
3732 * Take operations to assigned filter type on an Ethernet device.
3733 * All the supported operations and filter types are defined in 'rte_eth_ctrl.h'.
3736 * The port identifier of the Ethernet device.
3737 * @param filter_type
3740 * Type of operation.
3742 * A pointer to arguments defined specifically for the operation.
3744 * - (0) if successful.
3745 * - (-ENOTSUP) if hardware doesn't support.
3746 * - (-ENODEV) if *port_id* invalid.
3747 * - others depends on the specific operations implementation.
3749 int rte_eth_dev_filter_ctrl(uint8_t port_id, enum rte_filter_type filter_type,
3750 enum rte_filter_op filter_op, void *arg);
3753 * Get DCB information on an Ethernet device.
3756 * The port identifier of the Ethernet device.
3760 * - (0) if successful.
3761 * - (-ENODEV) if port identifier is invalid.
3762 * - (-ENOTSUP) if hardware doesn't support.
3764 int rte_eth_dev_get_dcb_info(uint8_t port_id,
3765 struct rte_eth_dcb_info *dcb_info);
3768 * Add a callback to be called on packet RX on a given port and queue.
3770 * This API configures a function to be called for each burst of
3771 * packets received on a given NIC port queue. The return value is a pointer
3772 * that can be used to later remove the callback using
3773 * rte_eth_remove_rx_callback().
3775 * Multiple functions are called in the order that they are added.
3778 * The port identifier of the Ethernet device.
3780 * The queue on the Ethernet device on which the callback is to be added.
3782 * The callback function
3784 * A generic pointer parameter which will be passed to each invocation of the
3785 * callback function on this port and queue.
3789 * On success, a pointer value which can later be used to remove the callback.
3791 void *rte_eth_add_rx_callback(uint8_t port_id, uint16_t queue_id,
3792 rte_rx_callback_fn fn, void *user_param);
3795 * Add a callback to be called on packet TX on a given port and queue.
3797 * This API configures a function to be called for each burst of
3798 * packets sent on a given NIC port queue. The return value is a pointer
3799 * that can be used to later remove the callback using
3800 * rte_eth_remove_tx_callback().
3802 * Multiple functions are called in the order that they are added.
3805 * The port identifier of the Ethernet device.
3807 * The queue on the Ethernet device on which the callback is to be added.
3809 * The callback function
3811 * A generic pointer parameter which will be passed to each invocation of the
3812 * callback function on this port and queue.
3816 * On success, a pointer value which can later be used to remove the callback.
3818 void *rte_eth_add_tx_callback(uint8_t port_id, uint16_t queue_id,
3819 rte_tx_callback_fn fn, void *user_param);
3822 * Remove an RX packet callback from a given port and queue.
3824 * This function is used to removed callbacks that were added to a NIC port
3825 * queue using rte_eth_add_rx_callback().
3827 * Note: the callback is removed from the callback list but it isn't freed
3828 * since the it may still be in use. The memory for the callback can be
3829 * subsequently freed back by the application by calling rte_free():
3831 * - Immediately - if the port is stopped, or the user knows that no
3832 * callbacks are in flight e.g. if called from the thread doing RX/TX
3835 * - After a short delay - where the delay is sufficient to allow any
3836 * in-flight callbacks to complete.
3839 * The port identifier of the Ethernet device.
3841 * The queue on the Ethernet device from which the callback is to be removed.
3843 * User supplied callback created via rte_eth_add_rx_callback().
3846 * - 0: Success. Callback was removed.
3847 * - -ENOTSUP: Callback support is not available.
3848 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
3849 * is NULL or not found for the port/queue.
3851 int rte_eth_remove_rx_callback(uint8_t port_id, uint16_t queue_id,
3852 struct rte_eth_rxtx_callback *user_cb);
3855 * Remove a TX packet callback from a given port and queue.
3857 * This function is used to removed callbacks that were added to a NIC port
3858 * queue using rte_eth_add_tx_callback().
3860 * Note: the callback is removed from the callback list but it isn't freed
3861 * since the it may still be in use. The memory for the callback can be
3862 * subsequently freed back by the application by calling rte_free():
3864 * - Immediately - if the port is stopped, or the user knows that no
3865 * callbacks are in flight e.g. if called from the thread doing RX/TX
3868 * - After a short delay - where the delay is sufficient to allow any
3869 * in-flight callbacks to complete.
3872 * The port identifier of the Ethernet device.
3874 * The queue on the Ethernet device from which the callback is to be removed.
3876 * User supplied callback created via rte_eth_add_tx_callback().
3879 * - 0: Success. Callback was removed.
3880 * - -ENOTSUP: Callback support is not available.
3881 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
3882 * is NULL or not found for the port/queue.
3884 int rte_eth_remove_tx_callback(uint8_t port_id, uint16_t queue_id,
3885 struct rte_eth_rxtx_callback *user_cb);
3888 * Retrieve information about given port's RX queue.
3891 * The port identifier of the Ethernet device.
3893 * The RX queue on the Ethernet device for which information
3894 * will be retrieved.
3896 * A pointer to a structure of type *rte_eth_rxq_info_info* to be filled with
3897 * the information of the Ethernet device.
3901 * - -ENOTSUP: routine is not supported by the device PMD.
3902 * - -EINVAL: The port_id or the queue_id is out of range.
3904 int rte_eth_rx_queue_info_get(uint8_t port_id, uint16_t queue_id,
3905 struct rte_eth_rxq_info *qinfo);
3908 * Retrieve information about given port's TX queue.
3911 * The port identifier of the Ethernet device.
3913 * The TX queue on the Ethernet device for which information
3914 * will be retrieved.
3916 * A pointer to a structure of type *rte_eth_txq_info_info* to be filled with
3917 * the information of the Ethernet device.
3921 * - -ENOTSUP: routine is not supported by the device PMD.
3922 * - -EINVAL: The port_id or the queue_id is out of range.
3924 int rte_eth_tx_queue_info_get(uint8_t port_id, uint16_t queue_id,
3925 struct rte_eth_txq_info *qinfo);
3928 * Retrieve number of available registers for access
3931 * The port identifier of the Ethernet device.
3933 * - (>=0) number of registers if successful.
3934 * - (-ENOTSUP) if hardware doesn't support.
3935 * - (-ENODEV) if *port_id* invalid.
3936 * - others depends on the specific operations implementation.
3938 int rte_eth_dev_get_reg_length(uint8_t port_id);
3941 * Retrieve device registers and register attributes
3944 * The port identifier of the Ethernet device.
3946 * The template includes buffer for register data and attribute to be filled.
3948 * - (0) if successful.
3949 * - (-ENOTSUP) if hardware doesn't support.
3950 * - (-ENODEV) if *port_id* invalid.
3951 * - others depends on the specific operations implementation.
3953 int rte_eth_dev_get_reg_info(uint8_t port_id, struct rte_dev_reg_info *info);
3956 * Retrieve size of device EEPROM
3959 * The port identifier of the Ethernet device.
3961 * - (>=0) EEPROM size if successful.
3962 * - (-ENOTSUP) if hardware doesn't support.
3963 * - (-ENODEV) if *port_id* invalid.
3964 * - others depends on the specific operations implementation.
3966 int rte_eth_dev_get_eeprom_length(uint8_t port_id);
3969 * Retrieve EEPROM and EEPROM attribute
3972 * The port identifier of the Ethernet device.
3974 * The template includes buffer for return EEPROM data and
3975 * EEPROM attributes to be filled.
3977 * - (0) if successful.
3978 * - (-ENOTSUP) if hardware doesn't support.
3979 * - (-ENODEV) if *port_id* invalid.
3980 * - others depends on the specific operations implementation.
3982 int rte_eth_dev_get_eeprom(uint8_t port_id, struct rte_dev_eeprom_info *info);
3985 * Program EEPROM with provided data
3988 * The port identifier of the Ethernet device.
3990 * The template includes EEPROM data for programming and
3991 * EEPROM attributes to be filled
3993 * - (0) if successful.
3994 * - (-ENOTSUP) if hardware doesn't support.
3995 * - (-ENODEV) if *port_id* invalid.
3996 * - others depends on the specific operations implementation.
3998 int rte_eth_dev_set_eeprom(uint8_t port_id, struct rte_dev_eeprom_info *info);
4001 * Set the list of multicast addresses to filter on an Ethernet device.
4004 * The port identifier of the Ethernet device.
4005 * @param mc_addr_set
4006 * The array of multicast addresses to set. Equal to NULL when the function
4007 * is invoked to flush the set of filtered addresses.
4009 * The number of multicast addresses in the *mc_addr_set* array. Equal to 0
4010 * when the function is invoked to flush the set of filtered addresses.
4012 * - (0) if successful.
4013 * - (-ENODEV) if *port_id* invalid.
4014 * - (-ENOTSUP) if PMD of *port_id* doesn't support multicast filtering.
4015 * - (-ENOSPC) if *port_id* has not enough multicast filtering resources.
4017 int rte_eth_dev_set_mc_addr_list(uint8_t port_id,
4018 struct ether_addr *mc_addr_set,
4019 uint32_t nb_mc_addr);
4022 * Enable IEEE1588/802.1AS timestamping for an Ethernet device.
4025 * The port identifier of the Ethernet device.
4029 * - -ENODEV: The port ID is invalid.
4030 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4032 int rte_eth_timesync_enable(uint8_t port_id);
4035 * Disable IEEE1588/802.1AS timestamping for an Ethernet device.
4038 * The port identifier of the Ethernet device.
4042 * - -ENODEV: The port ID is invalid.
4043 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4045 int rte_eth_timesync_disable(uint8_t port_id);
4048 * Read an IEEE1588/802.1AS RX timestamp from an Ethernet device.
4051 * The port identifier of the Ethernet device.
4053 * Pointer to the timestamp struct.
4055 * Device specific flags. Used to pass the RX timesync register index to
4056 * i40e. Unused in igb/ixgbe, pass 0 instead.
4060 * - -EINVAL: No timestamp is available.
4061 * - -ENODEV: The port ID is invalid.
4062 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4064 int rte_eth_timesync_read_rx_timestamp(uint8_t port_id,
4065 struct timespec *timestamp, uint32_t flags);
4068 * Read an IEEE1588/802.1AS TX timestamp from an Ethernet device.
4071 * The port identifier of the Ethernet device.
4073 * Pointer to the timestamp struct.
4077 * - -EINVAL: No timestamp is available.
4078 * - -ENODEV: The port ID is invalid.
4079 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4081 int rte_eth_timesync_read_tx_timestamp(uint8_t port_id,
4082 struct timespec *timestamp);
4085 * Adjust the timesync clock on an Ethernet device.
4087 * This is usually used in conjunction with other Ethdev timesync functions to
4088 * synchronize the device time using the IEEE1588/802.1AS protocol.
4091 * The port identifier of the Ethernet device.
4093 * The adjustment in nanoseconds.
4097 * - -ENODEV: The port ID is invalid.
4098 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4100 int rte_eth_timesync_adjust_time(uint8_t port_id, int64_t delta);
4103 * Read the time from the timesync clock on an Ethernet device.
4105 * This is usually used in conjunction with other Ethdev timesync functions to
4106 * synchronize the device time using the IEEE1588/802.1AS protocol.
4109 * The port identifier of the Ethernet device.
4111 * Pointer to the timespec struct that holds the time.
4116 int rte_eth_timesync_read_time(uint8_t port_id, struct timespec *time);
4119 * Set the time of the timesync clock on an Ethernet device.
4121 * This is usually used in conjunction with other Ethdev timesync functions to
4122 * synchronize the device time using the IEEE1588/802.1AS protocol.
4125 * The port identifier of the Ethernet device.
4127 * Pointer to the timespec struct that holds the time.
4131 * - -EINVAL: No timestamp is available.
4132 * - -ENODEV: The port ID is invalid.
4133 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4135 int rte_eth_timesync_write_time(uint8_t port_id, const struct timespec *time);
4138 * Copy pci device info to the Ethernet device data.
4141 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure.
4143 * The *pci_dev* pointer is the address of the *rte_pci_device* structure.
4146 * - 0 on success, negative on error
4148 void rte_eth_copy_pci_info(struct rte_eth_dev *eth_dev,
4149 struct rte_pci_device *pci_dev);
4152 * Create memzone for HW rings.
4153 * malloc can't be used as the physical address is needed.
4154 * If the memzone is already created, then this function returns a ptr
4158 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
4160 * The name of the memory zone
4162 * The index of the queue to add to name
4164 * The sizeof of the memory area
4166 * Alignment for resulting memzone. Must be a power of 2.
4168 * The *socket_id* argument is the socket identifier in case of NUMA.
4170 const struct rte_memzone *
4171 rte_eth_dma_zone_reserve(const struct rte_eth_dev *eth_dev, const char *name,
4172 uint16_t queue_id, size_t size,
4173 unsigned align, int socket_id);
4176 * Config l2 tunnel ether type of an Ethernet device for filtering specific
4177 * tunnel packets by ether type.
4180 * The port identifier of the Ethernet device.
4182 * l2 tunnel configuration.
4185 * - (0) if successful.
4186 * - (-ENODEV) if port identifier is invalid.
4187 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4190 rte_eth_dev_l2_tunnel_eth_type_conf(uint8_t port_id,
4191 struct rte_eth_l2_tunnel_conf *l2_tunnel);
4194 * Enable/disable l2 tunnel offload functions. Include,
4195 * 1, The ability of parsing a type of l2 tunnel of an Ethernet device.
4196 * Filtering, forwarding and offloading this type of tunnel packets depend on
4198 * 2, Stripping the l2 tunnel tag.
4199 * 3, Insertion of the l2 tunnel tag.
4200 * 4, Forwarding the packets based on the l2 tunnel tag.
4203 * The port identifier of the Ethernet device.
4205 * l2 tunnel parameters.
4207 * Indicate the offload function.
4209 * Enable or disable this function.
4212 * - (0) if successful.
4213 * - (-ENODEV) if port identifier is invalid.
4214 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4217 rte_eth_dev_l2_tunnel_offload_set(uint8_t port_id,
4218 struct rte_eth_l2_tunnel_conf *l2_tunnel,
4226 #endif /* _RTE_ETHDEV_H_ */