4 * Copyright(c) 2010-2015 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.
175 /* Use this macro to check if LRO API is supported */
176 #define RTE_ETHDEV_HAS_LRO_SUPPORT
179 #include <rte_interrupts.h>
182 #include <rte_devargs.h>
183 #include "rte_ether.h"
184 #include "rte_eth_ctrl.h"
185 #include "rte_dev_info.h"
190 * A structure used to retrieve statistics for an Ethernet port.
192 struct rte_eth_stats {
193 uint64_t ipackets; /**< Total number of successfully received packets. */
194 uint64_t opackets; /**< Total number of successfully transmitted packets.*/
195 uint64_t ibytes; /**< Total number of successfully received bytes. */
196 uint64_t obytes; /**< Total number of successfully transmitted bytes. */
198 /**< Deprecated; Total of RX missed packets (e.g full FIFO). */
200 /**< Deprecated; Total of RX packets with CRC error. */
202 /**< Deprecated; Total of RX packets with bad length. */
203 uint64_t ierrors; /**< Total number of erroneous received packets. */
204 uint64_t oerrors; /**< Total number of failed transmitted packets. */
206 /**< Deprecated; Total number of multicast received packets. */
207 uint64_t rx_nombuf; /**< Total number of RX mbuf allocation failures. */
209 /**< Deprecated; Total number of RX packets matching a filter. */
211 /**< Deprecated; Total number of RX packets not matching any filter. */
212 uint64_t tx_pause_xon;
213 /**< Deprecated; Total nb. of XON pause frame sent. */
214 uint64_t rx_pause_xon;
215 /**< Deprecated; Total nb. of XON pause frame received. */
216 uint64_t tx_pause_xoff;
217 /**< Deprecated; Total nb. of XOFF pause frame sent. */
218 uint64_t rx_pause_xoff;
219 /**< Deprecated; Total nb. of XOFF pause frame received. */
220 uint64_t q_ipackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
221 /**< Total number of queue RX packets. */
222 uint64_t q_opackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
223 /**< Total number of queue TX packets. */
224 uint64_t q_ibytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
225 /**< Total number of successfully received queue bytes. */
226 uint64_t q_obytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
227 /**< Total number of successfully transmitted queue bytes. */
228 uint64_t q_errors[RTE_ETHDEV_QUEUE_STAT_CNTRS];
229 /**< Total number of queue packets received that are dropped. */
231 /**< Total number of good packets received from loopback,VF Only */
233 /**< Total number of good packets transmitted to loopback,VF Only */
235 /**< Total number of good bytes received from loopback,VF Only */
237 /**< Total number of good bytes transmitted to loopback,VF Only */
241 * A structure used to retrieve link-level information of an Ethernet port.
243 struct rte_eth_link {
244 uint16_t link_speed; /**< ETH_LINK_SPEED_[10, 100, 1000, 10000] */
245 uint16_t link_duplex; /**< ETH_LINK_[HALF_DUPLEX, FULL_DUPLEX] */
246 uint8_t link_status : 1; /**< 1 -> link up, 0 -> link down */
247 }__attribute__((aligned(8))); /**< aligned for atomic64 read/write */
249 #define ETH_LINK_SPEED_AUTONEG 0 /**< Auto-negotiate link speed. */
250 #define ETH_LINK_SPEED_10 10 /**< 10 megabits/second. */
251 #define ETH_LINK_SPEED_100 100 /**< 100 megabits/second. */
252 #define ETH_LINK_SPEED_1000 1000 /**< 1 gigabits/second. */
253 #define ETH_LINK_SPEED_10000 10000 /**< 10 gigabits/second. */
254 #define ETH_LINK_SPEED_10G 10000 /**< alias of 10 gigabits/second. */
255 #define ETH_LINK_SPEED_20G 20000 /**< 20 gigabits/second. */
256 #define ETH_LINK_SPEED_40G 40000 /**< 40 gigabits/second. */
258 #define ETH_LINK_AUTONEG_DUPLEX 0 /**< Auto-negotiate duplex. */
259 #define ETH_LINK_HALF_DUPLEX 1 /**< Half-duplex connection. */
260 #define ETH_LINK_FULL_DUPLEX 2 /**< Full-duplex connection. */
263 * A structure used to configure the ring threshold registers of an RX/TX
264 * queue for an Ethernet port.
266 struct rte_eth_thresh {
267 uint8_t pthresh; /**< Ring prefetch threshold. */
268 uint8_t hthresh; /**< Ring host threshold. */
269 uint8_t wthresh; /**< Ring writeback threshold. */
273 * Simple flags are used for rte_eth_conf.rxmode.mq_mode.
275 #define ETH_MQ_RX_RSS_FLAG 0x1
276 #define ETH_MQ_RX_DCB_FLAG 0x2
277 #define ETH_MQ_RX_VMDQ_FLAG 0x4
280 * A set of values to identify what method is to be used to route
281 * packets to multiple queues.
283 enum rte_eth_rx_mq_mode {
284 /** None of DCB,RSS or VMDQ mode */
287 /** For RX side, only RSS is on */
288 ETH_MQ_RX_RSS = ETH_MQ_RX_RSS_FLAG,
289 /** For RX side,only DCB is on. */
290 ETH_MQ_RX_DCB = ETH_MQ_RX_DCB_FLAG,
291 /** Both DCB and RSS enable */
292 ETH_MQ_RX_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG,
294 /** Only VMDQ, no RSS nor DCB */
295 ETH_MQ_RX_VMDQ_ONLY = ETH_MQ_RX_VMDQ_FLAG,
296 /** RSS mode with VMDQ */
297 ETH_MQ_RX_VMDQ_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_VMDQ_FLAG,
298 /** Use VMDQ+DCB to route traffic to queues */
299 ETH_MQ_RX_VMDQ_DCB = ETH_MQ_RX_VMDQ_FLAG | ETH_MQ_RX_DCB_FLAG,
300 /** Enable both VMDQ and DCB in VMDq */
301 ETH_MQ_RX_VMDQ_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG |
306 * for rx mq mode backward compatible
308 #define ETH_RSS ETH_MQ_RX_RSS
309 #define VMDQ_DCB ETH_MQ_RX_VMDQ_DCB
310 #define ETH_DCB_RX ETH_MQ_RX_DCB
313 * A set of values to identify what method is to be used to transmit
314 * packets using multi-TCs.
316 enum rte_eth_tx_mq_mode {
317 ETH_MQ_TX_NONE = 0, /**< It is in neither DCB nor VT mode. */
318 ETH_MQ_TX_DCB, /**< For TX side,only DCB is on. */
319 ETH_MQ_TX_VMDQ_DCB, /**< For TX side,both DCB and VT is on. */
320 ETH_MQ_TX_VMDQ_ONLY, /**< Only VT on, no DCB */
324 * for tx mq mode backward compatible
326 #define ETH_DCB_NONE ETH_MQ_TX_NONE
327 #define ETH_VMDQ_DCB_TX ETH_MQ_TX_VMDQ_DCB
328 #define ETH_DCB_TX ETH_MQ_TX_DCB
331 * A structure used to configure the RX features of an Ethernet port.
333 struct rte_eth_rxmode {
334 /** The multi-queue packet distribution mode to be used, e.g. RSS. */
335 enum rte_eth_rx_mq_mode mq_mode;
336 uint32_t max_rx_pkt_len; /**< Only used if jumbo_frame enabled. */
337 uint16_t split_hdr_size; /**< hdr buf size (header_split enabled).*/
338 uint16_t header_split : 1, /**< Header Split enable. */
339 hw_ip_checksum : 1, /**< IP/UDP/TCP checksum offload enable. */
340 hw_vlan_filter : 1, /**< VLAN filter enable. */
341 hw_vlan_strip : 1, /**< VLAN strip enable. */
342 hw_vlan_extend : 1, /**< Extended VLAN enable. */
343 jumbo_frame : 1, /**< Jumbo Frame Receipt enable. */
344 hw_strip_crc : 1, /**< Enable CRC stripping by hardware. */
345 enable_scatter : 1, /**< Enable scatter packets rx handler */
346 enable_lro : 1; /**< Enable LRO */
350 * A structure used to configure the Receive Side Scaling (RSS) feature
351 * of an Ethernet port.
352 * If not NULL, the *rss_key* pointer of the *rss_conf* structure points
353 * to an array holding the RSS key to use for hashing specific header
354 * fields of received packets. The length of this array should be indicated
355 * by *rss_key_len* below. Otherwise, a default random hash key is used by
358 * The *rss_key_len* field of the *rss_conf* structure indicates the length
359 * in bytes of the array pointed by *rss_key*. To be compatible, this length
360 * will be checked in i40e only. Others assume 40 bytes to be used as before.
362 * The *rss_hf* field of the *rss_conf* structure indicates the different
363 * types of IPv4/IPv6 packets to which the RSS hashing must be applied.
364 * Supplying an *rss_hf* equal to zero disables the RSS feature.
366 struct rte_eth_rss_conf {
367 uint8_t *rss_key; /**< If not NULL, 40-byte hash key. */
368 uint8_t rss_key_len; /**< hash key length in bytes. */
369 uint64_t rss_hf; /**< Hash functions to apply - see below. */
373 * The RSS offload types are defined based on flow types which are defined
374 * in rte_eth_ctrl.h. Different NIC hardwares may support different RSS offload
375 * types. The supported flow types or RSS offload types can be queried by
376 * rte_eth_dev_info_get().
378 #define ETH_RSS_IPV4 (1ULL << RTE_ETH_FLOW_IPV4)
379 #define ETH_RSS_FRAG_IPV4 (1ULL << RTE_ETH_FLOW_FRAG_IPV4)
380 #define ETH_RSS_NONFRAG_IPV4_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_TCP)
381 #define ETH_RSS_NONFRAG_IPV4_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_UDP)
382 #define ETH_RSS_NONFRAG_IPV4_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_SCTP)
383 #define ETH_RSS_NONFRAG_IPV4_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_OTHER)
384 #define ETH_RSS_IPV6 (1ULL << RTE_ETH_FLOW_IPV6)
385 #define ETH_RSS_FRAG_IPV6 (1ULL << RTE_ETH_FLOW_FRAG_IPV6)
386 #define ETH_RSS_NONFRAG_IPV6_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_TCP)
387 #define ETH_RSS_NONFRAG_IPV6_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_UDP)
388 #define ETH_RSS_NONFRAG_IPV6_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_SCTP)
389 #define ETH_RSS_NONFRAG_IPV6_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_OTHER)
390 #define ETH_RSS_L2_PAYLOAD (1ULL << RTE_ETH_FLOW_L2_PAYLOAD)
391 #define ETH_RSS_IPV6_EX (1ULL << RTE_ETH_FLOW_IPV6_EX)
392 #define ETH_RSS_IPV6_TCP_EX (1ULL << RTE_ETH_FLOW_IPV6_TCP_EX)
393 #define ETH_RSS_IPV6_UDP_EX (1ULL << RTE_ETH_FLOW_IPV6_UDP_EX)
395 #define ETH_RSS_IP ( \
397 ETH_RSS_FRAG_IPV4 | \
398 ETH_RSS_NONFRAG_IPV4_OTHER | \
400 ETH_RSS_FRAG_IPV6 | \
401 ETH_RSS_NONFRAG_IPV6_OTHER | \
404 #define ETH_RSS_UDP ( \
405 ETH_RSS_NONFRAG_IPV4_UDP | \
406 ETH_RSS_NONFRAG_IPV6_UDP | \
409 #define ETH_RSS_TCP ( \
410 ETH_RSS_NONFRAG_IPV4_TCP | \
411 ETH_RSS_NONFRAG_IPV6_TCP | \
414 #define ETH_RSS_SCTP ( \
415 ETH_RSS_NONFRAG_IPV4_SCTP | \
416 ETH_RSS_NONFRAG_IPV6_SCTP)
418 /**< Mask of valid RSS hash protocols */
419 #define ETH_RSS_PROTO_MASK ( \
421 ETH_RSS_FRAG_IPV4 | \
422 ETH_RSS_NONFRAG_IPV4_TCP | \
423 ETH_RSS_NONFRAG_IPV4_UDP | \
424 ETH_RSS_NONFRAG_IPV4_SCTP | \
425 ETH_RSS_NONFRAG_IPV4_OTHER | \
427 ETH_RSS_FRAG_IPV6 | \
428 ETH_RSS_NONFRAG_IPV6_TCP | \
429 ETH_RSS_NONFRAG_IPV6_UDP | \
430 ETH_RSS_NONFRAG_IPV6_SCTP | \
431 ETH_RSS_NONFRAG_IPV6_OTHER | \
432 ETH_RSS_L2_PAYLOAD | \
434 ETH_RSS_IPV6_TCP_EX | \
438 * Definitions used for redirection table entry size.
439 * Some RSS RETA sizes may not be supported by some drivers, check the
440 * documentation or the description of relevant functions for more details.
442 #define ETH_RSS_RETA_SIZE_64 64
443 #define ETH_RSS_RETA_SIZE_128 128
444 #define ETH_RSS_RETA_SIZE_512 512
445 #define RTE_RETA_GROUP_SIZE 64
447 /* Definitions used for VMDQ and DCB functionality */
448 #define ETH_VMDQ_MAX_VLAN_FILTERS 64 /**< Maximum nb. of VMDQ vlan filters. */
449 #define ETH_DCB_NUM_USER_PRIORITIES 8 /**< Maximum nb. of DCB priorities. */
450 #define ETH_VMDQ_DCB_NUM_QUEUES 128 /**< Maximum nb. of VMDQ DCB queues. */
451 #define ETH_DCB_NUM_QUEUES 128 /**< Maximum nb. of DCB queues. */
453 /* DCB capability defines */
454 #define ETH_DCB_PG_SUPPORT 0x00000001 /**< Priority Group(ETS) support. */
455 #define ETH_DCB_PFC_SUPPORT 0x00000002 /**< Priority Flow Control support. */
457 /* Definitions used for VLAN Offload functionality */
458 #define ETH_VLAN_STRIP_OFFLOAD 0x0001 /**< VLAN Strip On/Off */
459 #define ETH_VLAN_FILTER_OFFLOAD 0x0002 /**< VLAN Filter On/Off */
460 #define ETH_VLAN_EXTEND_OFFLOAD 0x0004 /**< VLAN Extend On/Off */
462 /* Definitions used for mask VLAN setting */
463 #define ETH_VLAN_STRIP_MASK 0x0001 /**< VLAN Strip setting mask */
464 #define ETH_VLAN_FILTER_MASK 0x0002 /**< VLAN Filter setting mask*/
465 #define ETH_VLAN_EXTEND_MASK 0x0004 /**< VLAN Extend setting mask*/
466 #define ETH_VLAN_ID_MAX 0x0FFF /**< VLAN ID is in lower 12 bits*/
468 /* Definitions used for receive MAC address */
469 #define ETH_NUM_RECEIVE_MAC_ADDR 128 /**< Maximum nb. of receive mac addr. */
471 /* Definitions used for unicast hash */
472 #define ETH_VMDQ_NUM_UC_HASH_ARRAY 128 /**< Maximum nb. of UC hash array. */
474 /* Definitions used for VMDQ pool rx mode setting */
475 #define ETH_VMDQ_ACCEPT_UNTAG 0x0001 /**< accept untagged packets. */
476 #define ETH_VMDQ_ACCEPT_HASH_MC 0x0002 /**< accept packets in multicast table . */
477 #define ETH_VMDQ_ACCEPT_HASH_UC 0x0004 /**< accept packets in unicast table. */
478 #define ETH_VMDQ_ACCEPT_BROADCAST 0x0008 /**< accept broadcast packets. */
479 #define ETH_VMDQ_ACCEPT_MULTICAST 0x0010 /**< multicast promiscuous. */
481 /** Maximum nb. of vlan per mirror rule */
482 #define ETH_MIRROR_MAX_VLANS 64
484 #define ETH_MIRROR_VIRTUAL_POOL_UP 0x01 /**< Virtual Pool uplink Mirroring. */
485 #define ETH_MIRROR_UPLINK_PORT 0x02 /**< Uplink Port Mirroring. */
486 #define ETH_MIRROR_DOWNLINK_PORT 0x04 /**< Downlink Port Mirroring. */
487 #define ETH_MIRROR_VLAN 0x08 /**< VLAN Mirroring. */
488 #define ETH_MIRROR_VIRTUAL_POOL_DOWN 0x10 /**< Virtual Pool downlink Mirroring. */
491 * A structure used to configure VLAN traffic mirror of an Ethernet port.
493 struct rte_eth_vlan_mirror {
494 uint64_t vlan_mask; /**< mask for valid VLAN ID. */
495 /** VLAN ID list for vlan mirroring. */
496 uint16_t vlan_id[ETH_MIRROR_MAX_VLANS];
500 * A structure used to configure traffic mirror of an Ethernet port.
502 struct rte_eth_mirror_conf {
503 uint8_t rule_type; /**< Mirroring rule type */
504 uint8_t dst_pool; /**< Destination pool for this mirror rule. */
505 uint64_t pool_mask; /**< Bitmap of pool for pool mirroring */
506 /** VLAN ID setting for VLAN mirroring. */
507 struct rte_eth_vlan_mirror vlan;
511 * A structure used to configure 64 entries of Redirection Table of the
512 * Receive Side Scaling (RSS) feature of an Ethernet port. To configure
513 * more than 64 entries supported by hardware, an array of this structure
516 struct rte_eth_rss_reta_entry64 {
518 /**< Mask bits indicate which entries need to be updated/queried. */
519 uint8_t reta[RTE_RETA_GROUP_SIZE];
520 /**< Group of 64 redirection table entries. */
524 * This enum indicates the possible number of traffic classes
525 * in DCB configratioins
527 enum rte_eth_nb_tcs {
528 ETH_4_TCS = 4, /**< 4 TCs with DCB. */
529 ETH_8_TCS = 8 /**< 8 TCs with DCB. */
533 * This enum indicates the possible number of queue pools
534 * in VMDQ configurations.
536 enum rte_eth_nb_pools {
537 ETH_8_POOLS = 8, /**< 8 VMDq pools. */
538 ETH_16_POOLS = 16, /**< 16 VMDq pools. */
539 ETH_32_POOLS = 32, /**< 32 VMDq pools. */
540 ETH_64_POOLS = 64 /**< 64 VMDq pools. */
543 /* This structure may be extended in future. */
544 struct rte_eth_dcb_rx_conf {
545 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs */
546 /** Traffic class each UP mapped to. */
547 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
550 struct rte_eth_vmdq_dcb_tx_conf {
551 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools. */
552 /** Traffic class each UP mapped to. */
553 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
556 struct rte_eth_dcb_tx_conf {
557 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs. */
558 /** Traffic class each UP mapped to. */
559 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
562 struct rte_eth_vmdq_tx_conf {
563 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq mode, 64 pools. */
567 * A structure used to configure the VMDQ+DCB feature
568 * of an Ethernet port.
570 * Using this feature, packets are routed to a pool of queues, based
571 * on the vlan id in the vlan tag, and then to a specific queue within
572 * that pool, using the user priority vlan tag field.
574 * A default pool may be used, if desired, to route all traffic which
575 * does not match the vlan filter rules.
577 struct rte_eth_vmdq_dcb_conf {
578 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools */
579 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
580 uint8_t default_pool; /**< The default pool, if applicable */
581 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
583 uint16_t vlan_id; /**< The vlan id of the received frame */
584 uint64_t pools; /**< Bitmask of pools for packet rx */
585 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
586 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
587 /**< Selects a queue in a pool */
590 struct rte_eth_vmdq_rx_conf {
591 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq only mode, 8 or 64 pools */
592 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
593 uint8_t default_pool; /**< The default pool, if applicable */
594 uint8_t enable_loop_back; /**< Enable VT loop back */
595 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
596 uint32_t rx_mode; /**< Flags from ETH_VMDQ_ACCEPT_* */
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. */
604 * A structure used to configure the TX features of an Ethernet port.
606 struct rte_eth_txmode {
607 enum rte_eth_tx_mq_mode mq_mode; /**< TX multi-queues mode. */
609 /* For i40e specifically */
611 uint8_t hw_vlan_reject_tagged : 1,
612 /**< If set, reject sending out tagged pkts */
613 hw_vlan_reject_untagged : 1,
614 /**< If set, reject sending out untagged pkts */
615 hw_vlan_insert_pvid : 1;
616 /**< If set, enable port based VLAN insertion */
620 * A structure used to configure an RX ring of an Ethernet port.
622 struct rte_eth_rxconf {
623 struct rte_eth_thresh rx_thresh; /**< RX ring threshold registers. */
624 uint16_t rx_free_thresh; /**< Drives the freeing of RX descriptors. */
625 uint8_t rx_drop_en; /**< Drop packets if no descriptors are available. */
626 uint8_t rx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
629 #define ETH_TXQ_FLAGS_NOMULTSEGS 0x0001 /**< nb_segs=1 for all mbufs */
630 #define ETH_TXQ_FLAGS_NOREFCOUNT 0x0002 /**< refcnt can be ignored */
631 #define ETH_TXQ_FLAGS_NOMULTMEMP 0x0004 /**< all bufs come from same mempool */
632 #define ETH_TXQ_FLAGS_NOVLANOFFL 0x0100 /**< disable VLAN offload */
633 #define ETH_TXQ_FLAGS_NOXSUMSCTP 0x0200 /**< disable SCTP checksum offload */
634 #define ETH_TXQ_FLAGS_NOXSUMUDP 0x0400 /**< disable UDP checksum offload */
635 #define ETH_TXQ_FLAGS_NOXSUMTCP 0x0800 /**< disable TCP checksum offload */
636 #define ETH_TXQ_FLAGS_NOOFFLOADS \
637 (ETH_TXQ_FLAGS_NOVLANOFFL | ETH_TXQ_FLAGS_NOXSUMSCTP | \
638 ETH_TXQ_FLAGS_NOXSUMUDP | ETH_TXQ_FLAGS_NOXSUMTCP)
639 #define ETH_TXQ_FLAGS_NOXSUMS \
640 (ETH_TXQ_FLAGS_NOXSUMSCTP | ETH_TXQ_FLAGS_NOXSUMUDP | \
641 ETH_TXQ_FLAGS_NOXSUMTCP)
643 * A structure used to configure a TX ring of an Ethernet port.
645 struct rte_eth_txconf {
646 struct rte_eth_thresh tx_thresh; /**< TX ring threshold registers. */
647 uint16_t tx_rs_thresh; /**< Drives the setting of RS bit on TXDs. */
648 uint16_t tx_free_thresh; /**< Start freeing TX buffers if there are
649 less free descriptors than this value. */
651 uint32_t txq_flags; /**< Set flags for the Tx queue */
652 uint8_t tx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
656 * A structure contains information about HW descriptor ring limitations.
658 struct rte_eth_desc_lim {
659 uint16_t nb_max; /**< Max allowed number of descriptors. */
660 uint16_t nb_min; /**< Min allowed number of descriptors. */
661 uint16_t nb_align; /**< Number of descriptors should be aligned to. */
665 * This enum indicates the flow control mode
667 enum rte_eth_fc_mode {
668 RTE_FC_NONE = 0, /**< Disable flow control. */
669 RTE_FC_RX_PAUSE, /**< RX pause frame, enable flowctrl on TX side. */
670 RTE_FC_TX_PAUSE, /**< TX pause frame, enable flowctrl on RX side. */
671 RTE_FC_FULL /**< Enable flow control on both side. */
675 * A structure used to configure Ethernet flow control parameter.
676 * These parameters will be configured into the register of the NIC.
677 * Please refer to the corresponding data sheet for proper value.
679 struct rte_eth_fc_conf {
680 uint32_t high_water; /**< High threshold value to trigger XOFF */
681 uint32_t low_water; /**< Low threshold value to trigger XON */
682 uint16_t pause_time; /**< Pause quota in the Pause frame */
683 uint16_t send_xon; /**< Is XON frame need be sent */
684 enum rte_eth_fc_mode mode; /**< Link flow control mode */
685 uint8_t mac_ctrl_frame_fwd; /**< Forward MAC control frames */
686 uint8_t autoneg; /**< Use Pause autoneg */
690 * A structure used to configure Ethernet priority 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_pfc_conf {
695 struct rte_eth_fc_conf fc; /**< General flow control parameter. */
696 uint8_t priority; /**< VLAN User Priority. */
700 * Memory space that can be configured to store Flow Director filters
701 * in the board memory.
703 enum rte_fdir_pballoc_type {
704 RTE_FDIR_PBALLOC_64K = 0, /**< 64k. */
705 RTE_FDIR_PBALLOC_128K, /**< 128k. */
706 RTE_FDIR_PBALLOC_256K, /**< 256k. */
710 * Select report mode of FDIR hash information in RX descriptors.
712 enum rte_fdir_status_mode {
713 RTE_FDIR_NO_REPORT_STATUS = 0, /**< Never report FDIR hash. */
714 RTE_FDIR_REPORT_STATUS, /**< Only report FDIR hash for matching pkts. */
715 RTE_FDIR_REPORT_STATUS_ALWAYS, /**< Always report FDIR hash. */
719 * A structure used to configure the Flow Director (FDIR) feature
720 * of an Ethernet port.
722 * If mode is RTE_FDIR_DISABLE, the pballoc value is ignored.
724 struct rte_fdir_conf {
725 enum rte_fdir_mode mode; /**< Flow Director mode. */
726 enum rte_fdir_pballoc_type pballoc; /**< Space for FDIR filters. */
727 enum rte_fdir_status_mode status; /**< How to report FDIR hash. */
728 /** RX queue of packets matching a "drop" filter in perfect mode. */
730 struct rte_eth_fdir_masks mask;
731 struct rte_eth_fdir_flex_conf flex_conf;
732 /**< Flex payload configuration. */
736 * UDP tunneling configuration.
738 struct rte_eth_udp_tunnel {
744 * A structure used to enable/disable specific device interrupts.
746 struct rte_intr_conf {
747 /** enable/disable lsc interrupt. 0 (default) - disable, 1 enable */
749 /** enable/disable rxq interrupt. 0 (default) - disable, 1 enable */
754 * A structure used to configure an Ethernet port.
755 * Depending upon the RX multi-queue mode, extra advanced
756 * configuration settings may be needed.
758 struct rte_eth_conf {
760 /**< ETH_LINK_SPEED_10[0|00|000], or 0 for autonegotation */
761 uint16_t link_duplex;
762 /**< ETH_LINK_[HALF_DUPLEX|FULL_DUPLEX], or 0 for autonegotation */
763 struct rte_eth_rxmode rxmode; /**< Port RX configuration. */
764 struct rte_eth_txmode txmode; /**< Port TX configuration. */
765 uint32_t lpbk_mode; /**< Loopback operation mode. By default the value
766 is 0, meaning the loopback mode is disabled.
767 Read the datasheet of given ethernet controller
768 for details. The possible values of this field
769 are defined in implementation of each driver. */
771 struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
772 struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
773 /**< Port vmdq+dcb configuration. */
774 struct rte_eth_dcb_rx_conf dcb_rx_conf;
775 /**< Port dcb RX configuration. */
776 struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
777 /**< Port vmdq RX configuration. */
778 } rx_adv_conf; /**< Port RX filtering configuration (union). */
780 struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
781 /**< Port vmdq+dcb TX configuration. */
782 struct rte_eth_dcb_tx_conf dcb_tx_conf;
783 /**< Port dcb TX configuration. */
784 struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
785 /**< Port vmdq TX configuration. */
786 } tx_adv_conf; /**< Port TX DCB configuration (union). */
787 /** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
788 is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
789 uint32_t dcb_capability_en;
790 struct rte_fdir_conf fdir_conf; /**< FDIR configuration. */
791 struct rte_intr_conf intr_conf; /**< Interrupt mode configuration. */
795 * A structure used to retrieve the contextual information of
796 * an Ethernet device, such as the controlling driver of the device,
797 * its PCI context, etc...
801 * RX offload capabilities of a device.
803 #define DEV_RX_OFFLOAD_VLAN_STRIP 0x00000001
804 #define DEV_RX_OFFLOAD_IPV4_CKSUM 0x00000002
805 #define DEV_RX_OFFLOAD_UDP_CKSUM 0x00000004
806 #define DEV_RX_OFFLOAD_TCP_CKSUM 0x00000008
807 #define DEV_RX_OFFLOAD_TCP_LRO 0x00000010
808 #define DEV_RX_OFFLOAD_QINQ_STRIP 0x00000020
811 * TX offload capabilities of a device.
813 #define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001
814 #define DEV_TX_OFFLOAD_IPV4_CKSUM 0x00000002
815 #define DEV_TX_OFFLOAD_UDP_CKSUM 0x00000004
816 #define DEV_TX_OFFLOAD_TCP_CKSUM 0x00000008
817 #define DEV_TX_OFFLOAD_SCTP_CKSUM 0x00000010
818 #define DEV_TX_OFFLOAD_TCP_TSO 0x00000020
819 #define DEV_TX_OFFLOAD_UDP_TSO 0x00000040
820 #define DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000080 /**< Used for tunneling packet. */
821 #define DEV_TX_OFFLOAD_QINQ_INSERT 0x00000100
823 struct rte_eth_dev_info {
824 struct rte_pci_device *pci_dev; /**< Device PCI information. */
825 const char *driver_name; /**< Device Driver name. */
826 unsigned int if_index; /**< Index to bound host interface, or 0 if none.
827 Use if_indextoname() to translate into an interface name. */
828 uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
829 uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
830 uint16_t max_rx_queues; /**< Maximum number of RX queues. */
831 uint16_t max_tx_queues; /**< Maximum number of TX queues. */
832 uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
833 uint32_t max_hash_mac_addrs;
834 /** Maximum number of hash MAC addresses for MTA and UTA. */
835 uint16_t max_vfs; /**< Maximum number of VFs. */
836 uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
837 uint32_t rx_offload_capa; /**< Device RX offload capabilities. */
838 uint32_t tx_offload_capa; /**< Device TX offload capabilities. */
840 /**< Device redirection table size, the total number of entries. */
841 uint8_t hash_key_size; /**< Hash key size in bytes */
842 /** Bit mask of RSS offloads, the bit offset also means flow type */
843 uint64_t flow_type_rss_offloads;
844 struct rte_eth_rxconf default_rxconf; /**< Default RX configuration */
845 struct rte_eth_txconf default_txconf; /**< Default TX configuration */
846 uint16_t vmdq_queue_base; /**< First queue ID for VMDQ pools. */
847 uint16_t vmdq_queue_num; /**< Queue number for VMDQ pools. */
848 uint16_t vmdq_pool_base; /**< First ID of VMDQ pools. */
849 struct rte_eth_desc_lim rx_desc_lim; /**< RX descriptors limits */
850 struct rte_eth_desc_lim tx_desc_lim; /**< TX descriptors limits */
854 * Ethernet device RX queue information structure.
855 * Used to retieve information about configured queue.
857 struct rte_eth_rxq_info {
858 struct rte_mempool *mp; /**< mempool used by that queue. */
859 struct rte_eth_rxconf conf; /**< queue config parameters. */
860 uint8_t scattered_rx; /**< scattered packets RX supported. */
861 uint16_t nb_desc; /**< configured number of RXDs. */
862 } __rte_cache_aligned;
865 * Ethernet device TX queue information structure.
866 * Used to retieve information about configured queue.
868 struct rte_eth_txq_info {
869 struct rte_eth_txconf conf; /**< queue config parameters. */
870 uint16_t nb_desc; /**< configured number of TXDs. */
871 } __rte_cache_aligned;
873 /** Maximum name length for extended statistics counters */
874 #define RTE_ETH_XSTATS_NAME_SIZE 64
877 * An Ethernet device extended statistic structure
879 * This structure is used by ethdev->eth_xstats_get() to provide
880 * statistics that are not provided in the generic rte_eth_stats
883 struct rte_eth_xstats {
884 char name[RTE_ETH_XSTATS_NAME_SIZE];
888 #define ETH_DCB_NUM_TCS 8
889 #define ETH_MAX_VMDQ_POOL 64
892 * A structure used to get the information of queue and
893 * TC mapping on both TX and RX paths.
895 struct rte_eth_dcb_tc_queue_mapping {
896 /** rx queues assigned to tc per Pool */
900 } tc_rxq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
901 /** rx queues assigned to tc per Pool */
905 } tc_txq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
909 * A structure used to get the information of DCB.
910 * It includes TC UP mapping and queue TC mapping.
912 struct rte_eth_dcb_info {
913 uint8_t nb_tcs; /**< number of TCs */
914 uint8_t prio_tc[ETH_DCB_NUM_USER_PRIORITIES]; /**< Priority to tc */
915 uint8_t tc_bws[ETH_DCB_NUM_TCS]; /**< TX BW percentage for each TC */
916 /** rx queues assigned to tc */
917 struct rte_eth_dcb_tc_queue_mapping tc_queue;
922 struct rte_eth_dev_callback;
923 /** @internal Structure to keep track of registered callbacks */
924 TAILQ_HEAD(rte_eth_dev_cb_list, rte_eth_dev_callback);
927 * Definitions of all functions exported by an Ethernet driver through the
928 * the generic structure of type *eth_dev_ops* supplied in the *rte_eth_dev*
929 * structure associated with an Ethernet device.
932 typedef int (*eth_dev_configure_t)(struct rte_eth_dev *dev);
933 /**< @internal Ethernet device configuration. */
935 typedef int (*eth_dev_start_t)(struct rte_eth_dev *dev);
936 /**< @internal Function used to start a configured Ethernet device. */
938 typedef void (*eth_dev_stop_t)(struct rte_eth_dev *dev);
939 /**< @internal Function used to stop a configured Ethernet device. */
941 typedef int (*eth_dev_set_link_up_t)(struct rte_eth_dev *dev);
942 /**< @internal Function used to link up a configured Ethernet device. */
944 typedef int (*eth_dev_set_link_down_t)(struct rte_eth_dev *dev);
945 /**< @internal Function used to link down a configured Ethernet device. */
947 typedef void (*eth_dev_close_t)(struct rte_eth_dev *dev);
948 /**< @internal Function used to close a configured Ethernet device. */
950 typedef void (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev);
951 /**< @internal Function used to enable the RX promiscuous mode of an Ethernet device. */
953 typedef void (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev);
954 /**< @internal Function used to disable the RX promiscuous mode of an Ethernet device. */
956 typedef void (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
957 /**< @internal Enable the receipt of all multicast packets by an Ethernet device. */
959 typedef void (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
960 /**< @internal Disable the receipt of all multicast packets by an Ethernet device. */
962 typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
963 int wait_to_complete);
964 /**< @internal Get link speed, duplex mode and state (up/down) of an Ethernet device. */
966 typedef void (*eth_stats_get_t)(struct rte_eth_dev *dev,
967 struct rte_eth_stats *igb_stats);
968 /**< @internal Get global I/O statistics of an Ethernet device. */
970 typedef void (*eth_stats_reset_t)(struct rte_eth_dev *dev);
971 /**< @internal Reset global I/O statistics of an Ethernet device to 0. */
973 typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev,
974 struct rte_eth_xstats *stats, unsigned n);
975 /**< @internal Get extended stats of an Ethernet device. */
977 typedef void (*eth_xstats_reset_t)(struct rte_eth_dev *dev);
978 /**< @internal Reset extended stats of an Ethernet device. */
980 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
984 /**< @internal Set a queue statistics mapping for a tx/rx queue of an Ethernet device. */
986 typedef void (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
987 struct rte_eth_dev_info *dev_info);
988 /**< @internal Get specific informations of an Ethernet device. */
990 typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
992 /**< @internal Start rx and tx of a queue of an Ethernet device. */
994 typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
996 /**< @internal Stop rx and tx of a queue of an Ethernet device. */
998 typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
999 uint16_t rx_queue_id,
1000 uint16_t nb_rx_desc,
1001 unsigned int socket_id,
1002 const struct rte_eth_rxconf *rx_conf,
1003 struct rte_mempool *mb_pool);
1004 /**< @internal Set up a receive queue of an Ethernet device. */
1006 typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
1007 uint16_t tx_queue_id,
1008 uint16_t nb_tx_desc,
1009 unsigned int socket_id,
1010 const struct rte_eth_txconf *tx_conf);
1011 /**< @internal Setup a transmit queue of an Ethernet device. */
1013 typedef int (*eth_rx_enable_intr_t)(struct rte_eth_dev *dev,
1014 uint16_t rx_queue_id);
1015 /**< @internal Enable interrupt of a receive queue of an Ethernet device. */
1017 typedef int (*eth_rx_disable_intr_t)(struct rte_eth_dev *dev,
1018 uint16_t rx_queue_id);
1019 /**< @internal Disable interrupt of a receive queue of an Ethernet device. */
1021 typedef void (*eth_queue_release_t)(void *queue);
1022 /**< @internal Release memory resources allocated by given RX/TX queue. */
1024 typedef uint32_t (*eth_rx_queue_count_t)(struct rte_eth_dev *dev,
1025 uint16_t rx_queue_id);
1026 /**< @internal Get number of available descriptors on a receive queue of an Ethernet device. */
1028 typedef int (*eth_rx_descriptor_done_t)(void *rxq, uint16_t offset);
1029 /**< @internal Check DD bit of specific RX descriptor */
1031 typedef void (*eth_rxq_info_get_t)(struct rte_eth_dev *dev,
1032 uint16_t rx_queue_id, struct rte_eth_rxq_info *qinfo);
1034 typedef void (*eth_txq_info_get_t)(struct rte_eth_dev *dev,
1035 uint16_t tx_queue_id, struct rte_eth_txq_info *qinfo);
1037 typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);
1038 /**< @internal Set MTU. */
1040 typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
1043 /**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */
1045 typedef void (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
1047 /**< @internal set the outer VLAN-TPID by an Ethernet device. */
1049 typedef void (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
1050 /**< @internal set VLAN offload function by an Ethernet device. */
1052 typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
1055 /**< @internal set port based TX VLAN insertion by an Ethernet device. */
1057 typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
1058 uint16_t rx_queue_id,
1060 /**< @internal VLAN stripping enable/disable by an queue of Ethernet device. */
1062 typedef uint16_t (*eth_rx_burst_t)(void *rxq,
1063 struct rte_mbuf **rx_pkts,
1065 /**< @internal Retrieve input packets from a receive queue of an Ethernet device. */
1067 typedef uint16_t (*eth_tx_burst_t)(void *txq,
1068 struct rte_mbuf **tx_pkts,
1070 /**< @internal Send output packets on a transmit queue of an Ethernet device. */
1072 typedef int (*flow_ctrl_get_t)(struct rte_eth_dev *dev,
1073 struct rte_eth_fc_conf *fc_conf);
1074 /**< @internal Get current flow control parameter on an Ethernet device */
1076 typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
1077 struct rte_eth_fc_conf *fc_conf);
1078 /**< @internal Setup flow control parameter on an Ethernet device */
1080 typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
1081 struct rte_eth_pfc_conf *pfc_conf);
1082 /**< @internal Setup priority flow control parameter on an Ethernet device */
1084 typedef int (*reta_update_t)(struct rte_eth_dev *dev,
1085 struct rte_eth_rss_reta_entry64 *reta_conf,
1086 uint16_t reta_size);
1087 /**< @internal Update RSS redirection table on an Ethernet device */
1089 typedef int (*reta_query_t)(struct rte_eth_dev *dev,
1090 struct rte_eth_rss_reta_entry64 *reta_conf,
1091 uint16_t reta_size);
1092 /**< @internal Query RSS redirection table on an Ethernet device */
1094 typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
1095 struct rte_eth_rss_conf *rss_conf);
1096 /**< @internal Update RSS hash configuration of an Ethernet device */
1098 typedef int (*rss_hash_conf_get_t)(struct rte_eth_dev *dev,
1099 struct rte_eth_rss_conf *rss_conf);
1100 /**< @internal Get current RSS hash configuration of an Ethernet device */
1102 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
1103 /**< @internal Turn on SW controllable LED on an Ethernet device */
1105 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
1106 /**< @internal Turn off SW controllable LED on an Ethernet device */
1108 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
1109 /**< @internal Remove MAC address from receive address register */
1111 typedef void (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
1112 struct ether_addr *mac_addr,
1115 /**< @internal Set a MAC address into Receive Address Address Register */
1117 typedef void (*eth_mac_addr_set_t)(struct rte_eth_dev *dev,
1118 struct ether_addr *mac_addr);
1119 /**< @internal Set a MAC address into Receive Address Address Register */
1121 typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
1122 struct ether_addr *mac_addr,
1124 /**< @internal Set a Unicast Hash bitmap */
1126 typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
1128 /**< @internal Set all Unicast Hash bitmap */
1130 typedef int (*eth_set_vf_rx_mode_t)(struct rte_eth_dev *dev,
1134 /**< @internal Set a VF receive mode */
1136 typedef int (*eth_set_vf_rx_t)(struct rte_eth_dev *dev,
1139 /**< @internal Set a VF receive mode */
1141 typedef int (*eth_set_vf_tx_t)(struct rte_eth_dev *dev,
1144 /**< @internal Enable or disable a VF transmit */
1146 typedef int (*eth_set_vf_vlan_filter_t)(struct rte_eth_dev *dev,
1150 /**< @internal Set VF VLAN pool filter */
1152 typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
1155 /**< @internal Set queue TX rate */
1157 typedef int (*eth_set_vf_rate_limit_t)(struct rte_eth_dev *dev,
1161 /**< @internal Set VF TX rate */
1163 typedef int (*eth_mirror_rule_set_t)(struct rte_eth_dev *dev,
1164 struct rte_eth_mirror_conf *mirror_conf,
1167 /**< @internal Add a traffic mirroring rule on an Ethernet device */
1169 typedef int (*eth_mirror_rule_reset_t)(struct rte_eth_dev *dev,
1171 /**< @internal Remove a traffic mirroring rule on an Ethernet device */
1173 typedef int (*eth_udp_tunnel_add_t)(struct rte_eth_dev *dev,
1174 struct rte_eth_udp_tunnel *tunnel_udp);
1175 /**< @internal Add tunneling UDP info */
1177 typedef int (*eth_udp_tunnel_del_t)(struct rte_eth_dev *dev,
1178 struct rte_eth_udp_tunnel *tunnel_udp);
1179 /**< @internal Delete tunneling UDP info */
1181 typedef int (*eth_set_mc_addr_list_t)(struct rte_eth_dev *dev,
1182 struct ether_addr *mc_addr_set,
1183 uint32_t nb_mc_addr);
1184 /**< @internal set the list of multicast addresses on an Ethernet device */
1186 typedef int (*eth_timesync_enable_t)(struct rte_eth_dev *dev);
1187 /**< @internal Function used to enable IEEE1588/802.1AS timestamping. */
1189 typedef int (*eth_timesync_disable_t)(struct rte_eth_dev *dev);
1190 /**< @internal Function used to disable IEEE1588/802.1AS timestamping. */
1192 typedef int (*eth_timesync_read_rx_timestamp_t)(struct rte_eth_dev *dev,
1193 struct timespec *timestamp,
1195 /**< @internal Function used to read an RX IEEE1588/802.1AS timestamp. */
1197 typedef int (*eth_timesync_read_tx_timestamp_t)(struct rte_eth_dev *dev,
1198 struct timespec *timestamp);
1199 /**< @internal Function used to read a TX IEEE1588/802.1AS timestamp. */
1201 typedef int (*eth_get_reg_length_t)(struct rte_eth_dev *dev);
1202 /**< @internal Retrieve device register count */
1204 typedef int (*eth_get_reg_t)(struct rte_eth_dev *dev,
1205 struct rte_dev_reg_info *info);
1206 /**< @internal Retrieve registers */
1208 typedef int (*eth_get_eeprom_length_t)(struct rte_eth_dev *dev);
1209 /**< @internal Retrieve eeprom size */
1211 typedef int (*eth_get_eeprom_t)(struct rte_eth_dev *dev,
1212 struct rte_dev_eeprom_info *info);
1213 /**< @internal Retrieve eeprom data */
1215 typedef int (*eth_set_eeprom_t)(struct rte_eth_dev *dev,
1216 struct rte_dev_eeprom_info *info);
1217 /**< @internal Program eeprom data */
1219 #ifdef RTE_NIC_BYPASS
1222 RTE_BYPASS_MODE_NONE,
1223 RTE_BYPASS_MODE_NORMAL,
1224 RTE_BYPASS_MODE_BYPASS,
1225 RTE_BYPASS_MODE_ISOLATE,
1226 RTE_BYPASS_MODE_NUM,
1229 #define RTE_BYPASS_MODE_VALID(x) \
1230 ((x) > RTE_BYPASS_MODE_NONE && (x) < RTE_BYPASS_MODE_NUM)
1233 RTE_BYPASS_EVENT_NONE,
1234 RTE_BYPASS_EVENT_START,
1235 RTE_BYPASS_EVENT_OS_ON = RTE_BYPASS_EVENT_START,
1236 RTE_BYPASS_EVENT_POWER_ON,
1237 RTE_BYPASS_EVENT_OS_OFF,
1238 RTE_BYPASS_EVENT_POWER_OFF,
1239 RTE_BYPASS_EVENT_TIMEOUT,
1240 RTE_BYPASS_EVENT_NUM
1243 #define RTE_BYPASS_EVENT_VALID(x) \
1244 ((x) > RTE_BYPASS_EVENT_NONE && (x) < RTE_BYPASS_MODE_NUM)
1247 RTE_BYPASS_TMT_OFF, /* timeout disabled. */
1248 RTE_BYPASS_TMT_1_5_SEC, /* timeout for 1.5 seconds */
1249 RTE_BYPASS_TMT_2_SEC, /* timeout for 2 seconds */
1250 RTE_BYPASS_TMT_3_SEC, /* timeout for 3 seconds */
1251 RTE_BYPASS_TMT_4_SEC, /* timeout for 4 seconds */
1252 RTE_BYPASS_TMT_8_SEC, /* timeout for 8 seconds */
1253 RTE_BYPASS_TMT_16_SEC, /* timeout for 16 seconds */
1254 RTE_BYPASS_TMT_32_SEC, /* timeout for 32 seconds */
1258 #define RTE_BYPASS_TMT_VALID(x) \
1259 ((x) == RTE_BYPASS_TMT_OFF || \
1260 ((x) > RTE_BYPASS_TMT_OFF && (x) < RTE_BYPASS_TMT_NUM))
1262 typedef void (*bypass_init_t)(struct rte_eth_dev *dev);
1263 typedef int32_t (*bypass_state_set_t)(struct rte_eth_dev *dev, uint32_t *new_state);
1264 typedef int32_t (*bypass_state_show_t)(struct rte_eth_dev *dev, uint32_t *state);
1265 typedef int32_t (*bypass_event_set_t)(struct rte_eth_dev *dev, uint32_t state, uint32_t event);
1266 typedef int32_t (*bypass_event_show_t)(struct rte_eth_dev *dev, uint32_t event_shift, uint32_t *event);
1267 typedef int32_t (*bypass_wd_timeout_set_t)(struct rte_eth_dev *dev, uint32_t timeout);
1268 typedef int32_t (*bypass_wd_timeout_show_t)(struct rte_eth_dev *dev, uint32_t *wd_timeout);
1269 typedef int32_t (*bypass_ver_show_t)(struct rte_eth_dev *dev, uint32_t *ver);
1270 typedef int32_t (*bypass_wd_reset_t)(struct rte_eth_dev *dev);
1273 typedef int (*eth_filter_ctrl_t)(struct rte_eth_dev *dev,
1274 enum rte_filter_type filter_type,
1275 enum rte_filter_op filter_op,
1277 /**< @internal Take operations to assigned filter type on an Ethernet device */
1279 typedef int (*eth_get_dcb_info)(struct rte_eth_dev *dev,
1280 struct rte_eth_dcb_info *dcb_info);
1281 /**< @internal Get dcb information on an Ethernet device */
1284 * @internal A structure containing the functions exported by an Ethernet driver.
1286 struct eth_dev_ops {
1287 eth_dev_configure_t dev_configure; /**< Configure device. */
1288 eth_dev_start_t dev_start; /**< Start device. */
1289 eth_dev_stop_t dev_stop; /**< Stop device. */
1290 eth_dev_set_link_up_t dev_set_link_up; /**< Device link up. */
1291 eth_dev_set_link_down_t dev_set_link_down; /**< Device link down. */
1292 eth_dev_close_t dev_close; /**< Close device. */
1293 eth_promiscuous_enable_t promiscuous_enable; /**< Promiscuous ON. */
1294 eth_promiscuous_disable_t promiscuous_disable;/**< Promiscuous OFF. */
1295 eth_allmulticast_enable_t allmulticast_enable;/**< RX multicast ON. */
1296 eth_allmulticast_disable_t allmulticast_disable;/**< RX multicast OF. */
1297 eth_link_update_t link_update; /**< Get device link state. */
1298 eth_stats_get_t stats_get; /**< Get generic device statistics. */
1299 eth_stats_reset_t stats_reset; /**< Reset generic device statistics. */
1300 eth_xstats_get_t xstats_get; /**< Get extended device statistics. */
1301 eth_xstats_reset_t xstats_reset; /**< Reset extended device statistics. */
1302 eth_queue_stats_mapping_set_t queue_stats_mapping_set;
1303 /**< Configure per queue stat counter mapping. */
1304 eth_dev_infos_get_t dev_infos_get; /**< Get device info. */
1305 mtu_set_t mtu_set; /**< Set MTU. */
1306 vlan_filter_set_t vlan_filter_set; /**< Filter VLAN Setup. */
1307 vlan_tpid_set_t vlan_tpid_set; /**< Outer VLAN TPID Setup. */
1308 vlan_strip_queue_set_t vlan_strip_queue_set; /**< VLAN Stripping on queue. */
1309 vlan_offload_set_t vlan_offload_set; /**< Set VLAN Offload. */
1310 vlan_pvid_set_t vlan_pvid_set; /**< Set port based TX VLAN insertion */
1311 eth_queue_start_t rx_queue_start;/**< Start RX for a queue.*/
1312 eth_queue_stop_t rx_queue_stop;/**< Stop RX for a queue.*/
1313 eth_queue_start_t tx_queue_start;/**< Start TX for a queue.*/
1314 eth_queue_stop_t tx_queue_stop;/**< Stop TX for a queue.*/
1315 eth_rx_queue_setup_t rx_queue_setup;/**< Set up device RX queue.*/
1316 eth_queue_release_t rx_queue_release;/**< Release RX queue.*/
1317 eth_rx_queue_count_t rx_queue_count; /**< Get Rx queue count. */
1318 eth_rx_descriptor_done_t rx_descriptor_done; /**< Check rxd DD bit */
1319 /**< Enable Rx queue interrupt. */
1320 eth_rx_enable_intr_t rx_queue_intr_enable;
1321 /**< Disable Rx queue interrupt.*/
1322 eth_rx_disable_intr_t rx_queue_intr_disable;
1323 eth_tx_queue_setup_t tx_queue_setup;/**< Set up device TX queue.*/
1324 eth_queue_release_t tx_queue_release;/**< Release TX queue.*/
1325 eth_dev_led_on_t dev_led_on; /**< Turn on LED. */
1326 eth_dev_led_off_t dev_led_off; /**< Turn off LED. */
1327 flow_ctrl_get_t flow_ctrl_get; /**< Get flow control. */
1328 flow_ctrl_set_t flow_ctrl_set; /**< Setup flow control. */
1329 priority_flow_ctrl_set_t priority_flow_ctrl_set; /**< Setup priority flow control.*/
1330 eth_mac_addr_remove_t mac_addr_remove; /**< Remove MAC address */
1331 eth_mac_addr_add_t mac_addr_add; /**< Add a MAC address */
1332 eth_mac_addr_set_t mac_addr_set; /**< Set a MAC address */
1333 eth_uc_hash_table_set_t uc_hash_table_set; /**< Set Unicast Table Array */
1334 eth_uc_all_hash_table_set_t uc_all_hash_table_set; /**< Set Unicast hash bitmap */
1335 eth_mirror_rule_set_t mirror_rule_set; /**< Add a traffic mirror rule.*/
1336 eth_mirror_rule_reset_t mirror_rule_reset; /**< reset a traffic mirror rule.*/
1337 eth_set_vf_rx_mode_t set_vf_rx_mode; /**< Set VF RX mode */
1338 eth_set_vf_rx_t set_vf_rx; /**< enable/disable a VF receive */
1339 eth_set_vf_tx_t set_vf_tx; /**< enable/disable a VF transmit */
1340 eth_set_vf_vlan_filter_t set_vf_vlan_filter; /**< Set VF VLAN filter */
1341 eth_udp_tunnel_add_t udp_tunnel_add;
1342 eth_udp_tunnel_del_t udp_tunnel_del;
1343 eth_set_queue_rate_limit_t set_queue_rate_limit; /**< Set queue rate limit */
1344 eth_set_vf_rate_limit_t set_vf_rate_limit; /**< Set VF rate limit */
1345 /** Update redirection table. */
1346 reta_update_t reta_update;
1347 /** Query redirection table. */
1348 reta_query_t reta_query;
1350 eth_get_reg_length_t get_reg_length;
1351 /**< Get # of registers */
1352 eth_get_reg_t get_reg;
1353 /**< Get registers */
1354 eth_get_eeprom_length_t get_eeprom_length;
1355 /**< Get eeprom length */
1356 eth_get_eeprom_t get_eeprom;
1357 /**< Get eeprom data */
1358 eth_set_eeprom_t set_eeprom;
1360 /* bypass control */
1361 #ifdef RTE_NIC_BYPASS
1362 bypass_init_t bypass_init;
1363 bypass_state_set_t bypass_state_set;
1364 bypass_state_show_t bypass_state_show;
1365 bypass_event_set_t bypass_event_set;
1366 bypass_event_show_t bypass_event_show;
1367 bypass_wd_timeout_set_t bypass_wd_timeout_set;
1368 bypass_wd_timeout_show_t bypass_wd_timeout_show;
1369 bypass_ver_show_t bypass_ver_show;
1370 bypass_wd_reset_t bypass_wd_reset;
1373 /** Configure RSS hash protocols. */
1374 rss_hash_update_t rss_hash_update;
1375 /** Get current RSS hash configuration. */
1376 rss_hash_conf_get_t rss_hash_conf_get;
1377 eth_filter_ctrl_t filter_ctrl;
1378 /**< common filter control. */
1379 eth_set_mc_addr_list_t set_mc_addr_list; /**< set list of mcast addrs */
1380 eth_rxq_info_get_t rxq_info_get;
1381 /**< retrieve RX queue information. */
1382 eth_txq_info_get_t txq_info_get;
1383 /**< retrieve TX queue information. */
1384 /** Turn IEEE1588/802.1AS timestamping on. */
1385 eth_timesync_enable_t timesync_enable;
1386 /** Turn IEEE1588/802.1AS timestamping off. */
1387 eth_timesync_disable_t timesync_disable;
1388 /** Read the IEEE1588/802.1AS RX timestamp. */
1389 eth_timesync_read_rx_timestamp_t timesync_read_rx_timestamp;
1390 /** Read the IEEE1588/802.1AS TX timestamp. */
1391 eth_timesync_read_tx_timestamp_t timesync_read_tx_timestamp;
1393 /** Get DCB information */
1394 eth_get_dcb_info get_dcb_info;
1398 * Function type used for RX packet processing packet callbacks.
1400 * The callback function is called on RX with a burst of packets that have
1401 * been received on the given port and queue.
1404 * The Ethernet port on which RX is being performed.
1406 * The queue on the Ethernet port which is being used to receive the packets.
1408 * The burst of packets that have just been received.
1410 * The number of packets in the burst pointed to by "pkts".
1412 * The max number of packets that can be stored in the "pkts" array.
1414 * The arbitrary user parameter passed in by the application when the callback
1415 * was originally configured.
1417 * The number of packets returned to the user.
1419 typedef uint16_t (*rte_rx_callback_fn)(uint8_t port, uint16_t queue,
1420 struct rte_mbuf *pkts[], uint16_t nb_pkts, uint16_t max_pkts,
1424 * Function type used for TX packet processing packet callbacks.
1426 * The callback function is called on TX with a burst of packets immediately
1427 * before the packets are put onto the hardware queue for transmission.
1430 * The Ethernet port on which TX is being performed.
1432 * The queue on the Ethernet port which is being used to transmit the packets.
1434 * The burst of packets that are about to be transmitted.
1436 * The number of packets in the burst pointed to by "pkts".
1438 * The arbitrary user parameter passed in by the application when the callback
1439 * was originally configured.
1441 * The number of packets to be written to the NIC.
1443 typedef uint16_t (*rte_tx_callback_fn)(uint8_t port, uint16_t queue,
1444 struct rte_mbuf *pkts[], uint16_t nb_pkts, void *user_param);
1448 * Structure used to hold information about the callbacks to be called for a
1449 * queue on RX and TX.
1451 struct rte_eth_rxtx_callback {
1452 struct rte_eth_rxtx_callback *next;
1454 rte_rx_callback_fn rx;
1455 rte_tx_callback_fn tx;
1461 * The eth device type.
1463 enum rte_eth_dev_type {
1464 RTE_ETH_DEV_UNKNOWN, /**< unknown device type */
1466 /**< Physical function and Virtual function of PCI devices */
1467 RTE_ETH_DEV_VIRTUAL, /**< non hardware device */
1468 RTE_ETH_DEV_MAX /**< max value of this enum */
1473 * The generic data structure associated with each ethernet device.
1475 * Pointers to burst-oriented packet receive and transmit functions are
1476 * located at the beginning of the structure, along with the pointer to
1477 * where all the data elements for the particular device are stored in shared
1478 * memory. This split allows the function pointer and driver data to be per-
1479 * process, while the actual configuration data for the device is shared.
1481 struct rte_eth_dev {
1482 eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
1483 eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
1484 struct rte_eth_dev_data *data; /**< Pointer to device data */
1485 const struct eth_driver *driver;/**< Driver for this device */
1486 const struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
1487 struct rte_pci_device *pci_dev; /**< PCI info. supplied by probing */
1488 /** User application callbacks for NIC interrupts */
1489 struct rte_eth_dev_cb_list link_intr_cbs;
1491 * User-supplied functions called from rx_burst to post-process
1492 * received packets before passing them to the user
1494 struct rte_eth_rxtx_callback *post_rx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
1496 * User-supplied functions called from tx_burst to pre-process
1497 * received packets before passing them to the driver for transmission.
1499 struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
1500 uint8_t attached; /**< Flag indicating the port is attached */
1501 enum rte_eth_dev_type dev_type; /**< Flag indicating the device type */
1504 struct rte_eth_dev_sriov {
1505 uint8_t active; /**< SRIOV is active with 16, 32 or 64 pools */
1506 uint8_t nb_q_per_pool; /**< rx queue number per pool */
1507 uint16_t def_vmdq_idx; /**< Default pool num used for PF */
1508 uint16_t def_pool_q_idx; /**< Default pool queue start reg index */
1510 #define RTE_ETH_DEV_SRIOV(dev) ((dev)->data->sriov)
1512 #define RTE_ETH_NAME_MAX_LEN (32)
1516 * The data part, with no function pointers, associated with each ethernet device.
1518 * This structure is safe to place in shared memory to be common among different
1519 * processes in a multi-process configuration.
1521 struct rte_eth_dev_data {
1522 char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
1524 void **rx_queues; /**< Array of pointers to RX queues. */
1525 void **tx_queues; /**< Array of pointers to TX queues. */
1526 uint16_t nb_rx_queues; /**< Number of RX queues. */
1527 uint16_t nb_tx_queues; /**< Number of TX queues. */
1529 struct rte_eth_dev_sriov sriov; /**< SRIOV data */
1531 void *dev_private; /**< PMD-specific private data */
1533 struct rte_eth_link dev_link;
1534 /**< Link-level information & status */
1536 struct rte_eth_conf dev_conf; /**< Configuration applied to device. */
1537 uint16_t mtu; /**< Maximum Transmission Unit. */
1539 uint32_t min_rx_buf_size;
1540 /**< Common rx buffer size handled by all queues */
1542 uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
1543 struct ether_addr* mac_addrs;/**< Device Ethernet Link address. */
1544 uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
1545 /** bitmap array of associating Ethernet MAC addresses to pools */
1546 struct ether_addr* hash_mac_addrs;
1547 /** Device Ethernet MAC addresses of hash filtering. */
1548 uint8_t port_id; /**< Device [external] port identifier. */
1549 uint8_t promiscuous : 1, /**< RX promiscuous mode ON(1) / OFF(0). */
1550 scattered_rx : 1, /**< RX of scattered packets is ON(1) / OFF(0) */
1551 all_multicast : 1, /**< RX all multicast mode ON(1) / OFF(0). */
1552 dev_started : 1, /**< Device state: STARTED(1) / STOPPED(0). */
1553 lro : 1; /**< RX LRO is ON(1) / OFF(0) */
1558 * The pool of *rte_eth_dev* structures. The size of the pool
1559 * is configured at compile-time in the <rte_ethdev.c> file.
1561 extern struct rte_eth_dev rte_eth_devices[];
1564 * Get the total number of Ethernet devices that have been successfully
1565 * initialized by the [matching] Ethernet driver during the PCI probing phase.
1566 * All devices whose port identifier is in the range
1567 * [0, rte_eth_dev_count() - 1] can be operated on by network applications
1568 * immediately after invoking rte_eal_init().
1569 * If the application unplugs a port using hotplug function, The enabled port
1570 * numbers may be noncontiguous. In the case, the applications need to manage
1571 * enabled port by themselves.
1574 * - The total number of usable Ethernet devices.
1576 extern uint8_t rte_eth_dev_count(void);
1580 * Returns a ethdev slot specified by the unique identifier name.
1583 * The pointer to the Unique identifier name for each Ethernet device
1585 * - The pointer to the ethdev slot, on success. NULL on error
1587 extern struct rte_eth_dev *rte_eth_dev_allocated(const char *name);
1591 * Allocates a new ethdev slot for an ethernet device and returns the pointer
1592 * to that slot for the driver to use.
1594 * @param name Unique identifier name for each Ethernet device
1595 * @param type Device type of this Ethernet device
1597 * - Slot in the rte_dev_devices array for a new device;
1599 struct rte_eth_dev *rte_eth_dev_allocate(const char *name,
1600 enum rte_eth_dev_type type);
1604 * Release the specified ethdev port.
1607 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure.
1609 * - 0 on success, negative on error
1611 int rte_eth_dev_release_port(struct rte_eth_dev *eth_dev);
1614 * Attach a new Ethernet device specified by aruguments.
1617 * A pointer to a strings array describing the new device
1618 * to be attached. The strings should be a pci address like
1619 * '0000:01:00.0' or virtual device name like 'eth_pcap0'.
1621 * A pointer to a port identifier actually attached.
1623 * 0 on success and port_id is filled, negative on error
1625 int rte_eth_dev_attach(const char *devargs, uint8_t *port_id);
1628 * Detach a Ethernet device specified by port identifier.
1629 * This function must be called when the device is in the
1633 * The port identifier of the device to detach.
1635 * A pointer to a device name actually detached.
1637 * 0 on success and devname is filled, negative on error
1639 int rte_eth_dev_detach(uint8_t port_id, char *devname);
1644 * Initialization function of an Ethernet driver invoked for each matching
1645 * Ethernet PCI device detected during the PCI probing phase.
1648 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1649 * associated with the matching device and which have been [automatically]
1650 * allocated in the *rte_eth_devices* array.
1651 * The *eth_dev* structure is supplied to the driver initialization function
1652 * with the following fields already initialized:
1654 * - *pci_dev*: Holds the pointers to the *rte_pci_device* structure which
1655 * contains the generic PCI information of the matching device.
1657 * - *driver*: Holds the pointer to the *eth_driver* structure.
1659 * - *dev_private*: Holds a pointer to the device private data structure.
1661 * - *mtu*: Contains the default Ethernet maximum frame length (1500).
1663 * - *port_id*: Contains the port index of the device (actually the index
1664 * of the *eth_dev* structure in the *rte_eth_devices* array).
1667 * - 0: Success, the device is properly initialized by the driver.
1668 * In particular, the driver MUST have set up the *dev_ops* pointer
1669 * of the *eth_dev* structure.
1670 * - <0: Error code of the device initialization failure.
1672 typedef int (*eth_dev_init_t)(struct rte_eth_dev *eth_dev);
1676 * Finalization function of an Ethernet driver invoked for each matching
1677 * Ethernet PCI device detected during the PCI closing phase.
1680 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1681 * associated with the matching device and which have been [automatically]
1682 * allocated in the *rte_eth_devices* array.
1684 * - 0: Success, the device is properly finalized by the driver.
1685 * In particular, the driver MUST free the *dev_ops* pointer
1686 * of the *eth_dev* structure.
1687 * - <0: Error code of the device initialization failure.
1689 typedef int (*eth_dev_uninit_t)(struct rte_eth_dev *eth_dev);
1693 * The structure associated with a PMD Ethernet driver.
1695 * Each Ethernet driver acts as a PCI driver and is represented by a generic
1696 * *eth_driver* structure that holds:
1698 * - An *rte_pci_driver* structure (which must be the first field).
1700 * - The *eth_dev_init* function invoked for each matching PCI device.
1702 * - The *eth_dev_uninit* function invoked for each matching PCI device.
1704 * - The size of the private data to allocate for each matching device.
1707 struct rte_pci_driver pci_drv; /**< The PMD is also a PCI driver. */
1708 eth_dev_init_t eth_dev_init; /**< Device init function. */
1709 eth_dev_uninit_t eth_dev_uninit; /**< Device uninit function. */
1710 unsigned int dev_private_size; /**< Size of device private data. */
1715 * A function invoked by the initialization function of an Ethernet driver
1716 * to simultaneously register itself as a PCI driver and as an Ethernet
1717 * Poll Mode Driver (PMD).
1720 * The pointer to the *eth_driver* structure associated with
1721 * the Ethernet driver.
1723 extern void rte_eth_driver_register(struct eth_driver *eth_drv);
1726 * Configure an Ethernet device.
1727 * This function must be invoked first before any other function in the
1728 * Ethernet API. This function can also be re-invoked when a device is in the
1732 * The port identifier of the Ethernet device to configure.
1733 * @param nb_rx_queue
1734 * The number of receive queues to set up for the Ethernet device.
1735 * @param nb_tx_queue
1736 * The number of transmit queues to set up for the Ethernet device.
1738 * The pointer to the configuration data to be used for the Ethernet device.
1739 * The *rte_eth_conf* structure includes:
1740 * - the hardware offload features to activate, with dedicated fields for
1741 * each statically configurable offload hardware feature provided by
1742 * Ethernet devices, such as IP checksum or VLAN tag stripping for
1744 * - the Receive Side Scaling (RSS) configuration when using multiple RX
1747 * Embedding all configuration information in a single data structure
1748 * is the more flexible method that allows the addition of new features
1749 * without changing the syntax of the API.
1751 * - 0: Success, device configured.
1752 * - <0: Error code returned by the driver configuration function.
1754 extern int rte_eth_dev_configure(uint8_t port_id,
1755 uint16_t nb_rx_queue,
1756 uint16_t nb_tx_queue,
1757 const struct rte_eth_conf *eth_conf);
1760 * Allocate and set up a receive queue for an Ethernet device.
1762 * The function allocates a contiguous block of memory for *nb_rx_desc*
1763 * receive descriptors from a memory zone associated with *socket_id*
1764 * and initializes each receive descriptor with a network buffer allocated
1765 * from the memory pool *mb_pool*.
1768 * The port identifier of the Ethernet device.
1769 * @param rx_queue_id
1770 * The index of the receive queue to set up.
1771 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1772 * to rte_eth_dev_configure().
1774 * The number of receive descriptors to allocate for the receive ring.
1776 * The *socket_id* argument is the socket identifier in case of NUMA.
1777 * The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1778 * the DMA memory allocated for the receive descriptors of the ring.
1780 * The pointer to the configuration data to be used for the receive queue.
1781 * NULL value is allowed, in which case default RX configuration
1783 * The *rx_conf* structure contains an *rx_thresh* structure with the values
1784 * of the Prefetch, Host, and Write-Back threshold registers of the receive
1787 * The pointer to the memory pool from which to allocate *rte_mbuf* network
1788 * memory buffers to populate each descriptor of the receive ring.
1790 * - 0: Success, receive queue correctly set up.
1791 * - -EINVAL: The size of network buffers which can be allocated from the
1792 * memory pool does not fit the various buffer sizes allowed by the
1793 * device controller.
1794 * - -ENOMEM: Unable to allocate the receive ring descriptors or to
1795 * allocate network memory buffers from the memory pool when
1796 * initializing receive descriptors.
1798 extern int rte_eth_rx_queue_setup(uint8_t port_id, uint16_t rx_queue_id,
1799 uint16_t nb_rx_desc, unsigned int socket_id,
1800 const struct rte_eth_rxconf *rx_conf,
1801 struct rte_mempool *mb_pool);
1804 * Allocate and set up a transmit queue for an Ethernet device.
1807 * The port identifier of the Ethernet device.
1808 * @param tx_queue_id
1809 * The index of the transmit queue to set up.
1810 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1811 * to rte_eth_dev_configure().
1813 * The number of transmit descriptors to allocate for the transmit ring.
1815 * The *socket_id* argument is the socket identifier in case of NUMA.
1816 * Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1817 * the DMA memory allocated for the transmit descriptors of the ring.
1819 * The pointer to the configuration data to be used for the transmit queue.
1820 * NULL value is allowed, in which case default RX configuration
1822 * The *tx_conf* structure contains the following data:
1823 * - The *tx_thresh* structure with the values of the Prefetch, Host, and
1824 * Write-Back threshold registers of the transmit ring.
1825 * When setting Write-Back threshold to the value greater then zero,
1826 * *tx_rs_thresh* value should be explicitly set to one.
1827 * - The *tx_free_thresh* value indicates the [minimum] number of network
1828 * buffers that must be pending in the transmit ring to trigger their
1829 * [implicit] freeing by the driver transmit function.
1830 * - The *tx_rs_thresh* value indicates the [minimum] number of transmit
1831 * descriptors that must be pending in the transmit ring before setting the
1832 * RS bit on a descriptor by the driver transmit function.
1833 * The *tx_rs_thresh* value should be less or equal then
1834 * *tx_free_thresh* value, and both of them should be less then
1836 * - The *txq_flags* member contains flags to pass to the TX queue setup
1837 * function to configure the behavior of the TX queue. This should be set
1838 * to 0 if no special configuration is required.
1840 * Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces
1841 * the transmit function to use default values.
1843 * - 0: Success, the transmit queue is correctly set up.
1844 * - -ENOMEM: Unable to allocate the transmit ring descriptors.
1846 extern int rte_eth_tx_queue_setup(uint8_t port_id, uint16_t tx_queue_id,
1847 uint16_t nb_tx_desc, unsigned int socket_id,
1848 const struct rte_eth_txconf *tx_conf);
1851 * Return the NUMA socket to which an Ethernet device is connected
1854 * The port identifier of the Ethernet device
1856 * The NUMA socket id to which the Ethernet device is connected or
1857 * a default of zero if the socket could not be determined.
1858 * -1 is returned is the port_id value is out of range.
1860 extern int rte_eth_dev_socket_id(uint8_t port_id);
1863 * Check if port_id of device is attached
1866 * The port identifier of the Ethernet device
1868 * - 0 if port is out of range or not attached
1869 * - 1 if device is attached
1871 extern int rte_eth_dev_is_valid_port(uint8_t port_id);
1874 * Allocate mbuf from mempool, setup the DMA physical address
1875 * and then start RX for specified queue of a port. It is used
1876 * when rx_deferred_start flag of the specified queue is true.
1879 * The port identifier of the Ethernet device
1880 * @param rx_queue_id
1881 * The index of the rx queue to update the ring.
1882 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1883 * to rte_eth_dev_configure().
1885 * - 0: Success, the transmit queue is correctly set up.
1886 * - -EINVAL: The port_id or the queue_id out of range.
1887 * - -ENOTSUP: The function not supported in PMD driver.
1889 extern int rte_eth_dev_rx_queue_start(uint8_t port_id, uint16_t rx_queue_id);
1892 * Stop specified RX queue of a port
1895 * The port identifier of the Ethernet device
1896 * @param rx_queue_id
1897 * The index of the rx queue to update the ring.
1898 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1899 * to rte_eth_dev_configure().
1901 * - 0: Success, the transmit queue is correctly set up.
1902 * - -EINVAL: The port_id or the queue_id out of range.
1903 * - -ENOTSUP: The function not supported in PMD driver.
1905 extern int rte_eth_dev_rx_queue_stop(uint8_t port_id, uint16_t rx_queue_id);
1908 * Start TX for specified queue of a port. It is used when tx_deferred_start
1909 * flag of the specified queue is true.
1912 * The port identifier of the Ethernet device
1913 * @param tx_queue_id
1914 * The index of the tx queue to update the ring.
1915 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1916 * to rte_eth_dev_configure().
1918 * - 0: Success, the transmit queue is correctly set up.
1919 * - -EINVAL: The port_id or the queue_id out of range.
1920 * - -ENOTSUP: The function not supported in PMD driver.
1922 extern int rte_eth_dev_tx_queue_start(uint8_t port_id, uint16_t tx_queue_id);
1925 * Stop specified TX queue of a port
1928 * The port identifier of the Ethernet device
1929 * @param tx_queue_id
1930 * The index of the tx queue to update the ring.
1931 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1932 * to rte_eth_dev_configure().
1934 * - 0: Success, the transmit queue is correctly set up.
1935 * - -EINVAL: The port_id or the queue_id out of range.
1936 * - -ENOTSUP: The function not supported in PMD driver.
1938 extern int rte_eth_dev_tx_queue_stop(uint8_t port_id, uint16_t tx_queue_id);
1943 * Start an Ethernet device.
1945 * The device start step is the last one and consists of setting the configured
1946 * offload features and in starting the transmit and the receive units of the
1948 * On success, all basic functions exported by the Ethernet API (link status,
1949 * receive/transmit, and so on) can be invoked.
1952 * The port identifier of the Ethernet device.
1954 * - 0: Success, Ethernet device started.
1955 * - <0: Error code of the driver device start function.
1957 extern int rte_eth_dev_start(uint8_t port_id);
1960 * Stop an Ethernet device. The device can be restarted with a call to
1961 * rte_eth_dev_start()
1964 * The port identifier of the Ethernet device.
1966 extern void rte_eth_dev_stop(uint8_t port_id);
1970 * Link up an Ethernet device.
1972 * Set device link up will re-enable the device rx/tx
1973 * functionality after it is previously set device linked down.
1976 * The port identifier of the Ethernet device.
1978 * - 0: Success, Ethernet device linked up.
1979 * - <0: Error code of the driver device link up function.
1981 extern int rte_eth_dev_set_link_up(uint8_t port_id);
1984 * Link down an Ethernet device.
1985 * The device rx/tx functionality will be disabled if success,
1986 * and it can be re-enabled with a call to
1987 * rte_eth_dev_set_link_up()
1990 * The port identifier of the Ethernet device.
1992 extern int rte_eth_dev_set_link_down(uint8_t port_id);
1995 * Close a stopped Ethernet device. The device cannot be restarted!
1996 * The function frees all resources except for needed by the
1997 * closed state. To free these resources, call rte_eth_dev_detach().
2000 * The port identifier of the Ethernet device.
2002 extern void rte_eth_dev_close(uint8_t port_id);
2005 * Enable receipt in promiscuous mode for an Ethernet device.
2008 * The port identifier of the Ethernet device.
2010 extern void rte_eth_promiscuous_enable(uint8_t port_id);
2013 * Disable receipt in promiscuous mode for an Ethernet device.
2016 * The port identifier of the Ethernet device.
2018 extern void rte_eth_promiscuous_disable(uint8_t port_id);
2021 * Return the value of promiscuous mode for an Ethernet device.
2024 * The port identifier of the Ethernet device.
2026 * - (1) if promiscuous is enabled
2027 * - (0) if promiscuous is disabled.
2030 extern int rte_eth_promiscuous_get(uint8_t port_id);
2033 * Enable the receipt of any multicast frame by an Ethernet device.
2036 * The port identifier of the Ethernet device.
2038 extern void rte_eth_allmulticast_enable(uint8_t port_id);
2041 * Disable the receipt of all multicast frames by an Ethernet device.
2044 * The port identifier of the Ethernet device.
2046 extern void rte_eth_allmulticast_disable(uint8_t port_id);
2049 * Return the value of allmulticast mode for an Ethernet device.
2052 * The port identifier of the Ethernet device.
2054 * - (1) if allmulticast is enabled
2055 * - (0) if allmulticast is disabled.
2058 extern int rte_eth_allmulticast_get(uint8_t port_id);
2061 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2062 * or FULL-DUPLEX) of the physical link of an Ethernet device. It might need
2063 * to wait up to 9 seconds in it.
2066 * The port identifier of the Ethernet device.
2068 * A pointer to an *rte_eth_link* structure to be filled with
2069 * the status, the speed and the mode of the Ethernet device link.
2071 extern void rte_eth_link_get(uint8_t port_id, struct rte_eth_link *link);
2074 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2075 * or FULL-DUPLEX) of the physical link of an Ethernet device. It is a no-wait
2076 * version of rte_eth_link_get().
2079 * The port identifier of the Ethernet device.
2081 * A pointer to an *rte_eth_link* structure to be filled with
2082 * the status, the speed and the mode of the Ethernet device link.
2084 extern void rte_eth_link_get_nowait(uint8_t port_id,
2085 struct rte_eth_link *link);
2088 * Retrieve the general I/O statistics of an Ethernet device.
2091 * The port identifier of the Ethernet device.
2093 * A pointer to a structure of type *rte_eth_stats* to be filled with
2094 * the values of device counters for the following set of statistics:
2095 * - *ipackets* with the total of successfully received packets.
2096 * - *opackets* with the total of successfully transmitted packets.
2097 * - *ibytes* with the total of successfully received bytes.
2098 * - *obytes* with the total of successfully transmitted bytes.
2099 * - *ierrors* with the total of erroneous received packets.
2100 * - *oerrors* with the total of failed transmitted packets.
2102 * Zero if successful. Non-zero otherwise.
2104 extern int rte_eth_stats_get(uint8_t port_id, struct rte_eth_stats *stats);
2107 * Reset the general I/O statistics of an Ethernet device.
2110 * The port identifier of the Ethernet device.
2112 extern void rte_eth_stats_reset(uint8_t port_id);
2115 * Retrieve extended statistics of an Ethernet device.
2118 * The port identifier of the Ethernet device.
2120 * A pointer to a table of structure of type *rte_eth_xstats*
2121 * to be filled with device statistics names and values.
2122 * This parameter can be set to NULL if n is 0.
2124 * The size of the stats table, which should be large enough to store
2125 * all the statistics of the device.
2127 * - positive value lower or equal to n: success. The return value
2128 * is the number of entries filled in the stats table.
2129 * - positive value higher than n: error, the given statistics table
2130 * is too small. The return value corresponds to the size that should
2131 * be given to succeed. The entries in the table are not valid and
2132 * shall not be used by the caller.
2133 * - negative value on error (invalid port id)
2135 extern int rte_eth_xstats_get(uint8_t port_id,
2136 struct rte_eth_xstats *xstats, unsigned n);
2139 * Reset extended statistics of an Ethernet device.
2142 * The port identifier of the Ethernet device.
2144 extern void rte_eth_xstats_reset(uint8_t port_id);
2147 * Set a mapping for the specified transmit queue to the specified per-queue
2148 * statistics counter.
2151 * The port identifier of the Ethernet device.
2152 * @param tx_queue_id
2153 * The index of the transmit queue for which a queue stats mapping is required.
2154 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2155 * to rte_eth_dev_configure().
2157 * The per-queue packet statistics functionality number that the transmit
2158 * queue is to be assigned.
2159 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2161 * Zero if successful. Non-zero otherwise.
2163 extern int rte_eth_dev_set_tx_queue_stats_mapping(uint8_t port_id,
2164 uint16_t tx_queue_id,
2168 * Set a mapping for the specified receive queue to the specified per-queue
2169 * statistics counter.
2172 * The port identifier of the Ethernet device.
2173 * @param rx_queue_id
2174 * The index of the receive queue for which a queue stats mapping is required.
2175 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2176 * to rte_eth_dev_configure().
2178 * The per-queue packet statistics functionality number that the receive
2179 * queue is to be assigned.
2180 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2182 * Zero if successful. Non-zero otherwise.
2184 extern int rte_eth_dev_set_rx_queue_stats_mapping(uint8_t port_id,
2185 uint16_t rx_queue_id,
2189 * Retrieve the Ethernet address of an Ethernet device.
2192 * The port identifier of the Ethernet device.
2194 * A pointer to a structure of type *ether_addr* to be filled with
2195 * the Ethernet address of the Ethernet device.
2197 extern void rte_eth_macaddr_get(uint8_t port_id, struct ether_addr *mac_addr);
2200 * Retrieve the contextual information of an Ethernet device.
2203 * The port identifier of the Ethernet device.
2205 * A pointer to a structure of type *rte_eth_dev_info* to be filled with
2206 * the contextual information of the Ethernet device.
2208 extern void rte_eth_dev_info_get(uint8_t port_id,
2209 struct rte_eth_dev_info *dev_info);
2212 * Retrieve the MTU of an Ethernet device.
2215 * The port identifier of the Ethernet device.
2217 * A pointer to a uint16_t where the retrieved MTU is to be stored.
2219 * - (0) if successful.
2220 * - (-ENODEV) if *port_id* invalid.
2222 extern int rte_eth_dev_get_mtu(uint8_t port_id, uint16_t *mtu);
2225 * Change the MTU of an Ethernet device.
2228 * The port identifier of the Ethernet device.
2230 * A uint16_t for the MTU to be applied.
2232 * - (0) if successful.
2233 * - (-ENOTSUP) if operation is not supported.
2234 * - (-ENODEV) if *port_id* invalid.
2235 * - (-EINVAL) if *mtu* invalid.
2237 extern int rte_eth_dev_set_mtu(uint8_t port_id, uint16_t mtu);
2240 * Enable/Disable hardware filtering by an Ethernet device of received
2241 * VLAN packets tagged with a given VLAN Tag Identifier.
2244 * The port identifier of the Ethernet device.
2246 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
2248 * If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*.
2249 * Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*.
2251 * - (0) if successful.
2252 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2253 * - (-ENODEV) if *port_id* invalid.
2254 * - (-ENOSYS) if VLAN filtering on *port_id* disabled.
2255 * - (-EINVAL) if *vlan_id* > 4095.
2257 extern int rte_eth_dev_vlan_filter(uint8_t port_id, uint16_t vlan_id , int on);
2260 * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
2261 * 82599/X540/X550 can support VLAN stripping at the rx queue level
2264 * The port identifier of the Ethernet device.
2265 * @param rx_queue_id
2266 * The index of the receive queue for which a queue stats mapping is required.
2267 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2268 * to rte_eth_dev_configure().
2270 * If 1, Enable VLAN Stripping of the receive queue of the Ethernet port.
2271 * If 0, Disable VLAN Stripping of the receive queue of the Ethernet port.
2273 * - (0) if successful.
2274 * - (-ENOSUP) if hardware-assisted VLAN stripping not configured.
2275 * - (-ENODEV) if *port_id* invalid.
2276 * - (-EINVAL) if *rx_queue_id* invalid.
2278 extern int rte_eth_dev_set_vlan_strip_on_queue(uint8_t port_id,
2279 uint16_t rx_queue_id, int on);
2282 * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
2283 * the VLAN Header. This is a register setup available on some Intel NIC, not
2284 * but all, please check the data sheet for availability.
2287 * The port identifier of the Ethernet device.
2289 * The Tag Protocol ID
2291 * - (0) if successful.
2292 * - (-ENOSUP) if hardware-assisted VLAN TPID setup is not supported.
2293 * - (-ENODEV) if *port_id* invalid.
2295 extern int rte_eth_dev_set_vlan_ether_type(uint8_t port_id, uint16_t tag_type);
2298 * Set VLAN offload configuration on an Ethernet device
2299 * Enable/Disable Extended VLAN by an Ethernet device, This is a register setup
2300 * available on some Intel NIC, not but all, please check the data sheet for
2302 * Enable/Disable VLAN Strip can be done on rx queue for certain NIC, but here
2303 * the configuration is applied on the port level.
2306 * The port identifier of the Ethernet device.
2307 * @param offload_mask
2308 * The VLAN Offload bit mask can be mixed use with "OR"
2309 * ETH_VLAN_STRIP_OFFLOAD
2310 * ETH_VLAN_FILTER_OFFLOAD
2311 * ETH_VLAN_EXTEND_OFFLOAD
2313 * - (0) if successful.
2314 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2315 * - (-ENODEV) if *port_id* invalid.
2317 extern int rte_eth_dev_set_vlan_offload(uint8_t port_id, int offload_mask);
2320 * Read VLAN Offload configuration from an Ethernet device
2323 * The port identifier of the Ethernet device.
2325 * - (>0) if successful. Bit mask to indicate
2326 * ETH_VLAN_STRIP_OFFLOAD
2327 * ETH_VLAN_FILTER_OFFLOAD
2328 * ETH_VLAN_EXTEND_OFFLOAD
2329 * - (-ENODEV) if *port_id* invalid.
2331 extern int rte_eth_dev_get_vlan_offload(uint8_t port_id);
2334 * Set port based TX VLAN insersion on or off.
2337 * The port identifier of the Ethernet device.
2339 * Port based TX VLAN identifier togeth with user priority.
2341 * Turn on or off the port based TX VLAN insertion.
2344 * - (0) if successful.
2345 * - negative if failed.
2347 extern int rte_eth_dev_set_vlan_pvid(uint8_t port_id, uint16_t pvid, int on);
2351 * Retrieve a burst of input packets from a receive queue of an Ethernet
2352 * device. The retrieved packets are stored in *rte_mbuf* structures whose
2353 * pointers are supplied in the *rx_pkts* array.
2355 * The rte_eth_rx_burst() function loops, parsing the RX ring of the
2356 * receive queue, up to *nb_pkts* packets, and for each completed RX
2357 * descriptor in the ring, it performs the following operations:
2359 * - Initialize the *rte_mbuf* data structure associated with the
2360 * RX descriptor according to the information provided by the NIC into
2361 * that RX descriptor.
2363 * - Store the *rte_mbuf* data structure into the next entry of the
2366 * - Replenish the RX descriptor with a new *rte_mbuf* buffer
2367 * allocated from the memory pool associated with the receive queue at
2368 * initialization time.
2370 * When retrieving an input packet that was scattered by the controller
2371 * into multiple receive descriptors, the rte_eth_rx_burst() function
2372 * appends the associated *rte_mbuf* buffers to the first buffer of the
2375 * The rte_eth_rx_burst() function returns the number of packets
2376 * actually retrieved, which is the number of *rte_mbuf* data structures
2377 * effectively supplied into the *rx_pkts* array.
2378 * A return value equal to *nb_pkts* indicates that the RX queue contained
2379 * at least *rx_pkts* packets, and this is likely to signify that other
2380 * received packets remain in the input queue. Applications implementing
2381 * a "retrieve as much received packets as possible" policy can check this
2382 * specific case and keep invoking the rte_eth_rx_burst() function until
2383 * a value less than *nb_pkts* is returned.
2385 * This receive method has the following advantages:
2387 * - It allows a run-to-completion network stack engine to retrieve and
2388 * to immediately process received packets in a fast burst-oriented
2389 * approach, avoiding the overhead of unnecessary intermediate packet
2390 * queue/dequeue operations.
2392 * - Conversely, it also allows an asynchronous-oriented processing
2393 * method to retrieve bursts of received packets and to immediately
2394 * queue them for further parallel processing by another logical core,
2395 * for instance. However, instead of having received packets being
2396 * individually queued by the driver, this approach allows the invoker
2397 * of the rte_eth_rx_burst() function to queue a burst of retrieved
2398 * packets at a time and therefore dramatically reduce the cost of
2399 * enqueue/dequeue operations per packet.
2401 * - It allows the rte_eth_rx_burst() function of the driver to take
2402 * advantage of burst-oriented hardware features (CPU cache,
2403 * prefetch instructions, and so on) to minimize the number of CPU
2404 * cycles per packet.
2406 * To summarize, the proposed receive API enables many
2407 * burst-oriented optimizations in both synchronous and asynchronous
2408 * packet processing environments with no overhead in both cases.
2410 * The rte_eth_rx_burst() function does not provide any error
2411 * notification to avoid the corresponding overhead. As a hint, the
2412 * upper-level application might check the status of the device link once
2413 * being systematically returned a 0 value for a given number of tries.
2416 * The port identifier of the Ethernet device.
2418 * The index of the receive queue from which to retrieve input packets.
2419 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2420 * to rte_eth_dev_configure().
2422 * The address of an array of pointers to *rte_mbuf* structures that
2423 * must be large enough to store *nb_pkts* pointers in it.
2425 * The maximum number of packets to retrieve.
2427 * The number of packets actually retrieved, which is the number
2428 * of pointers to *rte_mbuf* structures effectively supplied to the
2431 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2432 extern uint16_t rte_eth_rx_burst(uint8_t port_id, uint16_t queue_id,
2433 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
2435 static inline uint16_t
2436 rte_eth_rx_burst(uint8_t port_id, uint16_t queue_id,
2437 struct rte_mbuf **rx_pkts, const uint16_t nb_pkts)
2439 struct rte_eth_dev *dev;
2441 dev = &rte_eth_devices[port_id];
2443 int16_t nb_rx = (*dev->rx_pkt_burst)(dev->data->rx_queues[queue_id],
2446 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
2447 struct rte_eth_rxtx_callback *cb = dev->post_rx_burst_cbs[queue_id];
2449 if (unlikely(cb != NULL)) {
2451 nb_rx = cb->fn.rx(port_id, queue_id, rx_pkts, nb_rx,
2452 nb_pkts, cb->param);
2454 } while (cb != NULL);
2463 * Get the number of used descriptors in a specific queue
2466 * The port identifier of the Ethernet device.
2468 * The queue id on the specific port.
2470 * The number of used descriptors in the specific queue.
2472 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2473 extern uint32_t rte_eth_rx_queue_count(uint8_t port_id, uint16_t queue_id);
2475 static inline uint32_t
2476 rte_eth_rx_queue_count(uint8_t port_id, uint16_t queue_id)
2478 struct rte_eth_dev *dev;
2480 dev = &rte_eth_devices[port_id];
2481 return (*dev->dev_ops->rx_queue_count)(dev, queue_id);
2486 * Check if the DD bit of the specific RX descriptor in the queue has been set
2489 * The port identifier of the Ethernet device.
2491 * The queue id on the specific port.
2493 * The offset of the descriptor ID from tail.
2495 * - (1) if the specific DD bit is set.
2496 * - (0) if the specific DD bit is not set.
2497 * - (-ENODEV) if *port_id* invalid.
2499 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2500 extern int rte_eth_rx_descriptor_done(uint8_t port_id,
2505 rte_eth_rx_descriptor_done(uint8_t port_id, uint16_t queue_id, uint16_t offset)
2507 struct rte_eth_dev *dev;
2509 dev = &rte_eth_devices[port_id];
2510 return (*dev->dev_ops->rx_descriptor_done)( \
2511 dev->data->rx_queues[queue_id], offset);
2516 * Send a burst of output packets on a transmit queue of an Ethernet device.
2518 * The rte_eth_tx_burst() function is invoked to transmit output packets
2519 * on the output queue *queue_id* of the Ethernet device designated by its
2521 * The *nb_pkts* parameter is the number of packets to send which are
2522 * supplied in the *tx_pkts* array of *rte_mbuf* structures.
2523 * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
2524 * up to the number of transmit descriptors available in the TX ring of the
2526 * For each packet to send, the rte_eth_tx_burst() function performs
2527 * the following operations:
2529 * - Pick up the next available descriptor in the transmit ring.
2531 * - Free the network buffer previously sent with that descriptor, if any.
2533 * - Initialize the transmit descriptor with the information provided
2534 * in the *rte_mbuf data structure.
2536 * In the case of a segmented packet composed of a list of *rte_mbuf* buffers,
2537 * the rte_eth_tx_burst() function uses several transmit descriptors
2540 * The rte_eth_tx_burst() function returns the number of packets it
2541 * actually sent. A return value equal to *nb_pkts* means that all packets
2542 * have been sent, and this is likely to signify that other output packets
2543 * could be immediately transmitted again. Applications that implement a
2544 * "send as many packets to transmit as possible" policy can check this
2545 * specific case and keep invoking the rte_eth_tx_burst() function until
2546 * a value less than *nb_pkts* is returned.
2548 * It is the responsibility of the rte_eth_tx_burst() function to
2549 * transparently free the memory buffers of packets previously sent.
2550 * This feature is driven by the *tx_free_thresh* value supplied to the
2551 * rte_eth_dev_configure() function at device configuration time.
2552 * When the number of free TX descriptors drops below this threshold, the
2553 * rte_eth_tx_burst() function must [attempt to] free the *rte_mbuf* buffers
2554 * of those packets whose transmission was effectively completed.
2557 * The port identifier of the Ethernet device.
2559 * The index of the transmit queue through which output packets must be
2561 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2562 * to rte_eth_dev_configure().
2564 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
2565 * which contain the output packets.
2567 * The maximum number of packets to transmit.
2569 * The number of output packets actually stored in transmit descriptors of
2570 * the transmit ring. The return value can be less than the value of the
2571 * *tx_pkts* parameter when the transmit ring is full or has been filled up.
2573 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2574 extern uint16_t rte_eth_tx_burst(uint8_t port_id, uint16_t queue_id,
2575 struct rte_mbuf **tx_pkts, uint16_t nb_pkts);
2577 static inline uint16_t
2578 rte_eth_tx_burst(uint8_t port_id, uint16_t queue_id,
2579 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
2581 struct rte_eth_dev *dev;
2583 dev = &rte_eth_devices[port_id];
2585 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
2586 struct rte_eth_rxtx_callback *cb = dev->pre_tx_burst_cbs[queue_id];
2588 if (unlikely(cb != NULL)) {
2590 nb_pkts = cb->fn.tx(port_id, queue_id, tx_pkts, nb_pkts,
2593 } while (cb != NULL);
2597 return (*dev->tx_pkt_burst)(dev->data->tx_queues[queue_id], tx_pkts, nb_pkts);
2602 * The eth device event type for interrupt, and maybe others in the future.
2604 enum rte_eth_event_type {
2605 RTE_ETH_EVENT_UNKNOWN, /**< unknown event type */
2606 RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
2607 RTE_ETH_EVENT_MAX /**< max value of this enum */
2610 typedef void (*rte_eth_dev_cb_fn)(uint8_t port_id, \
2611 enum rte_eth_event_type event, void *cb_arg);
2612 /**< user application callback to be registered for interrupts */
2617 * Register a callback function for specific port id.
2624 * User supplied callback function to be called.
2626 * Pointer to the parameters for the registered callback.
2629 * - On success, zero.
2630 * - On failure, a negative value.
2632 int rte_eth_dev_callback_register(uint8_t port_id,
2633 enum rte_eth_event_type event,
2634 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
2637 * Unregister a callback function for specific port id.
2644 * User supplied callback function to be called.
2646 * Pointer to the parameters for the registered callback. -1 means to
2647 * remove all for the same callback address and same event.
2650 * - On success, zero.
2651 * - On failure, a negative value.
2653 int rte_eth_dev_callback_unregister(uint8_t port_id,
2654 enum rte_eth_event_type event,
2655 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
2658 * @internal Executes all the user application registered callbacks for
2659 * the specific device. It is for DPDK internal user only. User
2660 * application should not call it directly.
2663 * Pointer to struct rte_eth_dev.
2665 * Eth device interrupt event type.
2670 void _rte_eth_dev_callback_process(struct rte_eth_dev *dev,
2671 enum rte_eth_event_type event);
2674 * When there is no rx packet coming in Rx Queue for a long time, we can
2675 * sleep lcore related to RX Queue for power saving, and enable rx interrupt
2676 * to be triggered when rx packect arrives.
2678 * The rte_eth_dev_rx_intr_enable() function enables rx queue
2679 * interrupt on specific rx queue of a port.
2682 * The port identifier of the Ethernet device.
2684 * The index of the receive queue from which to retrieve input packets.
2685 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2686 * to rte_eth_dev_configure().
2688 * - (0) if successful.
2689 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
2691 * - (-ENODEV) if *port_id* invalid.
2693 int rte_eth_dev_rx_intr_enable(uint8_t port_id, uint16_t queue_id);
2696 * When lcore wakes up from rx interrupt indicating packet coming, disable rx
2697 * interrupt and returns to polling mode.
2699 * The rte_eth_dev_rx_intr_disable() function disables rx queue
2700 * interrupt on specific rx queue of a port.
2703 * The port identifier of the Ethernet device.
2705 * The index of the receive queue from which to retrieve input packets.
2706 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2707 * to rte_eth_dev_configure().
2709 * - (0) if successful.
2710 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
2712 * - (-ENODEV) if *port_id* invalid.
2714 int rte_eth_dev_rx_intr_disable(uint8_t port_id, uint16_t queue_id);
2717 * RX Interrupt control per port.
2720 * The port identifier of the Ethernet device.
2722 * Epoll instance fd which the intr vector associated to.
2723 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
2725 * The operation be performed for the vector.
2726 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
2730 * - On success, zero.
2731 * - On failure, a negative value.
2733 int rte_eth_dev_rx_intr_ctl(uint8_t port_id, int epfd, int op, void *data);
2736 * RX Interrupt control per queue.
2739 * The port identifier of the Ethernet device.
2741 * The index of the receive queue from which to retrieve input packets.
2742 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2743 * to rte_eth_dev_configure().
2745 * Epoll instance fd which the intr vector associated to.
2746 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
2748 * The operation be performed for the vector.
2749 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
2753 * - On success, zero.
2754 * - On failure, a negative value.
2756 int rte_eth_dev_rx_intr_ctl_q(uint8_t port_id, uint16_t queue_id,
2757 int epfd, int op, void *data);
2760 * Turn on the LED on the Ethernet device.
2761 * This function turns on the LED on the Ethernet device.
2764 * The port identifier of the Ethernet device.
2766 * - (0) if successful.
2767 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
2769 * - (-ENODEV) if *port_id* invalid.
2771 int rte_eth_led_on(uint8_t port_id);
2774 * Turn off the LED on the Ethernet device.
2775 * This function turns off the LED on the Ethernet device.
2778 * The port identifier of the Ethernet device.
2780 * - (0) if successful.
2781 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
2783 * - (-ENODEV) if *port_id* invalid.
2785 int rte_eth_led_off(uint8_t port_id);
2788 * Get current status of the Ethernet link flow control for Ethernet device
2791 * The port identifier of the Ethernet device.
2793 * The pointer to the structure where to store the flow control parameters.
2795 * - (0) if successful.
2796 * - (-ENOTSUP) if hardware doesn't support flow control.
2797 * - (-ENODEV) if *port_id* invalid.
2799 int rte_eth_dev_flow_ctrl_get(uint8_t port_id,
2800 struct rte_eth_fc_conf *fc_conf);
2803 * Configure the Ethernet link flow control for Ethernet device
2806 * The port identifier of the Ethernet device.
2808 * The pointer to the structure of the flow control parameters.
2810 * - (0) if successful.
2811 * - (-ENOTSUP) if hardware doesn't support flow control mode.
2812 * - (-ENODEV) if *port_id* invalid.
2813 * - (-EINVAL) if bad parameter
2814 * - (-EIO) if flow control setup failure
2816 int rte_eth_dev_flow_ctrl_set(uint8_t port_id,
2817 struct rte_eth_fc_conf *fc_conf);
2820 * Configure the Ethernet priority flow control under DCB environment
2821 * for Ethernet device.
2824 * The port identifier of the Ethernet device.
2826 * The pointer to the structure of the priority flow control parameters.
2828 * - (0) if successful.
2829 * - (-ENOTSUP) if hardware doesn't support priority flow control mode.
2830 * - (-ENODEV) if *port_id* invalid.
2831 * - (-EINVAL) if bad parameter
2832 * - (-EIO) if flow control setup failure
2834 int rte_eth_dev_priority_flow_ctrl_set(uint8_t port_id,
2835 struct rte_eth_pfc_conf *pfc_conf);
2838 * Add a MAC address to an internal array of addresses used to enable whitelist
2839 * filtering to accept packets only if the destination MAC address matches.
2842 * The port identifier of the Ethernet device.
2844 * The MAC address to add.
2846 * VMDq pool index to associate address with (if VMDq is enabled). If VMDq is
2847 * not enabled, this should be set to 0.
2849 * - (0) if successfully added or *mac_addr" was already added.
2850 * - (-ENOTSUP) if hardware doesn't support this feature.
2851 * - (-ENODEV) if *port* is invalid.
2852 * - (-ENOSPC) if no more MAC addresses can be added.
2853 * - (-EINVAL) if MAC address is invalid.
2855 int rte_eth_dev_mac_addr_add(uint8_t port, struct ether_addr *mac_addr,
2859 * Remove a MAC address from the internal array of addresses.
2862 * The port identifier of the Ethernet device.
2864 * MAC address to remove.
2866 * - (0) if successful, or *mac_addr* didn't exist.
2867 * - (-ENOTSUP) if hardware doesn't support.
2868 * - (-ENODEV) if *port* invalid.
2869 * - (-EADDRINUSE) if attempting to remove the default MAC address
2871 int rte_eth_dev_mac_addr_remove(uint8_t port, struct ether_addr *mac_addr);
2874 * Set the default MAC address.
2877 * The port identifier of the Ethernet device.
2879 * New default MAC address.
2881 * - (0) if successful, or *mac_addr* didn't exist.
2882 * - (-ENOTSUP) if hardware doesn't support.
2883 * - (-ENODEV) if *port* invalid.
2884 * - (-EINVAL) if MAC address is invalid.
2886 int rte_eth_dev_default_mac_addr_set(uint8_t port, struct ether_addr *mac_addr);
2890 * Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
2893 * The port identifier of the Ethernet device.
2897 * Redirection table size. The table size can be queried by
2898 * rte_eth_dev_info_get().
2900 * - (0) if successful.
2901 * - (-ENOTSUP) if hardware doesn't support.
2902 * - (-EINVAL) if bad parameter.
2904 int rte_eth_dev_rss_reta_update(uint8_t port,
2905 struct rte_eth_rss_reta_entry64 *reta_conf,
2906 uint16_t reta_size);
2909 * Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
2912 * The port identifier of the Ethernet device.
2916 * Redirection table size. The table size can be queried by
2917 * rte_eth_dev_info_get().
2919 * - (0) if successful.
2920 * - (-ENOTSUP) if hardware doesn't support.
2921 * - (-EINVAL) if bad parameter.
2923 int rte_eth_dev_rss_reta_query(uint8_t port,
2924 struct rte_eth_rss_reta_entry64 *reta_conf,
2925 uint16_t reta_size);
2928 * Updates unicast hash table for receiving packet with the given destination
2929 * MAC address, and the packet is routed to all VFs for which the RX mode is
2930 * accept packets that match the unicast hash table.
2933 * The port identifier of the Ethernet device.
2935 * Unicast MAC address.
2937 * 1 - Set an unicast hash bit for receiving packets with the MAC address.
2938 * 0 - Clear an unicast hash bit.
2940 * - (0) if successful.
2941 * - (-ENOTSUP) if hardware doesn't support.
2942 * - (-ENODEV) if *port_id* invalid.
2943 * - (-EINVAL) if bad parameter.
2945 int rte_eth_dev_uc_hash_table_set(uint8_t port,struct ether_addr *addr,
2949 * Updates all unicast hash bitmaps for receiving packet with any Unicast
2950 * Ethernet MAC addresses,the packet is routed to all VFs for which the RX
2951 * mode is accept packets that match the unicast hash table.
2954 * The port identifier of the Ethernet device.
2956 * 1 - Set all unicast hash bitmaps for receiving all the Ethernet
2958 * 0 - Clear all unicast hash bitmaps
2960 * - (0) if successful.
2961 * - (-ENOTSUP) if hardware doesn't support.
2962 * - (-ENODEV) if *port_id* invalid.
2963 * - (-EINVAL) if bad parameter.
2965 int rte_eth_dev_uc_all_hash_table_set(uint8_t port,uint8_t on);
2968 * Set RX L2 Filtering mode of a VF of an Ethernet device.
2971 * The port identifier of the Ethernet device.
2975 * The RX mode mask, which is one or more of accepting Untagged Packets,
2976 * packets that match the PFUTA table, Broadcast and Multicast Promiscuous.
2977 * ETH_VMDQ_ACCEPT_UNTAG,ETH_VMDQ_ACCEPT_HASH_UC,
2978 * ETH_VMDQ_ACCEPT_BROADCAST and ETH_VMDQ_ACCEPT_MULTICAST will be used
2981 * 1 - Enable a VF RX mode.
2982 * 0 - Disable a VF RX mode.
2984 * - (0) if successful.
2985 * - (-ENOTSUP) if hardware doesn't support.
2986 * - (-ENOTSUP) if hardware doesn't support.
2987 * - (-EINVAL) if bad parameter.
2989 int rte_eth_dev_set_vf_rxmode(uint8_t port, uint16_t vf, uint16_t rx_mode,
2993 * Enable or disable a VF traffic transmit of the Ethernet device.
2996 * The port identifier of the Ethernet device.
3000 * 1 - Enable a VF traffic transmit.
3001 * 0 - Disable a VF traffic transmit.
3003 * - (0) if successful.
3004 * - (-ENODEV) if *port_id* invalid.
3005 * - (-ENOTSUP) if hardware doesn't support.
3006 * - (-EINVAL) if bad parameter.
3009 rte_eth_dev_set_vf_tx(uint8_t port,uint16_t vf, uint8_t on);
3012 * Enable or disable a VF traffic receive of an Ethernet device.
3015 * The port identifier of the Ethernet device.
3019 * 1 - Enable a VF traffic receive.
3020 * 0 - Disable a VF traffic receive.
3022 * - (0) if successful.
3023 * - (-ENOTSUP) if hardware doesn't support.
3024 * - (-ENODEV) if *port_id* invalid.
3025 * - (-EINVAL) if bad parameter.
3028 rte_eth_dev_set_vf_rx(uint8_t port,uint16_t vf, uint8_t on);
3031 * Enable/Disable hardware VF VLAN filtering by an Ethernet device of
3032 * received VLAN packets tagged with a given VLAN Tag Identifier.
3035 * The port identifier of the Ethernet device.
3037 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
3039 * Bitmap listing which VFs participate in the VLAN filtering.
3041 * 1 - Enable VFs VLAN filtering.
3042 * 0 - Disable VFs VLAN filtering.
3044 * - (0) if successful.
3045 * - (-ENOTSUP) if hardware doesn't support.
3046 * - (-ENODEV) if *port_id* invalid.
3047 * - (-EINVAL) if bad parameter.
3050 rte_eth_dev_set_vf_vlan_filter(uint8_t port, uint16_t vlan_id,
3055 * Set a traffic mirroring rule on an Ethernet device
3058 * The port identifier of the Ethernet device.
3059 * @param mirror_conf
3060 * The pointer to the traffic mirroring structure describing the mirroring rule.
3061 * The *rte_eth_vm_mirror_conf* structure includes the type of mirroring rule,
3062 * destination pool and the value of rule if enable vlan or pool mirroring.
3065 * The index of traffic mirroring rule, we support four separated rules.
3067 * 1 - Enable a mirroring rule.
3068 * 0 - Disable a mirroring rule.
3070 * - (0) if successful.
3071 * - (-ENOTSUP) if hardware doesn't support this feature.
3072 * - (-ENODEV) if *port_id* invalid.
3073 * - (-EINVAL) if the mr_conf information is not correct.
3075 int rte_eth_mirror_rule_set(uint8_t port_id,
3076 struct rte_eth_mirror_conf *mirror_conf,
3081 * Reset a traffic mirroring rule on an Ethernet device.
3084 * The port identifier of the Ethernet device.
3086 * The index of traffic mirroring rule, we support four separated rules.
3088 * - (0) if successful.
3089 * - (-ENOTSUP) if hardware doesn't support this feature.
3090 * - (-ENODEV) if *port_id* invalid.
3091 * - (-EINVAL) if bad parameter.
3093 int rte_eth_mirror_rule_reset(uint8_t port_id,
3097 * Set the rate limitation for a queue on an Ethernet device.
3100 * The port identifier of the Ethernet device.
3104 * The tx rate allocated from the total link speed for this queue.
3106 * - (0) if successful.
3107 * - (-ENOTSUP) if hardware doesn't support this feature.
3108 * - (-ENODEV) if *port_id* invalid.
3109 * - (-EINVAL) if bad parameter.
3111 int rte_eth_set_queue_rate_limit(uint8_t port_id, uint16_t queue_idx,
3115 * Set the rate limitation for a vf on an Ethernet device.
3118 * The port identifier of the Ethernet device.
3122 * The tx rate allocated from the total link speed for this VF id.
3124 * The queue mask which need to set the rate.
3126 * - (0) if successful.
3127 * - (-ENOTSUP) if hardware doesn't support this feature.
3128 * - (-ENODEV) if *port_id* invalid.
3129 * - (-EINVAL) if bad parameter.
3131 int rte_eth_set_vf_rate_limit(uint8_t port_id, uint16_t vf,
3132 uint16_t tx_rate, uint64_t q_msk);
3135 * Initialize bypass logic. This function needs to be called before
3136 * executing any other bypass API.
3139 * The port identifier of the Ethernet device.
3141 * - (0) if successful.
3142 * - (-ENOTSUP) if hardware doesn't support.
3143 * - (-EINVAL) if bad parameter.
3145 int rte_eth_dev_bypass_init(uint8_t port);
3148 * Return bypass state.
3151 * The port identifier of the Ethernet device.
3153 * The return bypass state.
3156 * - (3) Isolate mode
3158 * - (0) if successful.
3159 * - (-ENOTSUP) if hardware doesn't support.
3160 * - (-EINVAL) if bad parameter.
3162 int rte_eth_dev_bypass_state_show(uint8_t port, uint32_t *state);
3168 * The port identifier of the Ethernet device.
3170 * The current bypass state.
3173 * - (3) Isolate mode
3175 * - (0) if successful.
3176 * - (-ENOTSUP) if hardware doesn't support.
3177 * - (-EINVAL) if bad parameter.
3179 int rte_eth_dev_bypass_state_set(uint8_t port, uint32_t *new_state);
3182 * Return bypass state when given event occurs.
3185 * The port identifier of the Ethernet device.
3188 * - (1) Main power on (power button is pushed)
3189 * - (2) Auxiliary power on (power supply is being plugged)
3190 * - (3) Main power off (system shutdown and power supply is left plugged in)
3191 * - (4) Auxiliary power off (power supply is being unplugged)
3192 * - (5) Display or set the watchdog timer
3194 * The bypass state when given event occurred.
3197 * - (3) Isolate mode
3199 * - (0) if successful.
3200 * - (-ENOTSUP) if hardware doesn't support.
3201 * - (-EINVAL) if bad parameter.
3203 int rte_eth_dev_bypass_event_show(uint8_t port, uint32_t event, uint32_t *state);
3206 * Set bypass state when given event occurs.
3209 * The port identifier of the Ethernet device.
3212 * - (1) Main power on (power button is pushed)
3213 * - (2) Auxiliary power on (power supply is being plugged)
3214 * - (3) Main power off (system shutdown and power supply is left plugged in)
3215 * - (4) Auxiliary power off (power supply is being unplugged)
3216 * - (5) Display or set the watchdog timer
3218 * The assigned state when given event occurs.
3221 * - (3) Isolate mode
3223 * - (0) if successful.
3224 * - (-ENOTSUP) if hardware doesn't support.
3225 * - (-EINVAL) if bad parameter.
3227 int rte_eth_dev_bypass_event_store(uint8_t port, uint32_t event, uint32_t state);
3230 * Set bypass watchdog timeout count.
3233 * The port identifier of the Ethernet device.
3235 * The timeout to be set.
3236 * - (0) 0 seconds (timer is off)
3245 * - (0) if successful.
3246 * - (-ENOTSUP) if hardware doesn't support.
3247 * - (-EINVAL) if bad parameter.
3249 int rte_eth_dev_wd_timeout_store(uint8_t port, uint32_t timeout);
3252 * Get bypass firmware version.
3255 * The port identifier of the Ethernet device.
3257 * The firmware version
3259 * - (0) if successful.
3260 * - (-ENOTSUP) if hardware doesn't support.
3261 * - (-EINVAL) if bad parameter.
3263 int rte_eth_dev_bypass_ver_show(uint8_t port, uint32_t *ver);
3266 * Return bypass watchdog timeout in seconds
3269 * The port identifier of the Ethernet device.
3271 * The return watchdog timeout. "0" represents timer expired
3272 * - (0) 0 seconds (timer is off)
3281 * - (0) if successful.
3282 * - (-ENOTSUP) if hardware doesn't support.
3283 * - (-EINVAL) if bad parameter.
3285 int rte_eth_dev_bypass_wd_timeout_show(uint8_t port, uint32_t *wd_timeout);
3288 * Reset bypass watchdog timer
3291 * The port identifier of the Ethernet device.
3293 * - (0) if successful.
3294 * - (-ENOTSUP) if hardware doesn't support.
3295 * - (-EINVAL) if bad parameter.
3297 int rte_eth_dev_bypass_wd_reset(uint8_t port);
3300 * Configuration of Receive Side Scaling hash computation of Ethernet device.
3303 * The port identifier of the Ethernet device.
3305 * The new configuration to use for RSS hash computation on the port.
3307 * - (0) if successful.
3308 * - (-ENODEV) if port identifier is invalid.
3309 * - (-ENOTSUP) if hardware doesn't support.
3310 * - (-EINVAL) if bad parameter.
3312 int rte_eth_dev_rss_hash_update(uint8_t port_id,
3313 struct rte_eth_rss_conf *rss_conf);
3316 * Retrieve current configuration of Receive Side Scaling hash computation
3317 * of Ethernet device.
3320 * The port identifier of the Ethernet device.
3322 * Where to store the current RSS hash configuration of the Ethernet device.
3324 * - (0) if successful.
3325 * - (-ENODEV) if port identifier is invalid.
3326 * - (-ENOTSUP) if hardware doesn't support RSS.
3329 rte_eth_dev_rss_hash_conf_get(uint8_t port_id,
3330 struct rte_eth_rss_conf *rss_conf);
3333 * Add UDP tunneling port of an Ethernet device for filtering a specific
3334 * tunneling packet by UDP port number.
3337 * The port identifier of the Ethernet device.
3339 * UDP tunneling configuration.
3342 * - (0) if successful.
3343 * - (-ENODEV) if port identifier is invalid.
3344 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3347 rte_eth_dev_udp_tunnel_add(uint8_t port_id,
3348 struct rte_eth_udp_tunnel *tunnel_udp);
3351 * Detete UDP tunneling port configuration of Ethernet device
3354 * The port identifier of the Ethernet device.
3356 * UDP tunneling configuration.
3359 * - (0) if successful.
3360 * - (-ENODEV) if port identifier is invalid.
3361 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3364 rte_eth_dev_udp_tunnel_delete(uint8_t port_id,
3365 struct rte_eth_udp_tunnel *tunnel_udp);
3368 * Check whether the filter type is supported on an Ethernet device.
3369 * All the supported filter types are defined in 'rte_eth_ctrl.h'.
3372 * The port identifier of the Ethernet device.
3373 * @param filter_type
3376 * - (0) if successful.
3377 * - (-ENOTSUP) if hardware doesn't support this filter type.
3378 * - (-ENODEV) if *port_id* invalid.
3380 int rte_eth_dev_filter_supported(uint8_t port_id, enum rte_filter_type filter_type);
3383 * Take operations to assigned filter type on an Ethernet device.
3384 * All the supported operations and filter types are defined in 'rte_eth_ctrl.h'.
3387 * The port identifier of the Ethernet device.
3388 * @param filter_type
3391 * Type of operation.
3393 * A pointer to arguments defined specifically for the operation.
3395 * - (0) if successful.
3396 * - (-ENOTSUP) if hardware doesn't support.
3397 * - (-ENODEV) if *port_id* invalid.
3398 * - others depends on the specific operations implementation.
3400 int rte_eth_dev_filter_ctrl(uint8_t port_id, enum rte_filter_type filter_type,
3401 enum rte_filter_op filter_op, void *arg);
3404 * Get DCB information on an Ethernet device.
3407 * The port identifier of the Ethernet device.
3411 * - (0) if successful.
3412 * - (-ENODEV) if port identifier is invalid.
3413 * - (-ENOTSUP) if hardware doesn't support.
3415 int rte_eth_dev_get_dcb_info(uint8_t port_id,
3416 struct rte_eth_dcb_info *dcb_info);
3419 * Add a callback to be called on packet RX on a given port and queue.
3421 * This API configures a function to be called for each burst of
3422 * packets received on a given NIC port queue. The return value is a pointer
3423 * that can be used to later remove the callback using
3424 * rte_eth_remove_rx_callback().
3426 * Multiple functions are called in the order that they are added.
3429 * The port identifier of the Ethernet device.
3431 * The queue on the Ethernet device on which the callback is to be added.
3433 * The callback function
3435 * A generic pointer parameter which will be passed to each invocation of the
3436 * callback function on this port and queue.
3440 * On success, a pointer value which can later be used to remove the callback.
3442 void *rte_eth_add_rx_callback(uint8_t port_id, uint16_t queue_id,
3443 rte_rx_callback_fn fn, void *user_param);
3446 * Add a callback to be called on packet TX on a given port and queue.
3448 * This API configures a function to be called for each burst of
3449 * packets sent on a given NIC port queue. The return value is a pointer
3450 * that can be used to later remove the callback using
3451 * rte_eth_remove_tx_callback().
3453 * Multiple functions are called in the order that they are added.
3456 * The port identifier of the Ethernet device.
3458 * The queue on the Ethernet device on which the callback is to be added.
3460 * The callback function
3462 * A generic pointer parameter which will be passed to each invocation of the
3463 * callback function on this port and queue.
3467 * On success, a pointer value which can later be used to remove the callback.
3469 void *rte_eth_add_tx_callback(uint8_t port_id, uint16_t queue_id,
3470 rte_tx_callback_fn fn, void *user_param);
3473 * Remove an RX packet callback from a given port and queue.
3475 * This function is used to removed callbacks that were added to a NIC port
3476 * queue using rte_eth_add_rx_callback().
3478 * Note: the callback is removed from the callback list but it isn't freed
3479 * since the it may still be in use. The memory for the callback can be
3480 * subsequently freed back by the application by calling rte_free():
3482 * - Immediately - if the port is stopped, or the user knows that no
3483 * callbacks are in flight e.g. if called from the thread doing RX/TX
3486 * - After a short delay - where the delay is sufficient to allow any
3487 * in-flight callbacks to complete.
3490 * The port identifier of the Ethernet device.
3492 * The queue on the Ethernet device from which the callback is to be removed.
3494 * User supplied callback created via rte_eth_add_rx_callback().
3497 * - 0: Success. Callback was removed.
3498 * - -ENOTSUP: Callback support is not available.
3499 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
3500 * is NULL or not found for the port/queue.
3502 int rte_eth_remove_rx_callback(uint8_t port_id, uint16_t queue_id,
3503 struct rte_eth_rxtx_callback *user_cb);
3506 * Remove a TX packet callback from a given port and queue.
3508 * This function is used to removed callbacks that were added to a NIC port
3509 * queue using rte_eth_add_tx_callback().
3511 * Note: the callback is removed from the callback list but it isn't freed
3512 * since the it may still be in use. The memory for the callback can be
3513 * subsequently freed back by the application by calling rte_free():
3515 * - Immediately - if the port is stopped, or the user knows that no
3516 * callbacks are in flight e.g. if called from the thread doing RX/TX
3519 * - After a short delay - where the delay is sufficient to allow any
3520 * in-flight callbacks to complete.
3523 * The port identifier of the Ethernet device.
3525 * The queue on the Ethernet device from which the callback is to be removed.
3527 * User supplied callback created via rte_eth_add_tx_callback().
3530 * - 0: Success. Callback was removed.
3531 * - -ENOTSUP: Callback support is not available.
3532 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
3533 * is NULL or not found for the port/queue.
3535 int rte_eth_remove_tx_callback(uint8_t port_id, uint16_t queue_id,
3536 struct rte_eth_rxtx_callback *user_cb);
3539 * Retrieve information about given port's RX queue.
3542 * The port identifier of the Ethernet device.
3544 * The RX queue on the Ethernet device for which information
3545 * will be retrieved.
3547 * A pointer to a structure of type *rte_eth_rxq_info_info* to be filled with
3548 * the information of the Ethernet device.
3552 * - -ENOTSUP: routine is not supported by the device PMD.
3553 * - -EINVAL: The port_id or the queue_id is out of range.
3555 int rte_eth_rx_queue_info_get(uint8_t port_id, uint16_t queue_id,
3556 struct rte_eth_rxq_info *qinfo);
3559 * Retrieve information about given port's TX queue.
3562 * The port identifier of the Ethernet device.
3564 * The TX queue on the Ethernet device for which information
3565 * will be retrieved.
3567 * A pointer to a structure of type *rte_eth_txq_info_info* to be filled with
3568 * the information of the Ethernet device.
3572 * - -ENOTSUP: routine is not supported by the device PMD.
3573 * - -EINVAL: The port_id or the queue_id is out of range.
3575 int rte_eth_tx_queue_info_get(uint8_t port_id, uint16_t queue_id,
3576 struct rte_eth_txq_info *qinfo);
3579 * Retrieve number of available registers for access
3582 * The port identifier of the Ethernet device.
3584 * - (>=0) number of registers if successful.
3585 * - (-ENOTSUP) if hardware doesn't support.
3586 * - (-ENODEV) if *port_id* invalid.
3587 * - others depends on the specific operations implementation.
3589 int rte_eth_dev_get_reg_length(uint8_t port_id);
3592 * Retrieve device registers and register attributes
3595 * The port identifier of the Ethernet device.
3597 * The template includes buffer for register data and attribute to be filled.
3599 * - (0) if successful.
3600 * - (-ENOTSUP) if hardware doesn't support.
3601 * - (-ENODEV) if *port_id* invalid.
3602 * - others depends on the specific operations implementation.
3604 int rte_eth_dev_get_reg_info(uint8_t port_id, struct rte_dev_reg_info *info);
3607 * Retrieve size of device EEPROM
3610 * The port identifier of the Ethernet device.
3612 * - (>=0) EEPROM size if successful.
3613 * - (-ENOTSUP) if hardware doesn't support.
3614 * - (-ENODEV) if *port_id* invalid.
3615 * - others depends on the specific operations implementation.
3617 int rte_eth_dev_get_eeprom_length(uint8_t port_id);
3620 * Retrieve EEPROM and EEPROM attribute
3623 * The port identifier of the Ethernet device.
3625 * The template includes buffer for return EEPROM data and
3626 * EEPROM attributes to be filled.
3628 * - (0) if successful.
3629 * - (-ENOTSUP) if hardware doesn't support.
3630 * - (-ENODEV) if *port_id* invalid.
3631 * - others depends on the specific operations implementation.
3633 int rte_eth_dev_get_eeprom(uint8_t port_id, struct rte_dev_eeprom_info *info);
3636 * Program EEPROM with provided data
3639 * The port identifier of the Ethernet device.
3641 * The template includes EEPROM data for programming and
3642 * EEPROM attributes to be filled
3644 * - (0) if successful.
3645 * - (-ENOTSUP) if hardware doesn't support.
3646 * - (-ENODEV) if *port_id* invalid.
3647 * - others depends on the specific operations implementation.
3649 int rte_eth_dev_set_eeprom(uint8_t port_id, struct rte_dev_eeprom_info *info);
3652 * Set the list of multicast addresses to filter on an Ethernet device.
3655 * The port identifier of the Ethernet device.
3656 * @param mc_addr_set
3657 * The array of multicast addresses to set. Equal to NULL when the function
3658 * is invoked to flush the set of filtered addresses.
3660 * The number of multicast addresses in the *mc_addr_set* array. Equal to 0
3661 * when the function is invoked to flush the set of filtered addresses.
3663 * - (0) if successful.
3664 * - (-ENODEV) if *port_id* invalid.
3665 * - (-ENOTSUP) if PMD of *port_id* doesn't support multicast filtering.
3666 * - (-ENOSPC) if *port_id* has not enough multicast filtering resources.
3668 int rte_eth_dev_set_mc_addr_list(uint8_t port_id,
3669 struct ether_addr *mc_addr_set,
3670 uint32_t nb_mc_addr);
3673 * Enable IEEE1588/802.1AS timestamping for an Ethernet device.
3676 * The port identifier of the Ethernet device.
3680 * - -ENODEV: The port ID is invalid.
3681 * - -ENOTSUP: The function is not supported by the Ethernet driver.
3683 extern int rte_eth_timesync_enable(uint8_t port_id);
3686 * Disable IEEE1588/802.1AS timestamping for an Ethernet device.
3689 * The port identifier of the Ethernet device.
3693 * - -ENODEV: The port ID is invalid.
3694 * - -ENOTSUP: The function is not supported by the Ethernet driver.
3696 extern int rte_eth_timesync_disable(uint8_t port_id);
3699 * Read an IEEE1588/802.1AS RX timestamp from an Ethernet device.
3702 * The port identifier of the Ethernet device.
3704 * Pointer to the timestamp struct.
3706 * Device specific flags. Used to pass the RX timesync register index to
3707 * i40e. Unused in igb/ixgbe, pass 0 instead.
3711 * - -EINVAL: No timestamp is available.
3712 * - -ENODEV: The port ID is invalid.
3713 * - -ENOTSUP: The function is not supported by the Ethernet driver.
3715 extern int rte_eth_timesync_read_rx_timestamp(uint8_t port_id,
3716 struct timespec *timestamp,
3720 * Read an IEEE1588/802.1AS TX timestamp from an Ethernet device.
3723 * The port identifier of the Ethernet device.
3725 * Pointer to the timestamp struct.
3729 * - -EINVAL: No timestamp is available.
3730 * - -ENODEV: The port ID is invalid.
3731 * - -ENOTSUP: The function is not supported by the Ethernet driver.
3733 extern int rte_eth_timesync_read_tx_timestamp(uint8_t port_id,
3734 struct timespec *timestamp);
3740 #endif /* _RTE_ETHDEV_H_ */