4 * Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 #ifndef _RTE_ETHDEV_H_
35 #define _RTE_ETHDEV_H_
40 * RTE Ethernet Device API
42 * The Ethernet Device API is composed of two parts:
44 * - The application-oriented Ethernet API that includes functions to setup
45 * an Ethernet device (configure it, setup its RX and TX queues and start it),
46 * to get its MAC address, the speed and the status of its physical link,
47 * to receive and to transmit packets, and so on.
49 * - The driver-oriented Ethernet API that exports a function allowing
50 * an Ethernet Poll Mode Driver (PMD) to simultaneously register itself as
51 * an Ethernet device driver and as a PCI driver for a set of matching PCI
52 * [Ethernet] devices classes.
54 * By default, all the functions of the Ethernet Device API exported by a PMD
55 * are lock-free functions which assume to not be invoked in parallel on
56 * different logical cores to work on the same target object. For instance,
57 * the receive function of a PMD cannot be invoked in parallel on two logical
58 * cores to poll the same RX queue [of the same port]. Of course, this function
59 * can be invoked in parallel by different logical cores on different RX queues.
60 * It is the responsibility of the upper level application to enforce this rule.
62 * If needed, parallel accesses by multiple logical cores to shared queues
63 * shall be explicitly protected by dedicated inline lock-aware functions
64 * built on top of their corresponding lock-free functions of the PMD API.
66 * In all functions of the Ethernet API, the Ethernet device is
67 * designated by an integer >= 0 named the device port identifier.
69 * At the Ethernet driver level, Ethernet devices are represented by a generic
70 * data structure of type *rte_eth_dev*.
72 * Ethernet devices are dynamically registered during the PCI probing phase
73 * performed at EAL initialization time.
74 * When an Ethernet device is being probed, an *rte_eth_dev* structure and
75 * a new port identifier are allocated for that device. Then, the eth_dev_init()
76 * function supplied by the Ethernet driver matching the probed PCI
77 * device is invoked to properly initialize the device.
79 * The role of the device init function consists of resetting the hardware,
80 * checking access to Non-volatile Memory (NVM), reading the MAC address
83 * If the device init operation is successful, the correspondence between
84 * the port identifier assigned to the new device and its associated
85 * *rte_eth_dev* structure is effectively registered.
86 * Otherwise, both the *rte_eth_dev* structure and the port identifier are
89 * The functions exported by the application Ethernet API to setup a device
90 * designated by its port identifier must be invoked in the following order:
91 * - rte_eth_dev_configure()
92 * - rte_eth_tx_queue_setup()
93 * - rte_eth_rx_queue_setup()
94 * - rte_eth_dev_start()
96 * Then, the network application can invoke, in any order, the functions
97 * exported by the Ethernet API to get the MAC address of a given device, to
98 * get the speed and the status of a device physical link, to receive/transmit
99 * [burst of] packets, and so on.
101 * If the application wants to change the configuration (i.e. call
102 * rte_eth_dev_configure(), rte_eth_tx_queue_setup(), or
103 * rte_eth_rx_queue_setup()), it must call rte_eth_dev_stop() first to stop the
104 * device and then do the reconfiguration before calling rte_eth_dev_start()
105 * again. The tramsit and receive functions should not be invoked when the
108 * Please note that some configuration is not stored between calls to
109 * rte_eth_dev_stop()/rte_eth_dev_start(). The following configuration will
112 * - flow control settings
113 * - receive mode configuration (promiscuous mode, hardware checksum mode,
114 * RSS/VMDQ settings etc.)
115 * - VLAN filtering configuration
116 * - MAC addresses supplied to MAC address array
117 * - flow director filtering mode (but not filtering rules)
118 * - NIC queue statistics mappings
120 * Any other configuration will not be stored and will need to be re-entered
121 * after a call to rte_eth_dev_start().
123 * Finally, a network application can close an Ethernet device by invoking the
124 * rte_eth_dev_close() function.
126 * Each function of the application Ethernet API invokes a specific function
127 * of the PMD that controls the target device designated by its port
129 * For this purpose, all device-specific functions of an Ethernet driver are
130 * supplied through a set of pointers contained in a generic structure of type
132 * The address of the *eth_dev_ops* structure is stored in the *rte_eth_dev*
133 * structure by the device init function of the Ethernet driver, which is
134 * invoked during the PCI probing phase, as explained earlier.
136 * In other words, each function of the Ethernet API simply retrieves the
137 * *rte_eth_dev* structure associated with the device port identifier and
138 * performs an indirect invocation of the corresponding driver function
139 * supplied in the *eth_dev_ops* structure of the *rte_eth_dev* structure.
141 * For performance reasons, the address of the burst-oriented RX and TX
142 * functions of the Ethernet driver are not contained in the *eth_dev_ops*
143 * structure. Instead, they are directly stored at the beginning of the
144 * *rte_eth_dev* structure to avoid an extra indirect memory access during
147 * RTE ethernet device drivers do not use interrupts for transmitting or
148 * receiving. Instead, Ethernet drivers export Poll-Mode receive and transmit
149 * functions to applications.
150 * Both receive and transmit functions are packet-burst oriented to minimize
151 * their cost per packet through the following optimizations:
153 * - Sharing among multiple packets the incompressible cost of the
154 * invocation of receive/transmit functions.
156 * - Enabling receive/transmit functions to take advantage of burst-oriented
157 * hardware features (L1 cache, prefetch instructions, NIC head/tail
158 * registers) to minimize the number of CPU cycles per packet, for instance,
159 * by avoiding useless read memory accesses to ring descriptors, or by
160 * systematically using arrays of pointers that exactly fit L1 cache line
161 * boundaries and sizes.
163 * The burst-oriented receive function does not provide any error notification,
164 * to avoid the corresponding overhead. As a hint, the upper-level application
165 * might check the status of the device link once being systematically returned
166 * a 0 value by the receive function of the driver for a given number of tries.
175 /* Use this macro to check if LRO API is supported */
176 #define RTE_ETHDEV_HAS_LRO_SUPPORT
179 #include <rte_interrupts.h>
182 #include <rte_devargs.h>
183 #include "rte_ether.h"
184 #include "rte_eth_ctrl.h"
185 #include "rte_dev_info.h"
190 * A structure used to retrieve statistics for an Ethernet port.
192 struct rte_eth_stats {
193 uint64_t ipackets; /**< Total number of successfully received packets. */
194 uint64_t opackets; /**< Total number of successfully transmitted packets.*/
195 uint64_t ibytes; /**< Total number of successfully received bytes. */
196 uint64_t obytes; /**< Total number of successfully transmitted bytes. */
198 /**< Deprecated; Total of RX missed packets (e.g full FIFO). */
200 /**< Deprecated; Total of RX packets with CRC error. */
202 /**< Deprecated; Total of RX packets with bad length. */
203 uint64_t ierrors; /**< Total number of erroneous received packets. */
204 uint64_t oerrors; /**< Total number of failed transmitted packets. */
206 /**< Deprecated; Total number of multicast received packets. */
207 uint64_t rx_nombuf; /**< Total number of RX mbuf allocation failures. */
209 /**< Deprecated; Total number of RX packets matching a filter. */
211 /**< Deprecated; Total number of RX packets not matching any filter. */
212 uint64_t tx_pause_xon;
213 /**< Deprecated; Total nb. of XON pause frame sent. */
214 uint64_t rx_pause_xon;
215 /**< Deprecated; Total nb. of XON pause frame received. */
216 uint64_t tx_pause_xoff;
217 /**< Deprecated; Total nb. of XOFF pause frame sent. */
218 uint64_t rx_pause_xoff;
219 /**< Deprecated; Total nb. of XOFF pause frame received. */
220 uint64_t q_ipackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
221 /**< Total number of queue RX packets. */
222 uint64_t q_opackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
223 /**< Total number of queue TX packets. */
224 uint64_t q_ibytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
225 /**< Total number of successfully received queue bytes. */
226 uint64_t q_obytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
227 /**< Total number of successfully transmitted queue bytes. */
228 uint64_t q_errors[RTE_ETHDEV_QUEUE_STAT_CNTRS];
229 /**< Total number of queue packets received that are dropped. */
231 /**< Total number of good packets received from loopback,VF Only */
233 /**< Total number of good packets transmitted to loopback,VF Only */
235 /**< Total number of good bytes received from loopback,VF Only */
237 /**< Total number of good bytes transmitted to loopback,VF Only */
241 * A structure used to retrieve link-level information of an Ethernet port.
243 struct rte_eth_link {
244 uint16_t link_speed; /**< ETH_LINK_SPEED_[10, 100, 1000, 10000] */
245 uint16_t link_duplex; /**< ETH_LINK_[HALF_DUPLEX, FULL_DUPLEX] */
246 uint8_t link_status : 1; /**< 1 -> link up, 0 -> link down */
247 }__attribute__((aligned(8))); /**< aligned for atomic64 read/write */
249 #define ETH_LINK_SPEED_AUTONEG 0 /**< Auto-negotiate link speed. */
250 #define ETH_LINK_SPEED_10 10 /**< 10 megabits/second. */
251 #define ETH_LINK_SPEED_100 100 /**< 100 megabits/second. */
252 #define ETH_LINK_SPEED_1000 1000 /**< 1 gigabits/second. */
253 #define ETH_LINK_SPEED_10000 10000 /**< 10 gigabits/second. */
254 #define ETH_LINK_SPEED_10G 10000 /**< alias of 10 gigabits/second. */
255 #define ETH_LINK_SPEED_20G 20000 /**< 20 gigabits/second. */
256 #define ETH_LINK_SPEED_40G 40000 /**< 40 gigabits/second. */
258 #define ETH_LINK_AUTONEG_DUPLEX 0 /**< Auto-negotiate duplex. */
259 #define ETH_LINK_HALF_DUPLEX 1 /**< Half-duplex connection. */
260 #define ETH_LINK_FULL_DUPLEX 2 /**< Full-duplex connection. */
263 * A structure used to configure the ring threshold registers of an RX/TX
264 * queue for an Ethernet port.
266 struct rte_eth_thresh {
267 uint8_t pthresh; /**< Ring prefetch threshold. */
268 uint8_t hthresh; /**< Ring host threshold. */
269 uint8_t wthresh; /**< Ring writeback threshold. */
273 * Simple flags are used for rte_eth_conf.rxmode.mq_mode.
275 #define ETH_MQ_RX_RSS_FLAG 0x1
276 #define ETH_MQ_RX_DCB_FLAG 0x2
277 #define ETH_MQ_RX_VMDQ_FLAG 0x4
280 * A set of values to identify what method is to be used to route
281 * packets to multiple queues.
283 enum rte_eth_rx_mq_mode {
284 /** None of DCB,RSS or VMDQ mode */
287 /** For RX side, only RSS is on */
288 ETH_MQ_RX_RSS = ETH_MQ_RX_RSS_FLAG,
289 /** For RX side,only DCB is on. */
290 ETH_MQ_RX_DCB = ETH_MQ_RX_DCB_FLAG,
291 /** Both DCB and RSS enable */
292 ETH_MQ_RX_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG,
294 /** Only VMDQ, no RSS nor DCB */
295 ETH_MQ_RX_VMDQ_ONLY = ETH_MQ_RX_VMDQ_FLAG,
296 /** RSS mode with VMDQ */
297 ETH_MQ_RX_VMDQ_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_VMDQ_FLAG,
298 /** Use VMDQ+DCB to route traffic to queues */
299 ETH_MQ_RX_VMDQ_DCB = ETH_MQ_RX_VMDQ_FLAG | ETH_MQ_RX_DCB_FLAG,
300 /** Enable both VMDQ and DCB in VMDq */
301 ETH_MQ_RX_VMDQ_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG |
306 * for rx mq mode backward compatible
308 #define ETH_RSS ETH_MQ_RX_RSS
309 #define VMDQ_DCB ETH_MQ_RX_VMDQ_DCB
310 #define ETH_DCB_RX ETH_MQ_RX_DCB
313 * A set of values to identify what method is to be used to transmit
314 * packets using multi-TCs.
316 enum rte_eth_tx_mq_mode {
317 ETH_MQ_TX_NONE = 0, /**< It is in neither DCB nor VT mode. */
318 ETH_MQ_TX_DCB, /**< For TX side,only DCB is on. */
319 ETH_MQ_TX_VMDQ_DCB, /**< For TX side,both DCB and VT is on. */
320 ETH_MQ_TX_VMDQ_ONLY, /**< Only VT on, no DCB */
324 * for tx mq mode backward compatible
326 #define ETH_DCB_NONE ETH_MQ_TX_NONE
327 #define ETH_VMDQ_DCB_TX ETH_MQ_TX_VMDQ_DCB
328 #define ETH_DCB_TX ETH_MQ_TX_DCB
331 * A structure used to configure the RX features of an Ethernet port.
333 struct rte_eth_rxmode {
334 /** The multi-queue packet distribution mode to be used, e.g. RSS. */
335 enum rte_eth_rx_mq_mode mq_mode;
336 uint32_t max_rx_pkt_len; /**< Only used if jumbo_frame enabled. */
337 uint16_t split_hdr_size; /**< hdr buf size (header_split enabled).*/
338 uint16_t header_split : 1, /**< Header Split enable. */
339 hw_ip_checksum : 1, /**< IP/UDP/TCP checksum offload enable. */
340 hw_vlan_filter : 1, /**< VLAN filter enable. */
341 hw_vlan_strip : 1, /**< VLAN strip enable. */
342 hw_vlan_extend : 1, /**< Extended VLAN enable. */
343 jumbo_frame : 1, /**< Jumbo Frame Receipt enable. */
344 hw_strip_crc : 1, /**< Enable CRC stripping by hardware. */
345 enable_scatter : 1, /**< Enable scatter packets rx handler */
346 enable_lro : 1; /**< Enable LRO */
350 * A structure used to configure the Receive Side Scaling (RSS) feature
351 * of an Ethernet port.
352 * If not NULL, the *rss_key* pointer of the *rss_conf* structure points
353 * to an array holding the RSS key to use for hashing specific header
354 * fields of received packets. The length of this array should be indicated
355 * by *rss_key_len* below. Otherwise, a default random hash key is used by
358 * The *rss_key_len* field of the *rss_conf* structure indicates the length
359 * in bytes of the array pointed by *rss_key*. To be compatible, this length
360 * will be checked in i40e only. Others assume 40 bytes to be used as before.
362 * The *rss_hf* field of the *rss_conf* structure indicates the different
363 * types of IPv4/IPv6 packets to which the RSS hashing must be applied.
364 * Supplying an *rss_hf* equal to zero disables the RSS feature.
366 struct rte_eth_rss_conf {
367 uint8_t *rss_key; /**< If not NULL, 40-byte hash key. */
368 uint8_t rss_key_len; /**< hash key length in bytes. */
369 uint64_t rss_hf; /**< Hash functions to apply - see below. */
373 * The RSS offload types are defined based on flow types which are defined
374 * in rte_eth_ctrl.h. Different NIC hardwares may support different RSS offload
375 * types. The supported flow types or RSS offload types can be queried by
376 * rte_eth_dev_info_get().
378 #define ETH_RSS_IPV4 (1ULL << RTE_ETH_FLOW_IPV4)
379 #define ETH_RSS_FRAG_IPV4 (1ULL << RTE_ETH_FLOW_FRAG_IPV4)
380 #define ETH_RSS_NONFRAG_IPV4_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_TCP)
381 #define ETH_RSS_NONFRAG_IPV4_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_UDP)
382 #define ETH_RSS_NONFRAG_IPV4_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_SCTP)
383 #define ETH_RSS_NONFRAG_IPV4_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_OTHER)
384 #define ETH_RSS_IPV6 (1ULL << RTE_ETH_FLOW_IPV6)
385 #define ETH_RSS_FRAG_IPV6 (1ULL << RTE_ETH_FLOW_FRAG_IPV6)
386 #define ETH_RSS_NONFRAG_IPV6_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_TCP)
387 #define ETH_RSS_NONFRAG_IPV6_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_UDP)
388 #define ETH_RSS_NONFRAG_IPV6_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_SCTP)
389 #define ETH_RSS_NONFRAG_IPV6_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_OTHER)
390 #define ETH_RSS_L2_PAYLOAD (1ULL << RTE_ETH_FLOW_L2_PAYLOAD)
391 #define ETH_RSS_IPV6_EX (1ULL << RTE_ETH_FLOW_IPV6_EX)
392 #define ETH_RSS_IPV6_TCP_EX (1ULL << RTE_ETH_FLOW_IPV6_TCP_EX)
393 #define ETH_RSS_IPV6_UDP_EX (1ULL << RTE_ETH_FLOW_IPV6_UDP_EX)
395 #define ETH_RSS_IP ( \
397 ETH_RSS_FRAG_IPV4 | \
398 ETH_RSS_NONFRAG_IPV4_OTHER | \
400 ETH_RSS_FRAG_IPV6 | \
401 ETH_RSS_NONFRAG_IPV6_OTHER | \
404 #define ETH_RSS_UDP ( \
405 ETH_RSS_NONFRAG_IPV4_UDP | \
406 ETH_RSS_NONFRAG_IPV6_UDP | \
409 #define ETH_RSS_TCP ( \
410 ETH_RSS_NONFRAG_IPV4_TCP | \
411 ETH_RSS_NONFRAG_IPV6_TCP | \
414 #define ETH_RSS_SCTP ( \
415 ETH_RSS_NONFRAG_IPV4_SCTP | \
416 ETH_RSS_NONFRAG_IPV6_SCTP)
418 /**< Mask of valid RSS hash protocols */
419 #define ETH_RSS_PROTO_MASK ( \
421 ETH_RSS_FRAG_IPV4 | \
422 ETH_RSS_NONFRAG_IPV4_TCP | \
423 ETH_RSS_NONFRAG_IPV4_UDP | \
424 ETH_RSS_NONFRAG_IPV4_SCTP | \
425 ETH_RSS_NONFRAG_IPV4_OTHER | \
427 ETH_RSS_FRAG_IPV6 | \
428 ETH_RSS_NONFRAG_IPV6_TCP | \
429 ETH_RSS_NONFRAG_IPV6_UDP | \
430 ETH_RSS_NONFRAG_IPV6_SCTP | \
431 ETH_RSS_NONFRAG_IPV6_OTHER | \
432 ETH_RSS_L2_PAYLOAD | \
434 ETH_RSS_IPV6_TCP_EX | \
438 * Definitions used for redirection table entry size.
439 * Some RSS RETA sizes may not be supported by some drivers, check the
440 * documentation or the description of relevant functions for more details.
442 #define ETH_RSS_RETA_SIZE_64 64
443 #define ETH_RSS_RETA_SIZE_128 128
444 #define ETH_RSS_RETA_SIZE_512 512
445 #define RTE_RETA_GROUP_SIZE 64
447 /* Definitions used for VMDQ and DCB functionality */
448 #define ETH_VMDQ_MAX_VLAN_FILTERS 64 /**< Maximum nb. of VMDQ vlan filters. */
449 #define ETH_DCB_NUM_USER_PRIORITIES 8 /**< Maximum nb. of DCB priorities. */
450 #define ETH_VMDQ_DCB_NUM_QUEUES 128 /**< Maximum nb. of VMDQ DCB queues. */
451 #define ETH_DCB_NUM_QUEUES 128 /**< Maximum nb. of DCB queues. */
453 /* DCB capability defines */
454 #define ETH_DCB_PG_SUPPORT 0x00000001 /**< Priority Group(ETS) support. */
455 #define ETH_DCB_PFC_SUPPORT 0x00000002 /**< Priority Flow Control support. */
457 /* Definitions used for VLAN Offload functionality */
458 #define ETH_VLAN_STRIP_OFFLOAD 0x0001 /**< VLAN Strip On/Off */
459 #define ETH_VLAN_FILTER_OFFLOAD 0x0002 /**< VLAN Filter On/Off */
460 #define ETH_VLAN_EXTEND_OFFLOAD 0x0004 /**< VLAN Extend On/Off */
462 /* Definitions used for mask VLAN setting */
463 #define ETH_VLAN_STRIP_MASK 0x0001 /**< VLAN Strip setting mask */
464 #define ETH_VLAN_FILTER_MASK 0x0002 /**< VLAN Filter setting mask*/
465 #define ETH_VLAN_EXTEND_MASK 0x0004 /**< VLAN Extend setting mask*/
466 #define ETH_VLAN_ID_MAX 0x0FFF /**< VLAN ID is in lower 12 bits*/
468 /* Definitions used for receive MAC address */
469 #define ETH_NUM_RECEIVE_MAC_ADDR 128 /**< Maximum nb. of receive mac addr. */
471 /* Definitions used for unicast hash */
472 #define ETH_VMDQ_NUM_UC_HASH_ARRAY 128 /**< Maximum nb. of UC hash array. */
474 /* Definitions used for VMDQ pool rx mode setting */
475 #define ETH_VMDQ_ACCEPT_UNTAG 0x0001 /**< accept untagged packets. */
476 #define ETH_VMDQ_ACCEPT_HASH_MC 0x0002 /**< accept packets in multicast table . */
477 #define ETH_VMDQ_ACCEPT_HASH_UC 0x0004 /**< accept packets in unicast table. */
478 #define ETH_VMDQ_ACCEPT_BROADCAST 0x0008 /**< accept broadcast packets. */
479 #define ETH_VMDQ_ACCEPT_MULTICAST 0x0010 /**< multicast promiscuous. */
481 /** Maximum nb. of vlan per mirror rule */
482 #define ETH_MIRROR_MAX_VLANS 64
484 #define ETH_MIRROR_VIRTUAL_POOL_UP 0x01 /**< Virtual Pool uplink Mirroring. */
485 #define ETH_MIRROR_UPLINK_PORT 0x02 /**< Uplink Port Mirroring. */
486 #define ETH_MIRROR_DOWNLINK_PORT 0x04 /**< Downlink Port Mirroring. */
487 #define ETH_MIRROR_VLAN 0x08 /**< VLAN Mirroring. */
488 #define ETH_MIRROR_VIRTUAL_POOL_DOWN 0x10 /**< Virtual Pool downlink Mirroring. */
491 * A structure used to configure VLAN traffic mirror of an Ethernet port.
493 struct rte_eth_vlan_mirror {
494 uint64_t vlan_mask; /**< mask for valid VLAN ID. */
495 /** VLAN ID list for vlan mirroring. */
496 uint16_t vlan_id[ETH_MIRROR_MAX_VLANS];
500 * A structure used to configure traffic mirror of an Ethernet port.
502 struct rte_eth_mirror_conf {
503 uint8_t rule_type; /**< Mirroring rule type */
504 uint8_t dst_pool; /**< Destination pool for this mirror rule. */
505 uint64_t pool_mask; /**< Bitmap of pool for pool mirroring */
506 /** VLAN ID setting for VLAN mirroring. */
507 struct rte_eth_vlan_mirror vlan;
511 * A structure used to configure 64 entries of Redirection Table of the
512 * Receive Side Scaling (RSS) feature of an Ethernet port. To configure
513 * more than 64 entries supported by hardware, an array of this structure
516 struct rte_eth_rss_reta_entry64 {
518 /**< Mask bits indicate which entries need to be updated/queried. */
519 uint8_t reta[RTE_RETA_GROUP_SIZE];
520 /**< Group of 64 redirection table entries. */
524 * This enum indicates the possible number of traffic classes
525 * in DCB configratioins
527 enum rte_eth_nb_tcs {
528 ETH_4_TCS = 4, /**< 4 TCs with DCB. */
529 ETH_8_TCS = 8 /**< 8 TCs with DCB. */
533 * This enum indicates the possible number of queue pools
534 * in VMDQ configurations.
536 enum rte_eth_nb_pools {
537 ETH_8_POOLS = 8, /**< 8 VMDq pools. */
538 ETH_16_POOLS = 16, /**< 16 VMDq pools. */
539 ETH_32_POOLS = 32, /**< 32 VMDq pools. */
540 ETH_64_POOLS = 64 /**< 64 VMDq pools. */
543 /* This structure may be extended in future. */
544 struct rte_eth_dcb_rx_conf {
545 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs */
546 uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
547 /**< Possible DCB queue,4 or 8. */
550 struct rte_eth_vmdq_dcb_tx_conf {
551 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools. */
552 uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
553 /**< Possible DCB queue,4 or 8. */
556 struct rte_eth_dcb_tx_conf {
557 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs. */
558 uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
559 /**< Possible DCB queue,4 or 8. */
562 struct rte_eth_vmdq_tx_conf {
563 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq mode, 64 pools. */
567 * A structure used to configure the VMDQ+DCB feature
568 * of an Ethernet port.
570 * Using this feature, packets are routed to a pool of queues, based
571 * on the vlan id in the vlan tag, and then to a specific queue within
572 * that pool, using the user priority vlan tag field.
574 * A default pool may be used, if desired, to route all traffic which
575 * does not match the vlan filter rules.
577 struct rte_eth_vmdq_dcb_conf {
578 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools */
579 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
580 uint8_t default_pool; /**< The default pool, if applicable */
581 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
583 uint16_t vlan_id; /**< The vlan id of the received frame */
584 uint64_t pools; /**< Bitmask of pools for packet rx */
585 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
586 uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
587 /**< Selects a queue in a pool */
590 struct rte_eth_vmdq_rx_conf {
591 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq only mode, 8 or 64 pools */
592 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
593 uint8_t default_pool; /**< The default pool, if applicable */
594 uint8_t enable_loop_back; /**< Enable VT loop back */
595 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
596 uint32_t rx_mode; /**< Flags from ETH_VMDQ_ACCEPT_* */
598 uint16_t vlan_id; /**< The vlan id of the received frame */
599 uint64_t pools; /**< Bitmask of pools for packet rx */
600 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
604 * A structure used to configure the TX features of an Ethernet port.
606 struct rte_eth_txmode {
607 enum rte_eth_tx_mq_mode mq_mode; /**< TX multi-queues mode. */
609 /* For i40e specifically */
611 uint8_t hw_vlan_reject_tagged : 1,
612 /**< If set, reject sending out tagged pkts */
613 hw_vlan_reject_untagged : 1,
614 /**< If set, reject sending out untagged pkts */
615 hw_vlan_insert_pvid : 1;
616 /**< If set, enable port based VLAN insertion */
620 * A structure used to configure an RX ring of an Ethernet port.
622 struct rte_eth_rxconf {
623 struct rte_eth_thresh rx_thresh; /**< RX ring threshold registers. */
624 uint16_t rx_free_thresh; /**< Drives the freeing of RX descriptors. */
625 uint8_t rx_drop_en; /**< Drop packets if no descriptors are available. */
626 uint8_t rx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
629 #define ETH_TXQ_FLAGS_NOMULTSEGS 0x0001 /**< nb_segs=1 for all mbufs */
630 #define ETH_TXQ_FLAGS_NOREFCOUNT 0x0002 /**< refcnt can be ignored */
631 #define ETH_TXQ_FLAGS_NOMULTMEMP 0x0004 /**< all bufs come from same mempool */
632 #define ETH_TXQ_FLAGS_NOVLANOFFL 0x0100 /**< disable VLAN offload */
633 #define ETH_TXQ_FLAGS_NOXSUMSCTP 0x0200 /**< disable SCTP checksum offload */
634 #define ETH_TXQ_FLAGS_NOXSUMUDP 0x0400 /**< disable UDP checksum offload */
635 #define ETH_TXQ_FLAGS_NOXSUMTCP 0x0800 /**< disable TCP checksum offload */
636 #define ETH_TXQ_FLAGS_NOOFFLOADS \
637 (ETH_TXQ_FLAGS_NOVLANOFFL | ETH_TXQ_FLAGS_NOXSUMSCTP | \
638 ETH_TXQ_FLAGS_NOXSUMUDP | ETH_TXQ_FLAGS_NOXSUMTCP)
639 #define ETH_TXQ_FLAGS_NOXSUMS \
640 (ETH_TXQ_FLAGS_NOXSUMSCTP | ETH_TXQ_FLAGS_NOXSUMUDP | \
641 ETH_TXQ_FLAGS_NOXSUMTCP)
643 * A structure used to configure a TX ring of an Ethernet port.
645 struct rte_eth_txconf {
646 struct rte_eth_thresh tx_thresh; /**< TX ring threshold registers. */
647 uint16_t tx_rs_thresh; /**< Drives the setting of RS bit on TXDs. */
648 uint16_t tx_free_thresh; /**< Start freeing TX buffers if there are
649 less free descriptors than this value. */
651 uint32_t txq_flags; /**< Set flags for the Tx queue */
652 uint8_t tx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
656 * This enum indicates the flow control mode
658 enum rte_eth_fc_mode {
659 RTE_FC_NONE = 0, /**< Disable flow control. */
660 RTE_FC_RX_PAUSE, /**< RX pause frame, enable flowctrl on TX side. */
661 RTE_FC_TX_PAUSE, /**< TX pause frame, enable flowctrl on RX side. */
662 RTE_FC_FULL /**< Enable flow control on both side. */
666 * A structure used to configure Ethernet flow control parameter.
667 * These parameters will be configured into the register of the NIC.
668 * Please refer to the corresponding data sheet for proper value.
670 struct rte_eth_fc_conf {
671 uint32_t high_water; /**< High threshold value to trigger XOFF */
672 uint32_t low_water; /**< Low threshold value to trigger XON */
673 uint16_t pause_time; /**< Pause quota in the Pause frame */
674 uint16_t send_xon; /**< Is XON frame need be sent */
675 enum rte_eth_fc_mode mode; /**< Link flow control mode */
676 uint8_t mac_ctrl_frame_fwd; /**< Forward MAC control frames */
677 uint8_t autoneg; /**< Use Pause autoneg */
681 * A structure used to configure Ethernet priority flow control parameter.
682 * These parameters will be configured into the register of the NIC.
683 * Please refer to the corresponding data sheet for proper value.
685 struct rte_eth_pfc_conf {
686 struct rte_eth_fc_conf fc; /**< General flow control parameter. */
687 uint8_t priority; /**< VLAN User Priority. */
691 * Memory space that can be configured to store Flow Director filters
692 * in the board memory.
694 enum rte_fdir_pballoc_type {
695 RTE_FDIR_PBALLOC_64K = 0, /**< 64k. */
696 RTE_FDIR_PBALLOC_128K, /**< 128k. */
697 RTE_FDIR_PBALLOC_256K, /**< 256k. */
701 * Select report mode of FDIR hash information in RX descriptors.
703 enum rte_fdir_status_mode {
704 RTE_FDIR_NO_REPORT_STATUS = 0, /**< Never report FDIR hash. */
705 RTE_FDIR_REPORT_STATUS, /**< Only report FDIR hash for matching pkts. */
706 RTE_FDIR_REPORT_STATUS_ALWAYS, /**< Always report FDIR hash. */
710 * A structure used to configure the Flow Director (FDIR) feature
711 * of an Ethernet port.
713 * If mode is RTE_FDIR_DISABLE, the pballoc value is ignored.
715 struct rte_fdir_conf {
716 enum rte_fdir_mode mode; /**< Flow Director mode. */
717 enum rte_fdir_pballoc_type pballoc; /**< Space for FDIR filters. */
718 enum rte_fdir_status_mode status; /**< How to report FDIR hash. */
719 /** RX queue of packets matching a "drop" filter in perfect mode. */
721 struct rte_eth_fdir_masks mask;
722 struct rte_eth_fdir_flex_conf flex_conf;
723 /**< Flex payload configuration. */
727 * UDP tunneling configuration.
729 struct rte_eth_udp_tunnel {
735 * Possible l4type of FDIR filters.
738 RTE_FDIR_L4TYPE_NONE = 0, /**< None. */
739 RTE_FDIR_L4TYPE_UDP, /**< UDP. */
740 RTE_FDIR_L4TYPE_TCP, /**< TCP. */
741 RTE_FDIR_L4TYPE_SCTP, /**< SCTP. */
745 * Select IPv4 or IPv6 FDIR filters.
748 RTE_FDIR_IPTYPE_IPV4 = 0, /**< IPv4. */
749 RTE_FDIR_IPTYPE_IPV6 , /**< IPv6. */
753 * A structure used to define a FDIR packet filter.
755 struct rte_fdir_filter {
756 uint16_t flex_bytes; /**< Flex bytes value to match. */
757 uint16_t vlan_id; /**< VLAN ID value to match, 0 otherwise. */
758 uint16_t port_src; /**< Source port to match, 0 otherwise. */
759 uint16_t port_dst; /**< Destination port to match, 0 otherwise. */
761 uint32_t ipv4_addr; /**< IPv4 source address to match. */
762 uint32_t ipv6_addr[4]; /**< IPv6 source address to match. */
763 } ip_src; /**< IPv4/IPv6 source address to match (union of above). */
765 uint32_t ipv4_addr; /**< IPv4 destination address to match. */
766 uint32_t ipv6_addr[4]; /**< IPv6 destination address to match */
767 } ip_dst; /**< IPv4/IPv6 destination address to match (union of above). */
768 enum rte_l4type l4type; /**< l4type to match: NONE/UDP/TCP/SCTP. */
769 enum rte_iptype iptype; /**< IP packet type to match: IPv4 or IPv6. */
773 * A structure used to configure FDIR masks that are used by the device
774 * to match the various fields of RX packet headers.
775 * @note The only_ip_flow field has the opposite meaning compared to other
778 struct rte_fdir_masks {
779 /** When set to 1, packet l4type is \b NOT relevant in filters, and
780 source and destination port masks must be set to zero. */
781 uint8_t only_ip_flow;
782 /** If set to 1, vlan_id is relevant in filters. */
784 /** If set to 1, vlan_prio is relevant in filters. */
786 /** If set to 1, flexbytes is relevant in filters. */
788 /** If set to 1, set the IPv6 masks. Otherwise set the IPv4 masks. */
789 uint8_t set_ipv6_mask;
790 /** When set to 1, comparison of destination IPv6 address with IP6AT
791 registers is meaningful. */
792 uint8_t comp_ipv6_dst;
793 /** Mask of Destination IPv4 Address. All bits set to 1 define the
794 relevant bits to use in the destination address of an IPv4 packet
795 when matching it against FDIR filters. */
796 uint32_t dst_ipv4_mask;
797 /** Mask of Source IPv4 Address. All bits set to 1 define
798 the relevant bits to use in the source address of an IPv4 packet
799 when matching it against FDIR filters. */
800 uint32_t src_ipv4_mask;
801 /** Mask of Source IPv6 Address. All bits set to 1 define the
802 relevant BYTES to use in the source address of an IPv6 packet
803 when matching it against FDIR filters. */
804 uint16_t dst_ipv6_mask;
805 /** Mask of Destination IPv6 Address. All bits set to 1 define the
806 relevant BYTES to use in the destination address of an IPv6 packet
807 when matching it against FDIR filters. */
808 uint16_t src_ipv6_mask;
809 /** Mask of Source Port. All bits set to 1 define the relevant
810 bits to use in the source port of an IP packets when matching it
811 against FDIR filters. */
812 uint16_t src_port_mask;
813 /** Mask of Destination Port. All bits set to 1 define the relevant
814 bits to use in the destination port of an IP packet when matching it
815 against FDIR filters. */
816 uint16_t dst_port_mask;
820 * A structure used to report the status of the flow director filters in use.
822 struct rte_eth_fdir {
823 /** Number of filters with collision indication. */
825 /** Number of free (non programmed) filters. */
827 /** The Lookup hash value of the added filter that updated the value
828 of the MAXLEN field */
830 /** Longest linked list of filters in the table. */
832 /** Number of added filters. */
834 /** Number of removed filters. */
836 /** Number of failed added filters (no more space in device). */
838 /** Number of failed removed filters. */
843 * A structure used to enable/disable specific device interrupts.
845 struct rte_intr_conf {
846 /** enable/disable lsc interrupt. 0 (default) - disable, 1 enable */
851 * A structure used to configure an Ethernet port.
852 * Depending upon the RX multi-queue mode, extra advanced
853 * configuration settings may be needed.
855 struct rte_eth_conf {
857 /**< ETH_LINK_SPEED_10[0|00|000], or 0 for autonegotation */
858 uint16_t link_duplex;
859 /**< ETH_LINK_[HALF_DUPLEX|FULL_DUPLEX], or 0 for autonegotation */
860 struct rte_eth_rxmode rxmode; /**< Port RX configuration. */
861 struct rte_eth_txmode txmode; /**< Port TX configuration. */
862 uint32_t lpbk_mode; /**< Loopback operation mode. By default the value
863 is 0, meaning the loopback mode is disabled.
864 Read the datasheet of given ethernet controller
865 for details. The possible values of this field
866 are defined in implementation of each driver. */
868 struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
869 struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
870 /**< Port vmdq+dcb configuration. */
871 struct rte_eth_dcb_rx_conf dcb_rx_conf;
872 /**< Port dcb RX configuration. */
873 struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
874 /**< Port vmdq RX configuration. */
875 } rx_adv_conf; /**< Port RX filtering configuration (union). */
877 struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
878 /**< Port vmdq+dcb TX configuration. */
879 struct rte_eth_dcb_tx_conf dcb_tx_conf;
880 /**< Port dcb TX configuration. */
881 struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
882 /**< Port vmdq TX configuration. */
883 } tx_adv_conf; /**< Port TX DCB configuration (union). */
884 /** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
885 is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
886 uint32_t dcb_capability_en;
887 struct rte_fdir_conf fdir_conf; /**< FDIR configuration. */
888 struct rte_intr_conf intr_conf; /**< Interrupt mode configuration. */
892 * A structure used to retrieve the contextual information of
893 * an Ethernet device, such as the controlling driver of the device,
894 * its PCI context, etc...
898 * RX offload capabilities of a device.
900 #define DEV_RX_OFFLOAD_VLAN_STRIP 0x00000001
901 #define DEV_RX_OFFLOAD_IPV4_CKSUM 0x00000002
902 #define DEV_RX_OFFLOAD_UDP_CKSUM 0x00000004
903 #define DEV_RX_OFFLOAD_TCP_CKSUM 0x00000008
904 #define DEV_RX_OFFLOAD_TCP_LRO 0x00000010
905 #define DEV_RX_OFFLOAD_QINQ_STRIP 0x00000020
908 * TX offload capabilities of a device.
910 #define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001
911 #define DEV_TX_OFFLOAD_IPV4_CKSUM 0x00000002
912 #define DEV_TX_OFFLOAD_UDP_CKSUM 0x00000004
913 #define DEV_TX_OFFLOAD_TCP_CKSUM 0x00000008
914 #define DEV_TX_OFFLOAD_SCTP_CKSUM 0x00000010
915 #define DEV_TX_OFFLOAD_TCP_TSO 0x00000020
916 #define DEV_TX_OFFLOAD_UDP_TSO 0x00000040
917 #define DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000080 /**< Used for tunneling packet. */
918 #define DEV_TX_OFFLOAD_QINQ_INSERT 0x00000100
920 struct rte_eth_dev_info {
921 struct rte_pci_device *pci_dev; /**< Device PCI information. */
922 const char *driver_name; /**< Device Driver name. */
923 unsigned int if_index; /**< Index to bound host interface, or 0 if none.
924 Use if_indextoname() to translate into an interface name. */
925 uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
926 uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
927 uint16_t max_rx_queues; /**< Maximum number of RX queues. */
928 uint16_t max_tx_queues; /**< Maximum number of TX queues. */
929 uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
930 uint32_t max_hash_mac_addrs;
931 /** Maximum number of hash MAC addresses for MTA and UTA. */
932 uint16_t max_vfs; /**< Maximum number of VFs. */
933 uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
934 uint32_t rx_offload_capa; /**< Device RX offload capabilities. */
935 uint32_t tx_offload_capa; /**< Device TX offload capabilities. */
937 /**< Device redirection table size, the total number of entries. */
938 uint8_t hash_key_size; /**< Hash key size in bytes */
939 /** Bit mask of RSS offloads, the bit offset also means flow type */
940 uint64_t flow_type_rss_offloads;
941 struct rte_eth_rxconf default_rxconf; /**< Default RX configuration */
942 struct rte_eth_txconf default_txconf; /**< Default TX configuration */
943 uint16_t vmdq_queue_base; /**< First queue ID for VMDQ pools. */
944 uint16_t vmdq_queue_num; /**< Queue number for VMDQ pools. */
945 uint16_t vmdq_pool_base; /**< First ID of VMDQ pools. */
948 /** Maximum name length for extended statistics counters */
949 #define RTE_ETH_XSTATS_NAME_SIZE 64
952 * An Ethernet device extended statistic structure
954 * This structure is used by ethdev->eth_xstats_get() to provide
955 * statistics that are not provided in the generic rte_eth_stats
958 struct rte_eth_xstats {
959 char name[RTE_ETH_XSTATS_NAME_SIZE];
965 struct rte_eth_dev_callback;
966 /** @internal Structure to keep track of registered callbacks */
967 TAILQ_HEAD(rte_eth_dev_cb_list, rte_eth_dev_callback);
970 * Definitions of all functions exported by an Ethernet driver through the
971 * the generic structure of type *eth_dev_ops* supplied in the *rte_eth_dev*
972 * structure associated with an Ethernet device.
975 typedef int (*eth_dev_configure_t)(struct rte_eth_dev *dev);
976 /**< @internal Ethernet device configuration. */
978 typedef int (*eth_dev_start_t)(struct rte_eth_dev *dev);
979 /**< @internal Function used to start a configured Ethernet device. */
981 typedef void (*eth_dev_stop_t)(struct rte_eth_dev *dev);
982 /**< @internal Function used to stop a configured Ethernet device. */
984 typedef int (*eth_dev_set_link_up_t)(struct rte_eth_dev *dev);
985 /**< @internal Function used to link up a configured Ethernet device. */
987 typedef int (*eth_dev_set_link_down_t)(struct rte_eth_dev *dev);
988 /**< @internal Function used to link down a configured Ethernet device. */
990 typedef void (*eth_dev_close_t)(struct rte_eth_dev *dev);
991 /**< @internal Function used to close a configured Ethernet device. */
993 typedef void (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev);
994 /**< @internal Function used to enable the RX promiscuous mode of an Ethernet device. */
996 typedef void (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev);
997 /**< @internal Function used to disable the RX promiscuous mode of an Ethernet device. */
999 typedef void (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
1000 /**< @internal Enable the receipt of all multicast packets by an Ethernet device. */
1002 typedef void (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
1003 /**< @internal Disable the receipt of all multicast packets by an Ethernet device. */
1005 typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
1006 int wait_to_complete);
1007 /**< @internal Get link speed, duplex mode and state (up/down) of an Ethernet device. */
1009 typedef void (*eth_stats_get_t)(struct rte_eth_dev *dev,
1010 struct rte_eth_stats *igb_stats);
1011 /**< @internal Get global I/O statistics of an Ethernet device. */
1013 typedef void (*eth_stats_reset_t)(struct rte_eth_dev *dev);
1014 /**< @internal Reset global I/O statistics of an Ethernet device to 0. */
1016 typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev,
1017 struct rte_eth_xstats *stats, unsigned n);
1018 /**< @internal Get extended stats of an Ethernet device. */
1020 typedef void (*eth_xstats_reset_t)(struct rte_eth_dev *dev);
1021 /**< @internal Reset extended stats of an Ethernet device. */
1023 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
1027 /**< @internal Set a queue statistics mapping for a tx/rx queue of an Ethernet device. */
1029 typedef void (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
1030 struct rte_eth_dev_info *dev_info);
1031 /**< @internal Get specific informations of an Ethernet device. */
1033 typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
1035 /**< @internal Start rx and tx of a queue of an Ethernet device. */
1037 typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
1039 /**< @internal Stop rx and tx of a queue of an Ethernet device. */
1041 typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
1042 uint16_t rx_queue_id,
1043 uint16_t nb_rx_desc,
1044 unsigned int socket_id,
1045 const struct rte_eth_rxconf *rx_conf,
1046 struct rte_mempool *mb_pool);
1047 /**< @internal Set up a receive queue of an Ethernet device. */
1049 typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
1050 uint16_t tx_queue_id,
1051 uint16_t nb_tx_desc,
1052 unsigned int socket_id,
1053 const struct rte_eth_txconf *tx_conf);
1054 /**< @internal Setup a transmit queue of an Ethernet device. */
1056 typedef void (*eth_queue_release_t)(void *queue);
1057 /**< @internal Release memory resources allocated by given RX/TX queue. */
1059 typedef uint32_t (*eth_rx_queue_count_t)(struct rte_eth_dev *dev,
1060 uint16_t rx_queue_id);
1061 /**< @internal Get number of available descriptors on a receive queue of an Ethernet device. */
1063 typedef int (*eth_rx_descriptor_done_t)(void *rxq, uint16_t offset);
1064 /**< @internal Check DD bit of specific RX descriptor */
1066 typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);
1067 /**< @internal Set MTU. */
1069 typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
1072 /**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */
1074 typedef void (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
1076 /**< @internal set the outer VLAN-TPID by an Ethernet device. */
1078 typedef void (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
1079 /**< @internal set VLAN offload function by an Ethernet device. */
1081 typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
1084 /**< @internal set port based TX VLAN insertion by an Ethernet device. */
1086 typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
1087 uint16_t rx_queue_id,
1089 /**< @internal VLAN stripping enable/disable by an queue of Ethernet device. */
1091 typedef uint16_t (*eth_rx_burst_t)(void *rxq,
1092 struct rte_mbuf **rx_pkts,
1094 /**< @internal Retrieve input packets from a receive queue of an Ethernet device. */
1096 typedef uint16_t (*eth_tx_burst_t)(void *txq,
1097 struct rte_mbuf **tx_pkts,
1099 /**< @internal Send output packets on a transmit queue of an Ethernet device. */
1101 typedef int (*fdir_add_signature_filter_t)(struct rte_eth_dev *dev,
1102 struct rte_fdir_filter *fdir_ftr,
1104 /**< @internal Setup a new signature filter rule on an Ethernet device */
1106 typedef int (*fdir_update_signature_filter_t)(struct rte_eth_dev *dev,
1107 struct rte_fdir_filter *fdir_ftr,
1109 /**< @internal Update a signature filter rule on an Ethernet device */
1111 typedef int (*fdir_remove_signature_filter_t)(struct rte_eth_dev *dev,
1112 struct rte_fdir_filter *fdir_ftr);
1113 /**< @internal Remove a signature filter rule on an Ethernet device */
1115 typedef void (*fdir_infos_get_t)(struct rte_eth_dev *dev,
1116 struct rte_eth_fdir *fdir);
1117 /**< @internal Get information about fdir status */
1119 typedef int (*fdir_add_perfect_filter_t)(struct rte_eth_dev *dev,
1120 struct rte_fdir_filter *fdir_ftr,
1121 uint16_t soft_id, uint8_t rx_queue,
1123 /**< @internal Setup a new perfect filter rule on an Ethernet device */
1125 typedef int (*fdir_update_perfect_filter_t)(struct rte_eth_dev *dev,
1126 struct rte_fdir_filter *fdir_ftr,
1127 uint16_t soft_id, uint8_t rx_queue,
1129 /**< @internal Update a perfect filter rule on an Ethernet device */
1131 typedef int (*fdir_remove_perfect_filter_t)(struct rte_eth_dev *dev,
1132 struct rte_fdir_filter *fdir_ftr,
1134 /**< @internal Remove a perfect filter rule on an Ethernet device */
1136 typedef int (*fdir_set_masks_t)(struct rte_eth_dev *dev,
1137 struct rte_fdir_masks *fdir_masks);
1138 /**< @internal Setup flow director masks on an Ethernet device */
1140 typedef int (*flow_ctrl_get_t)(struct rte_eth_dev *dev,
1141 struct rte_eth_fc_conf *fc_conf);
1142 /**< @internal Get current flow control parameter on an Ethernet device */
1144 typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
1145 struct rte_eth_fc_conf *fc_conf);
1146 /**< @internal Setup flow control parameter on an Ethernet device */
1148 typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
1149 struct rte_eth_pfc_conf *pfc_conf);
1150 /**< @internal Setup priority flow control parameter on an Ethernet device */
1152 typedef int (*reta_update_t)(struct rte_eth_dev *dev,
1153 struct rte_eth_rss_reta_entry64 *reta_conf,
1154 uint16_t reta_size);
1155 /**< @internal Update RSS redirection table on an Ethernet device */
1157 typedef int (*reta_query_t)(struct rte_eth_dev *dev,
1158 struct rte_eth_rss_reta_entry64 *reta_conf,
1159 uint16_t reta_size);
1160 /**< @internal Query RSS redirection table on an Ethernet device */
1162 typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
1163 struct rte_eth_rss_conf *rss_conf);
1164 /**< @internal Update RSS hash configuration of an Ethernet device */
1166 typedef int (*rss_hash_conf_get_t)(struct rte_eth_dev *dev,
1167 struct rte_eth_rss_conf *rss_conf);
1168 /**< @internal Get current RSS hash configuration of an Ethernet device */
1170 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
1171 /**< @internal Turn on SW controllable LED on an Ethernet device */
1173 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
1174 /**< @internal Turn off SW controllable LED on an Ethernet device */
1176 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
1177 /**< @internal Remove MAC address from receive address register */
1179 typedef void (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
1180 struct ether_addr *mac_addr,
1183 /**< @internal Set a MAC address into Receive Address Address Register */
1185 typedef void (*eth_mac_addr_set_t)(struct rte_eth_dev *dev,
1186 struct ether_addr *mac_addr);
1187 /**< @internal Set a MAC address into Receive Address Address Register */
1189 typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
1190 struct ether_addr *mac_addr,
1192 /**< @internal Set a Unicast Hash bitmap */
1194 typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
1196 /**< @internal Set all Unicast Hash bitmap */
1198 typedef int (*eth_set_vf_rx_mode_t)(struct rte_eth_dev *dev,
1202 /**< @internal Set a VF receive mode */
1204 typedef int (*eth_set_vf_rx_t)(struct rte_eth_dev *dev,
1207 /**< @internal Set a VF receive mode */
1209 typedef int (*eth_set_vf_tx_t)(struct rte_eth_dev *dev,
1212 /**< @internal Enable or disable a VF transmit */
1214 typedef int (*eth_set_vf_vlan_filter_t)(struct rte_eth_dev *dev,
1218 /**< @internal Set VF VLAN pool filter */
1220 typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
1223 /**< @internal Set queue TX rate */
1225 typedef int (*eth_set_vf_rate_limit_t)(struct rte_eth_dev *dev,
1229 /**< @internal Set VF TX rate */
1231 typedef int (*eth_mirror_rule_set_t)(struct rte_eth_dev *dev,
1232 struct rte_eth_mirror_conf *mirror_conf,
1235 /**< @internal Add a traffic mirroring rule on an Ethernet device */
1237 typedef int (*eth_mirror_rule_reset_t)(struct rte_eth_dev *dev,
1239 /**< @internal Remove a traffic mirroring rule on an Ethernet device */
1241 typedef int (*eth_udp_tunnel_add_t)(struct rte_eth_dev *dev,
1242 struct rte_eth_udp_tunnel *tunnel_udp);
1243 /**< @internal Add tunneling UDP info */
1245 typedef int (*eth_udp_tunnel_del_t)(struct rte_eth_dev *dev,
1246 struct rte_eth_udp_tunnel *tunnel_udp);
1247 /**< @internal Delete tunneling UDP info */
1249 typedef int (*eth_set_mc_addr_list_t)(struct rte_eth_dev *dev,
1250 struct ether_addr *mc_addr_set,
1251 uint32_t nb_mc_addr);
1252 /**< @internal set the list of multicast addresses on an Ethernet device */
1254 typedef int (*eth_timesync_enable_t)(struct rte_eth_dev *dev);
1255 /**< @internal Function used to enable IEEE1588/802.1AS timestamping. */
1257 typedef int (*eth_timesync_disable_t)(struct rte_eth_dev *dev);
1258 /**< @internal Function used to disable IEEE1588/802.1AS timestamping. */
1260 typedef int (*eth_timesync_read_rx_timestamp_t)(struct rte_eth_dev *dev,
1261 struct timespec *timestamp,
1263 /**< @internal Function used to read an RX IEEE1588/802.1AS timestamp. */
1265 typedef int (*eth_timesync_read_tx_timestamp_t)(struct rte_eth_dev *dev,
1266 struct timespec *timestamp);
1267 /**< @internal Function used to read a TX IEEE1588/802.1AS timestamp. */
1269 typedef int (*eth_get_reg_length_t)(struct rte_eth_dev *dev);
1270 /**< @internal Retrieve device register count */
1272 typedef int (*eth_get_reg_t)(struct rte_eth_dev *dev,
1273 struct rte_dev_reg_info *info);
1274 /**< @internal Retrieve registers */
1276 typedef int (*eth_get_eeprom_length_t)(struct rte_eth_dev *dev);
1277 /**< @internal Retrieve eeprom size */
1279 typedef int (*eth_get_eeprom_t)(struct rte_eth_dev *dev,
1280 struct rte_dev_eeprom_info *info);
1281 /**< @internal Retrieve eeprom data */
1283 typedef int (*eth_set_eeprom_t)(struct rte_eth_dev *dev,
1284 struct rte_dev_eeprom_info *info);
1285 /**< @internal Program eeprom data */
1287 #ifdef RTE_NIC_BYPASS
1290 RTE_BYPASS_MODE_NONE,
1291 RTE_BYPASS_MODE_NORMAL,
1292 RTE_BYPASS_MODE_BYPASS,
1293 RTE_BYPASS_MODE_ISOLATE,
1294 RTE_BYPASS_MODE_NUM,
1297 #define RTE_BYPASS_MODE_VALID(x) \
1298 ((x) > RTE_BYPASS_MODE_NONE && (x) < RTE_BYPASS_MODE_NUM)
1301 RTE_BYPASS_EVENT_NONE,
1302 RTE_BYPASS_EVENT_START,
1303 RTE_BYPASS_EVENT_OS_ON = RTE_BYPASS_EVENT_START,
1304 RTE_BYPASS_EVENT_POWER_ON,
1305 RTE_BYPASS_EVENT_OS_OFF,
1306 RTE_BYPASS_EVENT_POWER_OFF,
1307 RTE_BYPASS_EVENT_TIMEOUT,
1308 RTE_BYPASS_EVENT_NUM
1311 #define RTE_BYPASS_EVENT_VALID(x) \
1312 ((x) > RTE_BYPASS_EVENT_NONE && (x) < RTE_BYPASS_MODE_NUM)
1315 RTE_BYPASS_TMT_OFF, /* timeout disabled. */
1316 RTE_BYPASS_TMT_1_5_SEC, /* timeout for 1.5 seconds */
1317 RTE_BYPASS_TMT_2_SEC, /* timeout for 2 seconds */
1318 RTE_BYPASS_TMT_3_SEC, /* timeout for 3 seconds */
1319 RTE_BYPASS_TMT_4_SEC, /* timeout for 4 seconds */
1320 RTE_BYPASS_TMT_8_SEC, /* timeout for 8 seconds */
1321 RTE_BYPASS_TMT_16_SEC, /* timeout for 16 seconds */
1322 RTE_BYPASS_TMT_32_SEC, /* timeout for 32 seconds */
1326 #define RTE_BYPASS_TMT_VALID(x) \
1327 ((x) == RTE_BYPASS_TMT_OFF || \
1328 ((x) > RTE_BYPASS_TMT_OFF && (x) < RTE_BYPASS_TMT_NUM))
1330 typedef void (*bypass_init_t)(struct rte_eth_dev *dev);
1331 typedef int32_t (*bypass_state_set_t)(struct rte_eth_dev *dev, uint32_t *new_state);
1332 typedef int32_t (*bypass_state_show_t)(struct rte_eth_dev *dev, uint32_t *state);
1333 typedef int32_t (*bypass_event_set_t)(struct rte_eth_dev *dev, uint32_t state, uint32_t event);
1334 typedef int32_t (*bypass_event_show_t)(struct rte_eth_dev *dev, uint32_t event_shift, uint32_t *event);
1335 typedef int32_t (*bypass_wd_timeout_set_t)(struct rte_eth_dev *dev, uint32_t timeout);
1336 typedef int32_t (*bypass_wd_timeout_show_t)(struct rte_eth_dev *dev, uint32_t *wd_timeout);
1337 typedef int32_t (*bypass_ver_show_t)(struct rte_eth_dev *dev, uint32_t *ver);
1338 typedef int32_t (*bypass_wd_reset_t)(struct rte_eth_dev *dev);
1341 typedef int (*eth_filter_ctrl_t)(struct rte_eth_dev *dev,
1342 enum rte_filter_type filter_type,
1343 enum rte_filter_op filter_op,
1345 /**< @internal Take operations to assigned filter type on an Ethernet device */
1348 * @internal A structure containing the functions exported by an Ethernet driver.
1350 struct eth_dev_ops {
1351 eth_dev_configure_t dev_configure; /**< Configure device. */
1352 eth_dev_start_t dev_start; /**< Start device. */
1353 eth_dev_stop_t dev_stop; /**< Stop device. */
1354 eth_dev_set_link_up_t dev_set_link_up; /**< Device link up. */
1355 eth_dev_set_link_down_t dev_set_link_down; /**< Device link down. */
1356 eth_dev_close_t dev_close; /**< Close device. */
1357 eth_promiscuous_enable_t promiscuous_enable; /**< Promiscuous ON. */
1358 eth_promiscuous_disable_t promiscuous_disable;/**< Promiscuous OFF. */
1359 eth_allmulticast_enable_t allmulticast_enable;/**< RX multicast ON. */
1360 eth_allmulticast_disable_t allmulticast_disable;/**< RX multicast OF. */
1361 eth_link_update_t link_update; /**< Get device link state. */
1362 eth_stats_get_t stats_get; /**< Get generic device statistics. */
1363 eth_stats_reset_t stats_reset; /**< Reset generic device statistics. */
1364 eth_xstats_get_t xstats_get; /**< Get extended device statistics. */
1365 eth_xstats_reset_t xstats_reset; /**< Reset extended device statistics. */
1366 eth_queue_stats_mapping_set_t queue_stats_mapping_set;
1367 /**< Configure per queue stat counter mapping. */
1368 eth_dev_infos_get_t dev_infos_get; /**< Get device info. */
1369 mtu_set_t mtu_set; /**< Set MTU. */
1370 vlan_filter_set_t vlan_filter_set; /**< Filter VLAN Setup. */
1371 vlan_tpid_set_t vlan_tpid_set; /**< Outer VLAN TPID Setup. */
1372 vlan_strip_queue_set_t vlan_strip_queue_set; /**< VLAN Stripping on queue. */
1373 vlan_offload_set_t vlan_offload_set; /**< Set VLAN Offload. */
1374 vlan_pvid_set_t vlan_pvid_set; /**< Set port based TX VLAN insertion */
1375 eth_queue_start_t rx_queue_start;/**< Start RX for a queue.*/
1376 eth_queue_stop_t rx_queue_stop;/**< Stop RX for a queue.*/
1377 eth_queue_start_t tx_queue_start;/**< Start TX for a queue.*/
1378 eth_queue_stop_t tx_queue_stop;/**< Stop TX for a queue.*/
1379 eth_rx_queue_setup_t rx_queue_setup;/**< Set up device RX queue.*/
1380 eth_queue_release_t rx_queue_release;/**< Release RX queue.*/
1381 eth_rx_queue_count_t rx_queue_count; /**< Get Rx queue count. */
1382 eth_rx_descriptor_done_t rx_descriptor_done; /**< Check rxd DD bit */
1383 eth_tx_queue_setup_t tx_queue_setup;/**< Set up device TX queue.*/
1384 eth_queue_release_t tx_queue_release;/**< Release TX queue.*/
1385 eth_dev_led_on_t dev_led_on; /**< Turn on LED. */
1386 eth_dev_led_off_t dev_led_off; /**< Turn off LED. */
1387 flow_ctrl_get_t flow_ctrl_get; /**< Get flow control. */
1388 flow_ctrl_set_t flow_ctrl_set; /**< Setup flow control. */
1389 priority_flow_ctrl_set_t priority_flow_ctrl_set; /**< Setup priority flow control.*/
1390 eth_mac_addr_remove_t mac_addr_remove; /**< Remove MAC address */
1391 eth_mac_addr_add_t mac_addr_add; /**< Add a MAC address */
1392 eth_mac_addr_set_t mac_addr_set; /**< Set a MAC address */
1393 eth_uc_hash_table_set_t uc_hash_table_set; /**< Set Unicast Table Array */
1394 eth_uc_all_hash_table_set_t uc_all_hash_table_set; /**< Set Unicast hash bitmap */
1395 eth_mirror_rule_set_t mirror_rule_set; /**< Add a traffic mirror rule.*/
1396 eth_mirror_rule_reset_t mirror_rule_reset; /**< reset a traffic mirror rule.*/
1397 eth_set_vf_rx_mode_t set_vf_rx_mode; /**< Set VF RX mode */
1398 eth_set_vf_rx_t set_vf_rx; /**< enable/disable a VF receive */
1399 eth_set_vf_tx_t set_vf_tx; /**< enable/disable a VF transmit */
1400 eth_set_vf_vlan_filter_t set_vf_vlan_filter; /**< Set VF VLAN filter */
1401 eth_udp_tunnel_add_t udp_tunnel_add;
1402 eth_udp_tunnel_del_t udp_tunnel_del;
1403 eth_set_queue_rate_limit_t set_queue_rate_limit; /**< Set queue rate limit */
1404 eth_set_vf_rate_limit_t set_vf_rate_limit; /**< Set VF rate limit */
1406 /** Add a signature filter. */
1407 fdir_add_signature_filter_t fdir_add_signature_filter;
1408 /** Update a signature filter. */
1409 fdir_update_signature_filter_t fdir_update_signature_filter;
1410 /** Remove a signature filter. */
1411 fdir_remove_signature_filter_t fdir_remove_signature_filter;
1412 /** Get information about FDIR status. */
1413 fdir_infos_get_t fdir_infos_get;
1414 /** Add a perfect filter. */
1415 fdir_add_perfect_filter_t fdir_add_perfect_filter;
1416 /** Update a perfect filter. */
1417 fdir_update_perfect_filter_t fdir_update_perfect_filter;
1418 /** Remove a perfect filter. */
1419 fdir_remove_perfect_filter_t fdir_remove_perfect_filter;
1420 /** Setup masks for FDIR filtering. */
1421 fdir_set_masks_t fdir_set_masks;
1422 /** Update redirection table. */
1423 reta_update_t reta_update;
1424 /** Query redirection table. */
1425 reta_query_t reta_query;
1427 eth_get_reg_length_t get_reg_length;
1428 /**< Get # of registers */
1429 eth_get_reg_t get_reg;
1430 /**< Get registers */
1431 eth_get_eeprom_length_t get_eeprom_length;
1432 /**< Get eeprom length */
1433 eth_get_eeprom_t get_eeprom;
1434 /**< Get eeprom data */
1435 eth_set_eeprom_t set_eeprom;
1437 /* bypass control */
1438 #ifdef RTE_NIC_BYPASS
1439 bypass_init_t bypass_init;
1440 bypass_state_set_t bypass_state_set;
1441 bypass_state_show_t bypass_state_show;
1442 bypass_event_set_t bypass_event_set;
1443 bypass_event_show_t bypass_event_show;
1444 bypass_wd_timeout_set_t bypass_wd_timeout_set;
1445 bypass_wd_timeout_show_t bypass_wd_timeout_show;
1446 bypass_ver_show_t bypass_ver_show;
1447 bypass_wd_reset_t bypass_wd_reset;
1450 /** Configure RSS hash protocols. */
1451 rss_hash_update_t rss_hash_update;
1452 /** Get current RSS hash configuration. */
1453 rss_hash_conf_get_t rss_hash_conf_get;
1454 eth_filter_ctrl_t filter_ctrl; /**< common filter control*/
1455 eth_set_mc_addr_list_t set_mc_addr_list; /**< set list of mcast addrs */
1457 /** Turn IEEE1588/802.1AS timestamping on. */
1458 eth_timesync_enable_t timesync_enable;
1459 /** Turn IEEE1588/802.1AS timestamping off. */
1460 eth_timesync_disable_t timesync_disable;
1461 /** Read the IEEE1588/802.1AS RX timestamp. */
1462 eth_timesync_read_rx_timestamp_t timesync_read_rx_timestamp;
1463 /** Read the IEEE1588/802.1AS TX timestamp. */
1464 eth_timesync_read_tx_timestamp_t timesync_read_tx_timestamp;
1468 * Function type used for RX packet processing packet callbacks.
1470 * The callback function is called on RX with a burst of packets that have
1471 * been received on the given port and queue.
1474 * The Ethernet port on which RX is being performed.
1476 * The queue on the Ethernet port which is being used to receive the packets.
1478 * The burst of packets that have just been received.
1480 * The number of packets in the burst pointed to by "pkts".
1482 * The max number of packets that can be stored in the "pkts" array.
1484 * The arbitrary user parameter passed in by the application when the callback
1485 * was originally configured.
1487 * The number of packets returned to the user.
1489 typedef uint16_t (*rte_rx_callback_fn)(uint8_t port, uint16_t queue,
1490 struct rte_mbuf *pkts[], uint16_t nb_pkts, uint16_t max_pkts,
1494 * Function type used for TX packet processing packet callbacks.
1496 * The callback function is called on TX with a burst of packets immediately
1497 * before the packets are put onto the hardware queue for transmission.
1500 * The Ethernet port on which TX is being performed.
1502 * The queue on the Ethernet port which is being used to transmit the packets.
1504 * The burst of packets that are about to be transmitted.
1506 * The number of packets in the burst pointed to by "pkts".
1508 * The arbitrary user parameter passed in by the application when the callback
1509 * was originally configured.
1511 * The number of packets to be written to the NIC.
1513 typedef uint16_t (*rte_tx_callback_fn)(uint8_t port, uint16_t queue,
1514 struct rte_mbuf *pkts[], uint16_t nb_pkts, void *user_param);
1518 * Structure used to hold information about the callbacks to be called for a
1519 * queue on RX and TX.
1521 struct rte_eth_rxtx_callback {
1522 struct rte_eth_rxtx_callback *next;
1524 rte_rx_callback_fn rx;
1525 rte_tx_callback_fn tx;
1531 * The eth device type.
1533 enum rte_eth_dev_type {
1534 RTE_ETH_DEV_UNKNOWN, /**< unknown device type */
1536 /**< Physical function and Virtual function of PCI devices */
1537 RTE_ETH_DEV_VIRTUAL, /**< non hardware device */
1538 RTE_ETH_DEV_MAX /**< max value of this enum */
1543 * The generic data structure associated with each ethernet device.
1545 * Pointers to burst-oriented packet receive and transmit functions are
1546 * located at the beginning of the structure, along with the pointer to
1547 * where all the data elements for the particular device are stored in shared
1548 * memory. This split allows the function pointer and driver data to be per-
1549 * process, while the actual configuration data for the device is shared.
1551 struct rte_eth_dev {
1552 eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
1553 eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
1554 struct rte_eth_dev_data *data; /**< Pointer to device data */
1555 const struct eth_driver *driver;/**< Driver for this device */
1556 const struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
1557 struct rte_pci_device *pci_dev; /**< PCI info. supplied by probing */
1558 /** User application callbacks for NIC interrupts */
1559 struct rte_eth_dev_cb_list link_intr_cbs;
1561 * User-supplied functions called from rx_burst to post-process
1562 * received packets before passing them to the user
1564 struct rte_eth_rxtx_callback *post_rx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
1566 * User-supplied functions called from tx_burst to pre-process
1567 * received packets before passing them to the driver for transmission.
1569 struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
1570 uint8_t attached; /**< Flag indicating the port is attached */
1571 enum rte_eth_dev_type dev_type; /**< Flag indicating the device type */
1574 struct rte_eth_dev_sriov {
1575 uint8_t active; /**< SRIOV is active with 16, 32 or 64 pools */
1576 uint8_t nb_q_per_pool; /**< rx queue number per pool */
1577 uint16_t def_vmdq_idx; /**< Default pool num used for PF */
1578 uint16_t def_pool_q_idx; /**< Default pool queue start reg index */
1580 #define RTE_ETH_DEV_SRIOV(dev) ((dev)->data->sriov)
1582 #define RTE_ETH_NAME_MAX_LEN (32)
1586 * The data part, with no function pointers, associated with each ethernet device.
1588 * This structure is safe to place in shared memory to be common among different
1589 * processes in a multi-process configuration.
1591 struct rte_eth_dev_data {
1592 char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
1594 void **rx_queues; /**< Array of pointers to RX queues. */
1595 void **tx_queues; /**< Array of pointers to TX queues. */
1596 uint16_t nb_rx_queues; /**< Number of RX queues. */
1597 uint16_t nb_tx_queues; /**< Number of TX queues. */
1599 struct rte_eth_dev_sriov sriov; /**< SRIOV data */
1601 void *dev_private; /**< PMD-specific private data */
1603 struct rte_eth_link dev_link;
1604 /**< Link-level information & status */
1606 struct rte_eth_conf dev_conf; /**< Configuration applied to device. */
1607 uint16_t mtu; /**< Maximum Transmission Unit. */
1609 uint32_t min_rx_buf_size;
1610 /**< Common rx buffer size handled by all queues */
1612 uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
1613 struct ether_addr* mac_addrs;/**< Device Ethernet Link address. */
1614 uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
1615 /** bitmap array of associating Ethernet MAC addresses to pools */
1616 struct ether_addr* hash_mac_addrs;
1617 /** Device Ethernet MAC addresses of hash filtering. */
1618 uint8_t port_id; /**< Device [external] port identifier. */
1619 uint8_t promiscuous : 1, /**< RX promiscuous mode ON(1) / OFF(0). */
1620 scattered_rx : 1, /**< RX of scattered packets is ON(1) / OFF(0) */
1621 lro : 1, /**< RX LRO is ON(1) / OFF(0) */
1622 all_multicast : 1, /**< RX all multicast mode ON(1) / OFF(0). */
1623 dev_started : 1; /**< Device state: STARTED(1) / STOPPED(0). */
1628 * The pool of *rte_eth_dev* structures. The size of the pool
1629 * is configured at compile-time in the <rte_ethdev.c> file.
1631 extern struct rte_eth_dev rte_eth_devices[];
1634 * Get the total number of Ethernet devices that have been successfully
1635 * initialized by the [matching] Ethernet driver during the PCI probing phase.
1636 * All devices whose port identifier is in the range
1637 * [0, rte_eth_dev_count() - 1] can be operated on by network applications
1638 * immediately after invoking rte_eal_init().
1639 * If the application unplugs a port using hotplug function, The enabled port
1640 * numbers may be noncontiguous. In the case, the applications need to manage
1641 * enabled port by themselves.
1644 * - The total number of usable Ethernet devices.
1646 extern uint8_t rte_eth_dev_count(void);
1650 * Returns a ethdev slot specified by the unique identifier name.
1653 * The pointer to the Unique identifier name for each Ethernet device
1655 * - The pointer to the ethdev slot, on success. NULL on error
1657 extern struct rte_eth_dev *rte_eth_dev_allocated(const char *name);
1661 * Allocates a new ethdev slot for an ethernet device and returns the pointer
1662 * to that slot for the driver to use.
1664 * @param name Unique identifier name for each Ethernet device
1665 * @param type Device type of this Ethernet device
1667 * - Slot in the rte_dev_devices array for a new device;
1669 struct rte_eth_dev *rte_eth_dev_allocate(const char *name,
1670 enum rte_eth_dev_type type);
1674 * Release the specified ethdev port.
1677 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure.
1679 * - 0 on success, negative on error
1681 int rte_eth_dev_release_port(struct rte_eth_dev *eth_dev);
1684 * Attach a new Ethernet device specified by aruguments.
1687 * A pointer to a strings array describing the new device
1688 * to be attached. The strings should be a pci address like
1689 * '0000:01:00.0' or virtual device name like 'eth_pcap0'.
1691 * A pointer to a port identifier actually attached.
1693 * 0 on success and port_id is filled, negative on error
1695 int rte_eth_dev_attach(const char *devargs, uint8_t *port_id);
1698 * Detach a Ethernet device specified by port identifier.
1699 * This function must be called when the device is in the
1703 * The port identifier of the device to detach.
1705 * A pointer to a device name actually detached.
1707 * 0 on success and devname is filled, negative on error
1709 int rte_eth_dev_detach(uint8_t port_id, char *devname);
1714 * Initialization function of an Ethernet driver invoked for each matching
1715 * Ethernet PCI device detected during the PCI probing phase.
1718 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1719 * associated with the matching device and which have been [automatically]
1720 * allocated in the *rte_eth_devices* array.
1721 * The *eth_dev* structure is supplied to the driver initialization function
1722 * with the following fields already initialized:
1724 * - *pci_dev*: Holds the pointers to the *rte_pci_device* structure which
1725 * contains the generic PCI information of the matching device.
1727 * - *driver*: Holds the pointer to the *eth_driver* structure.
1729 * - *dev_private*: Holds a pointer to the device private data structure.
1731 * - *mtu*: Contains the default Ethernet maximum frame length (1500).
1733 * - *port_id*: Contains the port index of the device (actually the index
1734 * of the *eth_dev* structure in the *rte_eth_devices* array).
1737 * - 0: Success, the device is properly initialized by the driver.
1738 * In particular, the driver MUST have set up the *dev_ops* pointer
1739 * of the *eth_dev* structure.
1740 * - <0: Error code of the device initialization failure.
1742 typedef int (*eth_dev_init_t)(struct rte_eth_dev *eth_dev);
1746 * Finalization function of an Ethernet driver invoked for each matching
1747 * Ethernet PCI device detected during the PCI closing phase.
1750 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1751 * associated with the matching device and which have been [automatically]
1752 * allocated in the *rte_eth_devices* array.
1754 * - 0: Success, the device is properly finalized by the driver.
1755 * In particular, the driver MUST free the *dev_ops* pointer
1756 * of the *eth_dev* structure.
1757 * - <0: Error code of the device initialization failure.
1759 typedef int (*eth_dev_uninit_t)(struct rte_eth_dev *eth_dev);
1763 * The structure associated with a PMD Ethernet driver.
1765 * Each Ethernet driver acts as a PCI driver and is represented by a generic
1766 * *eth_driver* structure that holds:
1768 * - An *rte_pci_driver* structure (which must be the first field).
1770 * - The *eth_dev_init* function invoked for each matching PCI device.
1772 * - The *eth_dev_uninit* function invoked for each matching PCI device.
1774 * - The size of the private data to allocate for each matching device.
1777 struct rte_pci_driver pci_drv; /**< The PMD is also a PCI driver. */
1778 eth_dev_init_t eth_dev_init; /**< Device init function. */
1779 eth_dev_uninit_t eth_dev_uninit; /**< Device uninit function. */
1780 unsigned int dev_private_size; /**< Size of device private data. */
1785 * A function invoked by the initialization function of an Ethernet driver
1786 * to simultaneously register itself as a PCI driver and as an Ethernet
1787 * Poll Mode Driver (PMD).
1790 * The pointer to the *eth_driver* structure associated with
1791 * the Ethernet driver.
1793 extern void rte_eth_driver_register(struct eth_driver *eth_drv);
1796 * Configure an Ethernet device.
1797 * This function must be invoked first before any other function in the
1798 * Ethernet API. This function can also be re-invoked when a device is in the
1802 * The port identifier of the Ethernet device to configure.
1803 * @param nb_rx_queue
1804 * The number of receive queues to set up for the Ethernet device.
1805 * @param nb_tx_queue
1806 * The number of transmit queues to set up for the Ethernet device.
1808 * The pointer to the configuration data to be used for the Ethernet device.
1809 * The *rte_eth_conf* structure includes:
1810 * - the hardware offload features to activate, with dedicated fields for
1811 * each statically configurable offload hardware feature provided by
1812 * Ethernet devices, such as IP checksum or VLAN tag stripping for
1814 * - the Receive Side Scaling (RSS) configuration when using multiple RX
1817 * Embedding all configuration information in a single data structure
1818 * is the more flexible method that allows the addition of new features
1819 * without changing the syntax of the API.
1821 * - 0: Success, device configured.
1822 * - <0: Error code returned by the driver configuration function.
1824 extern int rte_eth_dev_configure(uint8_t port_id,
1825 uint16_t nb_rx_queue,
1826 uint16_t nb_tx_queue,
1827 const struct rte_eth_conf *eth_conf);
1830 * Allocate and set up a receive queue for an Ethernet device.
1832 * The function allocates a contiguous block of memory for *nb_rx_desc*
1833 * receive descriptors from a memory zone associated with *socket_id*
1834 * and initializes each receive descriptor with a network buffer allocated
1835 * from the memory pool *mb_pool*.
1838 * The port identifier of the Ethernet device.
1839 * @param rx_queue_id
1840 * The index of the receive queue to set up.
1841 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1842 * to rte_eth_dev_configure().
1844 * The number of receive descriptors to allocate for the receive ring.
1846 * The *socket_id* argument is the socket identifier in case of NUMA.
1847 * The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1848 * the DMA memory allocated for the receive descriptors of the ring.
1850 * The pointer to the configuration data to be used for the receive queue.
1851 * NULL value is allowed, in which case default RX configuration
1853 * The *rx_conf* structure contains an *rx_thresh* structure with the values
1854 * of the Prefetch, Host, and Write-Back threshold registers of the receive
1857 * The pointer to the memory pool from which to allocate *rte_mbuf* network
1858 * memory buffers to populate each descriptor of the receive ring.
1860 * - 0: Success, receive queue correctly set up.
1861 * - -EINVAL: The size of network buffers which can be allocated from the
1862 * memory pool does not fit the various buffer sizes allowed by the
1863 * device controller.
1864 * - -ENOMEM: Unable to allocate the receive ring descriptors or to
1865 * allocate network memory buffers from the memory pool when
1866 * initializing receive descriptors.
1868 extern int rte_eth_rx_queue_setup(uint8_t port_id, uint16_t rx_queue_id,
1869 uint16_t nb_rx_desc, unsigned int socket_id,
1870 const struct rte_eth_rxconf *rx_conf,
1871 struct rte_mempool *mb_pool);
1874 * Allocate and set up a transmit queue for an Ethernet device.
1877 * The port identifier of the Ethernet device.
1878 * @param tx_queue_id
1879 * The index of the transmit queue to set up.
1880 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1881 * to rte_eth_dev_configure().
1883 * The number of transmit descriptors to allocate for the transmit ring.
1885 * The *socket_id* argument is the socket identifier in case of NUMA.
1886 * Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1887 * the DMA memory allocated for the transmit descriptors of the ring.
1889 * The pointer to the configuration data to be used for the transmit queue.
1890 * NULL value is allowed, in which case default RX configuration
1892 * The *tx_conf* structure contains the following data:
1893 * - The *tx_thresh* structure with the values of the Prefetch, Host, and
1894 * Write-Back threshold registers of the transmit ring.
1895 * When setting Write-Back threshold to the value greater then zero,
1896 * *tx_rs_thresh* value should be explicitly set to one.
1897 * - The *tx_free_thresh* value indicates the [minimum] number of network
1898 * buffers that must be pending in the transmit ring to trigger their
1899 * [implicit] freeing by the driver transmit function.
1900 * - The *tx_rs_thresh* value indicates the [minimum] number of transmit
1901 * descriptors that must be pending in the transmit ring before setting the
1902 * RS bit on a descriptor by the driver transmit function.
1903 * The *tx_rs_thresh* value should be less or equal then
1904 * *tx_free_thresh* value, and both of them should be less then
1906 * - The *txq_flags* member contains flags to pass to the TX queue setup
1907 * function to configure the behavior of the TX queue. This should be set
1908 * to 0 if no special configuration is required.
1910 * Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces
1911 * the transmit function to use default values.
1913 * - 0: Success, the transmit queue is correctly set up.
1914 * - -ENOMEM: Unable to allocate the transmit ring descriptors.
1916 extern int rte_eth_tx_queue_setup(uint8_t port_id, uint16_t tx_queue_id,
1917 uint16_t nb_tx_desc, unsigned int socket_id,
1918 const struct rte_eth_txconf *tx_conf);
1921 * Return the NUMA socket to which an Ethernet device is connected
1924 * The port identifier of the Ethernet device
1926 * The NUMA socket id to which the Ethernet device is connected or
1927 * a default of zero if the socket could not be determined.
1928 * -1 is returned is the port_id value is out of range.
1930 extern int rte_eth_dev_socket_id(uint8_t port_id);
1933 * Check if port_id of device is attached
1936 * The port identifier of the Ethernet device
1938 * - 0 if port is out of range or not attached
1939 * - 1 if device is attached
1941 extern int rte_eth_dev_is_valid_port(uint8_t port_id);
1944 * Allocate mbuf from mempool, setup the DMA physical address
1945 * and then start RX for specified queue of a port. It is used
1946 * when rx_deferred_start flag of the specified queue is true.
1949 * The port identifier of the Ethernet device
1950 * @param rx_queue_id
1951 * The index of the rx queue to update the ring.
1952 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1953 * to rte_eth_dev_configure().
1955 * - 0: Success, the transmit queue is correctly set up.
1956 * - -EINVAL: The port_id or the queue_id out of range.
1957 * - -ENOTSUP: The function not supported in PMD driver.
1959 extern int rte_eth_dev_rx_queue_start(uint8_t port_id, uint16_t rx_queue_id);
1962 * Stop specified RX queue of a port
1965 * The port identifier of the Ethernet device
1966 * @param rx_queue_id
1967 * The index of the rx queue to update the ring.
1968 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1969 * to rte_eth_dev_configure().
1971 * - 0: Success, the transmit queue is correctly set up.
1972 * - -EINVAL: The port_id or the queue_id out of range.
1973 * - -ENOTSUP: The function not supported in PMD driver.
1975 extern int rte_eth_dev_rx_queue_stop(uint8_t port_id, uint16_t rx_queue_id);
1978 * Start TX for specified queue of a port. It is used when tx_deferred_start
1979 * flag of the specified queue is true.
1982 * The port identifier of the Ethernet device
1983 * @param tx_queue_id
1984 * The index of the tx queue to update the ring.
1985 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1986 * to rte_eth_dev_configure().
1988 * - 0: Success, the transmit queue is correctly set up.
1989 * - -EINVAL: The port_id or the queue_id out of range.
1990 * - -ENOTSUP: The function not supported in PMD driver.
1992 extern int rte_eth_dev_tx_queue_start(uint8_t port_id, uint16_t tx_queue_id);
1995 * Stop specified TX queue of a port
1998 * The port identifier of the Ethernet device
1999 * @param tx_queue_id
2000 * The index of the tx queue to update the ring.
2001 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2002 * to rte_eth_dev_configure().
2004 * - 0: Success, the transmit queue is correctly set up.
2005 * - -EINVAL: The port_id or the queue_id out of range.
2006 * - -ENOTSUP: The function not supported in PMD driver.
2008 extern int rte_eth_dev_tx_queue_stop(uint8_t port_id, uint16_t tx_queue_id);
2013 * Start an Ethernet device.
2015 * The device start step is the last one and consists of setting the configured
2016 * offload features and in starting the transmit and the receive units of the
2018 * On success, all basic functions exported by the Ethernet API (link status,
2019 * receive/transmit, and so on) can be invoked.
2022 * The port identifier of the Ethernet device.
2024 * - 0: Success, Ethernet device started.
2025 * - <0: Error code of the driver device start function.
2027 extern int rte_eth_dev_start(uint8_t port_id);
2030 * Stop an Ethernet device. The device can be restarted with a call to
2031 * rte_eth_dev_start()
2034 * The port identifier of the Ethernet device.
2036 extern void rte_eth_dev_stop(uint8_t port_id);
2040 * Link up an Ethernet device.
2042 * Set device link up will re-enable the device rx/tx
2043 * functionality after it is previously set device linked down.
2046 * The port identifier of the Ethernet device.
2048 * - 0: Success, Ethernet device linked up.
2049 * - <0: Error code of the driver device link up function.
2051 extern int rte_eth_dev_set_link_up(uint8_t port_id);
2054 * Link down an Ethernet device.
2055 * The device rx/tx functionality will be disabled if success,
2056 * and it can be re-enabled with a call to
2057 * rte_eth_dev_set_link_up()
2060 * The port identifier of the Ethernet device.
2062 extern int rte_eth_dev_set_link_down(uint8_t port_id);
2065 * Close a stopped Ethernet device. The device cannot be restarted!
2066 * The function frees all resources except for needed by the
2067 * closed state. To free these resources, call rte_eth_dev_detach().
2070 * The port identifier of the Ethernet device.
2072 extern void rte_eth_dev_close(uint8_t port_id);
2075 * Enable receipt in promiscuous mode for an Ethernet device.
2078 * The port identifier of the Ethernet device.
2080 extern void rte_eth_promiscuous_enable(uint8_t port_id);
2083 * Disable receipt in promiscuous mode for an Ethernet device.
2086 * The port identifier of the Ethernet device.
2088 extern void rte_eth_promiscuous_disable(uint8_t port_id);
2091 * Return the value of promiscuous mode for an Ethernet device.
2094 * The port identifier of the Ethernet device.
2096 * - (1) if promiscuous is enabled
2097 * - (0) if promiscuous is disabled.
2100 extern int rte_eth_promiscuous_get(uint8_t port_id);
2103 * Enable the receipt of any multicast frame by an Ethernet device.
2106 * The port identifier of the Ethernet device.
2108 extern void rte_eth_allmulticast_enable(uint8_t port_id);
2111 * Disable the receipt of all multicast frames by an Ethernet device.
2114 * The port identifier of the Ethernet device.
2116 extern void rte_eth_allmulticast_disable(uint8_t port_id);
2119 * Return the value of allmulticast mode for an Ethernet device.
2122 * The port identifier of the Ethernet device.
2124 * - (1) if allmulticast is enabled
2125 * - (0) if allmulticast is disabled.
2128 extern int rte_eth_allmulticast_get(uint8_t port_id);
2131 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2132 * or FULL-DUPLEX) of the physical link of an Ethernet device. It might need
2133 * to wait up to 9 seconds in it.
2136 * The port identifier of the Ethernet device.
2138 * A pointer to an *rte_eth_link* structure to be filled with
2139 * the status, the speed and the mode of the Ethernet device link.
2141 extern void rte_eth_link_get(uint8_t port_id, struct rte_eth_link *link);
2144 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2145 * or FULL-DUPLEX) of the physical link of an Ethernet device. It is a no-wait
2146 * version of rte_eth_link_get().
2149 * The port identifier of the Ethernet device.
2151 * A pointer to an *rte_eth_link* structure to be filled with
2152 * the status, the speed and the mode of the Ethernet device link.
2154 extern void rte_eth_link_get_nowait(uint8_t port_id,
2155 struct rte_eth_link *link);
2158 * Retrieve the general I/O statistics of an Ethernet device.
2161 * The port identifier of the Ethernet device.
2163 * A pointer to a structure of type *rte_eth_stats* to be filled with
2164 * the values of device counters for the following set of statistics:
2165 * - *ipackets* with the total of successfully received packets.
2166 * - *opackets* with the total of successfully transmitted packets.
2167 * - *ibytes* with the total of successfully received bytes.
2168 * - *obytes* with the total of successfully transmitted bytes.
2169 * - *ierrors* with the total of erroneous received packets.
2170 * - *oerrors* with the total of failed transmitted packets.
2172 * Zero if successful. Non-zero otherwise.
2174 extern int rte_eth_stats_get(uint8_t port_id, struct rte_eth_stats *stats);
2177 * Reset the general I/O statistics of an Ethernet device.
2180 * The port identifier of the Ethernet device.
2182 extern void rte_eth_stats_reset(uint8_t port_id);
2185 * Retrieve extended statistics of an Ethernet device.
2188 * The port identifier of the Ethernet device.
2190 * A pointer to a table of structure of type *rte_eth_xstats*
2191 * to be filled with device statistics names and values.
2192 * This parameter can be set to NULL if n is 0.
2194 * The size of the stats table, which should be large enough to store
2195 * all the statistics of the device.
2197 * - positive value lower or equal to n: success. The return value
2198 * is the number of entries filled in the stats table.
2199 * - positive value higher than n: error, the given statistics table
2200 * is too small. The return value corresponds to the size that should
2201 * be given to succeed. The entries in the table are not valid and
2202 * shall not be used by the caller.
2203 * - negative value on error (invalid port id)
2205 extern int rte_eth_xstats_get(uint8_t port_id,
2206 struct rte_eth_xstats *xstats, unsigned n);
2209 * Reset extended statistics of an Ethernet device.
2212 * The port identifier of the Ethernet device.
2214 extern void rte_eth_xstats_reset(uint8_t port_id);
2217 * Set a mapping for the specified transmit queue to the specified per-queue
2218 * statistics counter.
2221 * The port identifier of the Ethernet device.
2222 * @param tx_queue_id
2223 * The index of the transmit queue for which a queue stats mapping is required.
2224 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2225 * to rte_eth_dev_configure().
2227 * The per-queue packet statistics functionality number that the transmit
2228 * queue is to be assigned.
2229 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2231 * Zero if successful. Non-zero otherwise.
2233 extern int rte_eth_dev_set_tx_queue_stats_mapping(uint8_t port_id,
2234 uint16_t tx_queue_id,
2238 * Set a mapping for the specified receive queue to the specified per-queue
2239 * statistics counter.
2242 * The port identifier of the Ethernet device.
2243 * @param rx_queue_id
2244 * The index of the receive queue for which a queue stats mapping is required.
2245 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2246 * to rte_eth_dev_configure().
2248 * The per-queue packet statistics functionality number that the receive
2249 * queue is to be assigned.
2250 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2252 * Zero if successful. Non-zero otherwise.
2254 extern int rte_eth_dev_set_rx_queue_stats_mapping(uint8_t port_id,
2255 uint16_t rx_queue_id,
2259 * Retrieve the Ethernet address of an Ethernet device.
2262 * The port identifier of the Ethernet device.
2264 * A pointer to a structure of type *ether_addr* to be filled with
2265 * the Ethernet address of the Ethernet device.
2267 extern void rte_eth_macaddr_get(uint8_t port_id, struct ether_addr *mac_addr);
2270 * Retrieve the contextual information of an Ethernet device.
2273 * The port identifier of the Ethernet device.
2275 * A pointer to a structure of type *rte_eth_dev_info* to be filled with
2276 * the contextual information of the Ethernet device.
2278 extern void rte_eth_dev_info_get(uint8_t port_id,
2279 struct rte_eth_dev_info *dev_info);
2282 * Retrieve the MTU of an Ethernet device.
2285 * The port identifier of the Ethernet device.
2287 * A pointer to a uint16_t where the retrieved MTU is to be stored.
2289 * - (0) if successful.
2290 * - (-ENODEV) if *port_id* invalid.
2292 extern int rte_eth_dev_get_mtu(uint8_t port_id, uint16_t *mtu);
2295 * Change the MTU of an Ethernet device.
2298 * The port identifier of the Ethernet device.
2300 * A uint16_t for the MTU to be applied.
2302 * - (0) if successful.
2303 * - (-ENOTSUP) if operation is not supported.
2304 * - (-ENODEV) if *port_id* invalid.
2305 * - (-EINVAL) if *mtu* invalid.
2307 extern int rte_eth_dev_set_mtu(uint8_t port_id, uint16_t mtu);
2310 * Enable/Disable hardware filtering by an Ethernet device of received
2311 * VLAN packets tagged with a given VLAN Tag Identifier.
2314 * The port identifier of the Ethernet device.
2316 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
2318 * If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*.
2319 * Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*.
2321 * - (0) if successful.
2322 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2323 * - (-ENODEV) if *port_id* invalid.
2324 * - (-ENOSYS) if VLAN filtering on *port_id* disabled.
2325 * - (-EINVAL) if *vlan_id* > 4095.
2327 extern int rte_eth_dev_vlan_filter(uint8_t port_id, uint16_t vlan_id , int on);
2330 * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
2331 * 82599/X540/X550 can support VLAN stripping at the rx queue level
2334 * The port identifier of the Ethernet device.
2335 * @param rx_queue_id
2336 * The index of the receive queue for which a queue stats mapping is required.
2337 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2338 * to rte_eth_dev_configure().
2340 * If 1, Enable VLAN Stripping of the receive queue of the Ethernet port.
2341 * If 0, Disable VLAN Stripping of the receive queue of the Ethernet port.
2343 * - (0) if successful.
2344 * - (-ENOSUP) if hardware-assisted VLAN stripping not configured.
2345 * - (-ENODEV) if *port_id* invalid.
2346 * - (-EINVAL) if *rx_queue_id* invalid.
2348 extern int rte_eth_dev_set_vlan_strip_on_queue(uint8_t port_id,
2349 uint16_t rx_queue_id, int on);
2352 * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
2353 * the VLAN Header. This is a register setup available on some Intel NIC, not
2354 * but all, please check the data sheet for availability.
2357 * The port identifier of the Ethernet device.
2359 * The Tag Protocol ID
2361 * - (0) if successful.
2362 * - (-ENOSUP) if hardware-assisted VLAN TPID setup is not supported.
2363 * - (-ENODEV) if *port_id* invalid.
2365 extern int rte_eth_dev_set_vlan_ether_type(uint8_t port_id, uint16_t tag_type);
2368 * Set VLAN offload configuration on an Ethernet device
2369 * Enable/Disable Extended VLAN by an Ethernet device, This is a register setup
2370 * available on some Intel NIC, not but all, please check the data sheet for
2372 * Enable/Disable VLAN Strip can be done on rx queue for certain NIC, but here
2373 * the configuration is applied on the port level.
2376 * The port identifier of the Ethernet device.
2377 * @param offload_mask
2378 * The VLAN Offload bit mask can be mixed use with "OR"
2379 * ETH_VLAN_STRIP_OFFLOAD
2380 * ETH_VLAN_FILTER_OFFLOAD
2381 * ETH_VLAN_EXTEND_OFFLOAD
2383 * - (0) if successful.
2384 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2385 * - (-ENODEV) if *port_id* invalid.
2387 extern int rte_eth_dev_set_vlan_offload(uint8_t port_id, int offload_mask);
2390 * Read VLAN Offload configuration from an Ethernet device
2393 * The port identifier of the Ethernet device.
2395 * - (>0) if successful. Bit mask to indicate
2396 * ETH_VLAN_STRIP_OFFLOAD
2397 * ETH_VLAN_FILTER_OFFLOAD
2398 * ETH_VLAN_EXTEND_OFFLOAD
2399 * - (-ENODEV) if *port_id* invalid.
2401 extern int rte_eth_dev_get_vlan_offload(uint8_t port_id);
2404 * Set port based TX VLAN insersion on or off.
2407 * The port identifier of the Ethernet device.
2409 * Port based TX VLAN identifier togeth with user priority.
2411 * Turn on or off the port based TX VLAN insertion.
2414 * - (0) if successful.
2415 * - negative if failed.
2417 extern int rte_eth_dev_set_vlan_pvid(uint8_t port_id, uint16_t pvid, int on);
2421 * Retrieve a burst of input packets from a receive queue of an Ethernet
2422 * device. The retrieved packets are stored in *rte_mbuf* structures whose
2423 * pointers are supplied in the *rx_pkts* array.
2425 * The rte_eth_rx_burst() function loops, parsing the RX ring of the
2426 * receive queue, up to *nb_pkts* packets, and for each completed RX
2427 * descriptor in the ring, it performs the following operations:
2429 * - Initialize the *rte_mbuf* data structure associated with the
2430 * RX descriptor according to the information provided by the NIC into
2431 * that RX descriptor.
2433 * - Store the *rte_mbuf* data structure into the next entry of the
2436 * - Replenish the RX descriptor with a new *rte_mbuf* buffer
2437 * allocated from the memory pool associated with the receive queue at
2438 * initialization time.
2440 * When retrieving an input packet that was scattered by the controller
2441 * into multiple receive descriptors, the rte_eth_rx_burst() function
2442 * appends the associated *rte_mbuf* buffers to the first buffer of the
2445 * The rte_eth_rx_burst() function returns the number of packets
2446 * actually retrieved, which is the number of *rte_mbuf* data structures
2447 * effectively supplied into the *rx_pkts* array.
2448 * A return value equal to *nb_pkts* indicates that the RX queue contained
2449 * at least *rx_pkts* packets, and this is likely to signify that other
2450 * received packets remain in the input queue. Applications implementing
2451 * a "retrieve as much received packets as possible" policy can check this
2452 * specific case and keep invoking the rte_eth_rx_burst() function until
2453 * a value less than *nb_pkts* is returned.
2455 * This receive method has the following advantages:
2457 * - It allows a run-to-completion network stack engine to retrieve and
2458 * to immediately process received packets in a fast burst-oriented
2459 * approach, avoiding the overhead of unnecessary intermediate packet
2460 * queue/dequeue operations.
2462 * - Conversely, it also allows an asynchronous-oriented processing
2463 * method to retrieve bursts of received packets and to immediately
2464 * queue them for further parallel processing by another logical core,
2465 * for instance. However, instead of having received packets being
2466 * individually queued by the driver, this approach allows the invoker
2467 * of the rte_eth_rx_burst() function to queue a burst of retrieved
2468 * packets at a time and therefore dramatically reduce the cost of
2469 * enqueue/dequeue operations per packet.
2471 * - It allows the rte_eth_rx_burst() function of the driver to take
2472 * advantage of burst-oriented hardware features (CPU cache,
2473 * prefetch instructions, and so on) to minimize the number of CPU
2474 * cycles per packet.
2476 * To summarize, the proposed receive API enables many
2477 * burst-oriented optimizations in both synchronous and asynchronous
2478 * packet processing environments with no overhead in both cases.
2480 * The rte_eth_rx_burst() function does not provide any error
2481 * notification to avoid the corresponding overhead. As a hint, the
2482 * upper-level application might check the status of the device link once
2483 * being systematically returned a 0 value for a given number of tries.
2486 * The port identifier of the Ethernet device.
2488 * The index of the receive queue from which to retrieve input packets.
2489 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2490 * to rte_eth_dev_configure().
2492 * The address of an array of pointers to *rte_mbuf* structures that
2493 * must be large enough to store *nb_pkts* pointers in it.
2495 * The maximum number of packets to retrieve.
2497 * The number of packets actually retrieved, which is the number
2498 * of pointers to *rte_mbuf* structures effectively supplied to the
2501 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2502 extern uint16_t rte_eth_rx_burst(uint8_t port_id, uint16_t queue_id,
2503 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
2505 static inline uint16_t
2506 rte_eth_rx_burst(uint8_t port_id, uint16_t queue_id,
2507 struct rte_mbuf **rx_pkts, const uint16_t nb_pkts)
2509 struct rte_eth_dev *dev;
2511 dev = &rte_eth_devices[port_id];
2513 int16_t nb_rx = (*dev->rx_pkt_burst)(dev->data->rx_queues[queue_id],
2516 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
2517 struct rte_eth_rxtx_callback *cb = dev->post_rx_burst_cbs[queue_id];
2519 if (unlikely(cb != NULL)) {
2521 nb_rx = cb->fn.rx(port_id, queue_id, rx_pkts, nb_rx,
2522 nb_pkts, cb->param);
2524 } while (cb != NULL);
2533 * Get the number of used descriptors in a specific queue
2536 * The port identifier of the Ethernet device.
2538 * The queue id on the specific port.
2540 * The number of used descriptors in the specific queue.
2542 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2543 extern uint32_t rte_eth_rx_queue_count(uint8_t port_id, uint16_t queue_id);
2545 static inline uint32_t
2546 rte_eth_rx_queue_count(uint8_t port_id, uint16_t queue_id)
2548 struct rte_eth_dev *dev;
2550 dev = &rte_eth_devices[port_id];
2551 return (*dev->dev_ops->rx_queue_count)(dev, queue_id);
2556 * Check if the DD bit of the specific RX descriptor in the queue has been set
2559 * The port identifier of the Ethernet device.
2561 * The queue id on the specific port.
2563 * The offset of the descriptor ID from tail.
2565 * - (1) if the specific DD bit is set.
2566 * - (0) if the specific DD bit is not set.
2567 * - (-ENODEV) if *port_id* invalid.
2569 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2570 extern int rte_eth_rx_descriptor_done(uint8_t port_id,
2575 rte_eth_rx_descriptor_done(uint8_t port_id, uint16_t queue_id, uint16_t offset)
2577 struct rte_eth_dev *dev;
2579 dev = &rte_eth_devices[port_id];
2580 return (*dev->dev_ops->rx_descriptor_done)( \
2581 dev->data->rx_queues[queue_id], offset);
2586 * Send a burst of output packets on a transmit queue of an Ethernet device.
2588 * The rte_eth_tx_burst() function is invoked to transmit output packets
2589 * on the output queue *queue_id* of the Ethernet device designated by its
2591 * The *nb_pkts* parameter is the number of packets to send which are
2592 * supplied in the *tx_pkts* array of *rte_mbuf* structures.
2593 * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
2594 * up to the number of transmit descriptors available in the TX ring of the
2596 * For each packet to send, the rte_eth_tx_burst() function performs
2597 * the following operations:
2599 * - Pick up the next available descriptor in the transmit ring.
2601 * - Free the network buffer previously sent with that descriptor, if any.
2603 * - Initialize the transmit descriptor with the information provided
2604 * in the *rte_mbuf data structure.
2606 * In the case of a segmented packet composed of a list of *rte_mbuf* buffers,
2607 * the rte_eth_tx_burst() function uses several transmit descriptors
2610 * The rte_eth_tx_burst() function returns the number of packets it
2611 * actually sent. A return value equal to *nb_pkts* means that all packets
2612 * have been sent, and this is likely to signify that other output packets
2613 * could be immediately transmitted again. Applications that implement a
2614 * "send as many packets to transmit as possible" policy can check this
2615 * specific case and keep invoking the rte_eth_tx_burst() function until
2616 * a value less than *nb_pkts* is returned.
2618 * It is the responsibility of the rte_eth_tx_burst() function to
2619 * transparently free the memory buffers of packets previously sent.
2620 * This feature is driven by the *tx_free_thresh* value supplied to the
2621 * rte_eth_dev_configure() function at device configuration time.
2622 * When the number of free TX descriptors drops below this threshold, the
2623 * rte_eth_tx_burst() function must [attempt to] free the *rte_mbuf* buffers
2624 * of those packets whose transmission was effectively completed.
2627 * The port identifier of the Ethernet device.
2629 * The index of the transmit queue through which output packets must be
2631 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2632 * to rte_eth_dev_configure().
2634 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
2635 * which contain the output packets.
2637 * The maximum number of packets to transmit.
2639 * The number of output packets actually stored in transmit descriptors of
2640 * the transmit ring. The return value can be less than the value of the
2641 * *tx_pkts* parameter when the transmit ring is full or has been filled up.
2643 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2644 extern uint16_t rte_eth_tx_burst(uint8_t port_id, uint16_t queue_id,
2645 struct rte_mbuf **tx_pkts, uint16_t nb_pkts);
2647 static inline uint16_t
2648 rte_eth_tx_burst(uint8_t port_id, uint16_t queue_id,
2649 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
2651 struct rte_eth_dev *dev;
2653 dev = &rte_eth_devices[port_id];
2655 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
2656 struct rte_eth_rxtx_callback *cb = dev->pre_tx_burst_cbs[queue_id];
2658 if (unlikely(cb != NULL)) {
2660 nb_pkts = cb->fn.tx(port_id, queue_id, tx_pkts, nb_pkts,
2663 } while (cb != NULL);
2667 return (*dev->tx_pkt_burst)(dev->data->tx_queues[queue_id], tx_pkts, nb_pkts);
2672 * Setup a new signature filter rule on an Ethernet device
2675 * The port identifier of the Ethernet device.
2676 * @param fdir_filter
2677 * The pointer to the fdir filter structure describing the signature filter
2679 * The *rte_fdir_filter* structure includes the values of the different fields
2680 * to match: source and destination IP addresses, vlan id, flexbytes, source
2681 * and destination ports, and so on.
2683 * The index of the RX queue where to store RX packets matching the added
2684 * signature filter defined in fdir_filter.
2686 * - (0) if successful.
2687 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2688 * - (-ENODEV) if *port_id* invalid.
2689 * - (-ENOSYS) if the FDIR mode is not configured in signature mode
2691 * - (-EINVAL) if the fdir_filter information is not correct.
2693 int rte_eth_dev_fdir_add_signature_filter(uint8_t port_id,
2694 struct rte_fdir_filter *fdir_filter,
2698 * Update a signature filter rule on an Ethernet device.
2699 * If the rule doesn't exits, it is created.
2702 * The port identifier of the Ethernet device.
2704 * The pointer to the structure describing the signature filter rule.
2705 * The *rte_fdir_filter* structure includes the values of the different fields
2706 * to match: source and destination IP addresses, vlan id, flexbytes, source
2707 * and destination ports, and so on.
2709 * The index of the RX queue where to store RX packets matching the added
2710 * signature filter defined in fdir_ftr.
2712 * - (0) if successful.
2713 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2714 * - (-ENODEV) if *port_id* invalid.
2715 * - (-ENOSYS) if the flow director mode is not configured in signature mode
2717 * - (-EINVAL) if the fdir_filter information is not correct.
2719 int rte_eth_dev_fdir_update_signature_filter(uint8_t port_id,
2720 struct rte_fdir_filter *fdir_ftr,
2724 * Remove a signature filter rule on an Ethernet device.
2727 * The port identifier of the Ethernet device.
2729 * The pointer to the structure describing the signature filter rule.
2730 * The *rte_fdir_filter* structure includes the values of the different fields
2731 * to match: source and destination IP addresses, vlan id, flexbytes, source
2732 * and destination ports, and so on.
2734 * - (0) if successful.
2735 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2736 * - (-ENODEV) if *port_id* invalid.
2737 * - (-ENOSYS) if the flow director mode is not configured in signature mode
2739 * - (-EINVAL) if the fdir_filter information is not correct.
2741 int rte_eth_dev_fdir_remove_signature_filter(uint8_t port_id,
2742 struct rte_fdir_filter *fdir_ftr);
2745 * Retrieve the flow director information of an Ethernet device.
2748 * The port identifier of the Ethernet device.
2750 * A pointer to a structure of type *rte_eth_dev_fdir* to be filled with
2751 * the flow director information of the Ethernet device.
2753 * - (0) if successful.
2754 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2755 * - (-ENODEV) if *port_id* invalid.
2756 * - (-ENOSYS) if the flow director mode is not configured on *port_id*.
2758 int rte_eth_dev_fdir_get_infos(uint8_t port_id, struct rte_eth_fdir *fdir);
2761 * Add a new perfect filter rule on an Ethernet device.
2764 * The port identifier of the Ethernet device.
2765 * @param fdir_filter
2766 * The pointer to the structure describing the perfect filter rule.
2767 * The *rte_fdir_filter* structure includes the values of the different fields
2768 * to match: source and destination IP addresses, vlan id, flexbytes, source
2769 * and destination ports, and so on.
2770 * IPv6 are not supported.
2772 * The 16-bit value supplied in the field hash.fdir.id of mbuf for RX
2773 * packets matching the perfect filter.
2775 * The index of the RX queue where to store RX packets matching the added
2776 * perfect filter defined in fdir_filter.
2778 * If drop is set to 1, matching RX packets are stored into the RX drop
2779 * queue defined in the rte_fdir_conf.
2781 * - (0) if successful.
2782 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2783 * - (-ENODEV) if *port_id* invalid.
2784 * - (-ENOSYS) if the flow director mode is not configured in perfect mode
2786 * - (-EINVAL) if the fdir_filter information is not correct.
2788 int rte_eth_dev_fdir_add_perfect_filter(uint8_t port_id,
2789 struct rte_fdir_filter *fdir_filter,
2790 uint16_t soft_id, uint8_t rx_queue,
2794 * Update a perfect filter rule on an Ethernet device.
2795 * If the rule doesn't exits, it is created.
2798 * The port identifier of the Ethernet device.
2799 * @param fdir_filter
2800 * The pointer to the structure describing the perfect filter rule.
2801 * The *rte_fdir_filter* structure includes the values of the different fields
2802 * to match: source and destination IP addresses, vlan id, flexbytes, source
2803 * and destination ports, and so on.
2804 * IPv6 are not supported.
2806 * The 16-bit value supplied in the field hash.fdir.id of mbuf for RX
2807 * packets matching the perfect filter.
2809 * The index of the RX queue where to store RX packets matching the added
2810 * perfect filter defined in fdir_filter.
2812 * If drop is set to 1, matching RX packets are stored into the RX drop
2813 * queue defined in the rte_fdir_conf.
2815 * - (0) if successful.
2816 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2817 * - (-ENODEV) if *port_id* invalid.
2818 * - (-ENOSYS) if the flow director mode is not configured in perfect mode
2820 * - (-EINVAL) if the fdir_filter information is not correct.
2822 int rte_eth_dev_fdir_update_perfect_filter(uint8_t port_id,
2823 struct rte_fdir_filter *fdir_filter,
2824 uint16_t soft_id, uint8_t rx_queue,
2828 * Remove a perfect filter rule on an Ethernet device.
2831 * The port identifier of the Ethernet device.
2832 * @param fdir_filter
2833 * The pointer to the structure describing the perfect filter rule.
2834 * The *rte_fdir_filter* structure includes the values of the different fields
2835 * to match: source and destination IP addresses, vlan id, flexbytes, source
2836 * and destination ports, and so on.
2837 * IPv6 are not supported.
2839 * The soft_id value provided when adding/updating the removed filter.
2841 * - (0) if successful.
2842 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2843 * - (-ENODEV) if *port_id* invalid.
2844 * - (-ENOSYS) if the flow director mode is not configured in perfect mode
2846 * - (-EINVAL) if the fdir_filter information is not correct.
2848 int rte_eth_dev_fdir_remove_perfect_filter(uint8_t port_id,
2849 struct rte_fdir_filter *fdir_filter,
2852 * Configure globally the masks for flow director mode for an Ethernet device.
2853 * For example, the device can match packets with only the first 24 bits of
2854 * the IPv4 source address.
2856 * The following fields can be masked: IPv4 addresses and L4 port numbers.
2857 * The following fields can be either enabled or disabled completely for the
2858 * matching functionality: VLAN ID tag; VLAN Priority + CFI bit; Flexible 2-byte
2860 * IPv6 masks are not supported.
2862 * All filters must comply with the masks previously configured.
2863 * For example, with a mask equal to 255.255.255.0 for the source IPv4 address,
2864 * all IPv4 filters must be created with a source IPv4 address that fits the
2867 * This function flushes all filters that have been previously added in
2871 * The port identifier of the Ethernet device.
2873 * The pointer to the fdir mask structure describing relevant headers fields
2874 * and relevant bits to use when matching packets addresses and ports.
2875 * IPv6 masks are not supported.
2877 * - (0) if successful.
2878 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2879 * - (-ENODEV) if *port_id* invalid.
2880 * - (-ENOSYS) if the flow director mode is not configured in perfect
2881 * mode on *port_id*.
2882 * - (-EINVAL) if the fdir_filter information is not correct
2884 int rte_eth_dev_fdir_set_masks(uint8_t port_id,
2885 struct rte_fdir_masks *fdir_mask);
2888 * The eth device event type for interrupt, and maybe others in the future.
2890 enum rte_eth_event_type {
2891 RTE_ETH_EVENT_UNKNOWN, /**< unknown event type */
2892 RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
2893 RTE_ETH_EVENT_MAX /**< max value of this enum */
2896 typedef void (*rte_eth_dev_cb_fn)(uint8_t port_id, \
2897 enum rte_eth_event_type event, void *cb_arg);
2898 /**< user application callback to be registered for interrupts */
2903 * Register a callback function for specific port id.
2910 * User supplied callback function to be called.
2912 * Pointer to the parameters for the registered callback.
2915 * - On success, zero.
2916 * - On failure, a negative value.
2918 int rte_eth_dev_callback_register(uint8_t port_id,
2919 enum rte_eth_event_type event,
2920 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
2923 * Unregister a callback function for specific port id.
2930 * User supplied callback function to be called.
2932 * Pointer to the parameters for the registered callback. -1 means to
2933 * remove all for the same callback address and same event.
2936 * - On success, zero.
2937 * - On failure, a negative value.
2939 int rte_eth_dev_callback_unregister(uint8_t port_id,
2940 enum rte_eth_event_type event,
2941 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
2944 * @internal Executes all the user application registered callbacks for
2945 * the specific device. It is for DPDK internal user only. User
2946 * application should not call it directly.
2949 * Pointer to struct rte_eth_dev.
2951 * Eth device interrupt event type.
2956 void _rte_eth_dev_callback_process(struct rte_eth_dev *dev,
2957 enum rte_eth_event_type event);
2960 * Turn on the LED on the Ethernet device.
2961 * This function turns on the LED on the Ethernet device.
2964 * The port identifier of the Ethernet device.
2966 * - (0) if successful.
2967 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
2969 * - (-ENODEV) if *port_id* invalid.
2971 int rte_eth_led_on(uint8_t port_id);
2974 * Turn off the LED on the Ethernet device.
2975 * This function turns off the LED on the Ethernet device.
2978 * The port identifier of the Ethernet device.
2980 * - (0) if successful.
2981 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
2983 * - (-ENODEV) if *port_id* invalid.
2985 int rte_eth_led_off(uint8_t port_id);
2988 * Get current status of the Ethernet link flow control for Ethernet device
2991 * The port identifier of the Ethernet device.
2993 * The pointer to the structure where to store the flow control parameters.
2995 * - (0) if successful.
2996 * - (-ENOTSUP) if hardware doesn't support flow control.
2997 * - (-ENODEV) if *port_id* invalid.
2999 int rte_eth_dev_flow_ctrl_get(uint8_t port_id,
3000 struct rte_eth_fc_conf *fc_conf);
3003 * Configure the Ethernet link flow control for Ethernet device
3006 * The port identifier of the Ethernet device.
3008 * The pointer to the structure of the flow control parameters.
3010 * - (0) if successful.
3011 * - (-ENOTSUP) if hardware doesn't support flow control mode.
3012 * - (-ENODEV) if *port_id* invalid.
3013 * - (-EINVAL) if bad parameter
3014 * - (-EIO) if flow control setup failure
3016 int rte_eth_dev_flow_ctrl_set(uint8_t port_id,
3017 struct rte_eth_fc_conf *fc_conf);
3020 * Configure the Ethernet priority flow control under DCB environment
3021 * for Ethernet device.
3024 * The port identifier of the Ethernet device.
3026 * The pointer to the structure of the priority flow control parameters.
3028 * - (0) if successful.
3029 * - (-ENOTSUP) if hardware doesn't support priority flow control mode.
3030 * - (-ENODEV) if *port_id* invalid.
3031 * - (-EINVAL) if bad parameter
3032 * - (-EIO) if flow control setup failure
3034 int rte_eth_dev_priority_flow_ctrl_set(uint8_t port_id,
3035 struct rte_eth_pfc_conf *pfc_conf);
3038 * Add a MAC address to an internal array of addresses used to enable whitelist
3039 * filtering to accept packets only if the destination MAC address matches.
3042 * The port identifier of the Ethernet device.
3044 * The MAC address to add.
3046 * VMDq pool index to associate address with (if VMDq is enabled). If VMDq is
3047 * not enabled, this should be set to 0.
3049 * - (0) if successfully added or *mac_addr" was already added.
3050 * - (-ENOTSUP) if hardware doesn't support this feature.
3051 * - (-ENODEV) if *port* is invalid.
3052 * - (-ENOSPC) if no more MAC addresses can be added.
3053 * - (-EINVAL) if MAC address is invalid.
3055 int rte_eth_dev_mac_addr_add(uint8_t port, struct ether_addr *mac_addr,
3059 * Remove a MAC address from the internal array of addresses.
3062 * The port identifier of the Ethernet device.
3064 * MAC address to remove.
3066 * - (0) if successful, or *mac_addr* didn't exist.
3067 * - (-ENOTSUP) if hardware doesn't support.
3068 * - (-ENODEV) if *port* invalid.
3069 * - (-EADDRINUSE) if attempting to remove the default MAC address
3071 int rte_eth_dev_mac_addr_remove(uint8_t port, struct ether_addr *mac_addr);
3074 * Set the default MAC address.
3077 * The port identifier of the Ethernet device.
3079 * New default MAC address.
3081 * - (0) if successful, or *mac_addr* didn't exist.
3082 * - (-ENOTSUP) if hardware doesn't support.
3083 * - (-ENODEV) if *port* invalid.
3084 * - (-EINVAL) if MAC address is invalid.
3086 int rte_eth_dev_default_mac_addr_set(uint8_t port, struct ether_addr *mac_addr);
3090 * Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3093 * The port identifier of the Ethernet device.
3097 * Redirection table size. The table size can be queried by
3098 * rte_eth_dev_info_get().
3100 * - (0) if successful.
3101 * - (-ENOTSUP) if hardware doesn't support.
3102 * - (-EINVAL) if bad parameter.
3104 int rte_eth_dev_rss_reta_update(uint8_t port,
3105 struct rte_eth_rss_reta_entry64 *reta_conf,
3106 uint16_t reta_size);
3109 * Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3112 * The port identifier of the Ethernet device.
3116 * Redirection table size. The table size can be queried by
3117 * rte_eth_dev_info_get().
3119 * - (0) if successful.
3120 * - (-ENOTSUP) if hardware doesn't support.
3121 * - (-EINVAL) if bad parameter.
3123 int rte_eth_dev_rss_reta_query(uint8_t port,
3124 struct rte_eth_rss_reta_entry64 *reta_conf,
3125 uint16_t reta_size);
3128 * Updates unicast hash table for receiving packet with the given destination
3129 * MAC address, and the packet is routed to all VFs for which the RX mode is
3130 * accept packets that match the unicast hash table.
3133 * The port identifier of the Ethernet device.
3135 * Unicast MAC address.
3137 * 1 - Set an unicast hash bit for receiving packets with the MAC address.
3138 * 0 - Clear an unicast hash bit.
3140 * - (0) if successful.
3141 * - (-ENOTSUP) if hardware doesn't support.
3142 * - (-ENODEV) if *port_id* invalid.
3143 * - (-EINVAL) if bad parameter.
3145 int rte_eth_dev_uc_hash_table_set(uint8_t port,struct ether_addr *addr,
3149 * Updates all unicast hash bitmaps for receiving packet with any Unicast
3150 * Ethernet MAC addresses,the packet is routed to all VFs for which the RX
3151 * mode is accept packets that match the unicast hash table.
3154 * The port identifier of the Ethernet device.
3156 * 1 - Set all unicast hash bitmaps for receiving all the Ethernet
3158 * 0 - Clear all unicast hash bitmaps
3160 * - (0) if successful.
3161 * - (-ENOTSUP) if hardware doesn't support.
3162 * - (-ENODEV) if *port_id* invalid.
3163 * - (-EINVAL) if bad parameter.
3165 int rte_eth_dev_uc_all_hash_table_set(uint8_t port,uint8_t on);
3168 * Set RX L2 Filtering mode of a VF of an Ethernet device.
3171 * The port identifier of the Ethernet device.
3175 * The RX mode mask, which is one or more of accepting Untagged Packets,
3176 * packets that match the PFUTA table, Broadcast and Multicast Promiscuous.
3177 * ETH_VMDQ_ACCEPT_UNTAG,ETH_VMDQ_ACCEPT_HASH_UC,
3178 * ETH_VMDQ_ACCEPT_BROADCAST and ETH_VMDQ_ACCEPT_MULTICAST will be used
3181 * 1 - Enable a VF RX mode.
3182 * 0 - Disable a VF RX mode.
3184 * - (0) if successful.
3185 * - (-ENOTSUP) if hardware doesn't support.
3186 * - (-ENOTSUP) if hardware doesn't support.
3187 * - (-EINVAL) if bad parameter.
3189 int rte_eth_dev_set_vf_rxmode(uint8_t port, uint16_t vf, uint16_t rx_mode,
3193 * Enable or disable a VF traffic transmit of the Ethernet device.
3196 * The port identifier of the Ethernet device.
3200 * 1 - Enable a VF traffic transmit.
3201 * 0 - Disable a VF traffic transmit.
3203 * - (0) if successful.
3204 * - (-ENODEV) if *port_id* invalid.
3205 * - (-ENOTSUP) if hardware doesn't support.
3206 * - (-EINVAL) if bad parameter.
3209 rte_eth_dev_set_vf_tx(uint8_t port,uint16_t vf, uint8_t on);
3212 * Enable or disable a VF traffic receive of an Ethernet device.
3215 * The port identifier of the Ethernet device.
3219 * 1 - Enable a VF traffic receive.
3220 * 0 - Disable a VF traffic receive.
3222 * - (0) if successful.
3223 * - (-ENOTSUP) if hardware doesn't support.
3224 * - (-ENODEV) if *port_id* invalid.
3225 * - (-EINVAL) if bad parameter.
3228 rte_eth_dev_set_vf_rx(uint8_t port,uint16_t vf, uint8_t on);
3231 * Enable/Disable hardware VF VLAN filtering by an Ethernet device of
3232 * received VLAN packets tagged with a given VLAN Tag Identifier.
3235 * The port identifier of the Ethernet device.
3237 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
3239 * Bitmap listing which VFs participate in the VLAN filtering.
3241 * 1 - Enable VFs VLAN filtering.
3242 * 0 - Disable VFs VLAN filtering.
3244 * - (0) if successful.
3245 * - (-ENOTSUP) if hardware doesn't support.
3246 * - (-ENODEV) if *port_id* invalid.
3247 * - (-EINVAL) if bad parameter.
3250 rte_eth_dev_set_vf_vlan_filter(uint8_t port, uint16_t vlan_id,
3255 * Set a traffic mirroring rule on an Ethernet device
3258 * The port identifier of the Ethernet device.
3259 * @param mirror_conf
3260 * The pointer to the traffic mirroring structure describing the mirroring rule.
3261 * The *rte_eth_vm_mirror_conf* structure includes the type of mirroring rule,
3262 * destination pool and the value of rule if enable vlan or pool mirroring.
3265 * The index of traffic mirroring rule, we support four separated rules.
3267 * 1 - Enable a mirroring rule.
3268 * 0 - Disable a mirroring rule.
3270 * - (0) if successful.
3271 * - (-ENOTSUP) if hardware doesn't support this feature.
3272 * - (-ENODEV) if *port_id* invalid.
3273 * - (-EINVAL) if the mr_conf information is not correct.
3275 int rte_eth_mirror_rule_set(uint8_t port_id,
3276 struct rte_eth_mirror_conf *mirror_conf,
3281 * Reset a traffic mirroring rule on an Ethernet device.
3284 * The port identifier of the Ethernet device.
3286 * The index of traffic mirroring rule, we support four separated rules.
3288 * - (0) if successful.
3289 * - (-ENOTSUP) if hardware doesn't support this feature.
3290 * - (-ENODEV) if *port_id* invalid.
3291 * - (-EINVAL) if bad parameter.
3293 int rte_eth_mirror_rule_reset(uint8_t port_id,
3297 * Set the rate limitation for a queue on an Ethernet device.
3300 * The port identifier of the Ethernet device.
3304 * The tx rate allocated from the total link speed for this queue.
3306 * - (0) if successful.
3307 * - (-ENOTSUP) if hardware doesn't support this feature.
3308 * - (-ENODEV) if *port_id* invalid.
3309 * - (-EINVAL) if bad parameter.
3311 int rte_eth_set_queue_rate_limit(uint8_t port_id, uint16_t queue_idx,
3315 * Set the rate limitation for a vf on an Ethernet device.
3318 * The port identifier of the Ethernet device.
3322 * The tx rate allocated from the total link speed for this VF id.
3324 * The queue mask which need to set the rate.
3326 * - (0) if successful.
3327 * - (-ENOTSUP) if hardware doesn't support this feature.
3328 * - (-ENODEV) if *port_id* invalid.
3329 * - (-EINVAL) if bad parameter.
3331 int rte_eth_set_vf_rate_limit(uint8_t port_id, uint16_t vf,
3332 uint16_t tx_rate, uint64_t q_msk);
3335 * Initialize bypass logic. This function needs to be called before
3336 * executing any other bypass API.
3339 * The port identifier of the Ethernet device.
3341 * - (0) if successful.
3342 * - (-ENOTSUP) if hardware doesn't support.
3343 * - (-EINVAL) if bad parameter.
3345 int rte_eth_dev_bypass_init(uint8_t port);
3348 * Return bypass state.
3351 * The port identifier of the Ethernet device.
3353 * The return bypass state.
3356 * - (3) Isolate mode
3358 * - (0) if successful.
3359 * - (-ENOTSUP) if hardware doesn't support.
3360 * - (-EINVAL) if bad parameter.
3362 int rte_eth_dev_bypass_state_show(uint8_t port, uint32_t *state);
3368 * The port identifier of the Ethernet device.
3370 * The current bypass state.
3373 * - (3) Isolate mode
3375 * - (0) if successful.
3376 * - (-ENOTSUP) if hardware doesn't support.
3377 * - (-EINVAL) if bad parameter.
3379 int rte_eth_dev_bypass_state_set(uint8_t port, uint32_t *new_state);
3382 * Return bypass state when given event occurs.
3385 * The port identifier of the Ethernet device.
3388 * - (1) Main power on (power button is pushed)
3389 * - (2) Auxiliary power on (power supply is being plugged)
3390 * - (3) Main power off (system shutdown and power supply is left plugged in)
3391 * - (4) Auxiliary power off (power supply is being unplugged)
3392 * - (5) Display or set the watchdog timer
3394 * The bypass state when given event occurred.
3397 * - (3) Isolate mode
3399 * - (0) if successful.
3400 * - (-ENOTSUP) if hardware doesn't support.
3401 * - (-EINVAL) if bad parameter.
3403 int rte_eth_dev_bypass_event_show(uint8_t port, uint32_t event, uint32_t *state);
3406 * Set bypass state when given event occurs.
3409 * The port identifier of the Ethernet device.
3412 * - (1) Main power on (power button is pushed)
3413 * - (2) Auxiliary power on (power supply is being plugged)
3414 * - (3) Main power off (system shutdown and power supply is left plugged in)
3415 * - (4) Auxiliary power off (power supply is being unplugged)
3416 * - (5) Display or set the watchdog timer
3418 * The assigned state when given event occurs.
3421 * - (3) Isolate mode
3423 * - (0) if successful.
3424 * - (-ENOTSUP) if hardware doesn't support.
3425 * - (-EINVAL) if bad parameter.
3427 int rte_eth_dev_bypass_event_store(uint8_t port, uint32_t event, uint32_t state);
3430 * Set bypass watchdog timeout count.
3433 * The port identifier of the Ethernet device.
3435 * The timeout to be set.
3436 * - (0) 0 seconds (timer is off)
3445 * - (0) if successful.
3446 * - (-ENOTSUP) if hardware doesn't support.
3447 * - (-EINVAL) if bad parameter.
3449 int rte_eth_dev_wd_timeout_store(uint8_t port, uint32_t timeout);
3452 * Get bypass firmware version.
3455 * The port identifier of the Ethernet device.
3457 * The firmware version
3459 * - (0) if successful.
3460 * - (-ENOTSUP) if hardware doesn't support.
3461 * - (-EINVAL) if bad parameter.
3463 int rte_eth_dev_bypass_ver_show(uint8_t port, uint32_t *ver);
3466 * Return bypass watchdog timeout in seconds
3469 * The port identifier of the Ethernet device.
3471 * The return watchdog timeout. "0" represents timer expired
3472 * - (0) 0 seconds (timer is off)
3481 * - (0) if successful.
3482 * - (-ENOTSUP) if hardware doesn't support.
3483 * - (-EINVAL) if bad parameter.
3485 int rte_eth_dev_bypass_wd_timeout_show(uint8_t port, uint32_t *wd_timeout);
3488 * Reset bypass watchdog timer
3491 * The port identifier of the Ethernet device.
3493 * - (0) if successful.
3494 * - (-ENOTSUP) if hardware doesn't support.
3495 * - (-EINVAL) if bad parameter.
3497 int rte_eth_dev_bypass_wd_reset(uint8_t port);
3500 * Configuration of Receive Side Scaling hash computation of Ethernet device.
3503 * The port identifier of the Ethernet device.
3505 * The new configuration to use for RSS hash computation on the port.
3507 * - (0) if successful.
3508 * - (-ENODEV) if port identifier is invalid.
3509 * - (-ENOTSUP) if hardware doesn't support.
3510 * - (-EINVAL) if bad parameter.
3512 int rte_eth_dev_rss_hash_update(uint8_t port_id,
3513 struct rte_eth_rss_conf *rss_conf);
3516 * Retrieve current configuration of Receive Side Scaling hash computation
3517 * of Ethernet device.
3520 * The port identifier of the Ethernet device.
3522 * Where to store the current RSS hash configuration of the Ethernet device.
3524 * - (0) if successful.
3525 * - (-ENODEV) if port identifier is invalid.
3526 * - (-ENOTSUP) if hardware doesn't support RSS.
3529 rte_eth_dev_rss_hash_conf_get(uint8_t port_id,
3530 struct rte_eth_rss_conf *rss_conf);
3533 * Add UDP tunneling port of an Ethernet device for filtering a specific
3534 * tunneling packet by UDP port number.
3537 * The port identifier of the Ethernet device.
3539 * UDP tunneling configuration.
3542 * - (0) if successful.
3543 * - (-ENODEV) if port identifier is invalid.
3544 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3547 rte_eth_dev_udp_tunnel_add(uint8_t port_id,
3548 struct rte_eth_udp_tunnel *tunnel_udp);
3551 * Detete UDP tunneling port configuration of Ethernet device
3554 * The port identifier of the Ethernet device.
3556 * UDP tunneling configuration.
3559 * - (0) if successful.
3560 * - (-ENODEV) if port identifier is invalid.
3561 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3564 rte_eth_dev_udp_tunnel_delete(uint8_t port_id,
3565 struct rte_eth_udp_tunnel *tunnel_udp);
3568 * Check whether the filter type is supported on an Ethernet device.
3569 * All the supported filter types are defined in 'rte_eth_ctrl.h'.
3572 * The port identifier of the Ethernet device.
3573 * @param filter_type
3576 * - (0) if successful.
3577 * - (-ENOTSUP) if hardware doesn't support this filter type.
3578 * - (-ENODEV) if *port_id* invalid.
3580 int rte_eth_dev_filter_supported(uint8_t port_id, enum rte_filter_type filter_type);
3583 * Take operations to assigned filter type on an Ethernet device.
3584 * All the supported operations and filter types are defined in 'rte_eth_ctrl.h'.
3587 * The port identifier of the Ethernet device.
3588 * @param filter_type
3591 * Type of operation.
3593 * A pointer to arguments defined specifically for the operation.
3595 * - (0) if successful.
3596 * - (-ENOTSUP) if hardware doesn't support.
3597 * - (-ENODEV) if *port_id* invalid.
3598 * - others depends on the specific operations implementation.
3600 int rte_eth_dev_filter_ctrl(uint8_t port_id, enum rte_filter_type filter_type,
3601 enum rte_filter_op filter_op, void *arg);
3604 * Add a callback to be called on packet RX on a given port and queue.
3606 * This API configures a function to be called for each burst of
3607 * packets received on a given NIC port queue. The return value is a pointer
3608 * that can be used to later remove the callback using
3609 * rte_eth_remove_rx_callback().
3611 * Multiple functions are called in the order that they are added.
3614 * The port identifier of the Ethernet device.
3616 * The queue on the Ethernet device on which the callback is to be added.
3618 * The callback function
3620 * A generic pointer parameter which will be passed to each invocation of the
3621 * callback function on this port and queue.
3625 * On success, a pointer value which can later be used to remove the callback.
3627 void *rte_eth_add_rx_callback(uint8_t port_id, uint16_t queue_id,
3628 rte_rx_callback_fn fn, void *user_param);
3631 * Add a callback to be called on packet TX on a given port and queue.
3633 * This API configures a function to be called for each burst of
3634 * packets sent on a given NIC port queue. The return value is a pointer
3635 * that can be used to later remove the callback using
3636 * rte_eth_remove_tx_callback().
3638 * Multiple functions are called in the order that they are added.
3641 * The port identifier of the Ethernet device.
3643 * The queue on the Ethernet device on which the callback is to be added.
3645 * The callback function
3647 * A generic pointer parameter which will be passed to each invocation of the
3648 * callback function on this port and queue.
3652 * On success, a pointer value which can later be used to remove the callback.
3654 void *rte_eth_add_tx_callback(uint8_t port_id, uint16_t queue_id,
3655 rte_tx_callback_fn fn, void *user_param);
3658 * Remove an RX packet callback from a given port and queue.
3660 * This function is used to removed callbacks that were added to a NIC port
3661 * queue using rte_eth_add_rx_callback().
3663 * Note: the callback is removed from the callback list but it isn't freed
3664 * since the it may still be in use. The memory for the callback can be
3665 * subsequently freed back by the application by calling rte_free():
3667 * - Immediately - if the port is stopped, or the user knows that no
3668 * callbacks are in flight e.g. if called from the thread doing RX/TX
3671 * - After a short delay - where the delay is sufficient to allow any
3672 * in-flight callbacks to complete.
3675 * The port identifier of the Ethernet device.
3677 * The queue on the Ethernet device from which the callback is to be removed.
3679 * User supplied callback created via rte_eth_add_rx_callback().
3682 * - 0: Success. Callback was removed.
3683 * - -ENOTSUP: Callback support is not available.
3684 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
3685 * is NULL or not found for the port/queue.
3687 int rte_eth_remove_rx_callback(uint8_t port_id, uint16_t queue_id,
3688 struct rte_eth_rxtx_callback *user_cb);
3691 * Remove a TX packet callback from a given port and queue.
3693 * This function is used to removed callbacks that were added to a NIC port
3694 * queue using rte_eth_add_tx_callback().
3696 * Note: the callback is removed from the callback list but it isn't freed
3697 * since the it may still be in use. The memory for the callback can be
3698 * subsequently freed back by the application by calling rte_free():
3700 * - Immediately - if the port is stopped, or the user knows that no
3701 * callbacks are in flight e.g. if called from the thread doing RX/TX
3704 * - After a short delay - where the delay is sufficient to allow any
3705 * in-flight callbacks to complete.
3708 * The port identifier of the Ethernet device.
3710 * The queue on the Ethernet device from which the callback is to be removed.
3712 * User supplied callback created via rte_eth_add_tx_callback().
3715 * - 0: Success. Callback was removed.
3716 * - -ENOTSUP: Callback support is not available.
3717 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
3718 * is NULL or not found for the port/queue.
3720 int rte_eth_remove_tx_callback(uint8_t port_id, uint16_t queue_id,
3721 struct rte_eth_rxtx_callback *user_cb);
3724 * Retrieve number of available registers for access
3727 * The port identifier of the Ethernet device.
3729 * - (>=0) number of registers if successful.
3730 * - (-ENOTSUP) if hardware doesn't support.
3731 * - (-ENODEV) if *port_id* invalid.
3732 * - others depends on the specific operations implementation.
3734 int rte_eth_dev_get_reg_length(uint8_t port_id);
3737 * Retrieve device registers and register attributes
3740 * The port identifier of the Ethernet device.
3742 * The template includes buffer for register data and attribute to be filled.
3744 * - (0) if successful.
3745 * - (-ENOTSUP) if hardware doesn't support.
3746 * - (-ENODEV) if *port_id* invalid.
3747 * - others depends on the specific operations implementation.
3749 int rte_eth_dev_get_reg_info(uint8_t port_id, struct rte_dev_reg_info *info);
3752 * Retrieve size of device EEPROM
3755 * The port identifier of the Ethernet device.
3757 * - (>=0) EEPROM size if successful.
3758 * - (-ENOTSUP) if hardware doesn't support.
3759 * - (-ENODEV) if *port_id* invalid.
3760 * - others depends on the specific operations implementation.
3762 int rte_eth_dev_get_eeprom_length(uint8_t port_id);
3765 * Retrieve EEPROM and EEPROM attribute
3768 * The port identifier of the Ethernet device.
3770 * The template includes buffer for return EEPROM data and
3771 * EEPROM attributes to be filled.
3773 * - (0) if successful.
3774 * - (-ENOTSUP) if hardware doesn't support.
3775 * - (-ENODEV) if *port_id* invalid.
3776 * - others depends on the specific operations implementation.
3778 int rte_eth_dev_get_eeprom(uint8_t port_id, struct rte_dev_eeprom_info *info);
3781 * Program EEPROM with provided data
3784 * The port identifier of the Ethernet device.
3786 * The template includes EEPROM data for programming and
3787 * EEPROM attributes to be filled
3789 * - (0) if successful.
3790 * - (-ENOTSUP) if hardware doesn't support.
3791 * - (-ENODEV) if *port_id* invalid.
3792 * - others depends on the specific operations implementation.
3794 int rte_eth_dev_set_eeprom(uint8_t port_id, struct rte_dev_eeprom_info *info);
3797 * Set the list of multicast addresses to filter on an Ethernet device.
3800 * The port identifier of the Ethernet device.
3801 * @param mc_addr_set
3802 * The array of multicast addresses to set. Equal to NULL when the function
3803 * is invoked to flush the set of filtered addresses.
3805 * The number of multicast addresses in the *mc_addr_set* array. Equal to 0
3806 * when the function is invoked to flush the set of filtered addresses.
3808 * - (0) if successful.
3809 * - (-ENODEV) if *port_id* invalid.
3810 * - (-ENOTSUP) if PMD of *port_id* doesn't support multicast filtering.
3811 * - (-ENOSPC) if *port_id* has not enough multicast filtering resources.
3813 int rte_eth_dev_set_mc_addr_list(uint8_t port_id,
3814 struct ether_addr *mc_addr_set,
3815 uint32_t nb_mc_addr);
3818 * Enable IEEE1588/802.1AS timestamping for an Ethernet device.
3821 * The port identifier of the Ethernet device.
3825 * - -ENODEV: The port ID is invalid.
3826 * - -ENOTSUP: The function is not supported by the Ethernet driver.
3828 extern int rte_eth_timesync_enable(uint8_t port_id);
3831 * Disable IEEE1588/802.1AS timestamping for an Ethernet device.
3834 * The port identifier of the Ethernet device.
3838 * - -ENODEV: The port ID is invalid.
3839 * - -ENOTSUP: The function is not supported by the Ethernet driver.
3841 extern int rte_eth_timesync_disable(uint8_t port_id);
3844 * Read an IEEE1588/802.1AS RX timestamp from an Ethernet device.
3847 * The port identifier of the Ethernet device.
3849 * Pointer to the timestamp struct.
3851 * Device specific flags. Used to pass the RX timesync register index to
3852 * i40e. Unused in igb/ixgbe, pass 0 instead.
3856 * - -EINVAL: No timestamp is available.
3857 * - -ENODEV: The port ID is invalid.
3858 * - -ENOTSUP: The function is not supported by the Ethernet driver.
3860 extern int rte_eth_timesync_read_rx_timestamp(uint8_t port_id,
3861 struct timespec *timestamp,
3865 * Read an IEEE1588/802.1AS TX timestamp from an Ethernet device.
3868 * The port identifier of the Ethernet device.
3870 * Pointer to the timestamp struct.
3874 * - -EINVAL: No timestamp is available.
3875 * - -ENODEV: The port ID is invalid.
3876 * - -ENOTSUP: The function is not supported by the Ethernet driver.
3878 extern int rte_eth_timesync_read_tx_timestamp(uint8_t port_id,
3879 struct timespec *timestamp);
3885 #endif /* _RTE_ETHDEV_H_ */