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 * This enum indicates the flow control mode
658 enum rte_eth_fc_mode {
659 RTE_FC_NONE = 0, /**< Disable flow control. */
660 RTE_FC_RX_PAUSE, /**< RX pause frame, enable flowctrl on TX side. */
661 RTE_FC_TX_PAUSE, /**< TX pause frame, enable flowctrl on RX side. */
662 RTE_FC_FULL /**< Enable flow control on both side. */
666 * A structure used to configure Ethernet flow control parameter.
667 * These parameters will be configured into the register of the NIC.
668 * Please refer to the corresponding data sheet for proper value.
670 struct rte_eth_fc_conf {
671 uint32_t high_water; /**< High threshold value to trigger XOFF */
672 uint32_t low_water; /**< Low threshold value to trigger XON */
673 uint16_t pause_time; /**< Pause quota in the Pause frame */
674 uint16_t send_xon; /**< Is XON frame need be sent */
675 enum rte_eth_fc_mode mode; /**< Link flow control mode */
676 uint8_t mac_ctrl_frame_fwd; /**< Forward MAC control frames */
677 uint8_t autoneg; /**< Use Pause autoneg */
681 * A structure used to configure Ethernet priority flow control parameter.
682 * These parameters will be configured into the register of the NIC.
683 * Please refer to the corresponding data sheet for proper value.
685 struct rte_eth_pfc_conf {
686 struct rte_eth_fc_conf fc; /**< General flow control parameter. */
687 uint8_t priority; /**< VLAN User Priority. */
691 * Memory space that can be configured to store Flow Director filters
692 * in the board memory.
694 enum rte_fdir_pballoc_type {
695 RTE_FDIR_PBALLOC_64K = 0, /**< 64k. */
696 RTE_FDIR_PBALLOC_128K, /**< 128k. */
697 RTE_FDIR_PBALLOC_256K, /**< 256k. */
701 * Select report mode of FDIR hash information in RX descriptors.
703 enum rte_fdir_status_mode {
704 RTE_FDIR_NO_REPORT_STATUS = 0, /**< Never report FDIR hash. */
705 RTE_FDIR_REPORT_STATUS, /**< Only report FDIR hash for matching pkts. */
706 RTE_FDIR_REPORT_STATUS_ALWAYS, /**< Always report FDIR hash. */
710 * A structure used to configure the Flow Director (FDIR) feature
711 * of an Ethernet port.
713 * If mode is RTE_FDIR_DISABLE, the pballoc value is ignored.
715 struct rte_fdir_conf {
716 enum rte_fdir_mode mode; /**< Flow Director mode. */
717 enum rte_fdir_pballoc_type pballoc; /**< Space for FDIR filters. */
718 enum rte_fdir_status_mode status; /**< How to report FDIR hash. */
719 /** RX queue of packets matching a "drop" filter in perfect mode. */
721 struct rte_eth_fdir_masks mask;
722 struct rte_eth_fdir_flex_conf flex_conf;
723 /**< Flex payload configuration. */
727 * UDP tunneling configuration.
729 struct rte_eth_udp_tunnel {
735 * A structure used to enable/disable specific device interrupts.
737 struct rte_intr_conf {
738 /** enable/disable lsc interrupt. 0 (default) - disable, 1 enable */
740 /** enable/disable rxq interrupt. 0 (default) - disable, 1 enable */
745 * A structure used to configure an Ethernet port.
746 * Depending upon the RX multi-queue mode, extra advanced
747 * configuration settings may be needed.
749 struct rte_eth_conf {
751 /**< ETH_LINK_SPEED_10[0|00|000], or 0 for autonegotation */
752 uint16_t link_duplex;
753 /**< ETH_LINK_[HALF_DUPLEX|FULL_DUPLEX], or 0 for autonegotation */
754 struct rte_eth_rxmode rxmode; /**< Port RX configuration. */
755 struct rte_eth_txmode txmode; /**< Port TX configuration. */
756 uint32_t lpbk_mode; /**< Loopback operation mode. By default the value
757 is 0, meaning the loopback mode is disabled.
758 Read the datasheet of given ethernet controller
759 for details. The possible values of this field
760 are defined in implementation of each driver. */
762 struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
763 struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
764 /**< Port vmdq+dcb configuration. */
765 struct rte_eth_dcb_rx_conf dcb_rx_conf;
766 /**< Port dcb RX configuration. */
767 struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
768 /**< Port vmdq RX configuration. */
769 } rx_adv_conf; /**< Port RX filtering configuration (union). */
771 struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
772 /**< Port vmdq+dcb TX configuration. */
773 struct rte_eth_dcb_tx_conf dcb_tx_conf;
774 /**< Port dcb TX configuration. */
775 struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
776 /**< Port vmdq TX configuration. */
777 } tx_adv_conf; /**< Port TX DCB configuration (union). */
778 /** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
779 is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
780 uint32_t dcb_capability_en;
781 struct rte_fdir_conf fdir_conf; /**< FDIR configuration. */
782 struct rte_intr_conf intr_conf; /**< Interrupt mode configuration. */
786 * A structure used to retrieve the contextual information of
787 * an Ethernet device, such as the controlling driver of the device,
788 * its PCI context, etc...
792 * RX offload capabilities of a device.
794 #define DEV_RX_OFFLOAD_VLAN_STRIP 0x00000001
795 #define DEV_RX_OFFLOAD_IPV4_CKSUM 0x00000002
796 #define DEV_RX_OFFLOAD_UDP_CKSUM 0x00000004
797 #define DEV_RX_OFFLOAD_TCP_CKSUM 0x00000008
798 #define DEV_RX_OFFLOAD_TCP_LRO 0x00000010
799 #define DEV_RX_OFFLOAD_QINQ_STRIP 0x00000020
802 * TX offload capabilities of a device.
804 #define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001
805 #define DEV_TX_OFFLOAD_IPV4_CKSUM 0x00000002
806 #define DEV_TX_OFFLOAD_UDP_CKSUM 0x00000004
807 #define DEV_TX_OFFLOAD_TCP_CKSUM 0x00000008
808 #define DEV_TX_OFFLOAD_SCTP_CKSUM 0x00000010
809 #define DEV_TX_OFFLOAD_TCP_TSO 0x00000020
810 #define DEV_TX_OFFLOAD_UDP_TSO 0x00000040
811 #define DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000080 /**< Used for tunneling packet. */
812 #define DEV_TX_OFFLOAD_QINQ_INSERT 0x00000100
814 struct rte_eth_dev_info {
815 struct rte_pci_device *pci_dev; /**< Device PCI information. */
816 const char *driver_name; /**< Device Driver name. */
817 unsigned int if_index; /**< Index to bound host interface, or 0 if none.
818 Use if_indextoname() to translate into an interface name. */
819 uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
820 uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
821 uint16_t max_rx_queues; /**< Maximum number of RX queues. */
822 uint16_t max_tx_queues; /**< Maximum number of TX queues. */
823 uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
824 uint32_t max_hash_mac_addrs;
825 /** Maximum number of hash MAC addresses for MTA and UTA. */
826 uint16_t max_vfs; /**< Maximum number of VFs. */
827 uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
828 uint32_t rx_offload_capa; /**< Device RX offload capabilities. */
829 uint32_t tx_offload_capa; /**< Device TX offload capabilities. */
831 /**< Device redirection table size, the total number of entries. */
832 uint8_t hash_key_size; /**< Hash key size in bytes */
833 /** Bit mask of RSS offloads, the bit offset also means flow type */
834 uint64_t flow_type_rss_offloads;
835 struct rte_eth_rxconf default_rxconf; /**< Default RX configuration */
836 struct rte_eth_txconf default_txconf; /**< Default TX configuration */
837 uint16_t vmdq_queue_base; /**< First queue ID for VMDQ pools. */
838 uint16_t vmdq_queue_num; /**< Queue number for VMDQ pools. */
839 uint16_t vmdq_pool_base; /**< First ID of VMDQ pools. */
842 /** Maximum name length for extended statistics counters */
843 #define RTE_ETH_XSTATS_NAME_SIZE 64
846 * An Ethernet device extended statistic structure
848 * This structure is used by ethdev->eth_xstats_get() to provide
849 * statistics that are not provided in the generic rte_eth_stats
852 struct rte_eth_xstats {
853 char name[RTE_ETH_XSTATS_NAME_SIZE];
857 #define ETH_DCB_NUM_TCS 8
858 #define ETH_MAX_VMDQ_POOL 64
861 * A structure used to get the information of queue and
862 * TC mapping on both TX and RX paths.
864 struct rte_eth_dcb_tc_queue_mapping {
865 /** rx queues assigned to tc per Pool */
869 } tc_rxq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
870 /** rx queues assigned to tc per Pool */
874 } tc_txq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
878 * A structure used to get the information of DCB.
879 * It includes TC UP mapping and queue TC mapping.
881 struct rte_eth_dcb_info {
882 uint8_t nb_tcs; /**< number of TCs */
883 uint8_t prio_tc[ETH_DCB_NUM_USER_PRIORITIES]; /**< Priority to tc */
884 uint8_t tc_bws[ETH_DCB_NUM_TCS]; /**< TX BW percentage for each TC */
885 /** rx queues assigned to tc */
886 struct rte_eth_dcb_tc_queue_mapping tc_queue;
891 struct rte_eth_dev_callback;
892 /** @internal Structure to keep track of registered callbacks */
893 TAILQ_HEAD(rte_eth_dev_cb_list, rte_eth_dev_callback);
896 * Definitions of all functions exported by an Ethernet driver through the
897 * the generic structure of type *eth_dev_ops* supplied in the *rte_eth_dev*
898 * structure associated with an Ethernet device.
901 typedef int (*eth_dev_configure_t)(struct rte_eth_dev *dev);
902 /**< @internal Ethernet device configuration. */
904 typedef int (*eth_dev_start_t)(struct rte_eth_dev *dev);
905 /**< @internal Function used to start a configured Ethernet device. */
907 typedef void (*eth_dev_stop_t)(struct rte_eth_dev *dev);
908 /**< @internal Function used to stop a configured Ethernet device. */
910 typedef int (*eth_dev_set_link_up_t)(struct rte_eth_dev *dev);
911 /**< @internal Function used to link up a configured Ethernet device. */
913 typedef int (*eth_dev_set_link_down_t)(struct rte_eth_dev *dev);
914 /**< @internal Function used to link down a configured Ethernet device. */
916 typedef void (*eth_dev_close_t)(struct rte_eth_dev *dev);
917 /**< @internal Function used to close a configured Ethernet device. */
919 typedef void (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev);
920 /**< @internal Function used to enable the RX promiscuous mode of an Ethernet device. */
922 typedef void (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev);
923 /**< @internal Function used to disable the RX promiscuous mode of an Ethernet device. */
925 typedef void (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
926 /**< @internal Enable the receipt of all multicast packets by an Ethernet device. */
928 typedef void (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
929 /**< @internal Disable the receipt of all multicast packets by an Ethernet device. */
931 typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
932 int wait_to_complete);
933 /**< @internal Get link speed, duplex mode and state (up/down) of an Ethernet device. */
935 typedef void (*eth_stats_get_t)(struct rte_eth_dev *dev,
936 struct rte_eth_stats *igb_stats);
937 /**< @internal Get global I/O statistics of an Ethernet device. */
939 typedef void (*eth_stats_reset_t)(struct rte_eth_dev *dev);
940 /**< @internal Reset global I/O statistics of an Ethernet device to 0. */
942 typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev,
943 struct rte_eth_xstats *stats, unsigned n);
944 /**< @internal Get extended stats of an Ethernet device. */
946 typedef void (*eth_xstats_reset_t)(struct rte_eth_dev *dev);
947 /**< @internal Reset extended stats of an Ethernet device. */
949 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
953 /**< @internal Set a queue statistics mapping for a tx/rx queue of an Ethernet device. */
955 typedef void (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
956 struct rte_eth_dev_info *dev_info);
957 /**< @internal Get specific informations of an Ethernet device. */
959 typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
961 /**< @internal Start rx and tx of a queue of an Ethernet device. */
963 typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
965 /**< @internal Stop rx and tx of a queue of an Ethernet device. */
967 typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
968 uint16_t rx_queue_id,
970 unsigned int socket_id,
971 const struct rte_eth_rxconf *rx_conf,
972 struct rte_mempool *mb_pool);
973 /**< @internal Set up a receive queue of an Ethernet device. */
975 typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
976 uint16_t tx_queue_id,
978 unsigned int socket_id,
979 const struct rte_eth_txconf *tx_conf);
980 /**< @internal Setup a transmit queue of an Ethernet device. */
982 typedef int (*eth_rx_enable_intr_t)(struct rte_eth_dev *dev,
983 uint16_t rx_queue_id);
984 /**< @internal Enable interrupt of a receive queue of an Ethernet device. */
986 typedef int (*eth_rx_disable_intr_t)(struct rte_eth_dev *dev,
987 uint16_t rx_queue_id);
988 /**< @internal Disable interrupt of a receive queue of an Ethernet device. */
990 typedef void (*eth_queue_release_t)(void *queue);
991 /**< @internal Release memory resources allocated by given RX/TX queue. */
993 typedef uint32_t (*eth_rx_queue_count_t)(struct rte_eth_dev *dev,
994 uint16_t rx_queue_id);
995 /**< @internal Get number of available descriptors on a receive queue of an Ethernet device. */
997 typedef int (*eth_rx_descriptor_done_t)(void *rxq, uint16_t offset);
998 /**< @internal Check DD bit of specific RX descriptor */
1000 typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);
1001 /**< @internal Set MTU. */
1003 typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
1006 /**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */
1008 typedef void (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
1010 /**< @internal set the outer VLAN-TPID by an Ethernet device. */
1012 typedef void (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
1013 /**< @internal set VLAN offload function by an Ethernet device. */
1015 typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
1018 /**< @internal set port based TX VLAN insertion by an Ethernet device. */
1020 typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
1021 uint16_t rx_queue_id,
1023 /**< @internal VLAN stripping enable/disable by an queue of Ethernet device. */
1025 typedef uint16_t (*eth_rx_burst_t)(void *rxq,
1026 struct rte_mbuf **rx_pkts,
1028 /**< @internal Retrieve input packets from a receive queue of an Ethernet device. */
1030 typedef uint16_t (*eth_tx_burst_t)(void *txq,
1031 struct rte_mbuf **tx_pkts,
1033 /**< @internal Send output packets on a transmit queue of an Ethernet device. */
1035 typedef int (*flow_ctrl_get_t)(struct rte_eth_dev *dev,
1036 struct rte_eth_fc_conf *fc_conf);
1037 /**< @internal Get current flow control parameter on an Ethernet device */
1039 typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
1040 struct rte_eth_fc_conf *fc_conf);
1041 /**< @internal Setup flow control parameter on an Ethernet device */
1043 typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
1044 struct rte_eth_pfc_conf *pfc_conf);
1045 /**< @internal Setup priority flow control parameter on an Ethernet device */
1047 typedef int (*reta_update_t)(struct rte_eth_dev *dev,
1048 struct rte_eth_rss_reta_entry64 *reta_conf,
1049 uint16_t reta_size);
1050 /**< @internal Update RSS redirection table on an Ethernet device */
1052 typedef int (*reta_query_t)(struct rte_eth_dev *dev,
1053 struct rte_eth_rss_reta_entry64 *reta_conf,
1054 uint16_t reta_size);
1055 /**< @internal Query RSS redirection table on an Ethernet device */
1057 typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
1058 struct rte_eth_rss_conf *rss_conf);
1059 /**< @internal Update RSS hash configuration of an Ethernet device */
1061 typedef int (*rss_hash_conf_get_t)(struct rte_eth_dev *dev,
1062 struct rte_eth_rss_conf *rss_conf);
1063 /**< @internal Get current RSS hash configuration of an Ethernet device */
1065 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
1066 /**< @internal Turn on SW controllable LED on an Ethernet device */
1068 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
1069 /**< @internal Turn off SW controllable LED on an Ethernet device */
1071 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
1072 /**< @internal Remove MAC address from receive address register */
1074 typedef void (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
1075 struct ether_addr *mac_addr,
1078 /**< @internal Set a MAC address into Receive Address Address Register */
1080 typedef void (*eth_mac_addr_set_t)(struct rte_eth_dev *dev,
1081 struct ether_addr *mac_addr);
1082 /**< @internal Set a MAC address into Receive Address Address Register */
1084 typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
1085 struct ether_addr *mac_addr,
1087 /**< @internal Set a Unicast Hash bitmap */
1089 typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
1091 /**< @internal Set all Unicast Hash bitmap */
1093 typedef int (*eth_set_vf_rx_mode_t)(struct rte_eth_dev *dev,
1097 /**< @internal Set a VF receive mode */
1099 typedef int (*eth_set_vf_rx_t)(struct rte_eth_dev *dev,
1102 /**< @internal Set a VF receive mode */
1104 typedef int (*eth_set_vf_tx_t)(struct rte_eth_dev *dev,
1107 /**< @internal Enable or disable a VF transmit */
1109 typedef int (*eth_set_vf_vlan_filter_t)(struct rte_eth_dev *dev,
1113 /**< @internal Set VF VLAN pool filter */
1115 typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
1118 /**< @internal Set queue TX rate */
1120 typedef int (*eth_set_vf_rate_limit_t)(struct rte_eth_dev *dev,
1124 /**< @internal Set VF TX rate */
1126 typedef int (*eth_mirror_rule_set_t)(struct rte_eth_dev *dev,
1127 struct rte_eth_mirror_conf *mirror_conf,
1130 /**< @internal Add a traffic mirroring rule on an Ethernet device */
1132 typedef int (*eth_mirror_rule_reset_t)(struct rte_eth_dev *dev,
1134 /**< @internal Remove a traffic mirroring rule on an Ethernet device */
1136 typedef int (*eth_udp_tunnel_add_t)(struct rte_eth_dev *dev,
1137 struct rte_eth_udp_tunnel *tunnel_udp);
1138 /**< @internal Add tunneling UDP info */
1140 typedef int (*eth_udp_tunnel_del_t)(struct rte_eth_dev *dev,
1141 struct rte_eth_udp_tunnel *tunnel_udp);
1142 /**< @internal Delete tunneling UDP info */
1144 typedef int (*eth_set_mc_addr_list_t)(struct rte_eth_dev *dev,
1145 struct ether_addr *mc_addr_set,
1146 uint32_t nb_mc_addr);
1147 /**< @internal set the list of multicast addresses on an Ethernet device */
1149 typedef int (*eth_timesync_enable_t)(struct rte_eth_dev *dev);
1150 /**< @internal Function used to enable IEEE1588/802.1AS timestamping. */
1152 typedef int (*eth_timesync_disable_t)(struct rte_eth_dev *dev);
1153 /**< @internal Function used to disable IEEE1588/802.1AS timestamping. */
1155 typedef int (*eth_timesync_read_rx_timestamp_t)(struct rte_eth_dev *dev,
1156 struct timespec *timestamp,
1158 /**< @internal Function used to read an RX IEEE1588/802.1AS timestamp. */
1160 typedef int (*eth_timesync_read_tx_timestamp_t)(struct rte_eth_dev *dev,
1161 struct timespec *timestamp);
1162 /**< @internal Function used to read a TX IEEE1588/802.1AS timestamp. */
1164 typedef int (*eth_get_reg_length_t)(struct rte_eth_dev *dev);
1165 /**< @internal Retrieve device register count */
1167 typedef int (*eth_get_reg_t)(struct rte_eth_dev *dev,
1168 struct rte_dev_reg_info *info);
1169 /**< @internal Retrieve registers */
1171 typedef int (*eth_get_eeprom_length_t)(struct rte_eth_dev *dev);
1172 /**< @internal Retrieve eeprom size */
1174 typedef int (*eth_get_eeprom_t)(struct rte_eth_dev *dev,
1175 struct rte_dev_eeprom_info *info);
1176 /**< @internal Retrieve eeprom data */
1178 typedef int (*eth_set_eeprom_t)(struct rte_eth_dev *dev,
1179 struct rte_dev_eeprom_info *info);
1180 /**< @internal Program eeprom data */
1182 #ifdef RTE_NIC_BYPASS
1185 RTE_BYPASS_MODE_NONE,
1186 RTE_BYPASS_MODE_NORMAL,
1187 RTE_BYPASS_MODE_BYPASS,
1188 RTE_BYPASS_MODE_ISOLATE,
1189 RTE_BYPASS_MODE_NUM,
1192 #define RTE_BYPASS_MODE_VALID(x) \
1193 ((x) > RTE_BYPASS_MODE_NONE && (x) < RTE_BYPASS_MODE_NUM)
1196 RTE_BYPASS_EVENT_NONE,
1197 RTE_BYPASS_EVENT_START,
1198 RTE_BYPASS_EVENT_OS_ON = RTE_BYPASS_EVENT_START,
1199 RTE_BYPASS_EVENT_POWER_ON,
1200 RTE_BYPASS_EVENT_OS_OFF,
1201 RTE_BYPASS_EVENT_POWER_OFF,
1202 RTE_BYPASS_EVENT_TIMEOUT,
1203 RTE_BYPASS_EVENT_NUM
1206 #define RTE_BYPASS_EVENT_VALID(x) \
1207 ((x) > RTE_BYPASS_EVENT_NONE && (x) < RTE_BYPASS_MODE_NUM)
1210 RTE_BYPASS_TMT_OFF, /* timeout disabled. */
1211 RTE_BYPASS_TMT_1_5_SEC, /* timeout for 1.5 seconds */
1212 RTE_BYPASS_TMT_2_SEC, /* timeout for 2 seconds */
1213 RTE_BYPASS_TMT_3_SEC, /* timeout for 3 seconds */
1214 RTE_BYPASS_TMT_4_SEC, /* timeout for 4 seconds */
1215 RTE_BYPASS_TMT_8_SEC, /* timeout for 8 seconds */
1216 RTE_BYPASS_TMT_16_SEC, /* timeout for 16 seconds */
1217 RTE_BYPASS_TMT_32_SEC, /* timeout for 32 seconds */
1221 #define RTE_BYPASS_TMT_VALID(x) \
1222 ((x) == RTE_BYPASS_TMT_OFF || \
1223 ((x) > RTE_BYPASS_TMT_OFF && (x) < RTE_BYPASS_TMT_NUM))
1225 typedef void (*bypass_init_t)(struct rte_eth_dev *dev);
1226 typedef int32_t (*bypass_state_set_t)(struct rte_eth_dev *dev, uint32_t *new_state);
1227 typedef int32_t (*bypass_state_show_t)(struct rte_eth_dev *dev, uint32_t *state);
1228 typedef int32_t (*bypass_event_set_t)(struct rte_eth_dev *dev, uint32_t state, uint32_t event);
1229 typedef int32_t (*bypass_event_show_t)(struct rte_eth_dev *dev, uint32_t event_shift, uint32_t *event);
1230 typedef int32_t (*bypass_wd_timeout_set_t)(struct rte_eth_dev *dev, uint32_t timeout);
1231 typedef int32_t (*bypass_wd_timeout_show_t)(struct rte_eth_dev *dev, uint32_t *wd_timeout);
1232 typedef int32_t (*bypass_ver_show_t)(struct rte_eth_dev *dev, uint32_t *ver);
1233 typedef int32_t (*bypass_wd_reset_t)(struct rte_eth_dev *dev);
1236 typedef int (*eth_filter_ctrl_t)(struct rte_eth_dev *dev,
1237 enum rte_filter_type filter_type,
1238 enum rte_filter_op filter_op,
1240 /**< @internal Take operations to assigned filter type on an Ethernet device */
1242 typedef int (*eth_get_dcb_info)(struct rte_eth_dev *dev,
1243 struct rte_eth_dcb_info *dcb_info);
1244 /**< @internal Get dcb information on an Ethernet device */
1247 * @internal A structure containing the functions exported by an Ethernet driver.
1249 struct eth_dev_ops {
1250 eth_dev_configure_t dev_configure; /**< Configure device. */
1251 eth_dev_start_t dev_start; /**< Start device. */
1252 eth_dev_stop_t dev_stop; /**< Stop device. */
1253 eth_dev_set_link_up_t dev_set_link_up; /**< Device link up. */
1254 eth_dev_set_link_down_t dev_set_link_down; /**< Device link down. */
1255 eth_dev_close_t dev_close; /**< Close device. */
1256 eth_promiscuous_enable_t promiscuous_enable; /**< Promiscuous ON. */
1257 eth_promiscuous_disable_t promiscuous_disable;/**< Promiscuous OFF. */
1258 eth_allmulticast_enable_t allmulticast_enable;/**< RX multicast ON. */
1259 eth_allmulticast_disable_t allmulticast_disable;/**< RX multicast OF. */
1260 eth_link_update_t link_update; /**< Get device link state. */
1261 eth_stats_get_t stats_get; /**< Get generic device statistics. */
1262 eth_stats_reset_t stats_reset; /**< Reset generic device statistics. */
1263 eth_xstats_get_t xstats_get; /**< Get extended device statistics. */
1264 eth_xstats_reset_t xstats_reset; /**< Reset extended device statistics. */
1265 eth_queue_stats_mapping_set_t queue_stats_mapping_set;
1266 /**< Configure per queue stat counter mapping. */
1267 eth_dev_infos_get_t dev_infos_get; /**< Get device info. */
1268 mtu_set_t mtu_set; /**< Set MTU. */
1269 vlan_filter_set_t vlan_filter_set; /**< Filter VLAN Setup. */
1270 vlan_tpid_set_t vlan_tpid_set; /**< Outer VLAN TPID Setup. */
1271 vlan_strip_queue_set_t vlan_strip_queue_set; /**< VLAN Stripping on queue. */
1272 vlan_offload_set_t vlan_offload_set; /**< Set VLAN Offload. */
1273 vlan_pvid_set_t vlan_pvid_set; /**< Set port based TX VLAN insertion */
1274 eth_queue_start_t rx_queue_start;/**< Start RX for a queue.*/
1275 eth_queue_stop_t rx_queue_stop;/**< Stop RX for a queue.*/
1276 eth_queue_start_t tx_queue_start;/**< Start TX for a queue.*/
1277 eth_queue_stop_t tx_queue_stop;/**< Stop TX for a queue.*/
1278 eth_rx_queue_setup_t rx_queue_setup;/**< Set up device RX queue.*/
1279 eth_queue_release_t rx_queue_release;/**< Release RX queue.*/
1280 eth_rx_queue_count_t rx_queue_count; /**< Get Rx queue count. */
1281 eth_rx_descriptor_done_t rx_descriptor_done; /**< Check rxd DD bit */
1282 /**< Enable Rx queue interrupt. */
1283 eth_rx_enable_intr_t rx_queue_intr_enable;
1284 /**< Disable Rx queue interrupt.*/
1285 eth_rx_disable_intr_t rx_queue_intr_disable;
1286 eth_tx_queue_setup_t tx_queue_setup;/**< Set up device TX queue.*/
1287 eth_queue_release_t tx_queue_release;/**< Release TX queue.*/
1288 eth_dev_led_on_t dev_led_on; /**< Turn on LED. */
1289 eth_dev_led_off_t dev_led_off; /**< Turn off LED. */
1290 flow_ctrl_get_t flow_ctrl_get; /**< Get flow control. */
1291 flow_ctrl_set_t flow_ctrl_set; /**< Setup flow control. */
1292 priority_flow_ctrl_set_t priority_flow_ctrl_set; /**< Setup priority flow control.*/
1293 eth_mac_addr_remove_t mac_addr_remove; /**< Remove MAC address */
1294 eth_mac_addr_add_t mac_addr_add; /**< Add a MAC address */
1295 eth_mac_addr_set_t mac_addr_set; /**< Set a MAC address */
1296 eth_uc_hash_table_set_t uc_hash_table_set; /**< Set Unicast Table Array */
1297 eth_uc_all_hash_table_set_t uc_all_hash_table_set; /**< Set Unicast hash bitmap */
1298 eth_mirror_rule_set_t mirror_rule_set; /**< Add a traffic mirror rule.*/
1299 eth_mirror_rule_reset_t mirror_rule_reset; /**< reset a traffic mirror rule.*/
1300 eth_set_vf_rx_mode_t set_vf_rx_mode; /**< Set VF RX mode */
1301 eth_set_vf_rx_t set_vf_rx; /**< enable/disable a VF receive */
1302 eth_set_vf_tx_t set_vf_tx; /**< enable/disable a VF transmit */
1303 eth_set_vf_vlan_filter_t set_vf_vlan_filter; /**< Set VF VLAN filter */
1304 eth_udp_tunnel_add_t udp_tunnel_add;
1305 eth_udp_tunnel_del_t udp_tunnel_del;
1306 eth_set_queue_rate_limit_t set_queue_rate_limit; /**< Set queue rate limit */
1307 eth_set_vf_rate_limit_t set_vf_rate_limit; /**< Set VF rate limit */
1308 /** Update redirection table. */
1309 reta_update_t reta_update;
1310 /** Query redirection table. */
1311 reta_query_t reta_query;
1313 eth_get_reg_length_t get_reg_length;
1314 /**< Get # of registers */
1315 eth_get_reg_t get_reg;
1316 /**< Get registers */
1317 eth_get_eeprom_length_t get_eeprom_length;
1318 /**< Get eeprom length */
1319 eth_get_eeprom_t get_eeprom;
1320 /**< Get eeprom data */
1321 eth_set_eeprom_t set_eeprom;
1323 /* bypass control */
1324 #ifdef RTE_NIC_BYPASS
1325 bypass_init_t bypass_init;
1326 bypass_state_set_t bypass_state_set;
1327 bypass_state_show_t bypass_state_show;
1328 bypass_event_set_t bypass_event_set;
1329 bypass_event_show_t bypass_event_show;
1330 bypass_wd_timeout_set_t bypass_wd_timeout_set;
1331 bypass_wd_timeout_show_t bypass_wd_timeout_show;
1332 bypass_ver_show_t bypass_ver_show;
1333 bypass_wd_reset_t bypass_wd_reset;
1336 /** Configure RSS hash protocols. */
1337 rss_hash_update_t rss_hash_update;
1338 /** Get current RSS hash configuration. */
1339 rss_hash_conf_get_t rss_hash_conf_get;
1340 eth_filter_ctrl_t filter_ctrl; /**< common filter control*/
1341 eth_set_mc_addr_list_t set_mc_addr_list; /**< set list of mcast addrs */
1343 /** Turn IEEE1588/802.1AS timestamping on. */
1344 eth_timesync_enable_t timesync_enable;
1345 /** Turn IEEE1588/802.1AS timestamping off. */
1346 eth_timesync_disable_t timesync_disable;
1347 /** Read the IEEE1588/802.1AS RX timestamp. */
1348 eth_timesync_read_rx_timestamp_t timesync_read_rx_timestamp;
1349 /** Read the IEEE1588/802.1AS TX timestamp. */
1350 eth_timesync_read_tx_timestamp_t timesync_read_tx_timestamp;
1352 /** Get DCB information */
1353 eth_get_dcb_info get_dcb_info;
1357 * Function type used for RX packet processing packet callbacks.
1359 * The callback function is called on RX with a burst of packets that have
1360 * been received on the given port and queue.
1363 * The Ethernet port on which RX is being performed.
1365 * The queue on the Ethernet port which is being used to receive the packets.
1367 * The burst of packets that have just been received.
1369 * The number of packets in the burst pointed to by "pkts".
1371 * The max number of packets that can be stored in the "pkts" array.
1373 * The arbitrary user parameter passed in by the application when the callback
1374 * was originally configured.
1376 * The number of packets returned to the user.
1378 typedef uint16_t (*rte_rx_callback_fn)(uint8_t port, uint16_t queue,
1379 struct rte_mbuf *pkts[], uint16_t nb_pkts, uint16_t max_pkts,
1383 * Function type used for TX packet processing packet callbacks.
1385 * The callback function is called on TX with a burst of packets immediately
1386 * before the packets are put onto the hardware queue for transmission.
1389 * The Ethernet port on which TX is being performed.
1391 * The queue on the Ethernet port which is being used to transmit the packets.
1393 * The burst of packets that are about to be transmitted.
1395 * The number of packets in the burst pointed to by "pkts".
1397 * The arbitrary user parameter passed in by the application when the callback
1398 * was originally configured.
1400 * The number of packets to be written to the NIC.
1402 typedef uint16_t (*rte_tx_callback_fn)(uint8_t port, uint16_t queue,
1403 struct rte_mbuf *pkts[], uint16_t nb_pkts, void *user_param);
1407 * Structure used to hold information about the callbacks to be called for a
1408 * queue on RX and TX.
1410 struct rte_eth_rxtx_callback {
1411 struct rte_eth_rxtx_callback *next;
1413 rte_rx_callback_fn rx;
1414 rte_tx_callback_fn tx;
1420 * The eth device type.
1422 enum rte_eth_dev_type {
1423 RTE_ETH_DEV_UNKNOWN, /**< unknown device type */
1425 /**< Physical function and Virtual function of PCI devices */
1426 RTE_ETH_DEV_VIRTUAL, /**< non hardware device */
1427 RTE_ETH_DEV_MAX /**< max value of this enum */
1432 * The generic data structure associated with each ethernet device.
1434 * Pointers to burst-oriented packet receive and transmit functions are
1435 * located at the beginning of the structure, along with the pointer to
1436 * where all the data elements for the particular device are stored in shared
1437 * memory. This split allows the function pointer and driver data to be per-
1438 * process, while the actual configuration data for the device is shared.
1440 struct rte_eth_dev {
1441 eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
1442 eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
1443 struct rte_eth_dev_data *data; /**< Pointer to device data */
1444 const struct eth_driver *driver;/**< Driver for this device */
1445 const struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
1446 struct rte_pci_device *pci_dev; /**< PCI info. supplied by probing */
1447 /** User application callbacks for NIC interrupts */
1448 struct rte_eth_dev_cb_list link_intr_cbs;
1450 * User-supplied functions called from rx_burst to post-process
1451 * received packets before passing them to the user
1453 struct rte_eth_rxtx_callback *post_rx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
1455 * User-supplied functions called from tx_burst to pre-process
1456 * received packets before passing them to the driver for transmission.
1458 struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
1459 uint8_t attached; /**< Flag indicating the port is attached */
1460 enum rte_eth_dev_type dev_type; /**< Flag indicating the device type */
1463 struct rte_eth_dev_sriov {
1464 uint8_t active; /**< SRIOV is active with 16, 32 or 64 pools */
1465 uint8_t nb_q_per_pool; /**< rx queue number per pool */
1466 uint16_t def_vmdq_idx; /**< Default pool num used for PF */
1467 uint16_t def_pool_q_idx; /**< Default pool queue start reg index */
1469 #define RTE_ETH_DEV_SRIOV(dev) ((dev)->data->sriov)
1471 #define RTE_ETH_NAME_MAX_LEN (32)
1475 * The data part, with no function pointers, associated with each ethernet device.
1477 * This structure is safe to place in shared memory to be common among different
1478 * processes in a multi-process configuration.
1480 struct rte_eth_dev_data {
1481 char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
1483 void **rx_queues; /**< Array of pointers to RX queues. */
1484 void **tx_queues; /**< Array of pointers to TX queues. */
1485 uint16_t nb_rx_queues; /**< Number of RX queues. */
1486 uint16_t nb_tx_queues; /**< Number of TX queues. */
1488 struct rte_eth_dev_sriov sriov; /**< SRIOV data */
1490 void *dev_private; /**< PMD-specific private data */
1492 struct rte_eth_link dev_link;
1493 /**< Link-level information & status */
1495 struct rte_eth_conf dev_conf; /**< Configuration applied to device. */
1496 uint16_t mtu; /**< Maximum Transmission Unit. */
1498 uint32_t min_rx_buf_size;
1499 /**< Common rx buffer size handled by all queues */
1501 uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
1502 struct ether_addr* mac_addrs;/**< Device Ethernet Link address. */
1503 uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
1504 /** bitmap array of associating Ethernet MAC addresses to pools */
1505 struct ether_addr* hash_mac_addrs;
1506 /** Device Ethernet MAC addresses of hash filtering. */
1507 uint8_t port_id; /**< Device [external] port identifier. */
1508 uint8_t promiscuous : 1, /**< RX promiscuous mode ON(1) / OFF(0). */
1509 scattered_rx : 1, /**< RX of scattered packets is ON(1) / OFF(0) */
1510 all_multicast : 1, /**< RX all multicast mode ON(1) / OFF(0). */
1511 dev_started : 1, /**< Device state: STARTED(1) / STOPPED(0). */
1512 lro : 1; /**< RX LRO is ON(1) / OFF(0) */
1517 * The pool of *rte_eth_dev* structures. The size of the pool
1518 * is configured at compile-time in the <rte_ethdev.c> file.
1520 extern struct rte_eth_dev rte_eth_devices[];
1523 * Get the total number of Ethernet devices that have been successfully
1524 * initialized by the [matching] Ethernet driver during the PCI probing phase.
1525 * All devices whose port identifier is in the range
1526 * [0, rte_eth_dev_count() - 1] can be operated on by network applications
1527 * immediately after invoking rte_eal_init().
1528 * If the application unplugs a port using hotplug function, The enabled port
1529 * numbers may be noncontiguous. In the case, the applications need to manage
1530 * enabled port by themselves.
1533 * - The total number of usable Ethernet devices.
1535 extern uint8_t rte_eth_dev_count(void);
1539 * Returns a ethdev slot specified by the unique identifier name.
1542 * The pointer to the Unique identifier name for each Ethernet device
1544 * - The pointer to the ethdev slot, on success. NULL on error
1546 extern struct rte_eth_dev *rte_eth_dev_allocated(const char *name);
1550 * Allocates a new ethdev slot for an ethernet device and returns the pointer
1551 * to that slot for the driver to use.
1553 * @param name Unique identifier name for each Ethernet device
1554 * @param type Device type of this Ethernet device
1556 * - Slot in the rte_dev_devices array for a new device;
1558 struct rte_eth_dev *rte_eth_dev_allocate(const char *name,
1559 enum rte_eth_dev_type type);
1563 * Release the specified ethdev port.
1566 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure.
1568 * - 0 on success, negative on error
1570 int rte_eth_dev_release_port(struct rte_eth_dev *eth_dev);
1573 * Attach a new Ethernet device specified by aruguments.
1576 * A pointer to a strings array describing the new device
1577 * to be attached. The strings should be a pci address like
1578 * '0000:01:00.0' or virtual device name like 'eth_pcap0'.
1580 * A pointer to a port identifier actually attached.
1582 * 0 on success and port_id is filled, negative on error
1584 int rte_eth_dev_attach(const char *devargs, uint8_t *port_id);
1587 * Detach a Ethernet device specified by port identifier.
1588 * This function must be called when the device is in the
1592 * The port identifier of the device to detach.
1594 * A pointer to a device name actually detached.
1596 * 0 on success and devname is filled, negative on error
1598 int rte_eth_dev_detach(uint8_t port_id, char *devname);
1603 * Initialization function of an Ethernet driver invoked for each matching
1604 * Ethernet PCI device detected during the PCI probing phase.
1607 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1608 * associated with the matching device and which have been [automatically]
1609 * allocated in the *rte_eth_devices* array.
1610 * The *eth_dev* structure is supplied to the driver initialization function
1611 * with the following fields already initialized:
1613 * - *pci_dev*: Holds the pointers to the *rte_pci_device* structure which
1614 * contains the generic PCI information of the matching device.
1616 * - *driver*: Holds the pointer to the *eth_driver* structure.
1618 * - *dev_private*: Holds a pointer to the device private data structure.
1620 * - *mtu*: Contains the default Ethernet maximum frame length (1500).
1622 * - *port_id*: Contains the port index of the device (actually the index
1623 * of the *eth_dev* structure in the *rte_eth_devices* array).
1626 * - 0: Success, the device is properly initialized by the driver.
1627 * In particular, the driver MUST have set up the *dev_ops* pointer
1628 * of the *eth_dev* structure.
1629 * - <0: Error code of the device initialization failure.
1631 typedef int (*eth_dev_init_t)(struct rte_eth_dev *eth_dev);
1635 * Finalization function of an Ethernet driver invoked for each matching
1636 * Ethernet PCI device detected during the PCI closing phase.
1639 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1640 * associated with the matching device and which have been [automatically]
1641 * allocated in the *rte_eth_devices* array.
1643 * - 0: Success, the device is properly finalized by the driver.
1644 * In particular, the driver MUST free the *dev_ops* pointer
1645 * of the *eth_dev* structure.
1646 * - <0: Error code of the device initialization failure.
1648 typedef int (*eth_dev_uninit_t)(struct rte_eth_dev *eth_dev);
1652 * The structure associated with a PMD Ethernet driver.
1654 * Each Ethernet driver acts as a PCI driver and is represented by a generic
1655 * *eth_driver* structure that holds:
1657 * - An *rte_pci_driver* structure (which must be the first field).
1659 * - The *eth_dev_init* function invoked for each matching PCI device.
1661 * - The *eth_dev_uninit* function invoked for each matching PCI device.
1663 * - The size of the private data to allocate for each matching device.
1666 struct rte_pci_driver pci_drv; /**< The PMD is also a PCI driver. */
1667 eth_dev_init_t eth_dev_init; /**< Device init function. */
1668 eth_dev_uninit_t eth_dev_uninit; /**< Device uninit function. */
1669 unsigned int dev_private_size; /**< Size of device private data. */
1674 * A function invoked by the initialization function of an Ethernet driver
1675 * to simultaneously register itself as a PCI driver and as an Ethernet
1676 * Poll Mode Driver (PMD).
1679 * The pointer to the *eth_driver* structure associated with
1680 * the Ethernet driver.
1682 extern void rte_eth_driver_register(struct eth_driver *eth_drv);
1685 * Configure an Ethernet device.
1686 * This function must be invoked first before any other function in the
1687 * Ethernet API. This function can also be re-invoked when a device is in the
1691 * The port identifier of the Ethernet device to configure.
1692 * @param nb_rx_queue
1693 * The number of receive queues to set up for the Ethernet device.
1694 * @param nb_tx_queue
1695 * The number of transmit queues to set up for the Ethernet device.
1697 * The pointer to the configuration data to be used for the Ethernet device.
1698 * The *rte_eth_conf* structure includes:
1699 * - the hardware offload features to activate, with dedicated fields for
1700 * each statically configurable offload hardware feature provided by
1701 * Ethernet devices, such as IP checksum or VLAN tag stripping for
1703 * - the Receive Side Scaling (RSS) configuration when using multiple RX
1706 * Embedding all configuration information in a single data structure
1707 * is the more flexible method that allows the addition of new features
1708 * without changing the syntax of the API.
1710 * - 0: Success, device configured.
1711 * - <0: Error code returned by the driver configuration function.
1713 extern int rte_eth_dev_configure(uint8_t port_id,
1714 uint16_t nb_rx_queue,
1715 uint16_t nb_tx_queue,
1716 const struct rte_eth_conf *eth_conf);
1719 * Allocate and set up a receive queue for an Ethernet device.
1721 * The function allocates a contiguous block of memory for *nb_rx_desc*
1722 * receive descriptors from a memory zone associated with *socket_id*
1723 * and initializes each receive descriptor with a network buffer allocated
1724 * from the memory pool *mb_pool*.
1727 * The port identifier of the Ethernet device.
1728 * @param rx_queue_id
1729 * The index of the receive queue to set up.
1730 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1731 * to rte_eth_dev_configure().
1733 * The number of receive descriptors to allocate for the receive ring.
1735 * The *socket_id* argument is the socket identifier in case of NUMA.
1736 * The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1737 * the DMA memory allocated for the receive descriptors of the ring.
1739 * The pointer to the configuration data to be used for the receive queue.
1740 * NULL value is allowed, in which case default RX configuration
1742 * The *rx_conf* structure contains an *rx_thresh* structure with the values
1743 * of the Prefetch, Host, and Write-Back threshold registers of the receive
1746 * The pointer to the memory pool from which to allocate *rte_mbuf* network
1747 * memory buffers to populate each descriptor of the receive ring.
1749 * - 0: Success, receive queue correctly set up.
1750 * - -EINVAL: The size of network buffers which can be allocated from the
1751 * memory pool does not fit the various buffer sizes allowed by the
1752 * device controller.
1753 * - -ENOMEM: Unable to allocate the receive ring descriptors or to
1754 * allocate network memory buffers from the memory pool when
1755 * initializing receive descriptors.
1757 extern int rte_eth_rx_queue_setup(uint8_t port_id, uint16_t rx_queue_id,
1758 uint16_t nb_rx_desc, unsigned int socket_id,
1759 const struct rte_eth_rxconf *rx_conf,
1760 struct rte_mempool *mb_pool);
1763 * Allocate and set up a transmit queue for an Ethernet device.
1766 * The port identifier of the Ethernet device.
1767 * @param tx_queue_id
1768 * The index of the transmit queue to set up.
1769 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1770 * to rte_eth_dev_configure().
1772 * The number of transmit descriptors to allocate for the transmit ring.
1774 * The *socket_id* argument is the socket identifier in case of NUMA.
1775 * Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1776 * the DMA memory allocated for the transmit descriptors of the ring.
1778 * The pointer to the configuration data to be used for the transmit queue.
1779 * NULL value is allowed, in which case default RX configuration
1781 * The *tx_conf* structure contains the following data:
1782 * - The *tx_thresh* structure with the values of the Prefetch, Host, and
1783 * Write-Back threshold registers of the transmit ring.
1784 * When setting Write-Back threshold to the value greater then zero,
1785 * *tx_rs_thresh* value should be explicitly set to one.
1786 * - The *tx_free_thresh* value indicates the [minimum] number of network
1787 * buffers that must be pending in the transmit ring to trigger their
1788 * [implicit] freeing by the driver transmit function.
1789 * - The *tx_rs_thresh* value indicates the [minimum] number of transmit
1790 * descriptors that must be pending in the transmit ring before setting the
1791 * RS bit on a descriptor by the driver transmit function.
1792 * The *tx_rs_thresh* value should be less or equal then
1793 * *tx_free_thresh* value, and both of them should be less then
1795 * - The *txq_flags* member contains flags to pass to the TX queue setup
1796 * function to configure the behavior of the TX queue. This should be set
1797 * to 0 if no special configuration is required.
1799 * Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces
1800 * the transmit function to use default values.
1802 * - 0: Success, the transmit queue is correctly set up.
1803 * - -ENOMEM: Unable to allocate the transmit ring descriptors.
1805 extern int rte_eth_tx_queue_setup(uint8_t port_id, uint16_t tx_queue_id,
1806 uint16_t nb_tx_desc, unsigned int socket_id,
1807 const struct rte_eth_txconf *tx_conf);
1810 * Return the NUMA socket to which an Ethernet device is connected
1813 * The port identifier of the Ethernet device
1815 * The NUMA socket id to which the Ethernet device is connected or
1816 * a default of zero if the socket could not be determined.
1817 * -1 is returned is the port_id value is out of range.
1819 extern int rte_eth_dev_socket_id(uint8_t port_id);
1822 * Check if port_id of device is attached
1825 * The port identifier of the Ethernet device
1827 * - 0 if port is out of range or not attached
1828 * - 1 if device is attached
1830 extern int rte_eth_dev_is_valid_port(uint8_t port_id);
1833 * Allocate mbuf from mempool, setup the DMA physical address
1834 * and then start RX for specified queue of a port. It is used
1835 * when rx_deferred_start flag of the specified queue is true.
1838 * The port identifier of the Ethernet device
1839 * @param rx_queue_id
1840 * The index of the rx queue to update the ring.
1841 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1842 * to rte_eth_dev_configure().
1844 * - 0: Success, the transmit queue is correctly set up.
1845 * - -EINVAL: The port_id or the queue_id out of range.
1846 * - -ENOTSUP: The function not supported in PMD driver.
1848 extern int rte_eth_dev_rx_queue_start(uint8_t port_id, uint16_t rx_queue_id);
1851 * Stop specified RX queue of a port
1854 * The port identifier of the Ethernet device
1855 * @param rx_queue_id
1856 * The index of the rx queue to update the ring.
1857 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1858 * to rte_eth_dev_configure().
1860 * - 0: Success, the transmit queue is correctly set up.
1861 * - -EINVAL: The port_id or the queue_id out of range.
1862 * - -ENOTSUP: The function not supported in PMD driver.
1864 extern int rte_eth_dev_rx_queue_stop(uint8_t port_id, uint16_t rx_queue_id);
1867 * Start TX for specified queue of a port. It is used when tx_deferred_start
1868 * flag of the specified queue is true.
1871 * The port identifier of the Ethernet device
1872 * @param tx_queue_id
1873 * The index of the tx queue to update the ring.
1874 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1875 * to rte_eth_dev_configure().
1877 * - 0: Success, the transmit queue is correctly set up.
1878 * - -EINVAL: The port_id or the queue_id out of range.
1879 * - -ENOTSUP: The function not supported in PMD driver.
1881 extern int rte_eth_dev_tx_queue_start(uint8_t port_id, uint16_t tx_queue_id);
1884 * Stop specified TX queue of a port
1887 * The port identifier of the Ethernet device
1888 * @param tx_queue_id
1889 * The index of the tx queue to update the ring.
1890 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1891 * to rte_eth_dev_configure().
1893 * - 0: Success, the transmit queue is correctly set up.
1894 * - -EINVAL: The port_id or the queue_id out of range.
1895 * - -ENOTSUP: The function not supported in PMD driver.
1897 extern int rte_eth_dev_tx_queue_stop(uint8_t port_id, uint16_t tx_queue_id);
1902 * Start an Ethernet device.
1904 * The device start step is the last one and consists of setting the configured
1905 * offload features and in starting the transmit and the receive units of the
1907 * On success, all basic functions exported by the Ethernet API (link status,
1908 * receive/transmit, and so on) can be invoked.
1911 * The port identifier of the Ethernet device.
1913 * - 0: Success, Ethernet device started.
1914 * - <0: Error code of the driver device start function.
1916 extern int rte_eth_dev_start(uint8_t port_id);
1919 * Stop an Ethernet device. The device can be restarted with a call to
1920 * rte_eth_dev_start()
1923 * The port identifier of the Ethernet device.
1925 extern void rte_eth_dev_stop(uint8_t port_id);
1929 * Link up an Ethernet device.
1931 * Set device link up will re-enable the device rx/tx
1932 * functionality after it is previously set device linked down.
1935 * The port identifier of the Ethernet device.
1937 * - 0: Success, Ethernet device linked up.
1938 * - <0: Error code of the driver device link up function.
1940 extern int rte_eth_dev_set_link_up(uint8_t port_id);
1943 * Link down an Ethernet device.
1944 * The device rx/tx functionality will be disabled if success,
1945 * and it can be re-enabled with a call to
1946 * rte_eth_dev_set_link_up()
1949 * The port identifier of the Ethernet device.
1951 extern int rte_eth_dev_set_link_down(uint8_t port_id);
1954 * Close a stopped Ethernet device. The device cannot be restarted!
1955 * The function frees all resources except for needed by the
1956 * closed state. To free these resources, call rte_eth_dev_detach().
1959 * The port identifier of the Ethernet device.
1961 extern void rte_eth_dev_close(uint8_t port_id);
1964 * Enable receipt in promiscuous mode for an Ethernet device.
1967 * The port identifier of the Ethernet device.
1969 extern void rte_eth_promiscuous_enable(uint8_t port_id);
1972 * Disable receipt in promiscuous mode for an Ethernet device.
1975 * The port identifier of the Ethernet device.
1977 extern void rte_eth_promiscuous_disable(uint8_t port_id);
1980 * Return the value of promiscuous mode for an Ethernet device.
1983 * The port identifier of the Ethernet device.
1985 * - (1) if promiscuous is enabled
1986 * - (0) if promiscuous is disabled.
1989 extern int rte_eth_promiscuous_get(uint8_t port_id);
1992 * Enable the receipt of any multicast frame by an Ethernet device.
1995 * The port identifier of the Ethernet device.
1997 extern void rte_eth_allmulticast_enable(uint8_t port_id);
2000 * Disable the receipt of all multicast frames by an Ethernet device.
2003 * The port identifier of the Ethernet device.
2005 extern void rte_eth_allmulticast_disable(uint8_t port_id);
2008 * Return the value of allmulticast mode for an Ethernet device.
2011 * The port identifier of the Ethernet device.
2013 * - (1) if allmulticast is enabled
2014 * - (0) if allmulticast is disabled.
2017 extern int rte_eth_allmulticast_get(uint8_t port_id);
2020 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2021 * or FULL-DUPLEX) of the physical link of an Ethernet device. It might need
2022 * to wait up to 9 seconds in it.
2025 * The port identifier of the Ethernet device.
2027 * A pointer to an *rte_eth_link* structure to be filled with
2028 * the status, the speed and the mode of the Ethernet device link.
2030 extern void rte_eth_link_get(uint8_t port_id, struct rte_eth_link *link);
2033 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2034 * or FULL-DUPLEX) of the physical link of an Ethernet device. It is a no-wait
2035 * version of rte_eth_link_get().
2038 * The port identifier of the Ethernet device.
2040 * A pointer to an *rte_eth_link* structure to be filled with
2041 * the status, the speed and the mode of the Ethernet device link.
2043 extern void rte_eth_link_get_nowait(uint8_t port_id,
2044 struct rte_eth_link *link);
2047 * Retrieve the general I/O statistics of an Ethernet device.
2050 * The port identifier of the Ethernet device.
2052 * A pointer to a structure of type *rte_eth_stats* to be filled with
2053 * the values of device counters for the following set of statistics:
2054 * - *ipackets* with the total of successfully received packets.
2055 * - *opackets* with the total of successfully transmitted packets.
2056 * - *ibytes* with the total of successfully received bytes.
2057 * - *obytes* with the total of successfully transmitted bytes.
2058 * - *ierrors* with the total of erroneous received packets.
2059 * - *oerrors* with the total of failed transmitted packets.
2061 * Zero if successful. Non-zero otherwise.
2063 extern int rte_eth_stats_get(uint8_t port_id, struct rte_eth_stats *stats);
2066 * Reset the general I/O statistics of an Ethernet device.
2069 * The port identifier of the Ethernet device.
2071 extern void rte_eth_stats_reset(uint8_t port_id);
2074 * Retrieve extended statistics of an Ethernet device.
2077 * The port identifier of the Ethernet device.
2079 * A pointer to a table of structure of type *rte_eth_xstats*
2080 * to be filled with device statistics names and values.
2081 * This parameter can be set to NULL if n is 0.
2083 * The size of the stats table, which should be large enough to store
2084 * all the statistics of the device.
2086 * - positive value lower or equal to n: success. The return value
2087 * is the number of entries filled in the stats table.
2088 * - positive value higher than n: error, the given statistics table
2089 * is too small. The return value corresponds to the size that should
2090 * be given to succeed. The entries in the table are not valid and
2091 * shall not be used by the caller.
2092 * - negative value on error (invalid port id)
2094 extern int rte_eth_xstats_get(uint8_t port_id,
2095 struct rte_eth_xstats *xstats, unsigned n);
2098 * Reset extended statistics of an Ethernet device.
2101 * The port identifier of the Ethernet device.
2103 extern void rte_eth_xstats_reset(uint8_t port_id);
2106 * Set a mapping for the specified transmit queue to the specified per-queue
2107 * statistics counter.
2110 * The port identifier of the Ethernet device.
2111 * @param tx_queue_id
2112 * The index of the transmit queue for which a queue stats mapping is required.
2113 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2114 * to rte_eth_dev_configure().
2116 * The per-queue packet statistics functionality number that the transmit
2117 * queue is to be assigned.
2118 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2120 * Zero if successful. Non-zero otherwise.
2122 extern int rte_eth_dev_set_tx_queue_stats_mapping(uint8_t port_id,
2123 uint16_t tx_queue_id,
2127 * Set a mapping for the specified receive queue to the specified per-queue
2128 * statistics counter.
2131 * The port identifier of the Ethernet device.
2132 * @param rx_queue_id
2133 * The index of the receive queue for which a queue stats mapping is required.
2134 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2135 * to rte_eth_dev_configure().
2137 * The per-queue packet statistics functionality number that the receive
2138 * queue is to be assigned.
2139 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2141 * Zero if successful. Non-zero otherwise.
2143 extern int rte_eth_dev_set_rx_queue_stats_mapping(uint8_t port_id,
2144 uint16_t rx_queue_id,
2148 * Retrieve the Ethernet address of an Ethernet device.
2151 * The port identifier of the Ethernet device.
2153 * A pointer to a structure of type *ether_addr* to be filled with
2154 * the Ethernet address of the Ethernet device.
2156 extern void rte_eth_macaddr_get(uint8_t port_id, struct ether_addr *mac_addr);
2159 * Retrieve the contextual information of an Ethernet device.
2162 * The port identifier of the Ethernet device.
2164 * A pointer to a structure of type *rte_eth_dev_info* to be filled with
2165 * the contextual information of the Ethernet device.
2167 extern void rte_eth_dev_info_get(uint8_t port_id,
2168 struct rte_eth_dev_info *dev_info);
2171 * Retrieve the MTU of an Ethernet device.
2174 * The port identifier of the Ethernet device.
2176 * A pointer to a uint16_t where the retrieved MTU is to be stored.
2178 * - (0) if successful.
2179 * - (-ENODEV) if *port_id* invalid.
2181 extern int rte_eth_dev_get_mtu(uint8_t port_id, uint16_t *mtu);
2184 * Change the MTU of an Ethernet device.
2187 * The port identifier of the Ethernet device.
2189 * A uint16_t for the MTU to be applied.
2191 * - (0) if successful.
2192 * - (-ENOTSUP) if operation is not supported.
2193 * - (-ENODEV) if *port_id* invalid.
2194 * - (-EINVAL) if *mtu* invalid.
2196 extern int rte_eth_dev_set_mtu(uint8_t port_id, uint16_t mtu);
2199 * Enable/Disable hardware filtering by an Ethernet device of received
2200 * VLAN packets tagged with a given VLAN Tag Identifier.
2203 * The port identifier of the Ethernet device.
2205 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
2207 * If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*.
2208 * Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*.
2210 * - (0) if successful.
2211 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2212 * - (-ENODEV) if *port_id* invalid.
2213 * - (-ENOSYS) if VLAN filtering on *port_id* disabled.
2214 * - (-EINVAL) if *vlan_id* > 4095.
2216 extern int rte_eth_dev_vlan_filter(uint8_t port_id, uint16_t vlan_id , int on);
2219 * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
2220 * 82599/X540/X550 can support VLAN stripping at the rx queue level
2223 * The port identifier of the Ethernet device.
2224 * @param rx_queue_id
2225 * The index of the receive queue for which a queue stats mapping is required.
2226 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2227 * to rte_eth_dev_configure().
2229 * If 1, Enable VLAN Stripping of the receive queue of the Ethernet port.
2230 * If 0, Disable VLAN Stripping of the receive queue of the Ethernet port.
2232 * - (0) if successful.
2233 * - (-ENOSUP) if hardware-assisted VLAN stripping not configured.
2234 * - (-ENODEV) if *port_id* invalid.
2235 * - (-EINVAL) if *rx_queue_id* invalid.
2237 extern int rte_eth_dev_set_vlan_strip_on_queue(uint8_t port_id,
2238 uint16_t rx_queue_id, int on);
2241 * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
2242 * the VLAN Header. This is a register setup available on some Intel NIC, not
2243 * but all, please check the data sheet for availability.
2246 * The port identifier of the Ethernet device.
2248 * The Tag Protocol ID
2250 * - (0) if successful.
2251 * - (-ENOSUP) if hardware-assisted VLAN TPID setup is not supported.
2252 * - (-ENODEV) if *port_id* invalid.
2254 extern int rte_eth_dev_set_vlan_ether_type(uint8_t port_id, uint16_t tag_type);
2257 * Set VLAN offload configuration on an Ethernet device
2258 * Enable/Disable Extended VLAN by an Ethernet device, This is a register setup
2259 * available on some Intel NIC, not but all, please check the data sheet for
2261 * Enable/Disable VLAN Strip can be done on rx queue for certain NIC, but here
2262 * the configuration is applied on the port level.
2265 * The port identifier of the Ethernet device.
2266 * @param offload_mask
2267 * The VLAN Offload bit mask can be mixed use with "OR"
2268 * ETH_VLAN_STRIP_OFFLOAD
2269 * ETH_VLAN_FILTER_OFFLOAD
2270 * ETH_VLAN_EXTEND_OFFLOAD
2272 * - (0) if successful.
2273 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2274 * - (-ENODEV) if *port_id* invalid.
2276 extern int rte_eth_dev_set_vlan_offload(uint8_t port_id, int offload_mask);
2279 * Read VLAN Offload configuration from an Ethernet device
2282 * The port identifier of the Ethernet device.
2284 * - (>0) if successful. Bit mask to indicate
2285 * ETH_VLAN_STRIP_OFFLOAD
2286 * ETH_VLAN_FILTER_OFFLOAD
2287 * ETH_VLAN_EXTEND_OFFLOAD
2288 * - (-ENODEV) if *port_id* invalid.
2290 extern int rte_eth_dev_get_vlan_offload(uint8_t port_id);
2293 * Set port based TX VLAN insersion on or off.
2296 * The port identifier of the Ethernet device.
2298 * Port based TX VLAN identifier togeth with user priority.
2300 * Turn on or off the port based TX VLAN insertion.
2303 * - (0) if successful.
2304 * - negative if failed.
2306 extern int rte_eth_dev_set_vlan_pvid(uint8_t port_id, uint16_t pvid, int on);
2310 * Retrieve a burst of input packets from a receive queue of an Ethernet
2311 * device. The retrieved packets are stored in *rte_mbuf* structures whose
2312 * pointers are supplied in the *rx_pkts* array.
2314 * The rte_eth_rx_burst() function loops, parsing the RX ring of the
2315 * receive queue, up to *nb_pkts* packets, and for each completed RX
2316 * descriptor in the ring, it performs the following operations:
2318 * - Initialize the *rte_mbuf* data structure associated with the
2319 * RX descriptor according to the information provided by the NIC into
2320 * that RX descriptor.
2322 * - Store the *rte_mbuf* data structure into the next entry of the
2325 * - Replenish the RX descriptor with a new *rte_mbuf* buffer
2326 * allocated from the memory pool associated with the receive queue at
2327 * initialization time.
2329 * When retrieving an input packet that was scattered by the controller
2330 * into multiple receive descriptors, the rte_eth_rx_burst() function
2331 * appends the associated *rte_mbuf* buffers to the first buffer of the
2334 * The rte_eth_rx_burst() function returns the number of packets
2335 * actually retrieved, which is the number of *rte_mbuf* data structures
2336 * effectively supplied into the *rx_pkts* array.
2337 * A return value equal to *nb_pkts* indicates that the RX queue contained
2338 * at least *rx_pkts* packets, and this is likely to signify that other
2339 * received packets remain in the input queue. Applications implementing
2340 * a "retrieve as much received packets as possible" policy can check this
2341 * specific case and keep invoking the rte_eth_rx_burst() function until
2342 * a value less than *nb_pkts* is returned.
2344 * This receive method has the following advantages:
2346 * - It allows a run-to-completion network stack engine to retrieve and
2347 * to immediately process received packets in a fast burst-oriented
2348 * approach, avoiding the overhead of unnecessary intermediate packet
2349 * queue/dequeue operations.
2351 * - Conversely, it also allows an asynchronous-oriented processing
2352 * method to retrieve bursts of received packets and to immediately
2353 * queue them for further parallel processing by another logical core,
2354 * for instance. However, instead of having received packets being
2355 * individually queued by the driver, this approach allows the invoker
2356 * of the rte_eth_rx_burst() function to queue a burst of retrieved
2357 * packets at a time and therefore dramatically reduce the cost of
2358 * enqueue/dequeue operations per packet.
2360 * - It allows the rte_eth_rx_burst() function of the driver to take
2361 * advantage of burst-oriented hardware features (CPU cache,
2362 * prefetch instructions, and so on) to minimize the number of CPU
2363 * cycles per packet.
2365 * To summarize, the proposed receive API enables many
2366 * burst-oriented optimizations in both synchronous and asynchronous
2367 * packet processing environments with no overhead in both cases.
2369 * The rte_eth_rx_burst() function does not provide any error
2370 * notification to avoid the corresponding overhead. As a hint, the
2371 * upper-level application might check the status of the device link once
2372 * being systematically returned a 0 value for a given number of tries.
2375 * The port identifier of the Ethernet device.
2377 * The index of the receive queue from which to retrieve input packets.
2378 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2379 * to rte_eth_dev_configure().
2381 * The address of an array of pointers to *rte_mbuf* structures that
2382 * must be large enough to store *nb_pkts* pointers in it.
2384 * The maximum number of packets to retrieve.
2386 * The number of packets actually retrieved, which is the number
2387 * of pointers to *rte_mbuf* structures effectively supplied to the
2390 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2391 extern uint16_t rte_eth_rx_burst(uint8_t port_id, uint16_t queue_id,
2392 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
2394 static inline uint16_t
2395 rte_eth_rx_burst(uint8_t port_id, uint16_t queue_id,
2396 struct rte_mbuf **rx_pkts, const uint16_t nb_pkts)
2398 struct rte_eth_dev *dev;
2400 dev = &rte_eth_devices[port_id];
2402 int16_t nb_rx = (*dev->rx_pkt_burst)(dev->data->rx_queues[queue_id],
2405 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
2406 struct rte_eth_rxtx_callback *cb = dev->post_rx_burst_cbs[queue_id];
2408 if (unlikely(cb != NULL)) {
2410 nb_rx = cb->fn.rx(port_id, queue_id, rx_pkts, nb_rx,
2411 nb_pkts, cb->param);
2413 } while (cb != NULL);
2422 * Get the number of used descriptors in a specific queue
2425 * The port identifier of the Ethernet device.
2427 * The queue id on the specific port.
2429 * The number of used descriptors in the specific queue.
2431 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2432 extern uint32_t rte_eth_rx_queue_count(uint8_t port_id, uint16_t queue_id);
2434 static inline uint32_t
2435 rte_eth_rx_queue_count(uint8_t port_id, uint16_t queue_id)
2437 struct rte_eth_dev *dev;
2439 dev = &rte_eth_devices[port_id];
2440 return (*dev->dev_ops->rx_queue_count)(dev, queue_id);
2445 * Check if the DD bit of the specific RX descriptor in the queue has been set
2448 * The port identifier of the Ethernet device.
2450 * The queue id on the specific port.
2452 * The offset of the descriptor ID from tail.
2454 * - (1) if the specific DD bit is set.
2455 * - (0) if the specific DD bit is not set.
2456 * - (-ENODEV) if *port_id* invalid.
2458 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2459 extern int rte_eth_rx_descriptor_done(uint8_t port_id,
2464 rte_eth_rx_descriptor_done(uint8_t port_id, uint16_t queue_id, uint16_t offset)
2466 struct rte_eth_dev *dev;
2468 dev = &rte_eth_devices[port_id];
2469 return (*dev->dev_ops->rx_descriptor_done)( \
2470 dev->data->rx_queues[queue_id], offset);
2475 * Send a burst of output packets on a transmit queue of an Ethernet device.
2477 * The rte_eth_tx_burst() function is invoked to transmit output packets
2478 * on the output queue *queue_id* of the Ethernet device designated by its
2480 * The *nb_pkts* parameter is the number of packets to send which are
2481 * supplied in the *tx_pkts* array of *rte_mbuf* structures.
2482 * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
2483 * up to the number of transmit descriptors available in the TX ring of the
2485 * For each packet to send, the rte_eth_tx_burst() function performs
2486 * the following operations:
2488 * - Pick up the next available descriptor in the transmit ring.
2490 * - Free the network buffer previously sent with that descriptor, if any.
2492 * - Initialize the transmit descriptor with the information provided
2493 * in the *rte_mbuf data structure.
2495 * In the case of a segmented packet composed of a list of *rte_mbuf* buffers,
2496 * the rte_eth_tx_burst() function uses several transmit descriptors
2499 * The rte_eth_tx_burst() function returns the number of packets it
2500 * actually sent. A return value equal to *nb_pkts* means that all packets
2501 * have been sent, and this is likely to signify that other output packets
2502 * could be immediately transmitted again. Applications that implement a
2503 * "send as many packets to transmit as possible" policy can check this
2504 * specific case and keep invoking the rte_eth_tx_burst() function until
2505 * a value less than *nb_pkts* is returned.
2507 * It is the responsibility of the rte_eth_tx_burst() function to
2508 * transparently free the memory buffers of packets previously sent.
2509 * This feature is driven by the *tx_free_thresh* value supplied to the
2510 * rte_eth_dev_configure() function at device configuration time.
2511 * When the number of free TX descriptors drops below this threshold, the
2512 * rte_eth_tx_burst() function must [attempt to] free the *rte_mbuf* buffers
2513 * of those packets whose transmission was effectively completed.
2516 * The port identifier of the Ethernet device.
2518 * The index of the transmit queue through which output packets must be
2520 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2521 * to rte_eth_dev_configure().
2523 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
2524 * which contain the output packets.
2526 * The maximum number of packets to transmit.
2528 * The number of output packets actually stored in transmit descriptors of
2529 * the transmit ring. The return value can be less than the value of the
2530 * *tx_pkts* parameter when the transmit ring is full or has been filled up.
2532 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2533 extern uint16_t rte_eth_tx_burst(uint8_t port_id, uint16_t queue_id,
2534 struct rte_mbuf **tx_pkts, uint16_t nb_pkts);
2536 static inline uint16_t
2537 rte_eth_tx_burst(uint8_t port_id, uint16_t queue_id,
2538 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
2540 struct rte_eth_dev *dev;
2542 dev = &rte_eth_devices[port_id];
2544 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
2545 struct rte_eth_rxtx_callback *cb = dev->pre_tx_burst_cbs[queue_id];
2547 if (unlikely(cb != NULL)) {
2549 nb_pkts = cb->fn.tx(port_id, queue_id, tx_pkts, nb_pkts,
2552 } while (cb != NULL);
2556 return (*dev->tx_pkt_burst)(dev->data->tx_queues[queue_id], tx_pkts, nb_pkts);
2561 * The eth device event type for interrupt, and maybe others in the future.
2563 enum rte_eth_event_type {
2564 RTE_ETH_EVENT_UNKNOWN, /**< unknown event type */
2565 RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
2566 RTE_ETH_EVENT_MAX /**< max value of this enum */
2569 typedef void (*rte_eth_dev_cb_fn)(uint8_t port_id, \
2570 enum rte_eth_event_type event, void *cb_arg);
2571 /**< user application callback to be registered for interrupts */
2576 * Register a callback function for specific port id.
2583 * User supplied callback function to be called.
2585 * Pointer to the parameters for the registered callback.
2588 * - On success, zero.
2589 * - On failure, a negative value.
2591 int rte_eth_dev_callback_register(uint8_t port_id,
2592 enum rte_eth_event_type event,
2593 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
2596 * Unregister a callback function for specific port id.
2603 * User supplied callback function to be called.
2605 * Pointer to the parameters for the registered callback. -1 means to
2606 * remove all for the same callback address and same event.
2609 * - On success, zero.
2610 * - On failure, a negative value.
2612 int rte_eth_dev_callback_unregister(uint8_t port_id,
2613 enum rte_eth_event_type event,
2614 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
2617 * @internal Executes all the user application registered callbacks for
2618 * the specific device. It is for DPDK internal user only. User
2619 * application should not call it directly.
2622 * Pointer to struct rte_eth_dev.
2624 * Eth device interrupt event type.
2629 void _rte_eth_dev_callback_process(struct rte_eth_dev *dev,
2630 enum rte_eth_event_type event);
2633 * When there is no rx packet coming in Rx Queue for a long time, we can
2634 * sleep lcore related to RX Queue for power saving, and enable rx interrupt
2635 * to be triggered when rx packect arrives.
2637 * The rte_eth_dev_rx_intr_enable() function enables rx queue
2638 * interrupt on specific rx queue of a port.
2641 * The port identifier of the Ethernet device.
2643 * The index of the receive queue from which to retrieve input packets.
2644 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2645 * to rte_eth_dev_configure().
2647 * - (0) if successful.
2648 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
2650 * - (-ENODEV) if *port_id* invalid.
2652 int rte_eth_dev_rx_intr_enable(uint8_t port_id, uint16_t queue_id);
2655 * When lcore wakes up from rx interrupt indicating packet coming, disable rx
2656 * interrupt and returns to polling mode.
2658 * The rte_eth_dev_rx_intr_disable() function disables rx queue
2659 * interrupt on specific rx queue of a port.
2662 * The port identifier of the Ethernet device.
2664 * The index of the receive queue from which to retrieve input packets.
2665 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2666 * to rte_eth_dev_configure().
2668 * - (0) if successful.
2669 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
2671 * - (-ENODEV) if *port_id* invalid.
2673 int rte_eth_dev_rx_intr_disable(uint8_t port_id, uint16_t queue_id);
2676 * RX Interrupt control per port.
2679 * The port identifier of the Ethernet device.
2681 * Epoll instance fd which the intr vector associated to.
2682 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
2684 * The operation be performed for the vector.
2685 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
2689 * - On success, zero.
2690 * - On failure, a negative value.
2692 int rte_eth_dev_rx_intr_ctl(uint8_t port_id, int epfd, int op, void *data);
2695 * RX Interrupt control per queue.
2698 * The port identifier of the Ethernet device.
2700 * The index of the receive queue from which to retrieve input packets.
2701 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2702 * to rte_eth_dev_configure().
2704 * Epoll instance fd which the intr vector associated to.
2705 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
2707 * The operation be performed for the vector.
2708 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
2712 * - On success, zero.
2713 * - On failure, a negative value.
2715 int rte_eth_dev_rx_intr_ctl_q(uint8_t port_id, uint16_t queue_id,
2716 int epfd, int op, void *data);
2719 * Turn on the LED on the Ethernet device.
2720 * This function turns on the LED on the Ethernet device.
2723 * The port identifier of the Ethernet device.
2725 * - (0) if successful.
2726 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
2728 * - (-ENODEV) if *port_id* invalid.
2730 int rte_eth_led_on(uint8_t port_id);
2733 * Turn off the LED on the Ethernet device.
2734 * This function turns off the LED on the Ethernet device.
2737 * The port identifier of the Ethernet device.
2739 * - (0) if successful.
2740 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
2742 * - (-ENODEV) if *port_id* invalid.
2744 int rte_eth_led_off(uint8_t port_id);
2747 * Get current status of the Ethernet link flow control for Ethernet device
2750 * The port identifier of the Ethernet device.
2752 * The pointer to the structure where to store the flow control parameters.
2754 * - (0) if successful.
2755 * - (-ENOTSUP) if hardware doesn't support flow control.
2756 * - (-ENODEV) if *port_id* invalid.
2758 int rte_eth_dev_flow_ctrl_get(uint8_t port_id,
2759 struct rte_eth_fc_conf *fc_conf);
2762 * Configure the Ethernet link flow control for Ethernet device
2765 * The port identifier of the Ethernet device.
2767 * The pointer to the structure of the flow control parameters.
2769 * - (0) if successful.
2770 * - (-ENOTSUP) if hardware doesn't support flow control mode.
2771 * - (-ENODEV) if *port_id* invalid.
2772 * - (-EINVAL) if bad parameter
2773 * - (-EIO) if flow control setup failure
2775 int rte_eth_dev_flow_ctrl_set(uint8_t port_id,
2776 struct rte_eth_fc_conf *fc_conf);
2779 * Configure the Ethernet priority flow control under DCB environment
2780 * for Ethernet device.
2783 * The port identifier of the Ethernet device.
2785 * The pointer to the structure of the priority flow control parameters.
2787 * - (0) if successful.
2788 * - (-ENOTSUP) if hardware doesn't support priority flow control mode.
2789 * - (-ENODEV) if *port_id* invalid.
2790 * - (-EINVAL) if bad parameter
2791 * - (-EIO) if flow control setup failure
2793 int rte_eth_dev_priority_flow_ctrl_set(uint8_t port_id,
2794 struct rte_eth_pfc_conf *pfc_conf);
2797 * Add a MAC address to an internal array of addresses used to enable whitelist
2798 * filtering to accept packets only if the destination MAC address matches.
2801 * The port identifier of the Ethernet device.
2803 * The MAC address to add.
2805 * VMDq pool index to associate address with (if VMDq is enabled). If VMDq is
2806 * not enabled, this should be set to 0.
2808 * - (0) if successfully added or *mac_addr" was already added.
2809 * - (-ENOTSUP) if hardware doesn't support this feature.
2810 * - (-ENODEV) if *port* is invalid.
2811 * - (-ENOSPC) if no more MAC addresses can be added.
2812 * - (-EINVAL) if MAC address is invalid.
2814 int rte_eth_dev_mac_addr_add(uint8_t port, struct ether_addr *mac_addr,
2818 * Remove a MAC address from the internal array of addresses.
2821 * The port identifier of the Ethernet device.
2823 * MAC address to remove.
2825 * - (0) if successful, or *mac_addr* didn't exist.
2826 * - (-ENOTSUP) if hardware doesn't support.
2827 * - (-ENODEV) if *port* invalid.
2828 * - (-EADDRINUSE) if attempting to remove the default MAC address
2830 int rte_eth_dev_mac_addr_remove(uint8_t port, struct ether_addr *mac_addr);
2833 * Set the default MAC address.
2836 * The port identifier of the Ethernet device.
2838 * New default MAC address.
2840 * - (0) if successful, or *mac_addr* didn't exist.
2841 * - (-ENOTSUP) if hardware doesn't support.
2842 * - (-ENODEV) if *port* invalid.
2843 * - (-EINVAL) if MAC address is invalid.
2845 int rte_eth_dev_default_mac_addr_set(uint8_t port, struct ether_addr *mac_addr);
2849 * Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
2852 * The port identifier of the Ethernet device.
2856 * Redirection table size. The table size can be queried by
2857 * rte_eth_dev_info_get().
2859 * - (0) if successful.
2860 * - (-ENOTSUP) if hardware doesn't support.
2861 * - (-EINVAL) if bad parameter.
2863 int rte_eth_dev_rss_reta_update(uint8_t port,
2864 struct rte_eth_rss_reta_entry64 *reta_conf,
2865 uint16_t reta_size);
2868 * Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
2871 * The port identifier of the Ethernet device.
2875 * Redirection table size. The table size can be queried by
2876 * rte_eth_dev_info_get().
2878 * - (0) if successful.
2879 * - (-ENOTSUP) if hardware doesn't support.
2880 * - (-EINVAL) if bad parameter.
2882 int rte_eth_dev_rss_reta_query(uint8_t port,
2883 struct rte_eth_rss_reta_entry64 *reta_conf,
2884 uint16_t reta_size);
2887 * Updates unicast hash table for receiving packet with the given destination
2888 * MAC address, and the packet is routed to all VFs for which the RX mode is
2889 * accept packets that match the unicast hash table.
2892 * The port identifier of the Ethernet device.
2894 * Unicast MAC address.
2896 * 1 - Set an unicast hash bit for receiving packets with the MAC address.
2897 * 0 - Clear an unicast hash bit.
2899 * - (0) if successful.
2900 * - (-ENOTSUP) if hardware doesn't support.
2901 * - (-ENODEV) if *port_id* invalid.
2902 * - (-EINVAL) if bad parameter.
2904 int rte_eth_dev_uc_hash_table_set(uint8_t port,struct ether_addr *addr,
2908 * Updates all unicast hash bitmaps for receiving packet with any Unicast
2909 * Ethernet MAC addresses,the packet is routed to all VFs for which the RX
2910 * mode is accept packets that match the unicast hash table.
2913 * The port identifier of the Ethernet device.
2915 * 1 - Set all unicast hash bitmaps for receiving all the Ethernet
2917 * 0 - Clear all unicast hash bitmaps
2919 * - (0) if successful.
2920 * - (-ENOTSUP) if hardware doesn't support.
2921 * - (-ENODEV) if *port_id* invalid.
2922 * - (-EINVAL) if bad parameter.
2924 int rte_eth_dev_uc_all_hash_table_set(uint8_t port,uint8_t on);
2927 * Set RX L2 Filtering mode of a VF of an Ethernet device.
2930 * The port identifier of the Ethernet device.
2934 * The RX mode mask, which is one or more of accepting Untagged Packets,
2935 * packets that match the PFUTA table, Broadcast and Multicast Promiscuous.
2936 * ETH_VMDQ_ACCEPT_UNTAG,ETH_VMDQ_ACCEPT_HASH_UC,
2937 * ETH_VMDQ_ACCEPT_BROADCAST and ETH_VMDQ_ACCEPT_MULTICAST will be used
2940 * 1 - Enable a VF RX mode.
2941 * 0 - Disable a VF RX mode.
2943 * - (0) if successful.
2944 * - (-ENOTSUP) if hardware doesn't support.
2945 * - (-ENOTSUP) if hardware doesn't support.
2946 * - (-EINVAL) if bad parameter.
2948 int rte_eth_dev_set_vf_rxmode(uint8_t port, uint16_t vf, uint16_t rx_mode,
2952 * Enable or disable a VF traffic transmit of the Ethernet device.
2955 * The port identifier of the Ethernet device.
2959 * 1 - Enable a VF traffic transmit.
2960 * 0 - Disable a VF traffic transmit.
2962 * - (0) if successful.
2963 * - (-ENODEV) if *port_id* invalid.
2964 * - (-ENOTSUP) if hardware doesn't support.
2965 * - (-EINVAL) if bad parameter.
2968 rte_eth_dev_set_vf_tx(uint8_t port,uint16_t vf, uint8_t on);
2971 * Enable or disable a VF traffic receive of an Ethernet device.
2974 * The port identifier of the Ethernet device.
2978 * 1 - Enable a VF traffic receive.
2979 * 0 - Disable a VF traffic receive.
2981 * - (0) if successful.
2982 * - (-ENOTSUP) if hardware doesn't support.
2983 * - (-ENODEV) if *port_id* invalid.
2984 * - (-EINVAL) if bad parameter.
2987 rte_eth_dev_set_vf_rx(uint8_t port,uint16_t vf, uint8_t on);
2990 * Enable/Disable hardware VF VLAN filtering by an Ethernet device of
2991 * received VLAN packets tagged with a given VLAN Tag Identifier.
2994 * The port identifier of the Ethernet device.
2996 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
2998 * Bitmap listing which VFs participate in the VLAN filtering.
3000 * 1 - Enable VFs VLAN filtering.
3001 * 0 - Disable VFs VLAN filtering.
3003 * - (0) if successful.
3004 * - (-ENOTSUP) if hardware doesn't support.
3005 * - (-ENODEV) if *port_id* invalid.
3006 * - (-EINVAL) if bad parameter.
3009 rte_eth_dev_set_vf_vlan_filter(uint8_t port, uint16_t vlan_id,
3014 * Set a traffic mirroring rule on an Ethernet device
3017 * The port identifier of the Ethernet device.
3018 * @param mirror_conf
3019 * The pointer to the traffic mirroring structure describing the mirroring rule.
3020 * The *rte_eth_vm_mirror_conf* structure includes the type of mirroring rule,
3021 * destination pool and the value of rule if enable vlan or pool mirroring.
3024 * The index of traffic mirroring rule, we support four separated rules.
3026 * 1 - Enable a mirroring rule.
3027 * 0 - Disable a mirroring rule.
3029 * - (0) if successful.
3030 * - (-ENOTSUP) if hardware doesn't support this feature.
3031 * - (-ENODEV) if *port_id* invalid.
3032 * - (-EINVAL) if the mr_conf information is not correct.
3034 int rte_eth_mirror_rule_set(uint8_t port_id,
3035 struct rte_eth_mirror_conf *mirror_conf,
3040 * Reset a traffic mirroring rule on an Ethernet device.
3043 * The port identifier of the Ethernet device.
3045 * The index of traffic mirroring rule, we support four separated rules.
3047 * - (0) if successful.
3048 * - (-ENOTSUP) if hardware doesn't support this feature.
3049 * - (-ENODEV) if *port_id* invalid.
3050 * - (-EINVAL) if bad parameter.
3052 int rte_eth_mirror_rule_reset(uint8_t port_id,
3056 * Set the rate limitation for a queue on an Ethernet device.
3059 * The port identifier of the Ethernet device.
3063 * The tx rate allocated from the total link speed for this queue.
3065 * - (0) if successful.
3066 * - (-ENOTSUP) if hardware doesn't support this feature.
3067 * - (-ENODEV) if *port_id* invalid.
3068 * - (-EINVAL) if bad parameter.
3070 int rte_eth_set_queue_rate_limit(uint8_t port_id, uint16_t queue_idx,
3074 * Set the rate limitation for a vf on an Ethernet device.
3077 * The port identifier of the Ethernet device.
3081 * The tx rate allocated from the total link speed for this VF id.
3083 * The queue mask which need to set the rate.
3085 * - (0) if successful.
3086 * - (-ENOTSUP) if hardware doesn't support this feature.
3087 * - (-ENODEV) if *port_id* invalid.
3088 * - (-EINVAL) if bad parameter.
3090 int rte_eth_set_vf_rate_limit(uint8_t port_id, uint16_t vf,
3091 uint16_t tx_rate, uint64_t q_msk);
3094 * Initialize bypass logic. This function needs to be called before
3095 * executing any other bypass API.
3098 * The port identifier of the Ethernet device.
3100 * - (0) if successful.
3101 * - (-ENOTSUP) if hardware doesn't support.
3102 * - (-EINVAL) if bad parameter.
3104 int rte_eth_dev_bypass_init(uint8_t port);
3107 * Return bypass state.
3110 * The port identifier of the Ethernet device.
3112 * The return bypass state.
3115 * - (3) Isolate mode
3117 * - (0) if successful.
3118 * - (-ENOTSUP) if hardware doesn't support.
3119 * - (-EINVAL) if bad parameter.
3121 int rte_eth_dev_bypass_state_show(uint8_t port, uint32_t *state);
3127 * The port identifier of the Ethernet device.
3129 * The current bypass state.
3132 * - (3) Isolate mode
3134 * - (0) if successful.
3135 * - (-ENOTSUP) if hardware doesn't support.
3136 * - (-EINVAL) if bad parameter.
3138 int rte_eth_dev_bypass_state_set(uint8_t port, uint32_t *new_state);
3141 * Return bypass state when given event occurs.
3144 * The port identifier of the Ethernet device.
3147 * - (1) Main power on (power button is pushed)
3148 * - (2) Auxiliary power on (power supply is being plugged)
3149 * - (3) Main power off (system shutdown and power supply is left plugged in)
3150 * - (4) Auxiliary power off (power supply is being unplugged)
3151 * - (5) Display or set the watchdog timer
3153 * The bypass state when given event occurred.
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_event_show(uint8_t port, uint32_t event, uint32_t *state);
3165 * Set bypass state when given event occurs.
3168 * The port identifier of the Ethernet device.
3171 * - (1) Main power on (power button is pushed)
3172 * - (2) Auxiliary power on (power supply is being plugged)
3173 * - (3) Main power off (system shutdown and power supply is left plugged in)
3174 * - (4) Auxiliary power off (power supply is being unplugged)
3175 * - (5) Display or set the watchdog timer
3177 * The assigned state when given event occurs.
3180 * - (3) Isolate mode
3182 * - (0) if successful.
3183 * - (-ENOTSUP) if hardware doesn't support.
3184 * - (-EINVAL) if bad parameter.
3186 int rte_eth_dev_bypass_event_store(uint8_t port, uint32_t event, uint32_t state);
3189 * Set bypass watchdog timeout count.
3192 * The port identifier of the Ethernet device.
3194 * The timeout to be set.
3195 * - (0) 0 seconds (timer is off)
3204 * - (0) if successful.
3205 * - (-ENOTSUP) if hardware doesn't support.
3206 * - (-EINVAL) if bad parameter.
3208 int rte_eth_dev_wd_timeout_store(uint8_t port, uint32_t timeout);
3211 * Get bypass firmware version.
3214 * The port identifier of the Ethernet device.
3216 * The firmware version
3218 * - (0) if successful.
3219 * - (-ENOTSUP) if hardware doesn't support.
3220 * - (-EINVAL) if bad parameter.
3222 int rte_eth_dev_bypass_ver_show(uint8_t port, uint32_t *ver);
3225 * Return bypass watchdog timeout in seconds
3228 * The port identifier of the Ethernet device.
3230 * The return watchdog timeout. "0" represents timer expired
3231 * - (0) 0 seconds (timer is off)
3240 * - (0) if successful.
3241 * - (-ENOTSUP) if hardware doesn't support.
3242 * - (-EINVAL) if bad parameter.
3244 int rte_eth_dev_bypass_wd_timeout_show(uint8_t port, uint32_t *wd_timeout);
3247 * Reset bypass watchdog timer
3250 * The port identifier of the Ethernet device.
3252 * - (0) if successful.
3253 * - (-ENOTSUP) if hardware doesn't support.
3254 * - (-EINVAL) if bad parameter.
3256 int rte_eth_dev_bypass_wd_reset(uint8_t port);
3259 * Configuration of Receive Side Scaling hash computation of Ethernet device.
3262 * The port identifier of the Ethernet device.
3264 * The new configuration to use for RSS hash computation on the port.
3266 * - (0) if successful.
3267 * - (-ENODEV) if port identifier is invalid.
3268 * - (-ENOTSUP) if hardware doesn't support.
3269 * - (-EINVAL) if bad parameter.
3271 int rte_eth_dev_rss_hash_update(uint8_t port_id,
3272 struct rte_eth_rss_conf *rss_conf);
3275 * Retrieve current configuration of Receive Side Scaling hash computation
3276 * of Ethernet device.
3279 * The port identifier of the Ethernet device.
3281 * Where to store the current RSS hash configuration of the Ethernet device.
3283 * - (0) if successful.
3284 * - (-ENODEV) if port identifier is invalid.
3285 * - (-ENOTSUP) if hardware doesn't support RSS.
3288 rte_eth_dev_rss_hash_conf_get(uint8_t port_id,
3289 struct rte_eth_rss_conf *rss_conf);
3292 * Add UDP tunneling port of an Ethernet device for filtering a specific
3293 * tunneling packet by UDP port number.
3296 * The port identifier of the Ethernet device.
3298 * UDP tunneling configuration.
3301 * - (0) if successful.
3302 * - (-ENODEV) if port identifier is invalid.
3303 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3306 rte_eth_dev_udp_tunnel_add(uint8_t port_id,
3307 struct rte_eth_udp_tunnel *tunnel_udp);
3310 * Detete UDP tunneling port configuration of Ethernet device
3313 * The port identifier of the Ethernet device.
3315 * UDP tunneling configuration.
3318 * - (0) if successful.
3319 * - (-ENODEV) if port identifier is invalid.
3320 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3323 rte_eth_dev_udp_tunnel_delete(uint8_t port_id,
3324 struct rte_eth_udp_tunnel *tunnel_udp);
3327 * Check whether the filter type is supported on an Ethernet device.
3328 * All the supported filter types are defined in 'rte_eth_ctrl.h'.
3331 * The port identifier of the Ethernet device.
3332 * @param filter_type
3335 * - (0) if successful.
3336 * - (-ENOTSUP) if hardware doesn't support this filter type.
3337 * - (-ENODEV) if *port_id* invalid.
3339 int rte_eth_dev_filter_supported(uint8_t port_id, enum rte_filter_type filter_type);
3342 * Take operations to assigned filter type on an Ethernet device.
3343 * All the supported operations and filter types are defined in 'rte_eth_ctrl.h'.
3346 * The port identifier of the Ethernet device.
3347 * @param filter_type
3350 * Type of operation.
3352 * A pointer to arguments defined specifically for the operation.
3354 * - (0) if successful.
3355 * - (-ENOTSUP) if hardware doesn't support.
3356 * - (-ENODEV) if *port_id* invalid.
3357 * - others depends on the specific operations implementation.
3359 int rte_eth_dev_filter_ctrl(uint8_t port_id, enum rte_filter_type filter_type,
3360 enum rte_filter_op filter_op, void *arg);
3363 * Get DCB information on an Ethernet device.
3366 * The port identifier of the Ethernet device.
3370 * - (0) if successful.
3371 * - (-ENODEV) if port identifier is invalid.
3372 * - (-ENOTSUP) if hardware doesn't support.
3374 int rte_eth_dev_get_dcb_info(uint8_t port_id,
3375 struct rte_eth_dcb_info *dcb_info);
3378 * Add a callback to be called on packet RX on a given port and queue.
3380 * This API configures a function to be called for each burst of
3381 * packets received on a given NIC port queue. The return value is a pointer
3382 * that can be used to later remove the callback using
3383 * rte_eth_remove_rx_callback().
3385 * Multiple functions are called in the order that they are added.
3388 * The port identifier of the Ethernet device.
3390 * The queue on the Ethernet device on which the callback is to be added.
3392 * The callback function
3394 * A generic pointer parameter which will be passed to each invocation of the
3395 * callback function on this port and queue.
3399 * On success, a pointer value which can later be used to remove the callback.
3401 void *rte_eth_add_rx_callback(uint8_t port_id, uint16_t queue_id,
3402 rte_rx_callback_fn fn, void *user_param);
3405 * Add a callback to be called on packet TX on a given port and queue.
3407 * This API configures a function to be called for each burst of
3408 * packets sent on a given NIC port queue. The return value is a pointer
3409 * that can be used to later remove the callback using
3410 * rte_eth_remove_tx_callback().
3412 * Multiple functions are called in the order that they are added.
3415 * The port identifier of the Ethernet device.
3417 * The queue on the Ethernet device on which the callback is to be added.
3419 * The callback function
3421 * A generic pointer parameter which will be passed to each invocation of the
3422 * callback function on this port and queue.
3426 * On success, a pointer value which can later be used to remove the callback.
3428 void *rte_eth_add_tx_callback(uint8_t port_id, uint16_t queue_id,
3429 rte_tx_callback_fn fn, void *user_param);
3432 * Remove an RX packet callback from a given port and queue.
3434 * This function is used to removed callbacks that were added to a NIC port
3435 * queue using rte_eth_add_rx_callback().
3437 * Note: the callback is removed from the callback list but it isn't freed
3438 * since the it may still be in use. The memory for the callback can be
3439 * subsequently freed back by the application by calling rte_free():
3441 * - Immediately - if the port is stopped, or the user knows that no
3442 * callbacks are in flight e.g. if called from the thread doing RX/TX
3445 * - After a short delay - where the delay is sufficient to allow any
3446 * in-flight callbacks to complete.
3449 * The port identifier of the Ethernet device.
3451 * The queue on the Ethernet device from which the callback is to be removed.
3453 * User supplied callback created via rte_eth_add_rx_callback().
3456 * - 0: Success. Callback was removed.
3457 * - -ENOTSUP: Callback support is not available.
3458 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
3459 * is NULL or not found for the port/queue.
3461 int rte_eth_remove_rx_callback(uint8_t port_id, uint16_t queue_id,
3462 struct rte_eth_rxtx_callback *user_cb);
3465 * Remove a TX packet callback from a given port and queue.
3467 * This function is used to removed callbacks that were added to a NIC port
3468 * queue using rte_eth_add_tx_callback().
3470 * Note: the callback is removed from the callback list but it isn't freed
3471 * since the it may still be in use. The memory for the callback can be
3472 * subsequently freed back by the application by calling rte_free():
3474 * - Immediately - if the port is stopped, or the user knows that no
3475 * callbacks are in flight e.g. if called from the thread doing RX/TX
3478 * - After a short delay - where the delay is sufficient to allow any
3479 * in-flight callbacks to complete.
3482 * The port identifier of the Ethernet device.
3484 * The queue on the Ethernet device from which the callback is to be removed.
3486 * User supplied callback created via rte_eth_add_tx_callback().
3489 * - 0: Success. Callback was removed.
3490 * - -ENOTSUP: Callback support is not available.
3491 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
3492 * is NULL or not found for the port/queue.
3494 int rte_eth_remove_tx_callback(uint8_t port_id, uint16_t queue_id,
3495 struct rte_eth_rxtx_callback *user_cb);
3498 * Retrieve number of available registers for access
3501 * The port identifier of the Ethernet device.
3503 * - (>=0) number of registers if successful.
3504 * - (-ENOTSUP) if hardware doesn't support.
3505 * - (-ENODEV) if *port_id* invalid.
3506 * - others depends on the specific operations implementation.
3508 int rte_eth_dev_get_reg_length(uint8_t port_id);
3511 * Retrieve device registers and register attributes
3514 * The port identifier of the Ethernet device.
3516 * The template includes buffer for register data and attribute to be filled.
3518 * - (0) if successful.
3519 * - (-ENOTSUP) if hardware doesn't support.
3520 * - (-ENODEV) if *port_id* invalid.
3521 * - others depends on the specific operations implementation.
3523 int rte_eth_dev_get_reg_info(uint8_t port_id, struct rte_dev_reg_info *info);
3526 * Retrieve size of device EEPROM
3529 * The port identifier of the Ethernet device.
3531 * - (>=0) EEPROM size if successful.
3532 * - (-ENOTSUP) if hardware doesn't support.
3533 * - (-ENODEV) if *port_id* invalid.
3534 * - others depends on the specific operations implementation.
3536 int rte_eth_dev_get_eeprom_length(uint8_t port_id);
3539 * Retrieve EEPROM and EEPROM attribute
3542 * The port identifier of the Ethernet device.
3544 * The template includes buffer for return EEPROM data and
3545 * EEPROM attributes to be filled.
3547 * - (0) if successful.
3548 * - (-ENOTSUP) if hardware doesn't support.
3549 * - (-ENODEV) if *port_id* invalid.
3550 * - others depends on the specific operations implementation.
3552 int rte_eth_dev_get_eeprom(uint8_t port_id, struct rte_dev_eeprom_info *info);
3555 * Program EEPROM with provided data
3558 * The port identifier of the Ethernet device.
3560 * The template includes EEPROM data for programming and
3561 * EEPROM attributes to be filled
3563 * - (0) if successful.
3564 * - (-ENOTSUP) if hardware doesn't support.
3565 * - (-ENODEV) if *port_id* invalid.
3566 * - others depends on the specific operations implementation.
3568 int rte_eth_dev_set_eeprom(uint8_t port_id, struct rte_dev_eeprom_info *info);
3571 * Set the list of multicast addresses to filter on an Ethernet device.
3574 * The port identifier of the Ethernet device.
3575 * @param mc_addr_set
3576 * The array of multicast addresses to set. Equal to NULL when the function
3577 * is invoked to flush the set of filtered addresses.
3579 * The number of multicast addresses in the *mc_addr_set* array. Equal to 0
3580 * when the function is invoked to flush the set of filtered addresses.
3582 * - (0) if successful.
3583 * - (-ENODEV) if *port_id* invalid.
3584 * - (-ENOTSUP) if PMD of *port_id* doesn't support multicast filtering.
3585 * - (-ENOSPC) if *port_id* has not enough multicast filtering resources.
3587 int rte_eth_dev_set_mc_addr_list(uint8_t port_id,
3588 struct ether_addr *mc_addr_set,
3589 uint32_t nb_mc_addr);
3592 * Enable IEEE1588/802.1AS timestamping for an Ethernet device.
3595 * The port identifier of the Ethernet device.
3599 * - -ENODEV: The port ID is invalid.
3600 * - -ENOTSUP: The function is not supported by the Ethernet driver.
3602 extern int rte_eth_timesync_enable(uint8_t port_id);
3605 * Disable IEEE1588/802.1AS timestamping for an Ethernet device.
3608 * The port identifier of the Ethernet device.
3612 * - -ENODEV: The port ID is invalid.
3613 * - -ENOTSUP: The function is not supported by the Ethernet driver.
3615 extern int rte_eth_timesync_disable(uint8_t port_id);
3618 * Read an IEEE1588/802.1AS RX timestamp from an Ethernet device.
3621 * The port identifier of the Ethernet device.
3623 * Pointer to the timestamp struct.
3625 * Device specific flags. Used to pass the RX timesync register index to
3626 * i40e. Unused in igb/ixgbe, pass 0 instead.
3630 * - -EINVAL: No timestamp is available.
3631 * - -ENODEV: The port ID is invalid.
3632 * - -ENOTSUP: The function is not supported by the Ethernet driver.
3634 extern int rte_eth_timesync_read_rx_timestamp(uint8_t port_id,
3635 struct timespec *timestamp,
3639 * Read an IEEE1588/802.1AS TX timestamp from an Ethernet device.
3642 * The port identifier of the Ethernet device.
3644 * Pointer to the timestamp struct.
3648 * - -EINVAL: No timestamp is available.
3649 * - -ENODEV: The port ID is invalid.
3650 * - -ENOTSUP: The function is not supported by the Ethernet driver.
3652 extern int rte_eth_timesync_read_tx_timestamp(uint8_t port_id,
3653 struct timespec *timestamp);
3659 #endif /* _RTE_ETHDEV_H_ */