4 * Copyright(c) 2010-2014 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.
176 #include <rte_interrupts.h>
178 #include <rte_mbuf.h>
179 #include "rte_ether.h"
180 #include "rte_eth_ctrl.h"
183 * A structure used to retrieve statistics for an Ethernet port.
185 struct rte_eth_stats {
186 uint64_t ipackets; /**< Total number of successfully received packets. */
187 uint64_t opackets; /**< Total number of successfully transmitted packets.*/
188 uint64_t ibytes; /**< Total number of successfully received bytes. */
189 uint64_t obytes; /**< Total number of successfully transmitted bytes. */
190 uint64_t imissed; /**< Total of RX missed packets (e.g full FIFO). */
191 uint64_t ibadcrc; /**< Total of RX packets with CRC error. */
192 uint64_t ibadlen; /**< Total of RX packets with bad length. */
193 uint64_t ierrors; /**< Total number of erroneous received packets. */
194 uint64_t oerrors; /**< Total number of failed transmitted packets. */
195 uint64_t imcasts; /**< Total number of multicast received packets. */
196 uint64_t rx_nombuf; /**< Total number of RX mbuf allocation failures. */
197 uint64_t fdirmatch; /**< Total number of RX packets matching a filter. */
198 uint64_t fdirmiss; /**< Total number of RX packets not matching any filter. */
199 uint64_t tx_pause_xon; /**< Total nb. of XON pause frame sent. */
200 uint64_t rx_pause_xon; /**< Total nb. of XON pause frame received. */
201 uint64_t tx_pause_xoff; /**< Total nb. of XOFF pause frame sent. */
202 uint64_t rx_pause_xoff; /**< Total nb. of XOFF pause frame received. */
203 uint64_t q_ipackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
204 /**< Total number of queue RX packets. */
205 uint64_t q_opackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
206 /**< Total number of queue TX packets. */
207 uint64_t q_ibytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
208 /**< Total number of successfully received queue bytes. */
209 uint64_t q_obytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
210 /**< Total number of successfully transmitted queue bytes. */
211 uint64_t q_errors[RTE_ETHDEV_QUEUE_STAT_CNTRS];
212 /**< Total number of queue packets received that are dropped. */
214 /**< Total number of good packets received from loopback,VF Only */
216 /**< Total number of good packets transmitted to loopback,VF Only */
218 /**< Total number of good bytes received from loopback,VF Only */
220 /**< Total number of good bytes transmitted to loopback,VF Only */
224 * A structure used to retrieve link-level information of an Ethernet port.
226 struct rte_eth_link {
227 uint16_t link_speed; /**< ETH_LINK_SPEED_[10, 100, 1000, 10000] */
228 uint16_t link_duplex; /**< ETH_LINK_[HALF_DUPLEX, FULL_DUPLEX] */
229 uint8_t link_status : 1; /**< 1 -> link up, 0 -> link down */
230 }__attribute__((aligned(8))); /**< aligned for atomic64 read/write */
232 #define ETH_LINK_SPEED_AUTONEG 0 /**< Auto-negotiate link speed. */
233 #define ETH_LINK_SPEED_10 10 /**< 10 megabits/second. */
234 #define ETH_LINK_SPEED_100 100 /**< 100 megabits/second. */
235 #define ETH_LINK_SPEED_1000 1000 /**< 1 gigabits/second. */
236 #define ETH_LINK_SPEED_10000 10000 /**< 10 gigabits/second. */
237 #define ETH_LINK_SPEED_10G 10000 /**< alias of 10 gigabits/second. */
238 #define ETH_LINK_SPEED_20G 20000 /**< 20 gigabits/second. */
239 #define ETH_LINK_SPEED_40G 40000 /**< 40 gigabits/second. */
241 #define ETH_LINK_AUTONEG_DUPLEX 0 /**< Auto-negotiate duplex. */
242 #define ETH_LINK_HALF_DUPLEX 1 /**< Half-duplex connection. */
243 #define ETH_LINK_FULL_DUPLEX 2 /**< Full-duplex connection. */
246 * A structure used to configure the ring threshold registers of an RX/TX
247 * queue for an Ethernet port.
249 struct rte_eth_thresh {
250 uint8_t pthresh; /**< Ring prefetch threshold. */
251 uint8_t hthresh; /**< Ring host threshold. */
252 uint8_t wthresh; /**< Ring writeback threshold. */
256 * Simple flags are used for rte_eth_conf.rxmode.mq_mode.
258 #define ETH_MQ_RX_RSS_FLAG 0x1
259 #define ETH_MQ_RX_DCB_FLAG 0x2
260 #define ETH_MQ_RX_VMDQ_FLAG 0x4
263 * A set of values to identify what method is to be used to route
264 * packets to multiple queues.
266 enum rte_eth_rx_mq_mode {
267 /** None of DCB,RSS or VMDQ mode */
270 /** For RX side, only RSS is on */
271 ETH_MQ_RX_RSS = ETH_MQ_RX_RSS_FLAG,
272 /** For RX side,only DCB is on. */
273 ETH_MQ_RX_DCB = ETH_MQ_RX_DCB_FLAG,
274 /** Both DCB and RSS enable */
275 ETH_MQ_RX_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG,
277 /** Only VMDQ, no RSS nor DCB */
278 ETH_MQ_RX_VMDQ_ONLY = ETH_MQ_RX_VMDQ_FLAG,
279 /** RSS mode with VMDQ */
280 ETH_MQ_RX_VMDQ_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_VMDQ_FLAG,
281 /** Use VMDQ+DCB to route traffic to queues */
282 ETH_MQ_RX_VMDQ_DCB = ETH_MQ_RX_VMDQ_FLAG | ETH_MQ_RX_DCB_FLAG,
283 /** Enable both VMDQ and DCB in VMDq */
284 ETH_MQ_RX_VMDQ_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG |
289 * for rx mq mode backward compatible
291 #define ETH_RSS ETH_MQ_RX_RSS
292 #define VMDQ_DCB ETH_MQ_RX_VMDQ_DCB
293 #define ETH_DCB_RX ETH_MQ_RX_DCB
296 * A set of values to identify what method is to be used to transmit
297 * packets using multi-TCs.
299 enum rte_eth_tx_mq_mode {
300 ETH_MQ_TX_NONE = 0, /**< It is in neither DCB nor VT mode. */
301 ETH_MQ_TX_DCB, /**< For TX side,only DCB is on. */
302 ETH_MQ_TX_VMDQ_DCB, /**< For TX side,both DCB and VT is on. */
303 ETH_MQ_TX_VMDQ_ONLY, /**< Only VT on, no DCB */
307 * for tx mq mode backward compatible
309 #define ETH_DCB_NONE ETH_MQ_TX_NONE
310 #define ETH_VMDQ_DCB_TX ETH_MQ_TX_VMDQ_DCB
311 #define ETH_DCB_TX ETH_MQ_TX_DCB
314 * A structure used to configure the RX features of an Ethernet port.
316 struct rte_eth_rxmode {
317 /** The multi-queue packet distribution mode to be used, e.g. RSS. */
318 enum rte_eth_rx_mq_mode mq_mode;
319 uint32_t max_rx_pkt_len; /**< Only used if jumbo_frame enabled. */
320 uint16_t split_hdr_size; /**< hdr buf size (header_split enabled).*/
321 uint8_t header_split : 1, /**< Header Split enable. */
322 hw_ip_checksum : 1, /**< IP/UDP/TCP checksum offload enable. */
323 hw_vlan_filter : 1, /**< VLAN filter enable. */
324 hw_vlan_strip : 1, /**< VLAN strip enable. */
325 hw_vlan_extend : 1, /**< Extended VLAN enable. */
326 jumbo_frame : 1, /**< Jumbo Frame Receipt enable. */
327 hw_strip_crc : 1, /**< Enable CRC stripping by hardware. */
328 enable_scatter : 1; /**< Enable scatter packets rx handler */
332 * A structure used to configure the Receive Side Scaling (RSS) feature
333 * of an Ethernet port.
334 * If not NULL, the *rss_key* pointer of the *rss_conf* structure points
335 * to an array holding the RSS key to use for hashing specific header
336 * fields of received packets. The length of this array should be indicated
337 * by *rss_key_len* below. Otherwise, a default random hash key is used by
340 * The *rss_key_len* field of the *rss_conf* structure indicates the length
341 * in bytes of the array pointed by *rss_key*. To be compatible, this length
342 * will be checked in i40e only. Others assume 40 bytes to be used as before.
344 * The *rss_hf* field of the *rss_conf* structure indicates the different
345 * types of IPv4/IPv6 packets to which the RSS hashing must be applied.
346 * Supplying an *rss_hf* equal to zero disables the RSS feature.
348 struct rte_eth_rss_conf {
349 uint8_t *rss_key; /**< If not NULL, 40-byte hash key. */
350 uint8_t rss_key_len; /**< hash key length in bytes. */
351 uint64_t rss_hf; /**< Hash functions to apply - see below. */
355 * The RSS offload types are defined based on flow types which are defined
356 * in rte_eth_ctrl.h. Different NIC hardwares may support different RSS offload
357 * types. The supported flow types or RSS offload types can be queried by
358 * rte_eth_dev_info_get().
360 #define ETH_RSS_IPV4 (1ULL << RTE_ETH_FLOW_IPV4)
361 #define ETH_RSS_FRAG_IPV4 (1ULL << RTE_ETH_FLOW_FRAG_IPV4)
362 #define ETH_RSS_NONFRAG_IPV4_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_TCP)
363 #define ETH_RSS_NONFRAG_IPV4_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_UDP)
364 #define ETH_RSS_NONFRAG_IPV4_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_SCTP)
365 #define ETH_RSS_NONFRAG_IPV4_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_OTHER)
366 #define ETH_RSS_IPV6 (1ULL << RTE_ETH_FLOW_IPV6)
367 #define ETH_RSS_FRAG_IPV6 (1ULL << RTE_ETH_FLOW_FRAG_IPV6)
368 #define ETH_RSS_NONFRAG_IPV6_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_TCP)
369 #define ETH_RSS_NONFRAG_IPV6_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_UDP)
370 #define ETH_RSS_NONFRAG_IPV6_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_SCTP)
371 #define ETH_RSS_NONFRAG_IPV6_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_OTHER)
372 #define ETH_RSS_L2_PAYLOAD (1ULL << RTE_ETH_FLOW_L2_PAYLOAD)
373 #define ETH_RSS_IPV6_EX (1ULL << RTE_ETH_FLOW_IPV6_EX)
374 #define ETH_RSS_IPV6_TCP_EX (1ULL << RTE_ETH_FLOW_IPV6_TCP_EX)
375 #define ETH_RSS_IPV6_UDP_EX (1ULL << RTE_ETH_FLOW_IPV6_UDP_EX)
377 #define ETH_RSS_IP ( \
379 ETH_RSS_FRAG_IPV4 | \
380 ETH_RSS_NONFRAG_IPV4_OTHER | \
382 ETH_RSS_FRAG_IPV6 | \
383 ETH_RSS_NONFRAG_IPV6_OTHER | \
386 #define ETH_RSS_UDP ( \
387 ETH_RSS_NONFRAG_IPV4_UDP | \
388 ETH_RSS_NONFRAG_IPV6_UDP | \
391 #define ETH_RSS_TCP ( \
392 ETH_RSS_NONFRAG_IPV4_TCP | \
393 ETH_RSS_NONFRAG_IPV6_TCP | \
396 #define ETH_RSS_SCTP ( \
397 ETH_RSS_NONFRAG_IPV4_SCTP | \
398 ETH_RSS_NONFRAG_IPV6_SCTP)
400 /**< Mask of valid RSS hash protocols */
401 #define ETH_RSS_PROTO_MASK ( \
403 ETH_RSS_FRAG_IPV4 | \
404 ETH_RSS_NONFRAG_IPV4_TCP | \
405 ETH_RSS_NONFRAG_IPV4_UDP | \
406 ETH_RSS_NONFRAG_IPV4_SCTP | \
407 ETH_RSS_NONFRAG_IPV4_OTHER | \
409 ETH_RSS_FRAG_IPV6 | \
410 ETH_RSS_NONFRAG_IPV6_TCP | \
411 ETH_RSS_NONFRAG_IPV6_UDP | \
412 ETH_RSS_NONFRAG_IPV6_SCTP | \
413 ETH_RSS_NONFRAG_IPV6_OTHER | \
414 ETH_RSS_L2_PAYLOAD | \
416 ETH_RSS_IPV6_TCP_EX | \
420 * Definitions used for redirection table entry size.
421 * Some RSS RETA sizes may not be supported by some drivers, check the
422 * documentation or the description of relevant functions for more details.
424 #define ETH_RSS_RETA_SIZE_64 64
425 #define ETH_RSS_RETA_SIZE_128 128
426 #define ETH_RSS_RETA_SIZE_512 512
427 #define RTE_RETA_GROUP_SIZE 64
429 /* Definitions used for VMDQ and DCB functionality */
430 #define ETH_VMDQ_MAX_VLAN_FILTERS 64 /**< Maximum nb. of VMDQ vlan filters. */
431 #define ETH_DCB_NUM_USER_PRIORITIES 8 /**< Maximum nb. of DCB priorities. */
432 #define ETH_VMDQ_DCB_NUM_QUEUES 128 /**< Maximum nb. of VMDQ DCB queues. */
433 #define ETH_DCB_NUM_QUEUES 128 /**< Maximum nb. of DCB queues. */
435 /* DCB capability defines */
436 #define ETH_DCB_PG_SUPPORT 0x00000001 /**< Priority Group(ETS) support. */
437 #define ETH_DCB_PFC_SUPPORT 0x00000002 /**< Priority Flow Control support. */
439 /* Definitions used for VLAN Offload functionality */
440 #define ETH_VLAN_STRIP_OFFLOAD 0x0001 /**< VLAN Strip On/Off */
441 #define ETH_VLAN_FILTER_OFFLOAD 0x0002 /**< VLAN Filter On/Off */
442 #define ETH_VLAN_EXTEND_OFFLOAD 0x0004 /**< VLAN Extend On/Off */
444 /* Definitions used for mask VLAN setting */
445 #define ETH_VLAN_STRIP_MASK 0x0001 /**< VLAN Strip setting mask */
446 #define ETH_VLAN_FILTER_MASK 0x0002 /**< VLAN Filter setting mask*/
447 #define ETH_VLAN_EXTEND_MASK 0x0004 /**< VLAN Extend setting mask*/
448 #define ETH_VLAN_ID_MAX 0x0FFF /**< VLAN ID is in lower 12 bits*/
450 /* Definitions used for receive MAC address */
451 #define ETH_NUM_RECEIVE_MAC_ADDR 128 /**< Maximum nb. of receive mac addr. */
453 /* Definitions used for unicast hash */
454 #define ETH_VMDQ_NUM_UC_HASH_ARRAY 128 /**< Maximum nb. of UC hash array. */
456 /* Definitions used for VMDQ pool rx mode setting */
457 #define ETH_VMDQ_ACCEPT_UNTAG 0x0001 /**< accept untagged packets. */
458 #define ETH_VMDQ_ACCEPT_HASH_MC 0x0002 /**< accept packets in multicast table . */
459 #define ETH_VMDQ_ACCEPT_HASH_UC 0x0004 /**< accept packets in unicast table. */
460 #define ETH_VMDQ_ACCEPT_BROADCAST 0x0008 /**< accept broadcast packets. */
461 #define ETH_VMDQ_ACCEPT_MULTICAST 0x0010 /**< multicast promiscuous. */
463 /* Definitions used for VMDQ mirror rules setting */
464 #define ETH_VMDQ_NUM_MIRROR_RULE 4 /**< Maximum nb. of mirror rules. . */
466 #define ETH_VMDQ_POOL_MIRROR 0x0001 /**< Virtual Pool Mirroring. */
467 #define ETH_VMDQ_UPLINK_MIRROR 0x0002 /**< Uplink Port Mirroring. */
468 #define ETH_VMDQ_DOWNLIN_MIRROR 0x0004 /**< Downlink Port Mirroring. */
469 #define ETH_VMDQ_VLAN_MIRROR 0x0008 /**< VLAN Mirroring. */
472 * A structure used to configure VLAN traffic mirror of an Ethernet port.
474 struct rte_eth_vlan_mirror {
475 uint64_t vlan_mask; /**< mask for valid VLAN ID. */
476 uint16_t vlan_id[ETH_VMDQ_MAX_VLAN_FILTERS];
477 /** VLAN ID list for vlan mirror. */
481 * A structure used to configure traffic mirror of an Ethernet port.
483 struct rte_eth_vmdq_mirror_conf {
484 uint8_t rule_type_mask; /**< Mirroring rule type mask we want to set */
485 uint8_t dst_pool; /**< Destination pool for this mirror rule. */
486 uint64_t pool_mask; /**< Bitmap of pool for pool mirroring */
487 struct rte_eth_vlan_mirror vlan; /**< VLAN ID setting for VLAN mirroring */
491 * A structure used to configure 64 entries of Redirection Table of the
492 * Receive Side Scaling (RSS) feature of an Ethernet port. To configure
493 * more than 64 entries supported by hardware, an array of this structure
496 struct rte_eth_rss_reta_entry64 {
498 /**< Mask bits indicate which entries need to be updated/queried. */
499 uint8_t reta[RTE_RETA_GROUP_SIZE];
500 /**< Group of 64 redirection table entries. */
504 * This enum indicates the possible number of traffic classes
505 * in DCB configratioins
507 enum rte_eth_nb_tcs {
508 ETH_4_TCS = 4, /**< 4 TCs with DCB. */
509 ETH_8_TCS = 8 /**< 8 TCs with DCB. */
513 * This enum indicates the possible number of queue pools
514 * in VMDQ configurations.
516 enum rte_eth_nb_pools {
517 ETH_8_POOLS = 8, /**< 8 VMDq pools. */
518 ETH_16_POOLS = 16, /**< 16 VMDq pools. */
519 ETH_32_POOLS = 32, /**< 32 VMDq pools. */
520 ETH_64_POOLS = 64 /**< 64 VMDq pools. */
523 /* This structure may be extended in future. */
524 struct rte_eth_dcb_rx_conf {
525 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs */
526 uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
527 /**< Possible DCB queue,4 or 8. */
530 struct rte_eth_vmdq_dcb_tx_conf {
531 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools. */
532 uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
533 /**< Possible DCB queue,4 or 8. */
536 struct rte_eth_dcb_tx_conf {
537 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs. */
538 uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
539 /**< Possible DCB queue,4 or 8. */
542 struct rte_eth_vmdq_tx_conf {
543 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq mode, 64 pools. */
547 * A structure used to configure the VMDQ+DCB feature
548 * of an Ethernet port.
550 * Using this feature, packets are routed to a pool of queues, based
551 * on the vlan id in the vlan tag, and then to a specific queue within
552 * that pool, using the user priority vlan tag field.
554 * A default pool may be used, if desired, to route all traffic which
555 * does not match the vlan filter rules.
557 struct rte_eth_vmdq_dcb_conf {
558 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools */
559 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
560 uint8_t default_pool; /**< The default pool, if applicable */
561 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
563 uint16_t vlan_id; /**< The vlan id of the received frame */
564 uint64_t pools; /**< Bitmask of pools for packet rx */
565 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
566 uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
567 /**< Selects a queue in a pool */
570 struct rte_eth_vmdq_rx_conf {
571 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq only mode, 8 or 64 pools */
572 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
573 uint8_t default_pool; /**< The default pool, if applicable */
574 uint8_t enable_loop_back; /**< Enable VT loop back */
575 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
576 uint32_t rx_mode; /**< Flags from ETH_VMDQ_ACCEPT_* */
578 uint16_t vlan_id; /**< The vlan id of the received frame */
579 uint64_t pools; /**< Bitmask of pools for packet rx */
580 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
584 * A structure used to configure the TX features of an Ethernet port.
586 struct rte_eth_txmode {
587 enum rte_eth_tx_mq_mode mq_mode; /**< TX multi-queues mode. */
589 /* For i40e specifically */
591 uint8_t hw_vlan_reject_tagged : 1,
592 /**< If set, reject sending out tagged pkts */
593 hw_vlan_reject_untagged : 1,
594 /**< If set, reject sending out untagged pkts */
595 hw_vlan_insert_pvid : 1;
596 /**< If set, enable port based VLAN insertion */
600 * A structure used to configure an RX ring of an Ethernet port.
602 struct rte_eth_rxconf {
603 struct rte_eth_thresh rx_thresh; /**< RX ring threshold registers. */
604 uint16_t rx_free_thresh; /**< Drives the freeing of RX descriptors. */
605 uint8_t rx_drop_en; /**< Drop packets if no descriptors are available. */
606 uint8_t rx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
609 #define ETH_TXQ_FLAGS_NOMULTSEGS 0x0001 /**< nb_segs=1 for all mbufs */
610 #define ETH_TXQ_FLAGS_NOREFCOUNT 0x0002 /**< refcnt can be ignored */
611 #define ETH_TXQ_FLAGS_NOMULTMEMP 0x0004 /**< all bufs come from same mempool */
612 #define ETH_TXQ_FLAGS_NOVLANOFFL 0x0100 /**< disable VLAN offload */
613 #define ETH_TXQ_FLAGS_NOXSUMSCTP 0x0200 /**< disable SCTP checksum offload */
614 #define ETH_TXQ_FLAGS_NOXSUMUDP 0x0400 /**< disable UDP checksum offload */
615 #define ETH_TXQ_FLAGS_NOXSUMTCP 0x0800 /**< disable TCP checksum offload */
616 #define ETH_TXQ_FLAGS_NOOFFLOADS \
617 (ETH_TXQ_FLAGS_NOVLANOFFL | ETH_TXQ_FLAGS_NOXSUMSCTP | \
618 ETH_TXQ_FLAGS_NOXSUMUDP | ETH_TXQ_FLAGS_NOXSUMTCP)
619 #define ETH_TXQ_FLAGS_NOXSUMS \
620 (ETH_TXQ_FLAGS_NOXSUMSCTP | ETH_TXQ_FLAGS_NOXSUMUDP | \
621 ETH_TXQ_FLAGS_NOXSUMTCP)
623 * A structure used to configure a TX ring of an Ethernet port.
625 struct rte_eth_txconf {
626 struct rte_eth_thresh tx_thresh; /**< TX ring threshold registers. */
627 uint16_t tx_rs_thresh; /**< Drives the setting of RS bit on TXDs. */
628 uint16_t tx_free_thresh; /**< Drives the freeing of TX buffers. */
629 uint32_t txq_flags; /**< Set flags for the Tx queue */
630 uint8_t tx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
634 * This enum indicates the flow control mode
636 enum rte_eth_fc_mode {
637 RTE_FC_NONE = 0, /**< Disable flow control. */
638 RTE_FC_RX_PAUSE, /**< RX pause frame, enable flowctrl on TX side. */
639 RTE_FC_TX_PAUSE, /**< TX pause frame, enable flowctrl on RX side. */
640 RTE_FC_FULL /**< Enable flow control on both side. */
644 * A structure used to configure Ethernet flow control parameter.
645 * These parameters will be configured into the register of the NIC.
646 * Please refer to the corresponding data sheet for proper value.
648 struct rte_eth_fc_conf {
649 uint32_t high_water; /**< High threshold value to trigger XOFF */
650 uint32_t low_water; /**< Low threshold value to trigger XON */
651 uint16_t pause_time; /**< Pause quota in the Pause frame */
652 uint16_t send_xon; /**< Is XON frame need be sent */
653 enum rte_eth_fc_mode mode; /**< Link flow control mode */
654 uint8_t mac_ctrl_frame_fwd; /**< Forward MAC control frames */
655 uint8_t autoneg; /**< Use Pause autoneg */
659 * A structure used to configure Ethernet priority flow control parameter.
660 * These parameters will be configured into the register of the NIC.
661 * Please refer to the corresponding data sheet for proper value.
663 struct rte_eth_pfc_conf {
664 struct rte_eth_fc_conf fc; /**< General flow control parameter. */
665 uint8_t priority; /**< VLAN User Priority. */
669 * Memory space that can be configured to store Flow Director filters
670 * in the board memory.
672 enum rte_fdir_pballoc_type {
673 RTE_FDIR_PBALLOC_64K = 0, /**< 64k. */
674 RTE_FDIR_PBALLOC_128K, /**< 128k. */
675 RTE_FDIR_PBALLOC_256K, /**< 256k. */
679 * Select report mode of FDIR hash information in RX descriptors.
681 enum rte_fdir_status_mode {
682 RTE_FDIR_NO_REPORT_STATUS = 0, /**< Never report FDIR hash. */
683 RTE_FDIR_REPORT_STATUS, /**< Only report FDIR hash for matching pkts. */
684 RTE_FDIR_REPORT_STATUS_ALWAYS, /**< Always report FDIR hash. */
688 * A structure used to configure the Flow Director (FDIR) feature
689 * of an Ethernet port.
691 * If mode is RTE_FDIR_DISABLE, the pballoc value is ignored.
693 struct rte_fdir_conf {
694 enum rte_fdir_mode mode; /**< Flow Director mode. */
695 enum rte_fdir_pballoc_type pballoc; /**< Space for FDIR filters. */
696 enum rte_fdir_status_mode status; /**< How to report FDIR hash. */
697 /** RX queue of packets matching a "drop" filter in perfect mode. */
699 struct rte_eth_fdir_masks mask;
700 struct rte_eth_fdir_flex_conf flex_conf;
701 /**< Flex payload configuration. */
705 * UDP tunneling configuration.
707 struct rte_eth_udp_tunnel {
713 * Possible l4type of FDIR filters.
716 RTE_FDIR_L4TYPE_NONE = 0, /**< None. */
717 RTE_FDIR_L4TYPE_UDP, /**< UDP. */
718 RTE_FDIR_L4TYPE_TCP, /**< TCP. */
719 RTE_FDIR_L4TYPE_SCTP, /**< SCTP. */
723 * Select IPv4 or IPv6 FDIR filters.
726 RTE_FDIR_IPTYPE_IPV4 = 0, /**< IPv4. */
727 RTE_FDIR_IPTYPE_IPV6 , /**< IPv6. */
731 * A structure used to define a FDIR packet filter.
733 struct rte_fdir_filter {
734 uint16_t flex_bytes; /**< Flex bytes value to match. */
735 uint16_t vlan_id; /**< VLAN ID value to match, 0 otherwise. */
736 uint16_t port_src; /**< Source port to match, 0 otherwise. */
737 uint16_t port_dst; /**< Destination port to match, 0 otherwise. */
739 uint32_t ipv4_addr; /**< IPv4 source address to match. */
740 uint32_t ipv6_addr[4]; /**< IPv6 source address to match. */
741 } ip_src; /**< IPv4/IPv6 source address to match (union of above). */
743 uint32_t ipv4_addr; /**< IPv4 destination address to match. */
744 uint32_t ipv6_addr[4]; /**< IPv6 destination address to match */
745 } ip_dst; /**< IPv4/IPv6 destination address to match (union of above). */
746 enum rte_l4type l4type; /**< l4type to match: NONE/UDP/TCP/SCTP. */
747 enum rte_iptype iptype; /**< IP packet type to match: IPv4 or IPv6. */
751 * A structure used to configure FDIR masks that are used by the device
752 * to match the various fields of RX packet headers.
753 * @note The only_ip_flow field has the opposite meaning compared to other
756 struct rte_fdir_masks {
757 /** When set to 1, packet l4type is \b NOT relevant in filters, and
758 source and destination port masks must be set to zero. */
759 uint8_t only_ip_flow;
760 /** If set to 1, vlan_id is relevant in filters. */
762 /** If set to 1, vlan_prio is relevant in filters. */
764 /** If set to 1, flexbytes is relevant in filters. */
766 /** If set to 1, set the IPv6 masks. Otherwise set the IPv4 masks. */
767 uint8_t set_ipv6_mask;
768 /** When set to 1, comparison of destination IPv6 address with IP6AT
769 registers is meaningful. */
770 uint8_t comp_ipv6_dst;
771 /** Mask of Destination IPv4 Address. All bits set to 1 define the
772 relevant bits to use in the destination address of an IPv4 packet
773 when matching it against FDIR filters. */
774 uint32_t dst_ipv4_mask;
775 /** Mask of Source IPv4 Address. All bits set to 1 define
776 the relevant bits to use in the source address of an IPv4 packet
777 when matching it against FDIR filters. */
778 uint32_t src_ipv4_mask;
779 /** Mask of Source IPv6 Address. All bits set to 1 define the
780 relevant BYTES to use in the source address of an IPv6 packet
781 when matching it against FDIR filters. */
782 uint16_t dst_ipv6_mask;
783 /** Mask of Destination IPv6 Address. All bits set to 1 define the
784 relevant BYTES to use in the destination address of an IPv6 packet
785 when matching it against FDIR filters. */
786 uint16_t src_ipv6_mask;
787 /** Mask of Source Port. All bits set to 1 define the relevant
788 bits to use in the source port of an IP packets when matching it
789 against FDIR filters. */
790 uint16_t src_port_mask;
791 /** Mask of Destination Port. All bits set to 1 define the relevant
792 bits to use in the destination port of an IP packet when matching it
793 against FDIR filters. */
794 uint16_t dst_port_mask;
798 * A structure used to report the status of the flow director filters in use.
800 struct rte_eth_fdir {
801 /** Number of filters with collision indication. */
803 /** Number of free (non programmed) filters. */
805 /** The Lookup hash value of the added filter that updated the value
806 of the MAXLEN field */
808 /** Longest linked list of filters in the table. */
810 /** Number of added filters. */
812 /** Number of removed filters. */
814 /** Number of failed added filters (no more space in device). */
816 /** Number of failed removed filters. */
821 * A structure used to enable/disable specific device interrupts.
823 struct rte_intr_conf {
824 /** enable/disable lsc interrupt. 0 (default) - disable, 1 enable */
829 * A structure used to configure an Ethernet port.
830 * Depending upon the RX multi-queue mode, extra advanced
831 * configuration settings may be needed.
833 struct rte_eth_conf {
835 /**< ETH_LINK_SPEED_10[0|00|000], or 0 for autonegotation */
836 uint16_t link_duplex;
837 /**< ETH_LINK_[HALF_DUPLEX|FULL_DUPLEX], or 0 for autonegotation */
838 struct rte_eth_rxmode rxmode; /**< Port RX configuration. */
839 struct rte_eth_txmode txmode; /**< Port TX configuration. */
840 uint32_t lpbk_mode; /**< Loopback operation mode. By default the value
841 is 0, meaning the loopback mode is disabled.
842 Read the datasheet of given ethernet controller
843 for details. The possible values of this field
844 are defined in implementation of each driver. */
846 struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
847 struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
848 /**< Port vmdq+dcb configuration. */
849 struct rte_eth_dcb_rx_conf dcb_rx_conf;
850 /**< Port dcb RX configuration. */
851 struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
852 /**< Port vmdq RX configuration. */
853 } rx_adv_conf; /**< Port RX filtering configuration (union). */
855 struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
856 /**< Port vmdq+dcb TX configuration. */
857 struct rte_eth_dcb_tx_conf dcb_tx_conf;
858 /**< Port dcb TX configuration. */
859 struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
860 /**< Port vmdq TX configuration. */
861 } tx_adv_conf; /**< Port TX DCB configuration (union). */
862 /** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
863 is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
864 uint32_t dcb_capability_en;
865 struct rte_fdir_conf fdir_conf; /**< FDIR configuration. */
866 struct rte_intr_conf intr_conf; /**< Interrupt mode configuration. */
870 * A structure used to retrieve the contextual information of
871 * an Ethernet device, such as the controlling driver of the device,
872 * its PCI context, etc...
876 * RX offload capabilities of a device.
878 #define DEV_RX_OFFLOAD_VLAN_STRIP 0x00000001
879 #define DEV_RX_OFFLOAD_IPV4_CKSUM 0x00000002
880 #define DEV_RX_OFFLOAD_UDP_CKSUM 0x00000004
881 #define DEV_RX_OFFLOAD_TCP_CKSUM 0x00000008
882 #define DEV_RX_OFFLOAD_TCP_LRO 0x00000010
885 * TX offload capabilities of a device.
887 #define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001
888 #define DEV_TX_OFFLOAD_IPV4_CKSUM 0x00000002
889 #define DEV_TX_OFFLOAD_UDP_CKSUM 0x00000004
890 #define DEV_TX_OFFLOAD_TCP_CKSUM 0x00000008
891 #define DEV_TX_OFFLOAD_SCTP_CKSUM 0x00000010
892 #define DEV_TX_OFFLOAD_TCP_TSO 0x00000020
893 #define DEV_TX_OFFLOAD_UDP_TSO 0x00000040
894 #define DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000080 /**< Used for tunneling packet. */
896 struct rte_eth_dev_info {
897 struct rte_pci_device *pci_dev; /**< Device PCI information. */
898 const char *driver_name; /**< Device Driver name. */
899 unsigned int if_index; /**< Index to bound host interface, or 0 if none.
900 Use if_indextoname() to translate into an interface name. */
901 uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
902 uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
903 uint16_t max_rx_queues; /**< Maximum number of RX queues. */
904 uint16_t max_tx_queues; /**< Maximum number of TX queues. */
905 uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
906 uint32_t max_hash_mac_addrs;
907 /** Maximum number of hash MAC addresses for MTA and UTA. */
908 uint16_t max_vfs; /**< Maximum number of VFs. */
909 uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
910 uint32_t rx_offload_capa; /**< Device RX offload capabilities. */
911 uint32_t tx_offload_capa; /**< Device TX offload capabilities. */
913 /**< Device redirection table size, the total number of entries. */
914 /** Bit mask of RSS offloads, the bit offset also means flow type */
915 uint64_t flow_type_rss_offloads;
916 struct rte_eth_rxconf default_rxconf; /**< Default RX configuration */
917 struct rte_eth_txconf default_txconf; /**< Default TX configuration */
918 uint16_t vmdq_queue_base; /**< First queue ID for VMDQ pools. */
919 uint16_t vmdq_queue_num; /**< Queue number for VMDQ pools. */
920 uint16_t vmdq_pool_base; /**< First ID of VMDQ pools. */
923 /** Maximum name length for extended statistics counters */
924 #define RTE_ETH_XSTATS_NAME_SIZE 64
927 * An Ethernet device extended statistic structure
929 * This structure is used by ethdev->eth_xstats_get() to provide
930 * statistics that are not provided in the generic rte_eth_stats
933 struct rte_eth_xstats {
934 char name[RTE_ETH_XSTATS_NAME_SIZE];
940 struct rte_eth_dev_callback;
941 /** @internal Structure to keep track of registered callbacks */
942 TAILQ_HEAD(rte_eth_dev_cb_list, rte_eth_dev_callback);
945 * Definitions of all functions exported by an Ethernet driver through the
946 * the generic structure of type *eth_dev_ops* supplied in the *rte_eth_dev*
947 * structure associated with an Ethernet device.
950 typedef int (*eth_dev_configure_t)(struct rte_eth_dev *dev);
951 /**< @internal Ethernet device configuration. */
953 typedef int (*eth_dev_start_t)(struct rte_eth_dev *dev);
954 /**< @internal Function used to start a configured Ethernet device. */
956 typedef void (*eth_dev_stop_t)(struct rte_eth_dev *dev);
957 /**< @internal Function used to stop a configured Ethernet device. */
959 typedef int (*eth_dev_set_link_up_t)(struct rte_eth_dev *dev);
960 /**< @internal Function used to link up a configured Ethernet device. */
962 typedef int (*eth_dev_set_link_down_t)(struct rte_eth_dev *dev);
963 /**< @internal Function used to link down a configured Ethernet device. */
965 typedef void (*eth_dev_close_t)(struct rte_eth_dev *dev);
966 /**< @internal Function used to close a configured Ethernet device. */
968 typedef void (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev);
969 /**< @internal Function used to enable the RX promiscuous mode of an Ethernet device. */
971 typedef void (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev);
972 /**< @internal Function used to disable the RX promiscuous mode of an Ethernet device. */
974 typedef void (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
975 /**< @internal Enable the receipt of all multicast packets by an Ethernet device. */
977 typedef void (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
978 /**< @internal Disable the receipt of all multicast packets by an Ethernet device. */
980 typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
981 int wait_to_complete);
982 /**< @internal Get link speed, duplex mode and state (up/down) of an Ethernet device. */
984 typedef void (*eth_stats_get_t)(struct rte_eth_dev *dev,
985 struct rte_eth_stats *igb_stats);
986 /**< @internal Get global I/O statistics of an Ethernet device. */
988 typedef void (*eth_stats_reset_t)(struct rte_eth_dev *dev);
989 /**< @internal Reset global I/O statistics of an Ethernet device to 0. */
991 typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev,
992 struct rte_eth_xstats *stats, unsigned n);
993 /**< @internal Get extended stats of an Ethernet device. */
995 typedef void (*eth_xstats_reset_t)(struct rte_eth_dev *dev);
996 /**< @internal Reset extended stats of an Ethernet device. */
998 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
1002 /**< @internal Set a queue statistics mapping for a tx/rx queue of an Ethernet device. */
1004 typedef void (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
1005 struct rte_eth_dev_info *dev_info);
1006 /**< @internal Get specific informations of an Ethernet device. */
1008 typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
1010 /**< @internal Start rx and tx of a queue of an Ethernet device. */
1012 typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
1014 /**< @internal Stop rx and tx of a queue of an Ethernet device. */
1016 typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
1017 uint16_t rx_queue_id,
1018 uint16_t nb_rx_desc,
1019 unsigned int socket_id,
1020 const struct rte_eth_rxconf *rx_conf,
1021 struct rte_mempool *mb_pool);
1022 /**< @internal Set up a receive queue of an Ethernet device. */
1024 typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
1025 uint16_t tx_queue_id,
1026 uint16_t nb_tx_desc,
1027 unsigned int socket_id,
1028 const struct rte_eth_txconf *tx_conf);
1029 /**< @internal Setup a transmit queue of an Ethernet device. */
1031 typedef void (*eth_queue_release_t)(void *queue);
1032 /**< @internal Release memory resources allocated by given RX/TX queue. */
1034 typedef uint32_t (*eth_rx_queue_count_t)(struct rte_eth_dev *dev,
1035 uint16_t rx_queue_id);
1036 /**< @Get number of available descriptors on a receive queue of an Ethernet device. */
1038 typedef int (*eth_rx_descriptor_done_t)(void *rxq, uint16_t offset);
1039 /**< @Check DD bit of specific RX descriptor */
1041 typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);
1042 /**< @internal Set MTU. */
1044 typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
1047 /**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */
1049 typedef void (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
1051 /**< @internal set the outer VLAN-TPID by an Ethernet device. */
1053 typedef void (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
1054 /**< @internal set VLAN offload function by an Ethernet device. */
1056 typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
1059 /**< @internal set port based TX VLAN insertion by an Ethernet device. */
1061 typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
1062 uint16_t rx_queue_id,
1064 /**< @internal VLAN stripping enable/disable by an queue of Ethernet device. */
1066 typedef uint16_t (*eth_rx_burst_t)(void *rxq,
1067 struct rte_mbuf **rx_pkts,
1069 /**< @internal Retrieve input packets from a receive queue of an Ethernet device. */
1071 typedef uint16_t (*eth_tx_burst_t)(void *txq,
1072 struct rte_mbuf **tx_pkts,
1074 /**< @internal Send output packets on a transmit queue of an Ethernet device. */
1076 typedef int (*fdir_add_signature_filter_t)(struct rte_eth_dev *dev,
1077 struct rte_fdir_filter *fdir_ftr,
1079 /**< @internal Setup a new signature filter rule on an Ethernet device */
1081 typedef int (*fdir_update_signature_filter_t)(struct rte_eth_dev *dev,
1082 struct rte_fdir_filter *fdir_ftr,
1084 /**< @internal Update a signature filter rule on an Ethernet device */
1086 typedef int (*fdir_remove_signature_filter_t)(struct rte_eth_dev *dev,
1087 struct rte_fdir_filter *fdir_ftr);
1088 /**< @internal Remove a signature filter rule on an Ethernet device */
1090 typedef void (*fdir_infos_get_t)(struct rte_eth_dev *dev,
1091 struct rte_eth_fdir *fdir);
1092 /**< @internal Get information about fdir status */
1094 typedef int (*fdir_add_perfect_filter_t)(struct rte_eth_dev *dev,
1095 struct rte_fdir_filter *fdir_ftr,
1096 uint16_t soft_id, uint8_t rx_queue,
1098 /**< @internal Setup a new perfect filter rule on an Ethernet device */
1100 typedef int (*fdir_update_perfect_filter_t)(struct rte_eth_dev *dev,
1101 struct rte_fdir_filter *fdir_ftr,
1102 uint16_t soft_id, uint8_t rx_queue,
1104 /**< @internal Update a perfect filter rule on an Ethernet device */
1106 typedef int (*fdir_remove_perfect_filter_t)(struct rte_eth_dev *dev,
1107 struct rte_fdir_filter *fdir_ftr,
1109 /**< @internal Remove a perfect filter rule on an Ethernet device */
1111 typedef int (*fdir_set_masks_t)(struct rte_eth_dev *dev,
1112 struct rte_fdir_masks *fdir_masks);
1113 /**< @internal Setup flow director masks on an Ethernet device */
1115 typedef int (*flow_ctrl_get_t)(struct rte_eth_dev *dev,
1116 struct rte_eth_fc_conf *fc_conf);
1117 /**< @internal Get current flow control parameter on an Ethernet device */
1119 typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
1120 struct rte_eth_fc_conf *fc_conf);
1121 /**< @internal Setup flow control parameter on an Ethernet device */
1123 typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
1124 struct rte_eth_pfc_conf *pfc_conf);
1125 /**< @internal Setup priority flow control parameter on an Ethernet device */
1127 typedef int (*reta_update_t)(struct rte_eth_dev *dev,
1128 struct rte_eth_rss_reta_entry64 *reta_conf,
1129 uint16_t reta_size);
1130 /**< @internal Update RSS redirection table on an Ethernet device */
1132 typedef int (*reta_query_t)(struct rte_eth_dev *dev,
1133 struct rte_eth_rss_reta_entry64 *reta_conf,
1134 uint16_t reta_size);
1135 /**< @internal Query RSS redirection table on an Ethernet device */
1137 typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
1138 struct rte_eth_rss_conf *rss_conf);
1139 /**< @internal Update RSS hash configuration of an Ethernet device */
1141 typedef int (*rss_hash_conf_get_t)(struct rte_eth_dev *dev,
1142 struct rte_eth_rss_conf *rss_conf);
1143 /**< @internal Get current RSS hash configuration of an Ethernet device */
1145 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
1146 /**< @internal Turn on SW controllable LED on an Ethernet device */
1148 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
1149 /**< @internal Turn off SW controllable LED on an Ethernet device */
1151 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
1152 /**< @internal Remove MAC address from receive address register */
1154 typedef void (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
1155 struct ether_addr *mac_addr,
1158 /**< @internal Set a MAC address into Receive Address Address Register */
1160 typedef void (*eth_mac_addr_set_t)(struct rte_eth_dev *dev,
1161 struct ether_addr *mac_addr);
1162 /**< @internal Set a MAC address into Receive Address Address Register */
1164 typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
1165 struct ether_addr *mac_addr,
1167 /**< @internal Set a Unicast Hash bitmap */
1169 typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
1171 /**< @internal Set all Unicast Hash bitmap */
1173 typedef int (*eth_set_vf_rx_mode_t)(struct rte_eth_dev *dev,
1177 /**< @internal Set a VF receive mode */
1179 typedef int (*eth_set_vf_rx_t)(struct rte_eth_dev *dev,
1182 /**< @internal Set a VF receive mode */
1184 typedef int (*eth_set_vf_tx_t)(struct rte_eth_dev *dev,
1187 /**< @internal Enable or disable a VF transmit */
1189 typedef int (*eth_set_vf_vlan_filter_t)(struct rte_eth_dev *dev,
1193 /**< @internal Set VF VLAN pool filter */
1195 typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
1198 /**< @internal Set queue TX rate */
1200 typedef int (*eth_set_vf_rate_limit_t)(struct rte_eth_dev *dev,
1204 /**< @internal Set VF TX rate */
1206 typedef int (*eth_mirror_rule_set_t)(struct rte_eth_dev *dev,
1207 struct rte_eth_vmdq_mirror_conf *mirror_conf,
1210 /**< @internal Add a traffic mirroring rule on an Ethernet device */
1212 typedef int (*eth_mirror_rule_reset_t)(struct rte_eth_dev *dev,
1214 /**< @internal Remove a traffic mirroring rule on an Ethernet device */
1216 typedef int (*eth_udp_tunnel_add_t)(struct rte_eth_dev *dev,
1217 struct rte_eth_udp_tunnel *tunnel_udp);
1218 /**< @internal Add tunneling UDP info */
1220 typedef int (*eth_udp_tunnel_del_t)(struct rte_eth_dev *dev,
1221 struct rte_eth_udp_tunnel *tunnel_udp);
1222 /**< @internal Delete tunneling UDP info */
1225 #ifdef RTE_NIC_BYPASS
1228 RTE_BYPASS_MODE_NONE,
1229 RTE_BYPASS_MODE_NORMAL,
1230 RTE_BYPASS_MODE_BYPASS,
1231 RTE_BYPASS_MODE_ISOLATE,
1232 RTE_BYPASS_MODE_NUM,
1235 #define RTE_BYPASS_MODE_VALID(x) \
1236 ((x) > RTE_BYPASS_MODE_NONE && (x) < RTE_BYPASS_MODE_NUM)
1239 RTE_BYPASS_EVENT_NONE,
1240 RTE_BYPASS_EVENT_START,
1241 RTE_BYPASS_EVENT_OS_ON = RTE_BYPASS_EVENT_START,
1242 RTE_BYPASS_EVENT_POWER_ON,
1243 RTE_BYPASS_EVENT_OS_OFF,
1244 RTE_BYPASS_EVENT_POWER_OFF,
1245 RTE_BYPASS_EVENT_TIMEOUT,
1246 RTE_BYPASS_EVENT_NUM
1249 #define RTE_BYPASS_EVENT_VALID(x) \
1250 ((x) > RTE_BYPASS_EVENT_NONE && (x) < RTE_BYPASS_MODE_NUM)
1253 RTE_BYPASS_TMT_OFF, /* timeout disabled. */
1254 RTE_BYPASS_TMT_1_5_SEC, /* timeout for 1.5 seconds */
1255 RTE_BYPASS_TMT_2_SEC, /* timeout for 2 seconds */
1256 RTE_BYPASS_TMT_3_SEC, /* timeout for 3 seconds */
1257 RTE_BYPASS_TMT_4_SEC, /* timeout for 4 seconds */
1258 RTE_BYPASS_TMT_8_SEC, /* timeout for 8 seconds */
1259 RTE_BYPASS_TMT_16_SEC, /* timeout for 16 seconds */
1260 RTE_BYPASS_TMT_32_SEC, /* timeout for 32 seconds */
1264 #define RTE_BYPASS_TMT_VALID(x) \
1265 ((x) == RTE_BYPASS_TMT_OFF || \
1266 ((x) > RTE_BYPASS_TMT_OFF && (x) < RTE_BYPASS_TMT_NUM))
1268 typedef void (*bypass_init_t)(struct rte_eth_dev *dev);
1269 typedef int32_t (*bypass_state_set_t)(struct rte_eth_dev *dev, uint32_t *new_state);
1270 typedef int32_t (*bypass_state_show_t)(struct rte_eth_dev *dev, uint32_t *state);
1271 typedef int32_t (*bypass_event_set_t)(struct rte_eth_dev *dev, uint32_t state, uint32_t event);
1272 typedef int32_t (*bypass_event_show_t)(struct rte_eth_dev *dev, uint32_t event_shift, uint32_t *event);
1273 typedef int32_t (*bypass_wd_timeout_set_t)(struct rte_eth_dev *dev, uint32_t timeout);
1274 typedef int32_t (*bypass_wd_timeout_show_t)(struct rte_eth_dev *dev, uint32_t *wd_timeout);
1275 typedef int32_t (*bypass_ver_show_t)(struct rte_eth_dev *dev, uint32_t *ver);
1276 typedef int32_t (*bypass_wd_reset_t)(struct rte_eth_dev *dev);
1279 typedef int (*eth_filter_ctrl_t)(struct rte_eth_dev *dev,
1280 enum rte_filter_type filter_type,
1281 enum rte_filter_op filter_op,
1283 /**< @internal Take operations to assigned filter type on an Ethernet device */
1286 * @internal A structure containing the functions exported by an Ethernet driver.
1288 struct eth_dev_ops {
1289 eth_dev_configure_t dev_configure; /**< Configure device. */
1290 eth_dev_start_t dev_start; /**< Start device. */
1291 eth_dev_stop_t dev_stop; /**< Stop device. */
1292 eth_dev_set_link_up_t dev_set_link_up; /**< Device link up. */
1293 eth_dev_set_link_down_t dev_set_link_down; /**< Device link down. */
1294 eth_dev_close_t dev_close; /**< Close device. */
1295 eth_promiscuous_enable_t promiscuous_enable; /**< Promiscuous ON. */
1296 eth_promiscuous_disable_t promiscuous_disable;/**< Promiscuous OFF. */
1297 eth_allmulticast_enable_t allmulticast_enable;/**< RX multicast ON. */
1298 eth_allmulticast_disable_t allmulticast_disable;/**< RX multicast OF. */
1299 eth_link_update_t link_update; /**< Get device link state. */
1300 eth_stats_get_t stats_get; /**< Get generic device statistics. */
1301 eth_stats_reset_t stats_reset; /**< Reset generic device statistics. */
1302 eth_xstats_get_t xstats_get; /**< Get extended device statistics. */
1303 eth_xstats_reset_t xstats_reset; /**< Reset extended device statistics. */
1304 eth_queue_stats_mapping_set_t queue_stats_mapping_set;
1305 /**< Configure per queue stat counter mapping. */
1306 eth_dev_infos_get_t dev_infos_get; /**< Get device info. */
1307 mtu_set_t mtu_set; /**< Set MTU. */
1308 vlan_filter_set_t vlan_filter_set; /**< Filter VLAN Setup. */
1309 vlan_tpid_set_t vlan_tpid_set; /**< Outer VLAN TPID Setup. */
1310 vlan_strip_queue_set_t vlan_strip_queue_set; /**< VLAN Stripping on queue. */
1311 vlan_offload_set_t vlan_offload_set; /**< Set VLAN Offload. */
1312 vlan_pvid_set_t vlan_pvid_set; /**< Set port based TX VLAN insertion */
1313 eth_queue_start_t rx_queue_start;/**< Start RX for a queue.*/
1314 eth_queue_stop_t rx_queue_stop;/**< Stop RX for a queue.*/
1315 eth_queue_start_t tx_queue_start;/**< Start TX for a queue.*/
1316 eth_queue_stop_t tx_queue_stop;/**< Stop TX for a queue.*/
1317 eth_rx_queue_setup_t rx_queue_setup;/**< Set up device RX queue.*/
1318 eth_queue_release_t rx_queue_release;/**< Release RX queue.*/
1319 eth_rx_queue_count_t rx_queue_count; /**< Get Rx queue count. */
1320 eth_rx_descriptor_done_t rx_descriptor_done; /**< Check rxd DD bit */
1321 eth_tx_queue_setup_t tx_queue_setup;/**< Set up device TX queue.*/
1322 eth_queue_release_t tx_queue_release;/**< Release TX queue.*/
1323 eth_dev_led_on_t dev_led_on; /**< Turn on LED. */
1324 eth_dev_led_off_t dev_led_off; /**< Turn off LED. */
1325 flow_ctrl_get_t flow_ctrl_get; /**< Get flow control. */
1326 flow_ctrl_set_t flow_ctrl_set; /**< Setup flow control. */
1327 priority_flow_ctrl_set_t priority_flow_ctrl_set; /**< Setup priority flow control.*/
1328 eth_mac_addr_remove_t mac_addr_remove; /**< Remove MAC address */
1329 eth_mac_addr_add_t mac_addr_add; /**< Add a MAC address */
1330 eth_mac_addr_set_t mac_addr_set; /**< Set a MAC address */
1331 eth_uc_hash_table_set_t uc_hash_table_set; /**< Set Unicast Table Array */
1332 eth_uc_all_hash_table_set_t uc_all_hash_table_set; /**< Set Unicast hash bitmap */
1333 eth_mirror_rule_set_t mirror_rule_set; /**< Add a traffic mirror rule.*/
1334 eth_mirror_rule_reset_t mirror_rule_reset; /**< reset a traffic mirror rule.*/
1335 eth_set_vf_rx_mode_t set_vf_rx_mode; /**< Set VF RX mode */
1336 eth_set_vf_rx_t set_vf_rx; /**< enable/disable a VF receive */
1337 eth_set_vf_tx_t set_vf_tx; /**< enable/disable a VF transmit */
1338 eth_set_vf_vlan_filter_t set_vf_vlan_filter; /**< Set VF VLAN filter */
1339 eth_udp_tunnel_add_t udp_tunnel_add;
1340 eth_udp_tunnel_del_t udp_tunnel_del;
1341 eth_set_queue_rate_limit_t set_queue_rate_limit; /**< Set queue rate limit */
1342 eth_set_vf_rate_limit_t set_vf_rate_limit; /**< Set VF rate limit */
1344 /** Add a signature filter. */
1345 fdir_add_signature_filter_t fdir_add_signature_filter;
1346 /** Update a signature filter. */
1347 fdir_update_signature_filter_t fdir_update_signature_filter;
1348 /** Remove a signature filter. */
1349 fdir_remove_signature_filter_t fdir_remove_signature_filter;
1350 /** Get information about FDIR status. */
1351 fdir_infos_get_t fdir_infos_get;
1352 /** Add a perfect filter. */
1353 fdir_add_perfect_filter_t fdir_add_perfect_filter;
1354 /** Update a perfect filter. */
1355 fdir_update_perfect_filter_t fdir_update_perfect_filter;
1356 /** Remove a perfect filter. */
1357 fdir_remove_perfect_filter_t fdir_remove_perfect_filter;
1358 /** Setup masks for FDIR filtering. */
1359 fdir_set_masks_t fdir_set_masks;
1360 /** Update redirection table. */
1361 reta_update_t reta_update;
1362 /** Query redirection table. */
1363 reta_query_t reta_query;
1364 /* bypass control */
1365 #ifdef RTE_NIC_BYPASS
1366 bypass_init_t bypass_init;
1367 bypass_state_set_t bypass_state_set;
1368 bypass_state_show_t bypass_state_show;
1369 bypass_event_set_t bypass_event_set;
1370 bypass_event_show_t bypass_event_show;
1371 bypass_wd_timeout_set_t bypass_wd_timeout_set;
1372 bypass_wd_timeout_show_t bypass_wd_timeout_show;
1373 bypass_ver_show_t bypass_ver_show;
1374 bypass_wd_reset_t bypass_wd_reset;
1377 /** Configure RSS hash protocols. */
1378 rss_hash_update_t rss_hash_update;
1379 /** Get current RSS hash configuration. */
1380 rss_hash_conf_get_t rss_hash_conf_get;
1381 eth_filter_ctrl_t filter_ctrl; /**< common filter control*/
1385 * Function type used for callbacks for processing packets on RX and TX
1387 * If configured for RX, it is called with a burst of packets that have just
1388 * been received on the given port and queue. On TX, it is called with a burst
1389 * of packets immediately before those packets are put onto the hardware queue
1393 * The ethernet port on which rx or tx is being performed
1395 * The queue on the ethernet port which is being used to receive or transmit
1398 * The burst of packets on which processing is to be done. On RX, these
1399 * packets have just been received. On TX, they are about to be transmitted.
1401 * The number of packets in the burst pointed to by "pkts"
1403 * The arbitrary user parameter passed in by the application when the callback
1404 * was originally configured.
1406 * The number of packets remaining in pkts are processing.
1407 * * On RX, this will be returned to the user as the return value from
1409 * * On TX, this will be the number of packets actually written to the NIC.
1411 typedef uint16_t (*rte_rxtx_callback_fn)(uint8_t port, uint16_t queue,
1412 struct rte_mbuf *pkts[], uint16_t nb_pkts, void *user_param);
1416 * Structure used to hold information about the callbacks to be called for a
1417 * queue on RX and TX.
1419 struct rte_eth_rxtx_callback {
1420 struct rte_eth_rxtx_callback *next;
1421 rte_rxtx_callback_fn fn;
1427 * The generic data structure associated with each ethernet device.
1429 * Pointers to burst-oriented packet receive and transmit functions are
1430 * located at the beginning of the structure, along with the pointer to
1431 * where all the data elements for the particular device are stored in shared
1432 * memory. This split allows the function pointer and driver data to be per-
1433 * process, while the actual configuration data for the device is shared.
1435 struct rte_eth_dev {
1436 eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
1437 eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
1438 struct rte_eth_dev_data *data; /**< Pointer to device data */
1439 const struct eth_driver *driver;/**< Driver for this device */
1440 struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
1441 struct rte_pci_device *pci_dev; /**< PCI info. supplied by probing */
1442 /** User application callbacks for NIC interrupts */
1443 struct rte_eth_dev_cb_list link_intr_cbs;
1445 * User-supplied functions called from rx_burst to post-process
1446 * received packets before passing them to the user
1448 struct rte_eth_rxtx_callback **post_rx_burst_cbs;
1450 * User-supplied functions called from tx_burst to pre-process
1451 * received packets before passing them to the driver for transmission.
1453 struct rte_eth_rxtx_callback **pre_tx_burst_cbs;
1456 struct rte_eth_dev_sriov {
1457 uint8_t active; /**< SRIOV is active with 16, 32 or 64 pools */
1458 uint8_t nb_q_per_pool; /**< rx queue number per pool */
1459 uint16_t def_vmdq_idx; /**< Default pool num used for PF */
1460 uint16_t def_pool_q_idx; /**< Default pool queue start reg index */
1462 #define RTE_ETH_DEV_SRIOV(dev) ((dev)->data->sriov)
1464 #define RTE_ETH_NAME_MAX_LEN (32)
1468 * The data part, with no function pointers, associated with each ethernet device.
1470 * This structure is safe to place in shared memory to be common among different
1471 * processes in a multi-process configuration.
1473 struct rte_eth_dev_data {
1474 char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
1476 void **rx_queues; /**< Array of pointers to RX queues. */
1477 void **tx_queues; /**< Array of pointers to TX queues. */
1478 uint16_t nb_rx_queues; /**< Number of RX queues. */
1479 uint16_t nb_tx_queues; /**< Number of TX queues. */
1481 struct rte_eth_dev_sriov sriov; /**< SRIOV data */
1483 void *dev_private; /**< PMD-specific private data */
1485 struct rte_eth_link dev_link;
1486 /**< Link-level information & status */
1488 struct rte_eth_conf dev_conf; /**< Configuration applied to device. */
1489 uint16_t mtu; /**< Maximum Transmission Unit. */
1491 uint32_t min_rx_buf_size;
1492 /**< Common rx buffer size handled by all queues */
1494 uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
1495 struct ether_addr* mac_addrs;/**< Device Ethernet Link address. */
1496 uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
1497 /** bitmap array of associating Ethernet MAC addresses to pools */
1498 struct ether_addr* hash_mac_addrs;
1499 /** Device Ethernet MAC addresses of hash filtering. */
1500 uint8_t port_id; /**< Device [external] port identifier. */
1501 uint8_t promiscuous : 1, /**< RX promiscuous mode ON(1) / OFF(0). */
1502 scattered_rx : 1, /**< RX of scattered packets is ON(1) / OFF(0) */
1503 all_multicast : 1, /**< RX all multicast mode ON(1) / OFF(0). */
1504 dev_started : 1; /**< Device state: STARTED(1) / STOPPED(0). */
1509 * The pool of *rte_eth_dev* structures. The size of the pool
1510 * is configured at compile-time in the <rte_ethdev.c> file.
1512 extern struct rte_eth_dev rte_eth_devices[];
1515 * Get the total number of Ethernet devices that have been successfully
1516 * initialized by the [matching] Ethernet driver during the PCI probing phase.
1517 * All devices whose port identifier is in the range
1518 * [0, rte_eth_dev_count() - 1] can be operated on by network applications.
1521 * - The total number of usable Ethernet devices.
1523 extern uint8_t rte_eth_dev_count(void);
1526 * Function for internal use by dummy drivers primarily, e.g. ring-based
1528 * Allocates a new ethdev slot for an ethernet device and returns the pointer
1529 * to that slot for the driver to use.
1531 * @param name Unique identifier name for each Ethernet device
1533 * - Slot in the rte_dev_devices array for a new device;
1535 struct rte_eth_dev *rte_eth_dev_allocate(const char *name);
1540 * Initialization function of an Ethernet driver invoked for each matching
1541 * Ethernet PCI device detected during the PCI probing phase.
1544 * The pointer to the [matching] Ethernet driver structure supplied by
1545 * the PMD when it registered itself.
1547 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1548 * associated with the matching device and which have been [automatically]
1549 * allocated in the *rte_eth_devices* array.
1550 * The *eth_dev* structure is supplied to the driver initialization function
1551 * with the following fields already initialized:
1553 * - *pci_dev*: Holds the pointers to the *rte_pci_device* structure which
1554 * contains the generic PCI information of the matching device.
1556 * - *dev_private*: Holds a pointer to the device private data structure.
1558 * - *mtu*: Contains the default Ethernet maximum frame length (1500).
1560 * - *port_id*: Contains the port index of the device (actually the index
1561 * of the *eth_dev* structure in the *rte_eth_devices* array).
1564 * - 0: Success, the device is properly initialized by the driver.
1565 * In particular, the driver MUST have set up the *dev_ops* pointer
1566 * of the *eth_dev* structure.
1567 * - <0: Error code of the device initialization failure.
1569 typedef int (*eth_dev_init_t)(struct eth_driver *eth_drv,
1570 struct rte_eth_dev *eth_dev);
1574 * The structure associated with a PMD Ethernet driver.
1576 * Each Ethernet driver acts as a PCI driver and is represented by a generic
1577 * *eth_driver* structure that holds:
1579 * - An *rte_pci_driver* structure (which must be the first field).
1581 * - The *eth_dev_init* function invoked for each matching PCI device.
1583 * - The size of the private data to allocate for each matching device.
1586 struct rte_pci_driver pci_drv; /**< The PMD is also a PCI driver. */
1587 eth_dev_init_t eth_dev_init; /**< Device init function. */
1588 unsigned int dev_private_size; /**< Size of device private data. */
1593 * A function invoked by the initialization function of an Ethernet driver
1594 * to simultaneously register itself as a PCI driver and as an Ethernet
1595 * Poll Mode Driver (PMD).
1598 * The pointer to the *eth_driver* structure associated with
1599 * the Ethernet driver.
1601 extern void rte_eth_driver_register(struct eth_driver *eth_drv);
1604 * Configure an Ethernet device.
1605 * This function must be invoked first before any other function in the
1606 * Ethernet API. This function can also be re-invoked when a device is in the
1610 * The port identifier of the Ethernet device to configure.
1611 * @param nb_rx_queue
1612 * The number of receive queues to set up for the Ethernet device.
1613 * @param nb_tx_queue
1614 * The number of transmit queues to set up for the Ethernet device.
1616 * The pointer to the configuration data to be used for the Ethernet device.
1617 * The *rte_eth_conf* structure includes:
1618 * - the hardware offload features to activate, with dedicated fields for
1619 * each statically configurable offload hardware feature provided by
1620 * Ethernet devices, such as IP checksum or VLAN tag stripping for
1622 * - the Receive Side Scaling (RSS) configuration when using multiple RX
1625 * Embedding all configuration information in a single data structure
1626 * is the more flexible method that allows the addition of new features
1627 * without changing the syntax of the API.
1629 * - 0: Success, device configured.
1630 * - <0: Error code returned by the driver configuration function.
1632 extern int rte_eth_dev_configure(uint8_t port_id,
1633 uint16_t nb_rx_queue,
1634 uint16_t nb_tx_queue,
1635 const struct rte_eth_conf *eth_conf);
1638 * Allocate and set up a receive queue for an Ethernet device.
1640 * The function allocates a contiguous block of memory for *nb_rx_desc*
1641 * receive descriptors from a memory zone associated with *socket_id*
1642 * and initializes each receive descriptor with a network buffer allocated
1643 * from the memory pool *mb_pool*.
1646 * The port identifier of the Ethernet device.
1647 * @param rx_queue_id
1648 * The index of the receive queue to set up.
1649 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1650 * to rte_eth_dev_configure().
1652 * The number of receive descriptors to allocate for the receive ring.
1654 * The *socket_id* argument is the socket identifier in case of NUMA.
1655 * The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1656 * the DMA memory allocated for the receive descriptors of the ring.
1658 * The pointer to the configuration data to be used for the receive queue.
1659 * NULL value is allowed, in which case default RX configuration
1661 * The *rx_conf* structure contains an *rx_thresh* structure with the values
1662 * of the Prefetch, Host, and Write-Back threshold registers of the receive
1665 * The pointer to the memory pool from which to allocate *rte_mbuf* network
1666 * memory buffers to populate each descriptor of the receive ring.
1668 * - 0: Success, receive queue correctly set up.
1669 * - -EINVAL: The size of network buffers which can be allocated from the
1670 * memory pool does not fit the various buffer sizes allowed by the
1671 * device controller.
1672 * - -ENOMEM: Unable to allocate the receive ring descriptors or to
1673 * allocate network memory buffers from the memory pool when
1674 * initializing receive descriptors.
1676 extern int rte_eth_rx_queue_setup(uint8_t port_id, uint16_t rx_queue_id,
1677 uint16_t nb_rx_desc, unsigned int socket_id,
1678 const struct rte_eth_rxconf *rx_conf,
1679 struct rte_mempool *mb_pool);
1682 * Allocate and set up a transmit queue for an Ethernet device.
1685 * The port identifier of the Ethernet device.
1686 * @param tx_queue_id
1687 * The index of the transmit queue to set up.
1688 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1689 * to rte_eth_dev_configure().
1691 * The number of transmit descriptors to allocate for the transmit ring.
1693 * The *socket_id* argument is the socket identifier in case of NUMA.
1694 * Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1695 * the DMA memory allocated for the transmit descriptors of the ring.
1697 * The pointer to the configuration data to be used for the transmit queue.
1698 * NULL value is allowed, in which case default RX configuration
1700 * The *tx_conf* structure contains the following data:
1701 * - The *tx_thresh* structure with the values of the Prefetch, Host, and
1702 * Write-Back threshold registers of the transmit ring.
1703 * When setting Write-Back threshold to the value greater then zero,
1704 * *tx_rs_thresh* value should be explicitly set to one.
1705 * - The *tx_free_thresh* value indicates the [minimum] number of network
1706 * buffers that must be pending in the transmit ring to trigger their
1707 * [implicit] freeing by the driver transmit function.
1708 * - The *tx_rs_thresh* value indicates the [minimum] number of transmit
1709 * descriptors that must be pending in the transmit ring before setting the
1710 * RS bit on a descriptor by the driver transmit function.
1711 * The *tx_rs_thresh* value should be less or equal then
1712 * *tx_free_thresh* value, and both of them should be less then
1714 * - The *txq_flags* member contains flags to pass to the TX queue setup
1715 * function to configure the behavior of the TX queue. This should be set
1716 * to 0 if no special configuration is required.
1718 * Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces
1719 * the transmit function to use default values.
1721 * - 0: Success, the transmit queue is correctly set up.
1722 * - -ENOMEM: Unable to allocate the transmit ring descriptors.
1724 extern int rte_eth_tx_queue_setup(uint8_t port_id, uint16_t tx_queue_id,
1725 uint16_t nb_tx_desc, unsigned int socket_id,
1726 const struct rte_eth_txconf *tx_conf);
1729 * Return the NUMA socket to which an Ethernet device is connected
1732 * The port identifier of the Ethernet device
1734 * The NUMA socket id to which the Ethernet device is connected or
1735 * a default of zero if the socket could not be determined.
1736 * -1 is returned is the port_id value is out of range.
1738 extern int rte_eth_dev_socket_id(uint8_t port_id);
1741 * Allocate mbuf from mempool, setup the DMA physical address
1742 * and then start RX for specified queue of a port. It is used
1743 * when rx_deferred_start flag of the specified queue is true.
1746 * The port identifier of the Ethernet device
1747 * @param rx_queue_id
1748 * The index of the rx queue to update the ring.
1749 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1750 * to rte_eth_dev_configure().
1752 * - 0: Success, the transmit queue is correctly set up.
1753 * - -EINVAL: The port_id or the queue_id out of range.
1754 * - -ENOTSUP: The function not supported in PMD driver.
1756 extern int rte_eth_dev_rx_queue_start(uint8_t port_id, uint16_t rx_queue_id);
1759 * Stop specified RX queue of a port
1762 * The port identifier of the Ethernet device
1763 * @param rx_queue_id
1764 * The index of the rx queue to update the ring.
1765 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1766 * to rte_eth_dev_configure().
1768 * - 0: Success, the transmit queue is correctly set up.
1769 * - -EINVAL: The port_id or the queue_id out of range.
1770 * - -ENOTSUP: The function not supported in PMD driver.
1772 extern int rte_eth_dev_rx_queue_stop(uint8_t port_id, uint16_t rx_queue_id);
1775 * Start TX for specified queue of a port. It is used when tx_deferred_start
1776 * flag of the specified queue is true.
1779 * The port identifier of the Ethernet device
1780 * @param tx_queue_id
1781 * The index of the tx queue to update the ring.
1782 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1783 * to rte_eth_dev_configure().
1785 * - 0: Success, the transmit queue is correctly set up.
1786 * - -EINVAL: The port_id or the queue_id out of range.
1787 * - -ENOTSUP: The function not supported in PMD driver.
1789 extern int rte_eth_dev_tx_queue_start(uint8_t port_id, uint16_t tx_queue_id);
1792 * Stop specified TX queue of a port
1795 * The port identifier of the Ethernet device
1796 * @param tx_queue_id
1797 * The index of the tx queue to update the ring.
1798 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1799 * to rte_eth_dev_configure().
1801 * - 0: Success, the transmit queue is correctly set up.
1802 * - -EINVAL: The port_id or the queue_id out of range.
1803 * - -ENOTSUP: The function not supported in PMD driver.
1805 extern int rte_eth_dev_tx_queue_stop(uint8_t port_id, uint16_t tx_queue_id);
1810 * Start an Ethernet device.
1812 * The device start step is the last one and consists of setting the configured
1813 * offload features and in starting the transmit and the receive units of the
1815 * On success, all basic functions exported by the Ethernet API (link status,
1816 * receive/transmit, and so on) can be invoked.
1819 * The port identifier of the Ethernet device.
1821 * - 0: Success, Ethernet device started.
1822 * - <0: Error code of the driver device start function.
1824 extern int rte_eth_dev_start(uint8_t port_id);
1827 * Stop an Ethernet device. The device can be restarted with a call to
1828 * rte_eth_dev_start()
1831 * The port identifier of the Ethernet device.
1833 extern void rte_eth_dev_stop(uint8_t port_id);
1837 * Link up an Ethernet device.
1839 * Set device link up will re-enable the device rx/tx
1840 * functionality after it is previously set device linked down.
1843 * The port identifier of the Ethernet device.
1845 * - 0: Success, Ethernet device linked up.
1846 * - <0: Error code of the driver device link up function.
1848 extern int rte_eth_dev_set_link_up(uint8_t port_id);
1851 * Link down an Ethernet device.
1852 * The device rx/tx functionality will be disabled if success,
1853 * and it can be re-enabled with a call to
1854 * rte_eth_dev_set_link_up()
1857 * The port identifier of the Ethernet device.
1859 extern int rte_eth_dev_set_link_down(uint8_t port_id);
1862 * Close an Ethernet device. The device cannot be restarted!
1865 * The port identifier of the Ethernet device.
1867 extern void rte_eth_dev_close(uint8_t port_id);
1870 * Enable receipt in promiscuous mode for an Ethernet device.
1873 * The port identifier of the Ethernet device.
1875 extern void rte_eth_promiscuous_enable(uint8_t port_id);
1878 * Disable receipt in promiscuous mode for an Ethernet device.
1881 * The port identifier of the Ethernet device.
1883 extern void rte_eth_promiscuous_disable(uint8_t port_id);
1886 * Return the value of promiscuous mode for an Ethernet device.
1889 * The port identifier of the Ethernet device.
1891 * - (1) if promiscuous is enabled
1892 * - (0) if promiscuous is disabled.
1895 extern int rte_eth_promiscuous_get(uint8_t port_id);
1898 * Enable the receipt of any multicast frame by an Ethernet device.
1901 * The port identifier of the Ethernet device.
1903 extern void rte_eth_allmulticast_enable(uint8_t port_id);
1906 * Disable the receipt of all multicast frames by an Ethernet device.
1909 * The port identifier of the Ethernet device.
1911 extern void rte_eth_allmulticast_disable(uint8_t port_id);
1914 * Return the value of allmulticast mode for an Ethernet device.
1917 * The port identifier of the Ethernet device.
1919 * - (1) if allmulticast is enabled
1920 * - (0) if allmulticast is disabled.
1923 extern int rte_eth_allmulticast_get(uint8_t port_id);
1926 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
1927 * or FULL-DUPLEX) of the physical link of an Ethernet device. It might need
1928 * to wait up to 9 seconds in it.
1931 * The port identifier of the Ethernet device.
1933 * A pointer to an *rte_eth_link* structure to be filled with
1934 * the status, the speed and the mode of the Ethernet device link.
1936 extern void rte_eth_link_get(uint8_t port_id, struct rte_eth_link *link);
1939 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
1940 * or FULL-DUPLEX) of the physical link of an Ethernet device. It is a no-wait
1941 * version of rte_eth_link_get().
1944 * The port identifier of the Ethernet device.
1946 * A pointer to an *rte_eth_link* structure to be filled with
1947 * the status, the speed and the mode of the Ethernet device link.
1949 extern void rte_eth_link_get_nowait(uint8_t port_id,
1950 struct rte_eth_link *link);
1953 * Retrieve the general I/O statistics of an Ethernet device.
1956 * The port identifier of the Ethernet device.
1958 * A pointer to a structure of type *rte_eth_stats* to be filled with
1959 * the values of device counters for the following set of statistics:
1960 * - *ipackets* with the total of successfully received packets.
1961 * - *opackets* with the total of successfully transmitted packets.
1962 * - *ibytes* with the total of successfully received bytes.
1963 * - *obytes* with the total of successfully transmitted bytes.
1964 * - *ierrors* with the total of erroneous received packets.
1965 * - *oerrors* with the total of failed transmitted packets.
1967 * Zero if successful. Non-zero otherwise.
1969 extern int rte_eth_stats_get(uint8_t port_id, struct rte_eth_stats *stats);
1972 * Reset the general I/O statistics of an Ethernet device.
1975 * The port identifier of the Ethernet device.
1977 extern void rte_eth_stats_reset(uint8_t port_id);
1980 * Retrieve extended statistics of an Ethernet device.
1983 * The port identifier of the Ethernet device.
1985 * A pointer to a table of structure of type *rte_eth_xstats*
1986 * to be filled with device statistics names and values.
1987 * This parameter can be set to NULL if n is 0.
1989 * The size of the stats table, which should be large enough to store
1990 * all the statistics of the device.
1992 * - positive value lower or equal to n: success. The return value
1993 * is the number of entries filled in the stats table.
1994 * - positive value higher than n: error, the given statistics table
1995 * is too small. The return value corresponds to the size that should
1996 * be given to succeed. The entries in the table are not valid and
1997 * shall not be used by the caller.
1998 * - negative value on error (invalid port id)
2000 extern int rte_eth_xstats_get(uint8_t port_id,
2001 struct rte_eth_xstats *xstats, unsigned n);
2004 * Reset extended statistics of an Ethernet device.
2007 * The port identifier of the Ethernet device.
2009 extern void rte_eth_xstats_reset(uint8_t port_id);
2012 * Set a mapping for the specified transmit queue to the specified per-queue
2013 * statistics counter.
2016 * The port identifier of the Ethernet device.
2017 * @param tx_queue_id
2018 * The index of the transmit queue for which a queue stats mapping is required.
2019 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2020 * to rte_eth_dev_configure().
2022 * The per-queue packet statistics functionality number that the transmit
2023 * queue is to be assigned.
2024 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2026 * Zero if successful. Non-zero otherwise.
2028 extern int rte_eth_dev_set_tx_queue_stats_mapping(uint8_t port_id,
2029 uint16_t tx_queue_id,
2033 * Set a mapping for the specified receive queue to the specified per-queue
2034 * statistics counter.
2037 * The port identifier of the Ethernet device.
2038 * @param rx_queue_id
2039 * The index of the receive queue for which a queue stats mapping is required.
2040 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2041 * to rte_eth_dev_configure().
2043 * The per-queue packet statistics functionality number that the receive
2044 * queue is to be assigned.
2045 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2047 * Zero if successful. Non-zero otherwise.
2049 extern int rte_eth_dev_set_rx_queue_stats_mapping(uint8_t port_id,
2050 uint16_t rx_queue_id,
2054 * Retrieve the Ethernet address of an Ethernet device.
2057 * The port identifier of the Ethernet device.
2059 * A pointer to a structure of type *ether_addr* to be filled with
2060 * the Ethernet address of the Ethernet device.
2062 extern void rte_eth_macaddr_get(uint8_t port_id, struct ether_addr *mac_addr);
2065 * Retrieve the contextual information of an Ethernet device.
2068 * The port identifier of the Ethernet device.
2070 * A pointer to a structure of type *rte_eth_dev_info* to be filled with
2071 * the contextual information of the Ethernet device.
2073 extern void rte_eth_dev_info_get(uint8_t port_id,
2074 struct rte_eth_dev_info *dev_info);
2077 * Retrieve the MTU of an Ethernet device.
2080 * The port identifier of the Ethernet device.
2082 * A pointer to a uint16_t where the retrieved MTU is to be stored.
2084 * - (0) if successful.
2085 * - (-ENODEV) if *port_id* invalid.
2087 extern int rte_eth_dev_get_mtu(uint8_t port_id, uint16_t *mtu);
2090 * Change the MTU of an Ethernet device.
2093 * The port identifier of the Ethernet device.
2095 * A uint16_t for the MTU to be applied.
2097 * - (0) if successful.
2098 * - (-ENOTSUP) if operation is not supported.
2099 * - (-ENODEV) if *port_id* invalid.
2100 * - (-EINVAL) if *mtu* invalid.
2102 extern int rte_eth_dev_set_mtu(uint8_t port_id, uint16_t mtu);
2105 * Enable/Disable hardware filtering by an Ethernet device of received
2106 * VLAN packets tagged with a given VLAN Tag Identifier.
2109 * The port identifier of the Ethernet device.
2111 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
2113 * If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*.
2114 * Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*.
2116 * - (0) if successful.
2117 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2118 * - (-ENODEV) if *port_id* invalid.
2119 * - (-ENOSYS) if VLAN filtering on *port_id* disabled.
2120 * - (-EINVAL) if *vlan_id* > 4095.
2122 extern int rte_eth_dev_vlan_filter(uint8_t port_id, uint16_t vlan_id , int on);
2125 * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
2126 * 82599/X540/X550 can support VLAN stripping at the rx queue level
2129 * The port identifier of the Ethernet device.
2130 * @param rx_queue_id
2131 * The index of the receive queue for which a queue stats mapping is required.
2132 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2133 * to rte_eth_dev_configure().
2135 * If 1, Enable VLAN Stripping of the receive queue of the Ethernet port.
2136 * If 0, Disable VLAN Stripping of the receive queue of the Ethernet port.
2138 * - (0) if successful.
2139 * - (-ENOSUP) if hardware-assisted VLAN stripping not configured.
2140 * - (-ENODEV) if *port_id* invalid.
2141 * - (-EINVAL) if *rx_queue_id* invalid.
2143 extern int rte_eth_dev_set_vlan_strip_on_queue(uint8_t port_id,
2144 uint16_t rx_queue_id, int on);
2147 * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
2148 * the VLAN Header. This is a register setup available on some Intel NIC, not
2149 * but all, please check the data sheet for availability.
2152 * The port identifier of the Ethernet device.
2154 * The Tag Protocol ID
2156 * - (0) if successful.
2157 * - (-ENOSUP) if hardware-assisted VLAN TPID setup is not supported.
2158 * - (-ENODEV) if *port_id* invalid.
2160 extern int rte_eth_dev_set_vlan_ether_type(uint8_t port_id, uint16_t tag_type);
2163 * Set VLAN offload configuration on an Ethernet device
2164 * Enable/Disable Extended VLAN by an Ethernet device, This is a register setup
2165 * available on some Intel NIC, not but all, please check the data sheet for
2167 * Enable/Disable VLAN Strip can be done on rx queue for certain NIC, but here
2168 * the configuration is applied on the port level.
2171 * The port identifier of the Ethernet device.
2172 * @param offload_mask
2173 * The VLAN Offload bit mask can be mixed use with "OR"
2174 * ETH_VLAN_STRIP_OFFLOAD
2175 * ETH_VLAN_FILTER_OFFLOAD
2176 * ETH_VLAN_EXTEND_OFFLOAD
2178 * - (0) if successful.
2179 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2180 * - (-ENODEV) if *port_id* invalid.
2182 extern int rte_eth_dev_set_vlan_offload(uint8_t port_id, int offload_mask);
2185 * Read VLAN Offload configuration from an Ethernet device
2188 * The port identifier of the Ethernet device.
2190 * - (>0) if successful. Bit mask to indicate
2191 * ETH_VLAN_STRIP_OFFLOAD
2192 * ETH_VLAN_FILTER_OFFLOAD
2193 * ETH_VLAN_EXTEND_OFFLOAD
2194 * - (-ENODEV) if *port_id* invalid.
2196 extern int rte_eth_dev_get_vlan_offload(uint8_t port_id);
2199 * Set port based TX VLAN insersion on or off.
2202 * The port identifier of the Ethernet device.
2204 * Port based TX VLAN identifier togeth with user priority.
2206 * Turn on or off the port based TX VLAN insertion.
2209 * - (0) if successful.
2210 * - negative if failed.
2212 extern int rte_eth_dev_set_vlan_pvid(uint8_t port_id, uint16_t pvid, int on);
2216 * Retrieve a burst of input packets from a receive queue of an Ethernet
2217 * device. The retrieved packets are stored in *rte_mbuf* structures whose
2218 * pointers are supplied in the *rx_pkts* array.
2220 * The rte_eth_rx_burst() function loops, parsing the RX ring of the
2221 * receive queue, up to *nb_pkts* packets, and for each completed RX
2222 * descriptor in the ring, it performs the following operations:
2224 * - Initialize the *rte_mbuf* data structure associated with the
2225 * RX descriptor according to the information provided by the NIC into
2226 * that RX descriptor.
2228 * - Store the *rte_mbuf* data structure into the next entry of the
2231 * - Replenish the RX descriptor with a new *rte_mbuf* buffer
2232 * allocated from the memory pool associated with the receive queue at
2233 * initialization time.
2235 * When retrieving an input packet that was scattered by the controller
2236 * into multiple receive descriptors, the rte_eth_rx_burst() function
2237 * appends the associated *rte_mbuf* buffers to the first buffer of the
2240 * The rte_eth_rx_burst() function returns the number of packets
2241 * actually retrieved, which is the number of *rte_mbuf* data structures
2242 * effectively supplied into the *rx_pkts* array.
2243 * A return value equal to *nb_pkts* indicates that the RX queue contained
2244 * at least *rx_pkts* packets, and this is likely to signify that other
2245 * received packets remain in the input queue. Applications implementing
2246 * a "retrieve as much received packets as possible" policy can check this
2247 * specific case and keep invoking the rte_eth_rx_burst() function until
2248 * a value less than *nb_pkts* is returned.
2250 * This receive method has the following advantages:
2252 * - It allows a run-to-completion network stack engine to retrieve and
2253 * to immediately process received packets in a fast burst-oriented
2254 * approach, avoiding the overhead of unnecessary intermediate packet
2255 * queue/dequeue operations.
2257 * - Conversely, it also allows an asynchronous-oriented processing
2258 * method to retrieve bursts of received packets and to immediately
2259 * queue them for further parallel processing by another logical core,
2260 * for instance. However, instead of having received packets being
2261 * individually queued by the driver, this approach allows the invoker
2262 * of the rte_eth_rx_burst() function to queue a burst of retrieved
2263 * packets at a time and therefore dramatically reduce the cost of
2264 * enqueue/dequeue operations per packet.
2266 * - It allows the rte_eth_rx_burst() function of the driver to take
2267 * advantage of burst-oriented hardware features (CPU cache,
2268 * prefetch instructions, and so on) to minimize the number of CPU
2269 * cycles per packet.
2271 * To summarize, the proposed receive API enables many
2272 * burst-oriented optimizations in both synchronous and asynchronous
2273 * packet processing environments with no overhead in both cases.
2275 * The rte_eth_rx_burst() function does not provide any error
2276 * notification to avoid the corresponding overhead. As a hint, the
2277 * upper-level application might check the status of the device link once
2278 * being systematically returned a 0 value for a given number of tries.
2281 * The port identifier of the Ethernet device.
2283 * The index of the receive queue from which to retrieve input packets.
2284 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2285 * to rte_eth_dev_configure().
2287 * The address of an array of pointers to *rte_mbuf* structures that
2288 * must be large enough to store *nb_pkts* pointers in it.
2290 * The maximum number of packets to retrieve.
2292 * The number of packets actually retrieved, which is the number
2293 * of pointers to *rte_mbuf* structures effectively supplied to the
2296 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2297 extern uint16_t rte_eth_rx_burst(uint8_t port_id, uint16_t queue_id,
2298 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
2300 static inline uint16_t
2301 rte_eth_rx_burst(uint8_t port_id, uint16_t queue_id,
2302 struct rte_mbuf **rx_pkts, uint16_t nb_pkts)
2304 struct rte_eth_dev *dev;
2306 dev = &rte_eth_devices[port_id];
2308 nb_pkts = (*dev->rx_pkt_burst)(dev->data->rx_queues[queue_id], rx_pkts,
2311 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
2312 struct rte_eth_rxtx_callback *cb = dev->post_rx_burst_cbs[queue_id];
2314 if (unlikely(cb != NULL)) {
2316 nb_pkts = cb->fn(port_id, queue_id, rx_pkts, nb_pkts,
2319 } while (cb != NULL);
2328 * Get the number of used descriptors in a specific queue
2331 * The port identifier of the Ethernet device.
2333 * The queue id on the specific port.
2335 * The number of used descriptors in the specific queue.
2337 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2338 extern uint32_t rte_eth_rx_queue_count(uint8_t port_id, uint16_t queue_id);
2340 static inline uint32_t
2341 rte_eth_rx_queue_count(uint8_t port_id, uint16_t queue_id)
2343 struct rte_eth_dev *dev;
2345 dev = &rte_eth_devices[port_id];
2346 return (*dev->dev_ops->rx_queue_count)(dev, queue_id);
2351 * Check if the DD bit of the specific RX descriptor in the queue has been set
2354 * The port identifier of the Ethernet device.
2356 * The queue id on the specific port.
2358 * The offset of the descriptor ID from tail.
2360 * - (1) if the specific DD bit is set.
2361 * - (0) if the specific DD bit is not set.
2362 * - (-ENODEV) if *port_id* invalid.
2364 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2365 extern int rte_eth_rx_descriptor_done(uint8_t port_id,
2370 rte_eth_rx_descriptor_done(uint8_t port_id, uint16_t queue_id, uint16_t offset)
2372 struct rte_eth_dev *dev;
2374 dev = &rte_eth_devices[port_id];
2375 return (*dev->dev_ops->rx_descriptor_done)( \
2376 dev->data->rx_queues[queue_id], offset);
2381 * Send a burst of output packets on a transmit queue of an Ethernet device.
2383 * The rte_eth_tx_burst() function is invoked to transmit output packets
2384 * on the output queue *queue_id* of the Ethernet device designated by its
2386 * The *nb_pkts* parameter is the number of packets to send which are
2387 * supplied in the *tx_pkts* array of *rte_mbuf* structures.
2388 * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
2389 * up to the number of transmit descriptors available in the TX ring of the
2391 * For each packet to send, the rte_eth_tx_burst() function performs
2392 * the following operations:
2394 * - Pick up the next available descriptor in the transmit ring.
2396 * - Free the network buffer previously sent with that descriptor, if any.
2398 * - Initialize the transmit descriptor with the information provided
2399 * in the *rte_mbuf data structure.
2401 * In the case of a segmented packet composed of a list of *rte_mbuf* buffers,
2402 * the rte_eth_tx_burst() function uses several transmit descriptors
2405 * The rte_eth_tx_burst() function returns the number of packets it
2406 * actually sent. A return value equal to *nb_pkts* means that all packets
2407 * have been sent, and this is likely to signify that other output packets
2408 * could be immediately transmitted again. Applications that implement a
2409 * "send as many packets to transmit as possible" policy can check this
2410 * specific case and keep invoking the rte_eth_tx_burst() function until
2411 * a value less than *nb_pkts* is returned.
2413 * It is the responsibility of the rte_eth_tx_burst() function to
2414 * transparently free the memory buffers of packets previously sent.
2415 * This feature is driven by the *tx_free_thresh* value supplied to the
2416 * rte_eth_dev_configure() function at device configuration time.
2417 * When the number of previously sent packets reached the "minimum transmit
2418 * packets to free" threshold, the rte_eth_tx_burst() function must
2419 * [attempt to] free the *rte_mbuf* buffers of those packets whose
2420 * transmission was effectively completed.
2423 * The port identifier of the Ethernet device.
2425 * The index of the transmit queue through which output packets must be
2427 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2428 * to rte_eth_dev_configure().
2430 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
2431 * which contain the output packets.
2433 * The maximum number of packets to transmit.
2435 * The number of output packets actually stored in transmit descriptors of
2436 * the transmit ring. The return value can be less than the value of the
2437 * *tx_pkts* parameter when the transmit ring is full or has been filled up.
2439 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2440 extern uint16_t rte_eth_tx_burst(uint8_t port_id, uint16_t queue_id,
2441 struct rte_mbuf **tx_pkts, uint16_t nb_pkts);
2443 static inline uint16_t
2444 rte_eth_tx_burst(uint8_t port_id, uint16_t queue_id,
2445 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
2447 struct rte_eth_dev *dev;
2449 dev = &rte_eth_devices[port_id];
2451 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
2452 struct rte_eth_rxtx_callback *cb = dev->pre_tx_burst_cbs[queue_id];
2454 if (unlikely(cb != NULL)) {
2456 nb_pkts = cb->fn(port_id, queue_id, tx_pkts, nb_pkts,
2459 } while (cb != NULL);
2463 return (*dev->tx_pkt_burst)(dev->data->tx_queues[queue_id], tx_pkts, nb_pkts);
2468 * Setup a new signature filter rule on an Ethernet device
2471 * The port identifier of the Ethernet device.
2472 * @param fdir_filter
2473 * The pointer to the fdir filter structure describing the signature filter
2475 * The *rte_fdir_filter* structure includes the values of the different fields
2476 * to match: source and destination IP addresses, vlan id, flexbytes, source
2477 * and destination ports, and so on.
2479 * The index of the RX queue where to store RX packets matching the added
2480 * signature filter defined in fdir_filter.
2482 * - (0) if successful.
2483 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2484 * - (-ENODEV) if *port_id* invalid.
2485 * - (-ENOSYS) if the FDIR mode is not configured in signature mode
2487 * - (-EINVAL) if the fdir_filter information is not correct.
2489 int rte_eth_dev_fdir_add_signature_filter(uint8_t port_id,
2490 struct rte_fdir_filter *fdir_filter,
2494 * Update a signature filter rule on an Ethernet device.
2495 * If the rule doesn't exits, it is created.
2498 * The port identifier of the Ethernet device.
2500 * The pointer to the structure describing the signature filter rule.
2501 * The *rte_fdir_filter* structure includes the values of the different fields
2502 * to match: source and destination IP addresses, vlan id, flexbytes, source
2503 * and destination ports, and so on.
2505 * The index of the RX queue where to store RX packets matching the added
2506 * signature filter defined in fdir_ftr.
2508 * - (0) if successful.
2509 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2510 * - (-ENODEV) if *port_id* invalid.
2511 * - (-ENOSYS) if the flow director mode is not configured in signature mode
2513 * - (-EINVAL) if the fdir_filter information is not correct.
2515 int rte_eth_dev_fdir_update_signature_filter(uint8_t port_id,
2516 struct rte_fdir_filter *fdir_ftr,
2520 * Remove a signature filter rule on an Ethernet device.
2523 * The port identifier of the Ethernet device.
2525 * The pointer to the structure describing the signature filter rule.
2526 * The *rte_fdir_filter* structure includes the values of the different fields
2527 * to match: source and destination IP addresses, vlan id, flexbytes, source
2528 * and destination ports, and so on.
2530 * - (0) if successful.
2531 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2532 * - (-ENODEV) if *port_id* invalid.
2533 * - (-ENOSYS) if the flow director mode is not configured in signature mode
2535 * - (-EINVAL) if the fdir_filter information is not correct.
2537 int rte_eth_dev_fdir_remove_signature_filter(uint8_t port_id,
2538 struct rte_fdir_filter *fdir_ftr);
2541 * Retrieve the flow director information of an Ethernet device.
2544 * The port identifier of the Ethernet device.
2546 * A pointer to a structure of type *rte_eth_dev_fdir* to be filled with
2547 * the flow director information of the Ethernet device.
2549 * - (0) if successful.
2550 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2551 * - (-ENODEV) if *port_id* invalid.
2552 * - (-ENOSYS) if the flow director mode is not configured on *port_id*.
2554 int rte_eth_dev_fdir_get_infos(uint8_t port_id, struct rte_eth_fdir *fdir);
2557 * Add a new perfect filter rule on an Ethernet device.
2560 * The port identifier of the Ethernet device.
2561 * @param fdir_filter
2562 * The pointer to the structure describing the perfect filter rule.
2563 * The *rte_fdir_filter* structure includes the values of the different fields
2564 * to match: source and destination IP addresses, vlan id, flexbytes, source
2565 * and destination ports, and so on.
2566 * IPv6 are not supported.
2568 * The 16-bit value supplied in the field hash.fdir.id of mbuf for RX
2569 * packets matching the perfect filter.
2571 * The index of the RX queue where to store RX packets matching the added
2572 * perfect filter defined in fdir_filter.
2574 * If drop is set to 1, matching RX packets are stored into the RX drop
2575 * queue defined in the rte_fdir_conf.
2577 * - (0) if successful.
2578 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2579 * - (-ENODEV) if *port_id* invalid.
2580 * - (-ENOSYS) if the flow director mode is not configured in perfect mode
2582 * - (-EINVAL) if the fdir_filter information is not correct.
2584 int rte_eth_dev_fdir_add_perfect_filter(uint8_t port_id,
2585 struct rte_fdir_filter *fdir_filter,
2586 uint16_t soft_id, uint8_t rx_queue,
2590 * Update a perfect filter rule on an Ethernet device.
2591 * If the rule doesn't exits, it is created.
2594 * The port identifier of the Ethernet device.
2595 * @param fdir_filter
2596 * The pointer to the structure describing the perfect filter rule.
2597 * The *rte_fdir_filter* structure includes the values of the different fields
2598 * to match: source and destination IP addresses, vlan id, flexbytes, source
2599 * and destination ports, and so on.
2600 * IPv6 are not supported.
2602 * The 16-bit value supplied in the field hash.fdir.id of mbuf for RX
2603 * packets matching the perfect filter.
2605 * The index of the RX queue where to store RX packets matching the added
2606 * perfect filter defined in fdir_filter.
2608 * If drop is set to 1, matching RX packets are stored into the RX drop
2609 * queue defined in the rte_fdir_conf.
2611 * - (0) if successful.
2612 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2613 * - (-ENODEV) if *port_id* invalid.
2614 * - (-ENOSYS) if the flow director mode is not configured in perfect mode
2616 * - (-EINVAL) if the fdir_filter information is not correct.
2618 int rte_eth_dev_fdir_update_perfect_filter(uint8_t port_id,
2619 struct rte_fdir_filter *fdir_filter,
2620 uint16_t soft_id, uint8_t rx_queue,
2624 * Remove a perfect filter rule on an Ethernet device.
2627 * The port identifier of the Ethernet device.
2628 * @param fdir_filter
2629 * The pointer to the structure describing the perfect filter rule.
2630 * The *rte_fdir_filter* structure includes the values of the different fields
2631 * to match: source and destination IP addresses, vlan id, flexbytes, source
2632 * and destination ports, and so on.
2633 * IPv6 are not supported.
2635 * The soft_id value provided when adding/updating the removed filter.
2637 * - (0) if successful.
2638 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2639 * - (-ENODEV) if *port_id* invalid.
2640 * - (-ENOSYS) if the flow director mode is not configured in perfect mode
2642 * - (-EINVAL) if the fdir_filter information is not correct.
2644 int rte_eth_dev_fdir_remove_perfect_filter(uint8_t port_id,
2645 struct rte_fdir_filter *fdir_filter,
2648 * Configure globally the masks for flow director mode for an Ethernet device.
2649 * For example, the device can match packets with only the first 24 bits of
2650 * the IPv4 source address.
2652 * The following fields can be masked: IPv4 addresses and L4 port numbers.
2653 * The following fields can be either enabled or disabled completely for the
2654 * matching functionality: VLAN ID tag; VLAN Priority + CFI bit; Flexible 2-byte
2656 * IPv6 masks are not supported.
2658 * All filters must comply with the masks previously configured.
2659 * For example, with a mask equal to 255.255.255.0 for the source IPv4 address,
2660 * all IPv4 filters must be created with a source IPv4 address that fits the
2663 * This function flushes all filters that have been previously added in
2667 * The port identifier of the Ethernet device.
2669 * The pointer to the fdir mask structure describing relevant headers fields
2670 * and relevant bits to use when matching packets addresses and ports.
2671 * IPv6 masks are not supported.
2673 * - (0) if successful.
2674 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2675 * - (-ENODEV) if *port_id* invalid.
2676 * - (-ENOSYS) if the flow director mode is not configured in perfect
2677 * mode on *port_id*.
2678 * - (-EINVAL) if the fdir_filter information is not correct
2680 int rte_eth_dev_fdir_set_masks(uint8_t port_id,
2681 struct rte_fdir_masks *fdir_mask);
2684 * The eth device event type for interrupt, and maybe others in the future.
2686 enum rte_eth_event_type {
2687 RTE_ETH_EVENT_UNKNOWN, /**< unknown event type */
2688 RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
2689 RTE_ETH_EVENT_MAX /**< max value of this enum */
2692 typedef void (*rte_eth_dev_cb_fn)(uint8_t port_id, \
2693 enum rte_eth_event_type event, void *cb_arg);
2694 /**< user application callback to be registered for interrupts */
2699 * Register a callback function for specific port id.
2706 * User supplied callback function to be called.
2708 * Pointer to the parameters for the registered callback.
2711 * - On success, zero.
2712 * - On failure, a negative value.
2714 int rte_eth_dev_callback_register(uint8_t port_id,
2715 enum rte_eth_event_type event,
2716 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
2719 * Unregister a callback function for specific port id.
2726 * User supplied callback function to be called.
2728 * Pointer to the parameters for the registered callback. -1 means to
2729 * remove all for the same callback address and same event.
2732 * - On success, zero.
2733 * - On failure, a negative value.
2735 int rte_eth_dev_callback_unregister(uint8_t port_id,
2736 enum rte_eth_event_type event,
2737 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
2740 * @internal Executes all the user application registered callbacks for
2741 * the specific device. It is for DPDK internal user only. User
2742 * application should not call it directly.
2745 * Pointer to struct rte_eth_dev.
2747 * Eth device interrupt event type.
2752 void _rte_eth_dev_callback_process(struct rte_eth_dev *dev,
2753 enum rte_eth_event_type event);
2756 * Turn on the LED on the Ethernet device.
2757 * This function turns on the LED on the Ethernet device.
2760 * The port identifier of the Ethernet device.
2762 * - (0) if successful.
2763 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
2765 * - (-ENODEV) if *port_id* invalid.
2767 int rte_eth_led_on(uint8_t port_id);
2770 * Turn off the LED on the Ethernet device.
2771 * This function turns off the LED on the Ethernet device.
2774 * The port identifier of the Ethernet device.
2776 * - (0) if successful.
2777 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
2779 * - (-ENODEV) if *port_id* invalid.
2781 int rte_eth_led_off(uint8_t port_id);
2784 * Get current status of the Ethernet link flow control for Ethernet device
2787 * The port identifier of the Ethernet device.
2789 * The pointer to the structure where to store the flow control parameters.
2791 * - (0) if successful.
2792 * - (-ENOTSUP) if hardware doesn't support flow control.
2793 * - (-ENODEV) if *port_id* invalid.
2795 int rte_eth_dev_flow_ctrl_get(uint8_t port_id,
2796 struct rte_eth_fc_conf *fc_conf);
2799 * Configure the Ethernet link flow control for Ethernet device
2802 * The port identifier of the Ethernet device.
2804 * The pointer to the structure of the flow control parameters.
2806 * - (0) if successful.
2807 * - (-ENOTSUP) if hardware doesn't support flow control mode.
2808 * - (-ENODEV) if *port_id* invalid.
2809 * - (-EINVAL) if bad parameter
2810 * - (-EIO) if flow control setup failure
2812 int rte_eth_dev_flow_ctrl_set(uint8_t port_id,
2813 struct rte_eth_fc_conf *fc_conf);
2816 * Configure the Ethernet priority flow control under DCB environment
2817 * for Ethernet device.
2820 * The port identifier of the Ethernet device.
2822 * The pointer to the structure of the priority flow control parameters.
2824 * - (0) if successful.
2825 * - (-ENOTSUP) if hardware doesn't support priority flow control mode.
2826 * - (-ENODEV) if *port_id* invalid.
2827 * - (-EINVAL) if bad parameter
2828 * - (-EIO) if flow control setup failure
2830 int rte_eth_dev_priority_flow_ctrl_set(uint8_t port_id,
2831 struct rte_eth_pfc_conf *pfc_conf);
2834 * Add a MAC address to an internal array of addresses used to enable whitelist
2835 * filtering to accept packets only if the destination MAC address matches.
2838 * The port identifier of the Ethernet device.
2840 * The MAC address to add.
2842 * VMDq pool index to associate address with (if VMDq is enabled). If VMDq is
2843 * not enabled, this should be set to 0.
2845 * - (0) if successfully added or *mac_addr" was already added.
2846 * - (-ENOTSUP) if hardware doesn't support this feature.
2847 * - (-ENODEV) if *port* is invalid.
2848 * - (-ENOSPC) if no more MAC addresses can be added.
2849 * - (-EINVAL) if MAC address is invalid.
2851 int rte_eth_dev_mac_addr_add(uint8_t port, struct ether_addr *mac_addr,
2855 * Remove a MAC address from the internal array of addresses.
2858 * The port identifier of the Ethernet device.
2860 * MAC address to remove.
2862 * - (0) if successful, or *mac_addr* didn't exist.
2863 * - (-ENOTSUP) if hardware doesn't support.
2864 * - (-ENODEV) if *port* invalid.
2865 * - (-EADDRINUSE) if attempting to remove the default MAC address
2867 int rte_eth_dev_mac_addr_remove(uint8_t port, struct ether_addr *mac_addr);
2870 * Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
2873 * The port identifier of the Ethernet device.
2877 * Redirection table size. The table size can be queried by
2878 * rte_eth_dev_info_get().
2880 * - (0) if successful.
2881 * - (-ENOTSUP) if hardware doesn't support.
2882 * - (-EINVAL) if bad parameter.
2884 int rte_eth_dev_rss_reta_update(uint8_t port,
2885 struct rte_eth_rss_reta_entry64 *reta_conf,
2886 uint16_t reta_size);
2889 * Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
2892 * The port identifier of the Ethernet device.
2896 * Redirection table size. The table size can be queried by
2897 * rte_eth_dev_info_get().
2899 * - (0) if successful.
2900 * - (-ENOTSUP) if hardware doesn't support.
2901 * - (-EINVAL) if bad parameter.
2903 int rte_eth_dev_rss_reta_query(uint8_t port,
2904 struct rte_eth_rss_reta_entry64 *reta_conf,
2905 uint16_t reta_size);
2908 * Updates unicast hash table for receiving packet with the given destination
2909 * MAC address, and the packet is routed to all VFs for which the RX mode is
2910 * accept packets that match the unicast hash table.
2913 * The port identifier of the Ethernet device.
2915 * Unicast MAC address.
2917 * 1 - Set an unicast hash bit for receiving packets with the MAC address.
2918 * 0 - Clear an unicast hash bit.
2920 * - (0) if successful.
2921 * - (-ENOTSUP) if hardware doesn't support.
2922 * - (-ENODEV) if *port_id* invalid.
2923 * - (-EINVAL) if bad parameter.
2925 int rte_eth_dev_uc_hash_table_set(uint8_t port,struct ether_addr *addr,
2929 * Updates all unicast hash bitmaps for receiving packet with any Unicast
2930 * Ethernet MAC addresses,the packet is routed to all VFs for which the RX
2931 * mode is accept packets that match the unicast hash table.
2934 * The port identifier of the Ethernet device.
2936 * 1 - Set all unicast hash bitmaps for receiving all the Ethernet
2938 * 0 - Clear all unicast hash bitmaps
2940 * - (0) if successful.
2941 * - (-ENOTSUP) if hardware doesn't support.
2942 * - (-ENODEV) if *port_id* invalid.
2943 * - (-EINVAL) if bad parameter.
2945 int rte_eth_dev_uc_all_hash_table_set(uint8_t port,uint8_t on);
2948 * Set RX L2 Filtering mode of a VF of an Ethernet device.
2951 * The port identifier of the Ethernet device.
2955 * The RX mode mask, which is one or more of accepting Untagged Packets,
2956 * packets that match the PFUTA table, Broadcast and Multicast Promiscuous.
2957 * ETH_VMDQ_ACCEPT_UNTAG,ETH_VMDQ_ACCEPT_HASH_UC,
2958 * ETH_VMDQ_ACCEPT_BROADCAST and ETH_VMDQ_ACCEPT_MULTICAST will be used
2961 * 1 - Enable a VF RX mode.
2962 * 0 - Disable a VF RX mode.
2964 * - (0) if successful.
2965 * - (-ENOTSUP) if hardware doesn't support.
2966 * - (-ENOTSUP) if hardware doesn't support.
2967 * - (-EINVAL) if bad parameter.
2969 int rte_eth_dev_set_vf_rxmode(uint8_t port, uint16_t vf, uint16_t rx_mode,
2973 * Enable or disable a VF traffic transmit of the Ethernet device.
2976 * The port identifier of the Ethernet device.
2980 * 1 - Enable a VF traffic transmit.
2981 * 0 - Disable a VF traffic transmit.
2983 * - (0) if successful.
2984 * - (-ENODEV) if *port_id* invalid.
2985 * - (-ENOTSUP) if hardware doesn't support.
2986 * - (-EINVAL) if bad parameter.
2989 rte_eth_dev_set_vf_tx(uint8_t port,uint16_t vf, uint8_t on);
2992 * Enable or disable a VF traffic receive of an Ethernet device.
2995 * The port identifier of the Ethernet device.
2999 * 1 - Enable a VF traffic receive.
3000 * 0 - Disable a VF traffic receive.
3002 * - (0) if successful.
3003 * - (-ENOTSUP) if hardware doesn't support.
3004 * - (-ENODEV) if *port_id* invalid.
3005 * - (-EINVAL) if bad parameter.
3008 rte_eth_dev_set_vf_rx(uint8_t port,uint16_t vf, uint8_t on);
3011 * Enable/Disable hardware VF VLAN filtering by an Ethernet device of
3012 * received VLAN packets tagged with a given VLAN Tag Identifier.
3015 * The port identifier of the Ethernet device.
3017 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
3019 * Bitmap listing which VFs participate in the VLAN filtering.
3021 * 1 - Enable VFs VLAN filtering.
3022 * 0 - Disable VFs VLAN filtering.
3024 * - (0) if successful.
3025 * - (-ENOTSUP) if hardware doesn't support.
3026 * - (-ENODEV) if *port_id* invalid.
3027 * - (-EINVAL) if bad parameter.
3030 rte_eth_dev_set_vf_vlan_filter(uint8_t port, uint16_t vlan_id,
3035 * Set a traffic mirroring rule on an Ethernet device
3038 * The port identifier of the Ethernet device.
3039 * @param mirror_conf
3040 * The pointer to the traffic mirroring structure describing the mirroring rule.
3041 * The *rte_eth_vm_mirror_conf* structure includes the type of mirroring rule,
3042 * destination pool and the value of rule if enable vlan or pool mirroring.
3045 * The index of traffic mirroring rule, we support four separated rules.
3047 * 1 - Enable a mirroring rule.
3048 * 0 - Disable a mirroring rule.
3050 * - (0) if successful.
3051 * - (-ENOTSUP) if hardware doesn't support this feature.
3052 * - (-ENODEV) if *port_id* invalid.
3053 * - (-EINVAL) if the mr_conf information is not correct.
3055 int rte_eth_mirror_rule_set(uint8_t port_id,
3056 struct rte_eth_vmdq_mirror_conf *mirror_conf,
3061 * Reset a traffic mirroring rule on an Ethernet device.
3064 * The port identifier of the Ethernet device.
3066 * The index of traffic mirroring rule, we support four separated rules.
3068 * - (0) if successful.
3069 * - (-ENOTSUP) if hardware doesn't support this feature.
3070 * - (-ENODEV) if *port_id* invalid.
3071 * - (-EINVAL) if bad parameter.
3073 int rte_eth_mirror_rule_reset(uint8_t port_id,
3077 * Set the rate limitation for a queue on an Ethernet device.
3080 * The port identifier of the Ethernet device.
3084 * The tx rate allocated from the total link speed for this queue.
3086 * - (0) if successful.
3087 * - (-ENOTSUP) if hardware doesn't support this feature.
3088 * - (-ENODEV) if *port_id* invalid.
3089 * - (-EINVAL) if bad parameter.
3091 int rte_eth_set_queue_rate_limit(uint8_t port_id, uint16_t queue_idx,
3095 * Set the rate limitation for a vf on an Ethernet device.
3098 * The port identifier of the Ethernet device.
3102 * The tx rate allocated from the total link speed for this VF id.
3104 * The queue mask which need to set the rate.
3106 * - (0) if successful.
3107 * - (-ENOTSUP) if hardware doesn't support this feature.
3108 * - (-ENODEV) if *port_id* invalid.
3109 * - (-EINVAL) if bad parameter.
3111 int rte_eth_set_vf_rate_limit(uint8_t port_id, uint16_t vf,
3112 uint16_t tx_rate, uint64_t q_msk);
3115 * Initialize bypass logic. This function needs to be called before
3116 * executing any other bypass API.
3119 * The port identifier of the Ethernet device.
3121 * - (0) if successful.
3122 * - (-ENOTSUP) if hardware doesn't support.
3123 * - (-EINVAL) if bad parameter.
3125 int rte_eth_dev_bypass_init(uint8_t port);
3128 * Return bypass state.
3131 * The port identifier of the Ethernet device.
3133 * The return bypass state.
3136 * - (3) Isolate mode
3138 * - (0) if successful.
3139 * - (-ENOTSUP) if hardware doesn't support.
3140 * - (-EINVAL) if bad parameter.
3142 int rte_eth_dev_bypass_state_show(uint8_t port, uint32_t *state);
3148 * The port identifier of the Ethernet device.
3150 * The current bypass state.
3153 * - (3) Isolate mode
3155 * - (0) if successful.
3156 * - (-ENOTSUP) if hardware doesn't support.
3157 * - (-EINVAL) if bad parameter.
3159 int rte_eth_dev_bypass_state_set(uint8_t port, uint32_t *new_state);
3162 * Return bypass state when given event occurs.
3165 * The port identifier of the Ethernet device.
3168 * - (1) Main power on (power button is pushed)
3169 * - (2) Auxiliary power on (power supply is being plugged)
3170 * - (3) Main power off (system shutdown and power supply is left plugged in)
3171 * - (4) Auxiliary power off (power supply is being unplugged)
3172 * - (5) Display or set the watchdog timer
3174 * The bypass state when given event occurred.
3177 * - (3) Isolate mode
3179 * - (0) if successful.
3180 * - (-ENOTSUP) if hardware doesn't support.
3181 * - (-EINVAL) if bad parameter.
3183 int rte_eth_dev_bypass_event_show(uint8_t port, uint32_t event, uint32_t *state);
3186 * Set bypass state when given event occurs.
3189 * The port identifier of the Ethernet device.
3192 * - (1) Main power on (power button is pushed)
3193 * - (2) Auxiliary power on (power supply is being plugged)
3194 * - (3) Main power off (system shutdown and power supply is left plugged in)
3195 * - (4) Auxiliary power off (power supply is being unplugged)
3196 * - (5) Display or set the watchdog timer
3198 * The assigned state when given event occurs.
3201 * - (3) Isolate mode
3203 * - (0) if successful.
3204 * - (-ENOTSUP) if hardware doesn't support.
3205 * - (-EINVAL) if bad parameter.
3207 int rte_eth_dev_bypass_event_store(uint8_t port, uint32_t event, uint32_t state);
3210 * Set bypass watchdog timeout count.
3213 * The port identifier of the Ethernet device.
3215 * The timeout to be set.
3216 * - (0) 0 seconds (timer is off)
3225 * - (0) if successful.
3226 * - (-ENOTSUP) if hardware doesn't support.
3227 * - (-EINVAL) if bad parameter.
3229 int rte_eth_dev_wd_timeout_store(uint8_t port, uint32_t timeout);
3232 * Get bypass firmware version.
3235 * The port identifier of the Ethernet device.
3237 * The firmware version
3239 * - (0) if successful.
3240 * - (-ENOTSUP) if hardware doesn't support.
3241 * - (-EINVAL) if bad parameter.
3243 int rte_eth_dev_bypass_ver_show(uint8_t port, uint32_t *ver);
3246 * Return bypass watchdog timeout in seconds
3249 * The port identifier of the Ethernet device.
3251 * The return watchdog timeout. "0" represents timer expired
3252 * - (0) 0 seconds (timer is off)
3261 * - (0) if successful.
3262 * - (-ENOTSUP) if hardware doesn't support.
3263 * - (-EINVAL) if bad parameter.
3265 int rte_eth_dev_bypass_wd_timeout_show(uint8_t port, uint32_t *wd_timeout);
3268 * Reset bypass watchdog timer
3271 * The port identifier of the Ethernet device.
3273 * - (0) if successful.
3274 * - (-ENOTSUP) if hardware doesn't support.
3275 * - (-EINVAL) if bad parameter.
3277 int rte_eth_dev_bypass_wd_reset(uint8_t port);
3280 * Configuration of Receive Side Scaling hash computation of Ethernet device.
3283 * The port identifier of the Ethernet device.
3285 * The new configuration to use for RSS hash computation on the port.
3287 * - (0) if successful.
3288 * - (-ENODEV) if port identifier is invalid.
3289 * - (-ENOTSUP) if hardware doesn't support.
3290 * - (-EINVAL) if bad parameter.
3292 int rte_eth_dev_rss_hash_update(uint8_t port_id,
3293 struct rte_eth_rss_conf *rss_conf);
3296 * Retrieve current configuration of Receive Side Scaling hash computation
3297 * of Ethernet device.
3300 * The port identifier of the Ethernet device.
3302 * Where to store the current RSS hash configuration of the Ethernet device.
3304 * - (0) if successful.
3305 * - (-ENODEV) if port identifier is invalid.
3306 * - (-ENOTSUP) if hardware doesn't support RSS.
3309 rte_eth_dev_rss_hash_conf_get(uint8_t port_id,
3310 struct rte_eth_rss_conf *rss_conf);
3313 * Add UDP tunneling port of an Ethernet device for filtering a specific
3314 * tunneling packet by UDP port number.
3317 * The port identifier of the Ethernet device.
3319 * UDP tunneling configuration.
3322 * - (0) if successful.
3323 * - (-ENODEV) if port identifier is invalid.
3324 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3327 rte_eth_dev_udp_tunnel_add(uint8_t port_id,
3328 struct rte_eth_udp_tunnel *tunnel_udp);
3331 * Detete UDP tunneling port configuration of Ethernet device
3334 * The port identifier of the Ethernet device.
3336 * UDP tunneling configuration.
3339 * - (0) if successful.
3340 * - (-ENODEV) if port identifier is invalid.
3341 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3344 rte_eth_dev_udp_tunnel_delete(uint8_t port_id,
3345 struct rte_eth_udp_tunnel *tunnel_udp);
3348 * Check whether the filter type is supported on an Ethernet device.
3349 * All the supported filter types are defined in 'rte_eth_ctrl.h'.
3352 * The port identifier of the Ethernet device.
3353 * @param filter_type
3356 * - (0) if successful.
3357 * - (-ENOTSUP) if hardware doesn't support this filter type.
3358 * - (-ENODEV) if *port_id* invalid.
3360 int rte_eth_dev_filter_supported(uint8_t port_id, enum rte_filter_type filter_type);
3363 * Take operations to assigned filter type on an Ethernet device.
3364 * All the supported operations and filter types are defined in 'rte_eth_ctrl.h'.
3367 * The port identifier of the Ethernet device.
3368 * @param filter_type
3371 * Type of operation.
3373 * A pointer to arguments defined specifically for the operation.
3375 * - (0) if successful.
3376 * - (-ENOTSUP) if hardware doesn't support.
3377 * - (-ENODEV) if *port_id* invalid.
3378 * - others depends on the specific operations implementation.
3380 int rte_eth_dev_filter_ctrl(uint8_t port_id, enum rte_filter_type filter_type,
3381 enum rte_filter_op filter_op, void *arg);
3384 * Add a callback to be called on packet RX on a given port and queue.
3386 * This API configures a function to be called for each burst of
3387 * packets received on a given NIC port queue. The return value is a pointer
3388 * that can be used to later remove the callback using
3389 * rte_eth_remove_rx_callback().
3392 * The port identifier of the Ethernet device.
3394 * The queue on the Ethernet device on which the callback is to be added.
3396 * The callback function
3398 * A generic pointer parameter which will be passed to each invocation of the
3399 * callback function on this port and queue.
3403 * On success, a pointer value which can later be used to remove the callback.
3405 void *rte_eth_add_rx_callback(uint8_t port_id, uint16_t queue_id,
3406 rte_rxtx_callback_fn fn, void *user_param);
3409 * Add a callback to be called on packet TX on a given port and queue.
3411 * This API configures a function to be called for each burst of
3412 * packets sent on a given NIC port queue. The return value is a pointer
3413 * that can be used to later remove the callback using
3414 * rte_eth_remove_tx_callback().
3417 * The port identifier of the Ethernet device.
3419 * The queue on the Ethernet device on which the callback is to be added.
3421 * The callback function
3423 * A generic pointer parameter which will be passed to each invocation of the
3424 * callback function on this port and queue.
3428 * On success, a pointer value which can later be used to remove the callback.
3430 void *rte_eth_add_tx_callback(uint8_t port_id, uint16_t queue_id,
3431 rte_rxtx_callback_fn fn, void *user_param);
3434 * Remove an RX packet callback from a given port and queue.
3436 * This function is used to removed callbacks that were added to a NIC port
3437 * queue using rte_eth_add_rx_callback().
3439 * Note: the callback is removed from the callback list but it isn't freed
3440 * since the it may still be in use. The memory for the callback can be
3441 * subsequently freed back by the application by calling rte_free():
3443 * - Immediately - if the port is stopped, or the user knows that no
3444 * callbacks are in flight e.g. if called from the thread doing RX/TX
3447 * - After a short delay - where the delay is sufficient to allow any
3448 * in-flight callbacks to complete.
3451 * The port identifier of the Ethernet device.
3453 * The queue on the Ethernet device from which the callback is to be removed.
3455 * User supplied callback created via rte_eth_add_rx_callback().
3458 * - 0: Success. Callback was removed.
3459 * - -ENOTSUP: Callback support is not available.
3460 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
3461 * is NULL or not found for the port/queue.
3463 int rte_eth_remove_rx_callback(uint8_t port_id, uint16_t queue_id,
3464 struct rte_eth_rxtx_callback *user_cb);
3467 * Remove a TX packet callback from a given port and queue.
3469 * This function is used to removed callbacks that were added to a NIC port
3470 * queue using rte_eth_add_tx_callback().
3472 * Note: the callback is removed from the callback list but it isn't freed
3473 * since the it may still be in use. The memory for the callback can be
3474 * subsequently freed back by the application by calling rte_free():
3476 * - Immediately - if the port is stopped, or the user knows that no
3477 * callbacks are in flight e.g. if called from the thread doing RX/TX
3480 * - After a short delay - where the delay is sufficient to allow any
3481 * in-flight callbacks to complete.
3484 * The port identifier of the Ethernet device.
3486 * The queue on the Ethernet device from which the callback is to be removed.
3488 * User supplied callback created via rte_eth_add_tx_callback().
3491 * - 0: Success. Callback was removed.
3492 * - -ENOTSUP: Callback support is not available.
3493 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
3494 * is NULL or not found for the port/queue.
3496 int rte_eth_remove_tx_callback(uint8_t port_id, uint16_t queue_id,
3497 struct rte_eth_rxtx_callback *user_cb);
3503 #endif /* _RTE_ETHDEV_H_ */