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 */
849 /** enable/disable rxq interrupt. 0 (default) - disable, 1 enable */
855 * A structure used to configure an Ethernet port.
856 * Depending upon the RX multi-queue mode, extra advanced
857 * configuration settings may be needed.
859 struct rte_eth_conf {
861 /**< ETH_LINK_SPEED_10[0|00|000], or 0 for autonegotation */
862 uint16_t link_duplex;
863 /**< ETH_LINK_[HALF_DUPLEX|FULL_DUPLEX], or 0 for autonegotation */
864 struct rte_eth_rxmode rxmode; /**< Port RX configuration. */
865 struct rte_eth_txmode txmode; /**< Port TX configuration. */
866 uint32_t lpbk_mode; /**< Loopback operation mode. By default the value
867 is 0, meaning the loopback mode is disabled.
868 Read the datasheet of given ethernet controller
869 for details. The possible values of this field
870 are defined in implementation of each driver. */
872 struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
873 struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
874 /**< Port vmdq+dcb configuration. */
875 struct rte_eth_dcb_rx_conf dcb_rx_conf;
876 /**< Port dcb RX configuration. */
877 struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
878 /**< Port vmdq RX configuration. */
879 } rx_adv_conf; /**< Port RX filtering configuration (union). */
881 struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
882 /**< Port vmdq+dcb TX configuration. */
883 struct rte_eth_dcb_tx_conf dcb_tx_conf;
884 /**< Port dcb TX configuration. */
885 struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
886 /**< Port vmdq TX configuration. */
887 } tx_adv_conf; /**< Port TX DCB configuration (union). */
888 /** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
889 is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
890 uint32_t dcb_capability_en;
891 struct rte_fdir_conf fdir_conf; /**< FDIR configuration. */
892 struct rte_intr_conf intr_conf; /**< Interrupt mode configuration. */
896 * A structure used to retrieve the contextual information of
897 * an Ethernet device, such as the controlling driver of the device,
898 * its PCI context, etc...
902 * RX offload capabilities of a device.
904 #define DEV_RX_OFFLOAD_VLAN_STRIP 0x00000001
905 #define DEV_RX_OFFLOAD_IPV4_CKSUM 0x00000002
906 #define DEV_RX_OFFLOAD_UDP_CKSUM 0x00000004
907 #define DEV_RX_OFFLOAD_TCP_CKSUM 0x00000008
908 #define DEV_RX_OFFLOAD_TCP_LRO 0x00000010
909 #define DEV_RX_OFFLOAD_QINQ_STRIP 0x00000020
912 * TX offload capabilities of a device.
914 #define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001
915 #define DEV_TX_OFFLOAD_IPV4_CKSUM 0x00000002
916 #define DEV_TX_OFFLOAD_UDP_CKSUM 0x00000004
917 #define DEV_TX_OFFLOAD_TCP_CKSUM 0x00000008
918 #define DEV_TX_OFFLOAD_SCTP_CKSUM 0x00000010
919 #define DEV_TX_OFFLOAD_TCP_TSO 0x00000020
920 #define DEV_TX_OFFLOAD_UDP_TSO 0x00000040
921 #define DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000080 /**< Used for tunneling packet. */
922 #define DEV_TX_OFFLOAD_QINQ_INSERT 0x00000100
924 struct rte_eth_dev_info {
925 struct rte_pci_device *pci_dev; /**< Device PCI information. */
926 const char *driver_name; /**< Device Driver name. */
927 unsigned int if_index; /**< Index to bound host interface, or 0 if none.
928 Use if_indextoname() to translate into an interface name. */
929 uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
930 uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
931 uint16_t max_rx_queues; /**< Maximum number of RX queues. */
932 uint16_t max_tx_queues; /**< Maximum number of TX queues. */
933 uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
934 uint32_t max_hash_mac_addrs;
935 /** Maximum number of hash MAC addresses for MTA and UTA. */
936 uint16_t max_vfs; /**< Maximum number of VFs. */
937 uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
938 uint32_t rx_offload_capa; /**< Device RX offload capabilities. */
939 uint32_t tx_offload_capa; /**< Device TX offload capabilities. */
941 /**< Device redirection table size, the total number of entries. */
942 uint8_t hash_key_size; /**< Hash key size in bytes */
943 /** Bit mask of RSS offloads, the bit offset also means flow type */
944 uint64_t flow_type_rss_offloads;
945 struct rte_eth_rxconf default_rxconf; /**< Default RX configuration */
946 struct rte_eth_txconf default_txconf; /**< Default TX configuration */
947 uint16_t vmdq_queue_base; /**< First queue ID for VMDQ pools. */
948 uint16_t vmdq_queue_num; /**< Queue number for VMDQ pools. */
949 uint16_t vmdq_pool_base; /**< First ID of VMDQ pools. */
952 /** Maximum name length for extended statistics counters */
953 #define RTE_ETH_XSTATS_NAME_SIZE 64
956 * An Ethernet device extended statistic structure
958 * This structure is used by ethdev->eth_xstats_get() to provide
959 * statistics that are not provided in the generic rte_eth_stats
962 struct rte_eth_xstats {
963 char name[RTE_ETH_XSTATS_NAME_SIZE];
969 struct rte_eth_dev_callback;
970 /** @internal Structure to keep track of registered callbacks */
971 TAILQ_HEAD(rte_eth_dev_cb_list, rte_eth_dev_callback);
974 * Definitions of all functions exported by an Ethernet driver through the
975 * the generic structure of type *eth_dev_ops* supplied in the *rte_eth_dev*
976 * structure associated with an Ethernet device.
979 typedef int (*eth_dev_configure_t)(struct rte_eth_dev *dev);
980 /**< @internal Ethernet device configuration. */
982 typedef int (*eth_dev_start_t)(struct rte_eth_dev *dev);
983 /**< @internal Function used to start a configured Ethernet device. */
985 typedef void (*eth_dev_stop_t)(struct rte_eth_dev *dev);
986 /**< @internal Function used to stop a configured Ethernet device. */
988 typedef int (*eth_dev_set_link_up_t)(struct rte_eth_dev *dev);
989 /**< @internal Function used to link up a configured Ethernet device. */
991 typedef int (*eth_dev_set_link_down_t)(struct rte_eth_dev *dev);
992 /**< @internal Function used to link down a configured Ethernet device. */
994 typedef void (*eth_dev_close_t)(struct rte_eth_dev *dev);
995 /**< @internal Function used to close a configured Ethernet device. */
997 typedef void (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev);
998 /**< @internal Function used to enable the RX promiscuous mode of an Ethernet device. */
1000 typedef void (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev);
1001 /**< @internal Function used to disable the RX promiscuous mode of an Ethernet device. */
1003 typedef void (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
1004 /**< @internal Enable the receipt of all multicast packets by an Ethernet device. */
1006 typedef void (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
1007 /**< @internal Disable the receipt of all multicast packets by an Ethernet device. */
1009 typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
1010 int wait_to_complete);
1011 /**< @internal Get link speed, duplex mode and state (up/down) of an Ethernet device. */
1013 typedef void (*eth_stats_get_t)(struct rte_eth_dev *dev,
1014 struct rte_eth_stats *igb_stats);
1015 /**< @internal Get global I/O statistics of an Ethernet device. */
1017 typedef void (*eth_stats_reset_t)(struct rte_eth_dev *dev);
1018 /**< @internal Reset global I/O statistics of an Ethernet device to 0. */
1020 typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev,
1021 struct rte_eth_xstats *stats, unsigned n);
1022 /**< @internal Get extended stats of an Ethernet device. */
1024 typedef void (*eth_xstats_reset_t)(struct rte_eth_dev *dev);
1025 /**< @internal Reset extended stats of an Ethernet device. */
1027 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
1031 /**< @internal Set a queue statistics mapping for a tx/rx queue of an Ethernet device. */
1033 typedef void (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
1034 struct rte_eth_dev_info *dev_info);
1035 /**< @internal Get specific informations of an Ethernet device. */
1037 typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
1039 /**< @internal Start rx and tx of a queue of an Ethernet device. */
1041 typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
1043 /**< @internal Stop rx and tx of a queue of an Ethernet device. */
1045 typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
1046 uint16_t rx_queue_id,
1047 uint16_t nb_rx_desc,
1048 unsigned int socket_id,
1049 const struct rte_eth_rxconf *rx_conf,
1050 struct rte_mempool *mb_pool);
1051 /**< @internal Set up a receive queue of an Ethernet device. */
1053 typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
1054 uint16_t tx_queue_id,
1055 uint16_t nb_tx_desc,
1056 unsigned int socket_id,
1057 const struct rte_eth_txconf *tx_conf);
1058 /**< @internal Setup a transmit queue of an Ethernet device. */
1060 typedef int (*eth_rx_enable_intr_t)(struct rte_eth_dev *dev,
1061 uint16_t rx_queue_id);
1062 /**< @internal Enable interrupt of a receive queue of an Ethernet device. */
1064 typedef int (*eth_rx_disable_intr_t)(struct rte_eth_dev *dev,
1065 uint16_t rx_queue_id);
1066 /**< @internal Disable interrupt of a receive queue of an Ethernet device. */
1068 typedef void (*eth_queue_release_t)(void *queue);
1069 /**< @internal Release memory resources allocated by given RX/TX queue. */
1071 typedef uint32_t (*eth_rx_queue_count_t)(struct rte_eth_dev *dev,
1072 uint16_t rx_queue_id);
1073 /**< @internal Get number of available descriptors on a receive queue of an Ethernet device. */
1075 typedef int (*eth_rx_descriptor_done_t)(void *rxq, uint16_t offset);
1076 /**< @internal Check DD bit of specific RX descriptor */
1078 typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);
1079 /**< @internal Set MTU. */
1081 typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
1084 /**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */
1086 typedef void (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
1088 /**< @internal set the outer VLAN-TPID by an Ethernet device. */
1090 typedef void (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
1091 /**< @internal set VLAN offload function by an Ethernet device. */
1093 typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
1096 /**< @internal set port based TX VLAN insertion by an Ethernet device. */
1098 typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
1099 uint16_t rx_queue_id,
1101 /**< @internal VLAN stripping enable/disable by an queue of Ethernet device. */
1103 typedef uint16_t (*eth_rx_burst_t)(void *rxq,
1104 struct rte_mbuf **rx_pkts,
1106 /**< @internal Retrieve input packets from a receive queue of an Ethernet device. */
1108 typedef uint16_t (*eth_tx_burst_t)(void *txq,
1109 struct rte_mbuf **tx_pkts,
1111 /**< @internal Send output packets on a transmit queue of an Ethernet device. */
1113 typedef int (*fdir_add_signature_filter_t)(struct rte_eth_dev *dev,
1114 struct rte_fdir_filter *fdir_ftr,
1116 /**< @internal Setup a new signature filter rule on an Ethernet device */
1118 typedef int (*fdir_update_signature_filter_t)(struct rte_eth_dev *dev,
1119 struct rte_fdir_filter *fdir_ftr,
1121 /**< @internal Update a signature filter rule on an Ethernet device */
1123 typedef int (*fdir_remove_signature_filter_t)(struct rte_eth_dev *dev,
1124 struct rte_fdir_filter *fdir_ftr);
1125 /**< @internal Remove a signature filter rule on an Ethernet device */
1127 typedef void (*fdir_infos_get_t)(struct rte_eth_dev *dev,
1128 struct rte_eth_fdir *fdir);
1129 /**< @internal Get information about fdir status */
1131 typedef int (*fdir_add_perfect_filter_t)(struct rte_eth_dev *dev,
1132 struct rte_fdir_filter *fdir_ftr,
1133 uint16_t soft_id, uint8_t rx_queue,
1135 /**< @internal Setup a new perfect filter rule on an Ethernet device */
1137 typedef int (*fdir_update_perfect_filter_t)(struct rte_eth_dev *dev,
1138 struct rte_fdir_filter *fdir_ftr,
1139 uint16_t soft_id, uint8_t rx_queue,
1141 /**< @internal Update a perfect filter rule on an Ethernet device */
1143 typedef int (*fdir_remove_perfect_filter_t)(struct rte_eth_dev *dev,
1144 struct rte_fdir_filter *fdir_ftr,
1146 /**< @internal Remove a perfect filter rule on an Ethernet device */
1148 typedef int (*fdir_set_masks_t)(struct rte_eth_dev *dev,
1149 struct rte_fdir_masks *fdir_masks);
1150 /**< @internal Setup flow director masks on an Ethernet device */
1152 typedef int (*flow_ctrl_get_t)(struct rte_eth_dev *dev,
1153 struct rte_eth_fc_conf *fc_conf);
1154 /**< @internal Get current flow control parameter on an Ethernet device */
1156 typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
1157 struct rte_eth_fc_conf *fc_conf);
1158 /**< @internal Setup flow control parameter on an Ethernet device */
1160 typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
1161 struct rte_eth_pfc_conf *pfc_conf);
1162 /**< @internal Setup priority flow control parameter on an Ethernet device */
1164 typedef int (*reta_update_t)(struct rte_eth_dev *dev,
1165 struct rte_eth_rss_reta_entry64 *reta_conf,
1166 uint16_t reta_size);
1167 /**< @internal Update RSS redirection table on an Ethernet device */
1169 typedef int (*reta_query_t)(struct rte_eth_dev *dev,
1170 struct rte_eth_rss_reta_entry64 *reta_conf,
1171 uint16_t reta_size);
1172 /**< @internal Query RSS redirection table on an Ethernet device */
1174 typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
1175 struct rte_eth_rss_conf *rss_conf);
1176 /**< @internal Update RSS hash configuration of an Ethernet device */
1178 typedef int (*rss_hash_conf_get_t)(struct rte_eth_dev *dev,
1179 struct rte_eth_rss_conf *rss_conf);
1180 /**< @internal Get current RSS hash configuration of an Ethernet device */
1182 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
1183 /**< @internal Turn on SW controllable LED on an Ethernet device */
1185 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
1186 /**< @internal Turn off SW controllable LED on an Ethernet device */
1188 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
1189 /**< @internal Remove MAC address from receive address register */
1191 typedef void (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
1192 struct ether_addr *mac_addr,
1195 /**< @internal Set a MAC address into Receive Address Address Register */
1197 typedef void (*eth_mac_addr_set_t)(struct rte_eth_dev *dev,
1198 struct ether_addr *mac_addr);
1199 /**< @internal Set a MAC address into Receive Address Address Register */
1201 typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
1202 struct ether_addr *mac_addr,
1204 /**< @internal Set a Unicast Hash bitmap */
1206 typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
1208 /**< @internal Set all Unicast Hash bitmap */
1210 typedef int (*eth_set_vf_rx_mode_t)(struct rte_eth_dev *dev,
1214 /**< @internal Set a VF receive mode */
1216 typedef int (*eth_set_vf_rx_t)(struct rte_eth_dev *dev,
1219 /**< @internal Set a VF receive mode */
1221 typedef int (*eth_set_vf_tx_t)(struct rte_eth_dev *dev,
1224 /**< @internal Enable or disable a VF transmit */
1226 typedef int (*eth_set_vf_vlan_filter_t)(struct rte_eth_dev *dev,
1230 /**< @internal Set VF VLAN pool filter */
1232 typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
1235 /**< @internal Set queue TX rate */
1237 typedef int (*eth_set_vf_rate_limit_t)(struct rte_eth_dev *dev,
1241 /**< @internal Set VF TX rate */
1243 typedef int (*eth_mirror_rule_set_t)(struct rte_eth_dev *dev,
1244 struct rte_eth_mirror_conf *mirror_conf,
1247 /**< @internal Add a traffic mirroring rule on an Ethernet device */
1249 typedef int (*eth_mirror_rule_reset_t)(struct rte_eth_dev *dev,
1251 /**< @internal Remove a traffic mirroring rule on an Ethernet device */
1253 typedef int (*eth_udp_tunnel_add_t)(struct rte_eth_dev *dev,
1254 struct rte_eth_udp_tunnel *tunnel_udp);
1255 /**< @internal Add tunneling UDP info */
1257 typedef int (*eth_udp_tunnel_del_t)(struct rte_eth_dev *dev,
1258 struct rte_eth_udp_tunnel *tunnel_udp);
1259 /**< @internal Delete tunneling UDP info */
1261 typedef int (*eth_set_mc_addr_list_t)(struct rte_eth_dev *dev,
1262 struct ether_addr *mc_addr_set,
1263 uint32_t nb_mc_addr);
1264 /**< @internal set the list of multicast addresses on an Ethernet device */
1266 typedef int (*eth_timesync_enable_t)(struct rte_eth_dev *dev);
1267 /**< @internal Function used to enable IEEE1588/802.1AS timestamping. */
1269 typedef int (*eth_timesync_disable_t)(struct rte_eth_dev *dev);
1270 /**< @internal Function used to disable IEEE1588/802.1AS timestamping. */
1272 typedef int (*eth_timesync_read_rx_timestamp_t)(struct rte_eth_dev *dev,
1273 struct timespec *timestamp,
1275 /**< @internal Function used to read an RX IEEE1588/802.1AS timestamp. */
1277 typedef int (*eth_timesync_read_tx_timestamp_t)(struct rte_eth_dev *dev,
1278 struct timespec *timestamp);
1279 /**< @internal Function used to read a TX IEEE1588/802.1AS timestamp. */
1281 typedef int (*eth_get_reg_length_t)(struct rte_eth_dev *dev);
1282 /**< @internal Retrieve device register count */
1284 typedef int (*eth_get_reg_t)(struct rte_eth_dev *dev,
1285 struct rte_dev_reg_info *info);
1286 /**< @internal Retrieve registers */
1288 typedef int (*eth_get_eeprom_length_t)(struct rte_eth_dev *dev);
1289 /**< @internal Retrieve eeprom size */
1291 typedef int (*eth_get_eeprom_t)(struct rte_eth_dev *dev,
1292 struct rte_dev_eeprom_info *info);
1293 /**< @internal Retrieve eeprom data */
1295 typedef int (*eth_set_eeprom_t)(struct rte_eth_dev *dev,
1296 struct rte_dev_eeprom_info *info);
1297 /**< @internal Program eeprom data */
1299 #ifdef RTE_NIC_BYPASS
1302 RTE_BYPASS_MODE_NONE,
1303 RTE_BYPASS_MODE_NORMAL,
1304 RTE_BYPASS_MODE_BYPASS,
1305 RTE_BYPASS_MODE_ISOLATE,
1306 RTE_BYPASS_MODE_NUM,
1309 #define RTE_BYPASS_MODE_VALID(x) \
1310 ((x) > RTE_BYPASS_MODE_NONE && (x) < RTE_BYPASS_MODE_NUM)
1313 RTE_BYPASS_EVENT_NONE,
1314 RTE_BYPASS_EVENT_START,
1315 RTE_BYPASS_EVENT_OS_ON = RTE_BYPASS_EVENT_START,
1316 RTE_BYPASS_EVENT_POWER_ON,
1317 RTE_BYPASS_EVENT_OS_OFF,
1318 RTE_BYPASS_EVENT_POWER_OFF,
1319 RTE_BYPASS_EVENT_TIMEOUT,
1320 RTE_BYPASS_EVENT_NUM
1323 #define RTE_BYPASS_EVENT_VALID(x) \
1324 ((x) > RTE_BYPASS_EVENT_NONE && (x) < RTE_BYPASS_MODE_NUM)
1327 RTE_BYPASS_TMT_OFF, /* timeout disabled. */
1328 RTE_BYPASS_TMT_1_5_SEC, /* timeout for 1.5 seconds */
1329 RTE_BYPASS_TMT_2_SEC, /* timeout for 2 seconds */
1330 RTE_BYPASS_TMT_3_SEC, /* timeout for 3 seconds */
1331 RTE_BYPASS_TMT_4_SEC, /* timeout for 4 seconds */
1332 RTE_BYPASS_TMT_8_SEC, /* timeout for 8 seconds */
1333 RTE_BYPASS_TMT_16_SEC, /* timeout for 16 seconds */
1334 RTE_BYPASS_TMT_32_SEC, /* timeout for 32 seconds */
1338 #define RTE_BYPASS_TMT_VALID(x) \
1339 ((x) == RTE_BYPASS_TMT_OFF || \
1340 ((x) > RTE_BYPASS_TMT_OFF && (x) < RTE_BYPASS_TMT_NUM))
1342 typedef void (*bypass_init_t)(struct rte_eth_dev *dev);
1343 typedef int32_t (*bypass_state_set_t)(struct rte_eth_dev *dev, uint32_t *new_state);
1344 typedef int32_t (*bypass_state_show_t)(struct rte_eth_dev *dev, uint32_t *state);
1345 typedef int32_t (*bypass_event_set_t)(struct rte_eth_dev *dev, uint32_t state, uint32_t event);
1346 typedef int32_t (*bypass_event_show_t)(struct rte_eth_dev *dev, uint32_t event_shift, uint32_t *event);
1347 typedef int32_t (*bypass_wd_timeout_set_t)(struct rte_eth_dev *dev, uint32_t timeout);
1348 typedef int32_t (*bypass_wd_timeout_show_t)(struct rte_eth_dev *dev, uint32_t *wd_timeout);
1349 typedef int32_t (*bypass_ver_show_t)(struct rte_eth_dev *dev, uint32_t *ver);
1350 typedef int32_t (*bypass_wd_reset_t)(struct rte_eth_dev *dev);
1353 typedef int (*eth_filter_ctrl_t)(struct rte_eth_dev *dev,
1354 enum rte_filter_type filter_type,
1355 enum rte_filter_op filter_op,
1357 /**< @internal Take operations to assigned filter type on an Ethernet device */
1360 * @internal A structure containing the functions exported by an Ethernet driver.
1362 struct eth_dev_ops {
1363 eth_dev_configure_t dev_configure; /**< Configure device. */
1364 eth_dev_start_t dev_start; /**< Start device. */
1365 eth_dev_stop_t dev_stop; /**< Stop device. */
1366 eth_dev_set_link_up_t dev_set_link_up; /**< Device link up. */
1367 eth_dev_set_link_down_t dev_set_link_down; /**< Device link down. */
1368 eth_dev_close_t dev_close; /**< Close device. */
1369 eth_promiscuous_enable_t promiscuous_enable; /**< Promiscuous ON. */
1370 eth_promiscuous_disable_t promiscuous_disable;/**< Promiscuous OFF. */
1371 eth_allmulticast_enable_t allmulticast_enable;/**< RX multicast ON. */
1372 eth_allmulticast_disable_t allmulticast_disable;/**< RX multicast OF. */
1373 eth_link_update_t link_update; /**< Get device link state. */
1374 eth_stats_get_t stats_get; /**< Get generic device statistics. */
1375 eth_stats_reset_t stats_reset; /**< Reset generic device statistics. */
1376 eth_xstats_get_t xstats_get; /**< Get extended device statistics. */
1377 eth_xstats_reset_t xstats_reset; /**< Reset extended device statistics. */
1378 eth_queue_stats_mapping_set_t queue_stats_mapping_set;
1379 /**< Configure per queue stat counter mapping. */
1380 eth_dev_infos_get_t dev_infos_get; /**< Get device info. */
1381 mtu_set_t mtu_set; /**< Set MTU. */
1382 vlan_filter_set_t vlan_filter_set; /**< Filter VLAN Setup. */
1383 vlan_tpid_set_t vlan_tpid_set; /**< Outer VLAN TPID Setup. */
1384 vlan_strip_queue_set_t vlan_strip_queue_set; /**< VLAN Stripping on queue. */
1385 vlan_offload_set_t vlan_offload_set; /**< Set VLAN Offload. */
1386 vlan_pvid_set_t vlan_pvid_set; /**< Set port based TX VLAN insertion */
1387 eth_queue_start_t rx_queue_start;/**< Start RX for a queue.*/
1388 eth_queue_stop_t rx_queue_stop;/**< Stop RX for a queue.*/
1389 eth_queue_start_t tx_queue_start;/**< Start TX for a queue.*/
1390 eth_queue_stop_t tx_queue_stop;/**< Stop TX for a queue.*/
1391 eth_rx_queue_setup_t rx_queue_setup;/**< Set up device RX queue.*/
1392 eth_queue_release_t rx_queue_release;/**< Release RX queue.*/
1393 eth_rx_queue_count_t rx_queue_count; /**< Get Rx queue count. */
1394 eth_rx_descriptor_done_t rx_descriptor_done; /**< Check rxd DD bit */
1396 /**< Enable Rx queue interrupt. */
1397 eth_rx_enable_intr_t rx_queue_intr_enable;
1398 /**< Disable Rx queue interrupt.*/
1399 eth_rx_disable_intr_t rx_queue_intr_disable;
1401 eth_tx_queue_setup_t tx_queue_setup;/**< Set up device TX queue.*/
1402 eth_queue_release_t tx_queue_release;/**< Release TX queue.*/
1403 eth_dev_led_on_t dev_led_on; /**< Turn on LED. */
1404 eth_dev_led_off_t dev_led_off; /**< Turn off LED. */
1405 flow_ctrl_get_t flow_ctrl_get; /**< Get flow control. */
1406 flow_ctrl_set_t flow_ctrl_set; /**< Setup flow control. */
1407 priority_flow_ctrl_set_t priority_flow_ctrl_set; /**< Setup priority flow control.*/
1408 eth_mac_addr_remove_t mac_addr_remove; /**< Remove MAC address */
1409 eth_mac_addr_add_t mac_addr_add; /**< Add a MAC address */
1410 eth_mac_addr_set_t mac_addr_set; /**< Set a MAC address */
1411 eth_uc_hash_table_set_t uc_hash_table_set; /**< Set Unicast Table Array */
1412 eth_uc_all_hash_table_set_t uc_all_hash_table_set; /**< Set Unicast hash bitmap */
1413 eth_mirror_rule_set_t mirror_rule_set; /**< Add a traffic mirror rule.*/
1414 eth_mirror_rule_reset_t mirror_rule_reset; /**< reset a traffic mirror rule.*/
1415 eth_set_vf_rx_mode_t set_vf_rx_mode; /**< Set VF RX mode */
1416 eth_set_vf_rx_t set_vf_rx; /**< enable/disable a VF receive */
1417 eth_set_vf_tx_t set_vf_tx; /**< enable/disable a VF transmit */
1418 eth_set_vf_vlan_filter_t set_vf_vlan_filter; /**< Set VF VLAN filter */
1419 eth_udp_tunnel_add_t udp_tunnel_add;
1420 eth_udp_tunnel_del_t udp_tunnel_del;
1421 eth_set_queue_rate_limit_t set_queue_rate_limit; /**< Set queue rate limit */
1422 eth_set_vf_rate_limit_t set_vf_rate_limit; /**< Set VF rate limit */
1424 /** Add a signature filter. */
1425 fdir_add_signature_filter_t fdir_add_signature_filter;
1426 /** Update a signature filter. */
1427 fdir_update_signature_filter_t fdir_update_signature_filter;
1428 /** Remove a signature filter. */
1429 fdir_remove_signature_filter_t fdir_remove_signature_filter;
1430 /** Get information about FDIR status. */
1431 fdir_infos_get_t fdir_infos_get;
1432 /** Add a perfect filter. */
1433 fdir_add_perfect_filter_t fdir_add_perfect_filter;
1434 /** Update a perfect filter. */
1435 fdir_update_perfect_filter_t fdir_update_perfect_filter;
1436 /** Remove a perfect filter. */
1437 fdir_remove_perfect_filter_t fdir_remove_perfect_filter;
1438 /** Setup masks for FDIR filtering. */
1439 fdir_set_masks_t fdir_set_masks;
1440 /** Update redirection table. */
1441 reta_update_t reta_update;
1442 /** Query redirection table. */
1443 reta_query_t reta_query;
1445 eth_get_reg_length_t get_reg_length;
1446 /**< Get # of registers */
1447 eth_get_reg_t get_reg;
1448 /**< Get registers */
1449 eth_get_eeprom_length_t get_eeprom_length;
1450 /**< Get eeprom length */
1451 eth_get_eeprom_t get_eeprom;
1452 /**< Get eeprom data */
1453 eth_set_eeprom_t set_eeprom;
1455 /* bypass control */
1456 #ifdef RTE_NIC_BYPASS
1457 bypass_init_t bypass_init;
1458 bypass_state_set_t bypass_state_set;
1459 bypass_state_show_t bypass_state_show;
1460 bypass_event_set_t bypass_event_set;
1461 bypass_event_show_t bypass_event_show;
1462 bypass_wd_timeout_set_t bypass_wd_timeout_set;
1463 bypass_wd_timeout_show_t bypass_wd_timeout_show;
1464 bypass_ver_show_t bypass_ver_show;
1465 bypass_wd_reset_t bypass_wd_reset;
1468 /** Configure RSS hash protocols. */
1469 rss_hash_update_t rss_hash_update;
1470 /** Get current RSS hash configuration. */
1471 rss_hash_conf_get_t rss_hash_conf_get;
1472 eth_filter_ctrl_t filter_ctrl; /**< common filter control*/
1473 eth_set_mc_addr_list_t set_mc_addr_list; /**< set list of mcast addrs */
1475 /** Turn IEEE1588/802.1AS timestamping on. */
1476 eth_timesync_enable_t timesync_enable;
1477 /** Turn IEEE1588/802.1AS timestamping off. */
1478 eth_timesync_disable_t timesync_disable;
1479 /** Read the IEEE1588/802.1AS RX timestamp. */
1480 eth_timesync_read_rx_timestamp_t timesync_read_rx_timestamp;
1481 /** Read the IEEE1588/802.1AS TX timestamp. */
1482 eth_timesync_read_tx_timestamp_t timesync_read_tx_timestamp;
1486 * Function type used for RX packet processing packet callbacks.
1488 * The callback function is called on RX with a burst of packets that have
1489 * been received on the given port and queue.
1492 * The Ethernet port on which RX is being performed.
1494 * The queue on the Ethernet port which is being used to receive the packets.
1496 * The burst of packets that have just been received.
1498 * The number of packets in the burst pointed to by "pkts".
1500 * The max number of packets that can be stored in the "pkts" array.
1502 * The arbitrary user parameter passed in by the application when the callback
1503 * was originally configured.
1505 * The number of packets returned to the user.
1507 typedef uint16_t (*rte_rx_callback_fn)(uint8_t port, uint16_t queue,
1508 struct rte_mbuf *pkts[], uint16_t nb_pkts, uint16_t max_pkts,
1512 * Function type used for TX packet processing packet callbacks.
1514 * The callback function is called on TX with a burst of packets immediately
1515 * before the packets are put onto the hardware queue for transmission.
1518 * The Ethernet port on which TX is being performed.
1520 * The queue on the Ethernet port which is being used to transmit the packets.
1522 * The burst of packets that are about to be transmitted.
1524 * The number of packets in the burst pointed to by "pkts".
1526 * The arbitrary user parameter passed in by the application when the callback
1527 * was originally configured.
1529 * The number of packets to be written to the NIC.
1531 typedef uint16_t (*rte_tx_callback_fn)(uint8_t port, uint16_t queue,
1532 struct rte_mbuf *pkts[], uint16_t nb_pkts, void *user_param);
1536 * Structure used to hold information about the callbacks to be called for a
1537 * queue on RX and TX.
1539 struct rte_eth_rxtx_callback {
1540 struct rte_eth_rxtx_callback *next;
1542 rte_rx_callback_fn rx;
1543 rte_tx_callback_fn tx;
1549 * The eth device type.
1551 enum rte_eth_dev_type {
1552 RTE_ETH_DEV_UNKNOWN, /**< unknown device type */
1554 /**< Physical function and Virtual function of PCI devices */
1555 RTE_ETH_DEV_VIRTUAL, /**< non hardware device */
1556 RTE_ETH_DEV_MAX /**< max value of this enum */
1561 * The generic data structure associated with each ethernet device.
1563 * Pointers to burst-oriented packet receive and transmit functions are
1564 * located at the beginning of the structure, along with the pointer to
1565 * where all the data elements for the particular device are stored in shared
1566 * memory. This split allows the function pointer and driver data to be per-
1567 * process, while the actual configuration data for the device is shared.
1569 struct rte_eth_dev {
1570 eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
1571 eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
1572 struct rte_eth_dev_data *data; /**< Pointer to device data */
1573 const struct eth_driver *driver;/**< Driver for this device */
1574 const struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
1575 struct rte_pci_device *pci_dev; /**< PCI info. supplied by probing */
1576 /** User application callbacks for NIC interrupts */
1577 struct rte_eth_dev_cb_list link_intr_cbs;
1579 * User-supplied functions called from rx_burst to post-process
1580 * received packets before passing them to the user
1582 struct rte_eth_rxtx_callback *post_rx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
1584 * User-supplied functions called from tx_burst to pre-process
1585 * received packets before passing them to the driver for transmission.
1587 struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
1588 uint8_t attached; /**< Flag indicating the port is attached */
1589 enum rte_eth_dev_type dev_type; /**< Flag indicating the device type */
1592 struct rte_eth_dev_sriov {
1593 uint8_t active; /**< SRIOV is active with 16, 32 or 64 pools */
1594 uint8_t nb_q_per_pool; /**< rx queue number per pool */
1595 uint16_t def_vmdq_idx; /**< Default pool num used for PF */
1596 uint16_t def_pool_q_idx; /**< Default pool queue start reg index */
1598 #define RTE_ETH_DEV_SRIOV(dev) ((dev)->data->sriov)
1600 #define RTE_ETH_NAME_MAX_LEN (32)
1604 * The data part, with no function pointers, associated with each ethernet device.
1606 * This structure is safe to place in shared memory to be common among different
1607 * processes in a multi-process configuration.
1609 struct rte_eth_dev_data {
1610 char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
1612 void **rx_queues; /**< Array of pointers to RX queues. */
1613 void **tx_queues; /**< Array of pointers to TX queues. */
1614 uint16_t nb_rx_queues; /**< Number of RX queues. */
1615 uint16_t nb_tx_queues; /**< Number of TX queues. */
1617 struct rte_eth_dev_sriov sriov; /**< SRIOV data */
1619 void *dev_private; /**< PMD-specific private data */
1621 struct rte_eth_link dev_link;
1622 /**< Link-level information & status */
1624 struct rte_eth_conf dev_conf; /**< Configuration applied to device. */
1625 uint16_t mtu; /**< Maximum Transmission Unit. */
1627 uint32_t min_rx_buf_size;
1628 /**< Common rx buffer size handled by all queues */
1630 uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
1631 struct ether_addr* mac_addrs;/**< Device Ethernet Link address. */
1632 uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
1633 /** bitmap array of associating Ethernet MAC addresses to pools */
1634 struct ether_addr* hash_mac_addrs;
1635 /** Device Ethernet MAC addresses of hash filtering. */
1636 uint8_t port_id; /**< Device [external] port identifier. */
1637 uint8_t promiscuous : 1, /**< RX promiscuous mode ON(1) / OFF(0). */
1638 scattered_rx : 1, /**< RX of scattered packets is ON(1) / OFF(0) */
1639 lro : 1, /**< RX LRO is ON(1) / OFF(0) */
1640 all_multicast : 1, /**< RX all multicast mode ON(1) / OFF(0). */
1641 dev_started : 1; /**< Device state: STARTED(1) / STOPPED(0). */
1646 * The pool of *rte_eth_dev* structures. The size of the pool
1647 * is configured at compile-time in the <rte_ethdev.c> file.
1649 extern struct rte_eth_dev rte_eth_devices[];
1652 * Get the total number of Ethernet devices that have been successfully
1653 * initialized by the [matching] Ethernet driver during the PCI probing phase.
1654 * All devices whose port identifier is in the range
1655 * [0, rte_eth_dev_count() - 1] can be operated on by network applications
1656 * immediately after invoking rte_eal_init().
1657 * If the application unplugs a port using hotplug function, The enabled port
1658 * numbers may be noncontiguous. In the case, the applications need to manage
1659 * enabled port by themselves.
1662 * - The total number of usable Ethernet devices.
1664 extern uint8_t rte_eth_dev_count(void);
1668 * Returns a ethdev slot specified by the unique identifier name.
1671 * The pointer to the Unique identifier name for each Ethernet device
1673 * - The pointer to the ethdev slot, on success. NULL on error
1675 extern struct rte_eth_dev *rte_eth_dev_allocated(const char *name);
1679 * Allocates a new ethdev slot for an ethernet device and returns the pointer
1680 * to that slot for the driver to use.
1682 * @param name Unique identifier name for each Ethernet device
1683 * @param type Device type of this Ethernet device
1685 * - Slot in the rte_dev_devices array for a new device;
1687 struct rte_eth_dev *rte_eth_dev_allocate(const char *name,
1688 enum rte_eth_dev_type type);
1692 * Release the specified ethdev port.
1695 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure.
1697 * - 0 on success, negative on error
1699 int rte_eth_dev_release_port(struct rte_eth_dev *eth_dev);
1702 * Attach a new Ethernet device specified by aruguments.
1705 * A pointer to a strings array describing the new device
1706 * to be attached. The strings should be a pci address like
1707 * '0000:01:00.0' or virtual device name like 'eth_pcap0'.
1709 * A pointer to a port identifier actually attached.
1711 * 0 on success and port_id is filled, negative on error
1713 int rte_eth_dev_attach(const char *devargs, uint8_t *port_id);
1716 * Detach a Ethernet device specified by port identifier.
1717 * This function must be called when the device is in the
1721 * The port identifier of the device to detach.
1723 * A pointer to a device name actually detached.
1725 * 0 on success and devname is filled, negative on error
1727 int rte_eth_dev_detach(uint8_t port_id, char *devname);
1732 * Initialization function of an Ethernet driver invoked for each matching
1733 * Ethernet PCI device detected during the PCI probing phase.
1736 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1737 * associated with the matching device and which have been [automatically]
1738 * allocated in the *rte_eth_devices* array.
1739 * The *eth_dev* structure is supplied to the driver initialization function
1740 * with the following fields already initialized:
1742 * - *pci_dev*: Holds the pointers to the *rte_pci_device* structure which
1743 * contains the generic PCI information of the matching device.
1745 * - *driver*: Holds the pointer to the *eth_driver* structure.
1747 * - *dev_private*: Holds a pointer to the device private data structure.
1749 * - *mtu*: Contains the default Ethernet maximum frame length (1500).
1751 * - *port_id*: Contains the port index of the device (actually the index
1752 * of the *eth_dev* structure in the *rte_eth_devices* array).
1755 * - 0: Success, the device is properly initialized by the driver.
1756 * In particular, the driver MUST have set up the *dev_ops* pointer
1757 * of the *eth_dev* structure.
1758 * - <0: Error code of the device initialization failure.
1760 typedef int (*eth_dev_init_t)(struct rte_eth_dev *eth_dev);
1764 * Finalization function of an Ethernet driver invoked for each matching
1765 * Ethernet PCI device detected during the PCI closing phase.
1768 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1769 * associated with the matching device and which have been [automatically]
1770 * allocated in the *rte_eth_devices* array.
1772 * - 0: Success, the device is properly finalized by the driver.
1773 * In particular, the driver MUST free the *dev_ops* pointer
1774 * of the *eth_dev* structure.
1775 * - <0: Error code of the device initialization failure.
1777 typedef int (*eth_dev_uninit_t)(struct rte_eth_dev *eth_dev);
1781 * The structure associated with a PMD Ethernet driver.
1783 * Each Ethernet driver acts as a PCI driver and is represented by a generic
1784 * *eth_driver* structure that holds:
1786 * - An *rte_pci_driver* structure (which must be the first field).
1788 * - The *eth_dev_init* function invoked for each matching PCI device.
1790 * - The *eth_dev_uninit* function invoked for each matching PCI device.
1792 * - The size of the private data to allocate for each matching device.
1795 struct rte_pci_driver pci_drv; /**< The PMD is also a PCI driver. */
1796 eth_dev_init_t eth_dev_init; /**< Device init function. */
1797 eth_dev_uninit_t eth_dev_uninit; /**< Device uninit function. */
1798 unsigned int dev_private_size; /**< Size of device private data. */
1803 * A function invoked by the initialization function of an Ethernet driver
1804 * to simultaneously register itself as a PCI driver and as an Ethernet
1805 * Poll Mode Driver (PMD).
1808 * The pointer to the *eth_driver* structure associated with
1809 * the Ethernet driver.
1811 extern void rte_eth_driver_register(struct eth_driver *eth_drv);
1814 * Configure an Ethernet device.
1815 * This function must be invoked first before any other function in the
1816 * Ethernet API. This function can also be re-invoked when a device is in the
1820 * The port identifier of the Ethernet device to configure.
1821 * @param nb_rx_queue
1822 * The number of receive queues to set up for the Ethernet device.
1823 * @param nb_tx_queue
1824 * The number of transmit queues to set up for the Ethernet device.
1826 * The pointer to the configuration data to be used for the Ethernet device.
1827 * The *rte_eth_conf* structure includes:
1828 * - the hardware offload features to activate, with dedicated fields for
1829 * each statically configurable offload hardware feature provided by
1830 * Ethernet devices, such as IP checksum or VLAN tag stripping for
1832 * - the Receive Side Scaling (RSS) configuration when using multiple RX
1835 * Embedding all configuration information in a single data structure
1836 * is the more flexible method that allows the addition of new features
1837 * without changing the syntax of the API.
1839 * - 0: Success, device configured.
1840 * - <0: Error code returned by the driver configuration function.
1842 extern int rte_eth_dev_configure(uint8_t port_id,
1843 uint16_t nb_rx_queue,
1844 uint16_t nb_tx_queue,
1845 const struct rte_eth_conf *eth_conf);
1848 * Allocate and set up a receive queue for an Ethernet device.
1850 * The function allocates a contiguous block of memory for *nb_rx_desc*
1851 * receive descriptors from a memory zone associated with *socket_id*
1852 * and initializes each receive descriptor with a network buffer allocated
1853 * from the memory pool *mb_pool*.
1856 * The port identifier of the Ethernet device.
1857 * @param rx_queue_id
1858 * The index of the receive queue to set up.
1859 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1860 * to rte_eth_dev_configure().
1862 * The number of receive descriptors to allocate for the receive ring.
1864 * The *socket_id* argument is the socket identifier in case of NUMA.
1865 * The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1866 * the DMA memory allocated for the receive descriptors of the ring.
1868 * The pointer to the configuration data to be used for the receive queue.
1869 * NULL value is allowed, in which case default RX configuration
1871 * The *rx_conf* structure contains an *rx_thresh* structure with the values
1872 * of the Prefetch, Host, and Write-Back threshold registers of the receive
1875 * The pointer to the memory pool from which to allocate *rte_mbuf* network
1876 * memory buffers to populate each descriptor of the receive ring.
1878 * - 0: Success, receive queue correctly set up.
1879 * - -EINVAL: The size of network buffers which can be allocated from the
1880 * memory pool does not fit the various buffer sizes allowed by the
1881 * device controller.
1882 * - -ENOMEM: Unable to allocate the receive ring descriptors or to
1883 * allocate network memory buffers from the memory pool when
1884 * initializing receive descriptors.
1886 extern int rte_eth_rx_queue_setup(uint8_t port_id, uint16_t rx_queue_id,
1887 uint16_t nb_rx_desc, unsigned int socket_id,
1888 const struct rte_eth_rxconf *rx_conf,
1889 struct rte_mempool *mb_pool);
1892 * Allocate and set up a transmit queue for an Ethernet device.
1895 * The port identifier of the Ethernet device.
1896 * @param tx_queue_id
1897 * The index of the transmit queue to set up.
1898 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1899 * to rte_eth_dev_configure().
1901 * The number of transmit descriptors to allocate for the transmit ring.
1903 * The *socket_id* argument is the socket identifier in case of NUMA.
1904 * Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1905 * the DMA memory allocated for the transmit descriptors of the ring.
1907 * The pointer to the configuration data to be used for the transmit queue.
1908 * NULL value is allowed, in which case default RX configuration
1910 * The *tx_conf* structure contains the following data:
1911 * - The *tx_thresh* structure with the values of the Prefetch, Host, and
1912 * Write-Back threshold registers of the transmit ring.
1913 * When setting Write-Back threshold to the value greater then zero,
1914 * *tx_rs_thresh* value should be explicitly set to one.
1915 * - The *tx_free_thresh* value indicates the [minimum] number of network
1916 * buffers that must be pending in the transmit ring to trigger their
1917 * [implicit] freeing by the driver transmit function.
1918 * - The *tx_rs_thresh* value indicates the [minimum] number of transmit
1919 * descriptors that must be pending in the transmit ring before setting the
1920 * RS bit on a descriptor by the driver transmit function.
1921 * The *tx_rs_thresh* value should be less or equal then
1922 * *tx_free_thresh* value, and both of them should be less then
1924 * - The *txq_flags* member contains flags to pass to the TX queue setup
1925 * function to configure the behavior of the TX queue. This should be set
1926 * to 0 if no special configuration is required.
1928 * Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces
1929 * the transmit function to use default values.
1931 * - 0: Success, the transmit queue is correctly set up.
1932 * - -ENOMEM: Unable to allocate the transmit ring descriptors.
1934 extern int rte_eth_tx_queue_setup(uint8_t port_id, uint16_t tx_queue_id,
1935 uint16_t nb_tx_desc, unsigned int socket_id,
1936 const struct rte_eth_txconf *tx_conf);
1939 * Return the NUMA socket to which an Ethernet device is connected
1942 * The port identifier of the Ethernet device
1944 * The NUMA socket id to which the Ethernet device is connected or
1945 * a default of zero if the socket could not be determined.
1946 * -1 is returned is the port_id value is out of range.
1948 extern int rte_eth_dev_socket_id(uint8_t port_id);
1951 * Check if port_id of device is attached
1954 * The port identifier of the Ethernet device
1956 * - 0 if port is out of range or not attached
1957 * - 1 if device is attached
1959 extern int rte_eth_dev_is_valid_port(uint8_t port_id);
1962 * Allocate mbuf from mempool, setup the DMA physical address
1963 * and then start RX for specified queue of a port. It is used
1964 * when rx_deferred_start flag of the specified queue is true.
1967 * The port identifier of the Ethernet device
1968 * @param rx_queue_id
1969 * The index of the rx queue to update the ring.
1970 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1971 * to rte_eth_dev_configure().
1973 * - 0: Success, the transmit queue is correctly set up.
1974 * - -EINVAL: The port_id or the queue_id out of range.
1975 * - -ENOTSUP: The function not supported in PMD driver.
1977 extern int rte_eth_dev_rx_queue_start(uint8_t port_id, uint16_t rx_queue_id);
1980 * Stop specified RX queue of a port
1983 * The port identifier of the Ethernet device
1984 * @param rx_queue_id
1985 * The index of the rx queue to update the ring.
1986 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1987 * to rte_eth_dev_configure().
1989 * - 0: Success, the transmit queue is correctly set up.
1990 * - -EINVAL: The port_id or the queue_id out of range.
1991 * - -ENOTSUP: The function not supported in PMD driver.
1993 extern int rte_eth_dev_rx_queue_stop(uint8_t port_id, uint16_t rx_queue_id);
1996 * Start TX for specified queue of a port. It is used when tx_deferred_start
1997 * flag of the specified queue is true.
2000 * The port identifier of the Ethernet device
2001 * @param tx_queue_id
2002 * The index of the tx queue to update the ring.
2003 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2004 * to rte_eth_dev_configure().
2006 * - 0: Success, the transmit queue is correctly set up.
2007 * - -EINVAL: The port_id or the queue_id out of range.
2008 * - -ENOTSUP: The function not supported in PMD driver.
2010 extern int rte_eth_dev_tx_queue_start(uint8_t port_id, uint16_t tx_queue_id);
2013 * Stop specified TX queue of a port
2016 * The port identifier of the Ethernet device
2017 * @param tx_queue_id
2018 * The index of the tx queue to update the ring.
2019 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2020 * to rte_eth_dev_configure().
2022 * - 0: Success, the transmit queue is correctly set up.
2023 * - -EINVAL: The port_id or the queue_id out of range.
2024 * - -ENOTSUP: The function not supported in PMD driver.
2026 extern int rte_eth_dev_tx_queue_stop(uint8_t port_id, uint16_t tx_queue_id);
2031 * Start an Ethernet device.
2033 * The device start step is the last one and consists of setting the configured
2034 * offload features and in starting the transmit and the receive units of the
2036 * On success, all basic functions exported by the Ethernet API (link status,
2037 * receive/transmit, and so on) can be invoked.
2040 * The port identifier of the Ethernet device.
2042 * - 0: Success, Ethernet device started.
2043 * - <0: Error code of the driver device start function.
2045 extern int rte_eth_dev_start(uint8_t port_id);
2048 * Stop an Ethernet device. The device can be restarted with a call to
2049 * rte_eth_dev_start()
2052 * The port identifier of the Ethernet device.
2054 extern void rte_eth_dev_stop(uint8_t port_id);
2058 * Link up an Ethernet device.
2060 * Set device link up will re-enable the device rx/tx
2061 * functionality after it is previously set device linked down.
2064 * The port identifier of the Ethernet device.
2066 * - 0: Success, Ethernet device linked up.
2067 * - <0: Error code of the driver device link up function.
2069 extern int rte_eth_dev_set_link_up(uint8_t port_id);
2072 * Link down an Ethernet device.
2073 * The device rx/tx functionality will be disabled if success,
2074 * and it can be re-enabled with a call to
2075 * rte_eth_dev_set_link_up()
2078 * The port identifier of the Ethernet device.
2080 extern int rte_eth_dev_set_link_down(uint8_t port_id);
2083 * Close a stopped Ethernet device. The device cannot be restarted!
2084 * The function frees all resources except for needed by the
2085 * closed state. To free these resources, call rte_eth_dev_detach().
2088 * The port identifier of the Ethernet device.
2090 extern void rte_eth_dev_close(uint8_t port_id);
2093 * Enable receipt in promiscuous mode for an Ethernet device.
2096 * The port identifier of the Ethernet device.
2098 extern void rte_eth_promiscuous_enable(uint8_t port_id);
2101 * Disable receipt in promiscuous mode for an Ethernet device.
2104 * The port identifier of the Ethernet device.
2106 extern void rte_eth_promiscuous_disable(uint8_t port_id);
2109 * Return the value of promiscuous mode for an Ethernet device.
2112 * The port identifier of the Ethernet device.
2114 * - (1) if promiscuous is enabled
2115 * - (0) if promiscuous is disabled.
2118 extern int rte_eth_promiscuous_get(uint8_t port_id);
2121 * Enable the receipt of any multicast frame by an Ethernet device.
2124 * The port identifier of the Ethernet device.
2126 extern void rte_eth_allmulticast_enable(uint8_t port_id);
2129 * Disable the receipt of all multicast frames by an Ethernet device.
2132 * The port identifier of the Ethernet device.
2134 extern void rte_eth_allmulticast_disable(uint8_t port_id);
2137 * Return the value of allmulticast mode for an Ethernet device.
2140 * The port identifier of the Ethernet device.
2142 * - (1) if allmulticast is enabled
2143 * - (0) if allmulticast is disabled.
2146 extern int rte_eth_allmulticast_get(uint8_t port_id);
2149 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2150 * or FULL-DUPLEX) of the physical link of an Ethernet device. It might need
2151 * to wait up to 9 seconds in it.
2154 * The port identifier of the Ethernet device.
2156 * A pointer to an *rte_eth_link* structure to be filled with
2157 * the status, the speed and the mode of the Ethernet device link.
2159 extern void rte_eth_link_get(uint8_t port_id, struct rte_eth_link *link);
2162 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2163 * or FULL-DUPLEX) of the physical link of an Ethernet device. It is a no-wait
2164 * version of rte_eth_link_get().
2167 * The port identifier of the Ethernet device.
2169 * A pointer to an *rte_eth_link* structure to be filled with
2170 * the status, the speed and the mode of the Ethernet device link.
2172 extern void rte_eth_link_get_nowait(uint8_t port_id,
2173 struct rte_eth_link *link);
2176 * Retrieve the general I/O statistics of an Ethernet device.
2179 * The port identifier of the Ethernet device.
2181 * A pointer to a structure of type *rte_eth_stats* to be filled with
2182 * the values of device counters for the following set of statistics:
2183 * - *ipackets* with the total of successfully received packets.
2184 * - *opackets* with the total of successfully transmitted packets.
2185 * - *ibytes* with the total of successfully received bytes.
2186 * - *obytes* with the total of successfully transmitted bytes.
2187 * - *ierrors* with the total of erroneous received packets.
2188 * - *oerrors* with the total of failed transmitted packets.
2190 * Zero if successful. Non-zero otherwise.
2192 extern int rte_eth_stats_get(uint8_t port_id, struct rte_eth_stats *stats);
2195 * Reset the general I/O statistics of an Ethernet device.
2198 * The port identifier of the Ethernet device.
2200 extern void rte_eth_stats_reset(uint8_t port_id);
2203 * Retrieve extended statistics of an Ethernet device.
2206 * The port identifier of the Ethernet device.
2208 * A pointer to a table of structure of type *rte_eth_xstats*
2209 * to be filled with device statistics names and values.
2210 * This parameter can be set to NULL if n is 0.
2212 * The size of the stats table, which should be large enough to store
2213 * all the statistics of the device.
2215 * - positive value lower or equal to n: success. The return value
2216 * is the number of entries filled in the stats table.
2217 * - positive value higher than n: error, the given statistics table
2218 * is too small. The return value corresponds to the size that should
2219 * be given to succeed. The entries in the table are not valid and
2220 * shall not be used by the caller.
2221 * - negative value on error (invalid port id)
2223 extern int rte_eth_xstats_get(uint8_t port_id,
2224 struct rte_eth_xstats *xstats, unsigned n);
2227 * Reset extended statistics of an Ethernet device.
2230 * The port identifier of the Ethernet device.
2232 extern void rte_eth_xstats_reset(uint8_t port_id);
2235 * Set a mapping for the specified transmit queue to the specified per-queue
2236 * statistics counter.
2239 * The port identifier of the Ethernet device.
2240 * @param tx_queue_id
2241 * The index of the transmit queue for which a queue stats mapping is required.
2242 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2243 * to rte_eth_dev_configure().
2245 * The per-queue packet statistics functionality number that the transmit
2246 * queue is to be assigned.
2247 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2249 * Zero if successful. Non-zero otherwise.
2251 extern int rte_eth_dev_set_tx_queue_stats_mapping(uint8_t port_id,
2252 uint16_t tx_queue_id,
2256 * Set a mapping for the specified receive queue to the specified per-queue
2257 * statistics counter.
2260 * The port identifier of the Ethernet device.
2261 * @param rx_queue_id
2262 * The index of the receive queue for which a queue stats mapping is required.
2263 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2264 * to rte_eth_dev_configure().
2266 * The per-queue packet statistics functionality number that the receive
2267 * queue is to be assigned.
2268 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2270 * Zero if successful. Non-zero otherwise.
2272 extern int rte_eth_dev_set_rx_queue_stats_mapping(uint8_t port_id,
2273 uint16_t rx_queue_id,
2277 * Retrieve the Ethernet address of an Ethernet device.
2280 * The port identifier of the Ethernet device.
2282 * A pointer to a structure of type *ether_addr* to be filled with
2283 * the Ethernet address of the Ethernet device.
2285 extern void rte_eth_macaddr_get(uint8_t port_id, struct ether_addr *mac_addr);
2288 * Retrieve the contextual information of an Ethernet device.
2291 * The port identifier of the Ethernet device.
2293 * A pointer to a structure of type *rte_eth_dev_info* to be filled with
2294 * the contextual information of the Ethernet device.
2296 extern void rte_eth_dev_info_get(uint8_t port_id,
2297 struct rte_eth_dev_info *dev_info);
2300 * Retrieve the MTU of an Ethernet device.
2303 * The port identifier of the Ethernet device.
2305 * A pointer to a uint16_t where the retrieved MTU is to be stored.
2307 * - (0) if successful.
2308 * - (-ENODEV) if *port_id* invalid.
2310 extern int rte_eth_dev_get_mtu(uint8_t port_id, uint16_t *mtu);
2313 * Change the MTU of an Ethernet device.
2316 * The port identifier of the Ethernet device.
2318 * A uint16_t for the MTU to be applied.
2320 * - (0) if successful.
2321 * - (-ENOTSUP) if operation is not supported.
2322 * - (-ENODEV) if *port_id* invalid.
2323 * - (-EINVAL) if *mtu* invalid.
2325 extern int rte_eth_dev_set_mtu(uint8_t port_id, uint16_t mtu);
2328 * Enable/Disable hardware filtering by an Ethernet device of received
2329 * VLAN packets tagged with a given VLAN Tag Identifier.
2332 * The port identifier of the Ethernet device.
2334 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
2336 * If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*.
2337 * Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*.
2339 * - (0) if successful.
2340 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2341 * - (-ENODEV) if *port_id* invalid.
2342 * - (-ENOSYS) if VLAN filtering on *port_id* disabled.
2343 * - (-EINVAL) if *vlan_id* > 4095.
2345 extern int rte_eth_dev_vlan_filter(uint8_t port_id, uint16_t vlan_id , int on);
2348 * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
2349 * 82599/X540/X550 can support VLAN stripping at the rx queue level
2352 * The port identifier of the Ethernet device.
2353 * @param rx_queue_id
2354 * The index of the receive queue for which a queue stats mapping is required.
2355 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2356 * to rte_eth_dev_configure().
2358 * If 1, Enable VLAN Stripping of the receive queue of the Ethernet port.
2359 * If 0, Disable VLAN Stripping of the receive queue of the Ethernet port.
2361 * - (0) if successful.
2362 * - (-ENOSUP) if hardware-assisted VLAN stripping not configured.
2363 * - (-ENODEV) if *port_id* invalid.
2364 * - (-EINVAL) if *rx_queue_id* invalid.
2366 extern int rte_eth_dev_set_vlan_strip_on_queue(uint8_t port_id,
2367 uint16_t rx_queue_id, int on);
2370 * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
2371 * the VLAN Header. This is a register setup available on some Intel NIC, not
2372 * but all, please check the data sheet for availability.
2375 * The port identifier of the Ethernet device.
2377 * The Tag Protocol ID
2379 * - (0) if successful.
2380 * - (-ENOSUP) if hardware-assisted VLAN TPID setup is not supported.
2381 * - (-ENODEV) if *port_id* invalid.
2383 extern int rte_eth_dev_set_vlan_ether_type(uint8_t port_id, uint16_t tag_type);
2386 * Set VLAN offload configuration on an Ethernet device
2387 * Enable/Disable Extended VLAN by an Ethernet device, This is a register setup
2388 * available on some Intel NIC, not but all, please check the data sheet for
2390 * Enable/Disable VLAN Strip can be done on rx queue for certain NIC, but here
2391 * the configuration is applied on the port level.
2394 * The port identifier of the Ethernet device.
2395 * @param offload_mask
2396 * The VLAN Offload bit mask can be mixed use with "OR"
2397 * ETH_VLAN_STRIP_OFFLOAD
2398 * ETH_VLAN_FILTER_OFFLOAD
2399 * ETH_VLAN_EXTEND_OFFLOAD
2401 * - (0) if successful.
2402 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2403 * - (-ENODEV) if *port_id* invalid.
2405 extern int rte_eth_dev_set_vlan_offload(uint8_t port_id, int offload_mask);
2408 * Read VLAN Offload configuration from an Ethernet device
2411 * The port identifier of the Ethernet device.
2413 * - (>0) if successful. Bit mask to indicate
2414 * ETH_VLAN_STRIP_OFFLOAD
2415 * ETH_VLAN_FILTER_OFFLOAD
2416 * ETH_VLAN_EXTEND_OFFLOAD
2417 * - (-ENODEV) if *port_id* invalid.
2419 extern int rte_eth_dev_get_vlan_offload(uint8_t port_id);
2422 * Set port based TX VLAN insersion on or off.
2425 * The port identifier of the Ethernet device.
2427 * Port based TX VLAN identifier togeth with user priority.
2429 * Turn on or off the port based TX VLAN insertion.
2432 * - (0) if successful.
2433 * - negative if failed.
2435 extern int rte_eth_dev_set_vlan_pvid(uint8_t port_id, uint16_t pvid, int on);
2439 * Retrieve a burst of input packets from a receive queue of an Ethernet
2440 * device. The retrieved packets are stored in *rte_mbuf* structures whose
2441 * pointers are supplied in the *rx_pkts* array.
2443 * The rte_eth_rx_burst() function loops, parsing the RX ring of the
2444 * receive queue, up to *nb_pkts* packets, and for each completed RX
2445 * descriptor in the ring, it performs the following operations:
2447 * - Initialize the *rte_mbuf* data structure associated with the
2448 * RX descriptor according to the information provided by the NIC into
2449 * that RX descriptor.
2451 * - Store the *rte_mbuf* data structure into the next entry of the
2454 * - Replenish the RX descriptor with a new *rte_mbuf* buffer
2455 * allocated from the memory pool associated with the receive queue at
2456 * initialization time.
2458 * When retrieving an input packet that was scattered by the controller
2459 * into multiple receive descriptors, the rte_eth_rx_burst() function
2460 * appends the associated *rte_mbuf* buffers to the first buffer of the
2463 * The rte_eth_rx_burst() function returns the number of packets
2464 * actually retrieved, which is the number of *rte_mbuf* data structures
2465 * effectively supplied into the *rx_pkts* array.
2466 * A return value equal to *nb_pkts* indicates that the RX queue contained
2467 * at least *rx_pkts* packets, and this is likely to signify that other
2468 * received packets remain in the input queue. Applications implementing
2469 * a "retrieve as much received packets as possible" policy can check this
2470 * specific case and keep invoking the rte_eth_rx_burst() function until
2471 * a value less than *nb_pkts* is returned.
2473 * This receive method has the following advantages:
2475 * - It allows a run-to-completion network stack engine to retrieve and
2476 * to immediately process received packets in a fast burst-oriented
2477 * approach, avoiding the overhead of unnecessary intermediate packet
2478 * queue/dequeue operations.
2480 * - Conversely, it also allows an asynchronous-oriented processing
2481 * method to retrieve bursts of received packets and to immediately
2482 * queue them for further parallel processing by another logical core,
2483 * for instance. However, instead of having received packets being
2484 * individually queued by the driver, this approach allows the invoker
2485 * of the rte_eth_rx_burst() function to queue a burst of retrieved
2486 * packets at a time and therefore dramatically reduce the cost of
2487 * enqueue/dequeue operations per packet.
2489 * - It allows the rte_eth_rx_burst() function of the driver to take
2490 * advantage of burst-oriented hardware features (CPU cache,
2491 * prefetch instructions, and so on) to minimize the number of CPU
2492 * cycles per packet.
2494 * To summarize, the proposed receive API enables many
2495 * burst-oriented optimizations in both synchronous and asynchronous
2496 * packet processing environments with no overhead in both cases.
2498 * The rte_eth_rx_burst() function does not provide any error
2499 * notification to avoid the corresponding overhead. As a hint, the
2500 * upper-level application might check the status of the device link once
2501 * being systematically returned a 0 value for a given number of tries.
2504 * The port identifier of the Ethernet device.
2506 * The index of the receive queue from which to retrieve input packets.
2507 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2508 * to rte_eth_dev_configure().
2510 * The address of an array of pointers to *rte_mbuf* structures that
2511 * must be large enough to store *nb_pkts* pointers in it.
2513 * The maximum number of packets to retrieve.
2515 * The number of packets actually retrieved, which is the number
2516 * of pointers to *rte_mbuf* structures effectively supplied to the
2519 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2520 extern uint16_t rte_eth_rx_burst(uint8_t port_id, uint16_t queue_id,
2521 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
2523 static inline uint16_t
2524 rte_eth_rx_burst(uint8_t port_id, uint16_t queue_id,
2525 struct rte_mbuf **rx_pkts, const uint16_t nb_pkts)
2527 struct rte_eth_dev *dev;
2529 dev = &rte_eth_devices[port_id];
2531 int16_t nb_rx = (*dev->rx_pkt_burst)(dev->data->rx_queues[queue_id],
2534 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
2535 struct rte_eth_rxtx_callback *cb = dev->post_rx_burst_cbs[queue_id];
2537 if (unlikely(cb != NULL)) {
2539 nb_rx = cb->fn.rx(port_id, queue_id, rx_pkts, nb_rx,
2540 nb_pkts, cb->param);
2542 } while (cb != NULL);
2551 * Get the number of used descriptors in a specific queue
2554 * The port identifier of the Ethernet device.
2556 * The queue id on the specific port.
2558 * The number of used descriptors in the specific queue.
2560 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2561 extern uint32_t rte_eth_rx_queue_count(uint8_t port_id, uint16_t queue_id);
2563 static inline uint32_t
2564 rte_eth_rx_queue_count(uint8_t port_id, uint16_t queue_id)
2566 struct rte_eth_dev *dev;
2568 dev = &rte_eth_devices[port_id];
2569 return (*dev->dev_ops->rx_queue_count)(dev, queue_id);
2574 * Check if the DD bit of the specific RX descriptor in the queue has been set
2577 * The port identifier of the Ethernet device.
2579 * The queue id on the specific port.
2581 * The offset of the descriptor ID from tail.
2583 * - (1) if the specific DD bit is set.
2584 * - (0) if the specific DD bit is not set.
2585 * - (-ENODEV) if *port_id* invalid.
2587 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2588 extern int rte_eth_rx_descriptor_done(uint8_t port_id,
2593 rte_eth_rx_descriptor_done(uint8_t port_id, uint16_t queue_id, uint16_t offset)
2595 struct rte_eth_dev *dev;
2597 dev = &rte_eth_devices[port_id];
2598 return (*dev->dev_ops->rx_descriptor_done)( \
2599 dev->data->rx_queues[queue_id], offset);
2604 * Send a burst of output packets on a transmit queue of an Ethernet device.
2606 * The rte_eth_tx_burst() function is invoked to transmit output packets
2607 * on the output queue *queue_id* of the Ethernet device designated by its
2609 * The *nb_pkts* parameter is the number of packets to send which are
2610 * supplied in the *tx_pkts* array of *rte_mbuf* structures.
2611 * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
2612 * up to the number of transmit descriptors available in the TX ring of the
2614 * For each packet to send, the rte_eth_tx_burst() function performs
2615 * the following operations:
2617 * - Pick up the next available descriptor in the transmit ring.
2619 * - Free the network buffer previously sent with that descriptor, if any.
2621 * - Initialize the transmit descriptor with the information provided
2622 * in the *rte_mbuf data structure.
2624 * In the case of a segmented packet composed of a list of *rte_mbuf* buffers,
2625 * the rte_eth_tx_burst() function uses several transmit descriptors
2628 * The rte_eth_tx_burst() function returns the number of packets it
2629 * actually sent. A return value equal to *nb_pkts* means that all packets
2630 * have been sent, and this is likely to signify that other output packets
2631 * could be immediately transmitted again. Applications that implement a
2632 * "send as many packets to transmit as possible" policy can check this
2633 * specific case and keep invoking the rte_eth_tx_burst() function until
2634 * a value less than *nb_pkts* is returned.
2636 * It is the responsibility of the rte_eth_tx_burst() function to
2637 * transparently free the memory buffers of packets previously sent.
2638 * This feature is driven by the *tx_free_thresh* value supplied to the
2639 * rte_eth_dev_configure() function at device configuration time.
2640 * When the number of free TX descriptors drops below this threshold, the
2641 * rte_eth_tx_burst() function must [attempt to] free the *rte_mbuf* buffers
2642 * of those packets whose transmission was effectively completed.
2645 * The port identifier of the Ethernet device.
2647 * The index of the transmit queue through which output packets must be
2649 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2650 * to rte_eth_dev_configure().
2652 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
2653 * which contain the output packets.
2655 * The maximum number of packets to transmit.
2657 * The number of output packets actually stored in transmit descriptors of
2658 * the transmit ring. The return value can be less than the value of the
2659 * *tx_pkts* parameter when the transmit ring is full or has been filled up.
2661 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2662 extern uint16_t rte_eth_tx_burst(uint8_t port_id, uint16_t queue_id,
2663 struct rte_mbuf **tx_pkts, uint16_t nb_pkts);
2665 static inline uint16_t
2666 rte_eth_tx_burst(uint8_t port_id, uint16_t queue_id,
2667 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
2669 struct rte_eth_dev *dev;
2671 dev = &rte_eth_devices[port_id];
2673 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
2674 struct rte_eth_rxtx_callback *cb = dev->pre_tx_burst_cbs[queue_id];
2676 if (unlikely(cb != NULL)) {
2678 nb_pkts = cb->fn.tx(port_id, queue_id, tx_pkts, nb_pkts,
2681 } while (cb != NULL);
2685 return (*dev->tx_pkt_burst)(dev->data->tx_queues[queue_id], tx_pkts, nb_pkts);
2690 * Setup a new signature filter rule on an Ethernet device
2693 * The port identifier of the Ethernet device.
2694 * @param fdir_filter
2695 * The pointer to the fdir filter structure describing the signature filter
2697 * The *rte_fdir_filter* structure includes the values of the different fields
2698 * to match: source and destination IP addresses, vlan id, flexbytes, source
2699 * and destination ports, and so on.
2701 * The index of the RX queue where to store RX packets matching the added
2702 * signature filter defined in fdir_filter.
2704 * - (0) if successful.
2705 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2706 * - (-ENODEV) if *port_id* invalid.
2707 * - (-ENOSYS) if the FDIR mode is not configured in signature mode
2709 * - (-EINVAL) if the fdir_filter information is not correct.
2711 int rte_eth_dev_fdir_add_signature_filter(uint8_t port_id,
2712 struct rte_fdir_filter *fdir_filter,
2716 * Update a signature filter rule on an Ethernet device.
2717 * If the rule doesn't exits, it is created.
2720 * The port identifier of the Ethernet device.
2722 * The pointer to the structure describing the signature filter rule.
2723 * The *rte_fdir_filter* structure includes the values of the different fields
2724 * to match: source and destination IP addresses, vlan id, flexbytes, source
2725 * and destination ports, and so on.
2727 * The index of the RX queue where to store RX packets matching the added
2728 * signature filter defined in fdir_ftr.
2730 * - (0) if successful.
2731 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2732 * - (-ENODEV) if *port_id* invalid.
2733 * - (-ENOSYS) if the flow director mode is not configured in signature mode
2735 * - (-EINVAL) if the fdir_filter information is not correct.
2737 int rte_eth_dev_fdir_update_signature_filter(uint8_t port_id,
2738 struct rte_fdir_filter *fdir_ftr,
2742 * Remove a signature filter rule on an Ethernet device.
2745 * The port identifier of the Ethernet device.
2747 * The pointer to the structure describing the signature filter rule.
2748 * The *rte_fdir_filter* structure includes the values of the different fields
2749 * to match: source and destination IP addresses, vlan id, flexbytes, source
2750 * and destination ports, and so on.
2752 * - (0) if successful.
2753 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2754 * - (-ENODEV) if *port_id* invalid.
2755 * - (-ENOSYS) if the flow director mode is not configured in signature mode
2757 * - (-EINVAL) if the fdir_filter information is not correct.
2759 int rte_eth_dev_fdir_remove_signature_filter(uint8_t port_id,
2760 struct rte_fdir_filter *fdir_ftr);
2763 * Retrieve the flow director information of an Ethernet device.
2766 * The port identifier of the Ethernet device.
2768 * A pointer to a structure of type *rte_eth_dev_fdir* to be filled with
2769 * the flow director information of the Ethernet device.
2771 * - (0) if successful.
2772 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2773 * - (-ENODEV) if *port_id* invalid.
2774 * - (-ENOSYS) if the flow director mode is not configured on *port_id*.
2776 int rte_eth_dev_fdir_get_infos(uint8_t port_id, struct rte_eth_fdir *fdir);
2779 * Add a new perfect filter rule on an Ethernet device.
2782 * The port identifier of the Ethernet device.
2783 * @param fdir_filter
2784 * The pointer to the structure describing the perfect filter rule.
2785 * The *rte_fdir_filter* structure includes the values of the different fields
2786 * to match: source and destination IP addresses, vlan id, flexbytes, source
2787 * and destination ports, and so on.
2788 * IPv6 are not supported.
2790 * The 16-bit value supplied in the field hash.fdir.id of mbuf for RX
2791 * packets matching the perfect filter.
2793 * The index of the RX queue where to store RX packets matching the added
2794 * perfect filter defined in fdir_filter.
2796 * If drop is set to 1, matching RX packets are stored into the RX drop
2797 * queue defined in the rte_fdir_conf.
2799 * - (0) if successful.
2800 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2801 * - (-ENODEV) if *port_id* invalid.
2802 * - (-ENOSYS) if the flow director mode is not configured in perfect mode
2804 * - (-EINVAL) if the fdir_filter information is not correct.
2806 int rte_eth_dev_fdir_add_perfect_filter(uint8_t port_id,
2807 struct rte_fdir_filter *fdir_filter,
2808 uint16_t soft_id, uint8_t rx_queue,
2812 * Update a perfect filter rule on an Ethernet device.
2813 * If the rule doesn't exits, it is created.
2816 * The port identifier of the Ethernet device.
2817 * @param fdir_filter
2818 * The pointer to the structure describing the perfect filter rule.
2819 * The *rte_fdir_filter* structure includes the values of the different fields
2820 * to match: source and destination IP addresses, vlan id, flexbytes, source
2821 * and destination ports, and so on.
2822 * IPv6 are not supported.
2824 * The 16-bit value supplied in the field hash.fdir.id of mbuf for RX
2825 * packets matching the perfect filter.
2827 * The index of the RX queue where to store RX packets matching the added
2828 * perfect filter defined in fdir_filter.
2830 * If drop is set to 1, matching RX packets are stored into the RX drop
2831 * queue defined in the rte_fdir_conf.
2833 * - (0) if successful.
2834 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2835 * - (-ENODEV) if *port_id* invalid.
2836 * - (-ENOSYS) if the flow director mode is not configured in perfect mode
2838 * - (-EINVAL) if the fdir_filter information is not correct.
2840 int rte_eth_dev_fdir_update_perfect_filter(uint8_t port_id,
2841 struct rte_fdir_filter *fdir_filter,
2842 uint16_t soft_id, uint8_t rx_queue,
2846 * Remove a perfect filter rule on an Ethernet device.
2849 * The port identifier of the Ethernet device.
2850 * @param fdir_filter
2851 * The pointer to the structure describing the perfect filter rule.
2852 * The *rte_fdir_filter* structure includes the values of the different fields
2853 * to match: source and destination IP addresses, vlan id, flexbytes, source
2854 * and destination ports, and so on.
2855 * IPv6 are not supported.
2857 * The soft_id value provided when adding/updating the removed filter.
2859 * - (0) if successful.
2860 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2861 * - (-ENODEV) if *port_id* invalid.
2862 * - (-ENOSYS) if the flow director mode is not configured in perfect mode
2864 * - (-EINVAL) if the fdir_filter information is not correct.
2866 int rte_eth_dev_fdir_remove_perfect_filter(uint8_t port_id,
2867 struct rte_fdir_filter *fdir_filter,
2870 * Configure globally the masks for flow director mode for an Ethernet device.
2871 * For example, the device can match packets with only the first 24 bits of
2872 * the IPv4 source address.
2874 * The following fields can be masked: IPv4 addresses and L4 port numbers.
2875 * The following fields can be either enabled or disabled completely for the
2876 * matching functionality: VLAN ID tag; VLAN Priority + CFI bit; Flexible 2-byte
2878 * IPv6 masks are not supported.
2880 * All filters must comply with the masks previously configured.
2881 * For example, with a mask equal to 255.255.255.0 for the source IPv4 address,
2882 * all IPv4 filters must be created with a source IPv4 address that fits the
2885 * This function flushes all filters that have been previously added in
2889 * The port identifier of the Ethernet device.
2891 * The pointer to the fdir mask structure describing relevant headers fields
2892 * and relevant bits to use when matching packets addresses and ports.
2893 * IPv6 masks are not supported.
2895 * - (0) if successful.
2896 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2897 * - (-ENODEV) if *port_id* invalid.
2898 * - (-ENOSYS) if the flow director mode is not configured in perfect
2899 * mode on *port_id*.
2900 * - (-EINVAL) if the fdir_filter information is not correct
2902 int rte_eth_dev_fdir_set_masks(uint8_t port_id,
2903 struct rte_fdir_masks *fdir_mask);
2906 * The eth device event type for interrupt, and maybe others in the future.
2908 enum rte_eth_event_type {
2909 RTE_ETH_EVENT_UNKNOWN, /**< unknown event type */
2910 RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
2911 RTE_ETH_EVENT_MAX /**< max value of this enum */
2914 typedef void (*rte_eth_dev_cb_fn)(uint8_t port_id, \
2915 enum rte_eth_event_type event, void *cb_arg);
2916 /**< user application callback to be registered for interrupts */
2921 * Register a callback function for specific port id.
2928 * User supplied callback function to be called.
2930 * Pointer to the parameters for the registered callback.
2933 * - On success, zero.
2934 * - On failure, a negative value.
2936 int rte_eth_dev_callback_register(uint8_t port_id,
2937 enum rte_eth_event_type event,
2938 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
2941 * Unregister a callback function for specific port id.
2948 * User supplied callback function to be called.
2950 * Pointer to the parameters for the registered callback. -1 means to
2951 * remove all for the same callback address and same event.
2954 * - On success, zero.
2955 * - On failure, a negative value.
2957 int rte_eth_dev_callback_unregister(uint8_t port_id,
2958 enum rte_eth_event_type event,
2959 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
2962 * @internal Executes all the user application registered callbacks for
2963 * the specific device. It is for DPDK internal user only. User
2964 * application should not call it directly.
2967 * Pointer to struct rte_eth_dev.
2969 * Eth device interrupt event type.
2974 void _rte_eth_dev_callback_process(struct rte_eth_dev *dev,
2975 enum rte_eth_event_type event);
2978 * When there is no rx packet coming in Rx Queue for a long time, we can
2979 * sleep lcore related to RX Queue for power saving, and enable rx interrupt
2980 * to be triggered when rx packect arrives.
2982 * The rte_eth_dev_rx_intr_enable() function enables rx queue
2983 * interrupt on specific rx queue of a port.
2986 * The port identifier of the Ethernet device.
2988 * The index of the receive queue from which to retrieve input packets.
2989 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2990 * to rte_eth_dev_configure().
2992 * - (0) if successful.
2993 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
2995 * - (-ENODEV) if *port_id* invalid.
2997 int rte_eth_dev_rx_intr_enable(uint8_t port_id, uint16_t queue_id);
3000 * When lcore wakes up from rx interrupt indicating packet coming, disable rx
3001 * interrupt and returns to polling mode.
3003 * The rte_eth_dev_rx_intr_disable() function disables rx queue
3004 * interrupt on specific rx queue of a port.
3007 * The port identifier of the Ethernet device.
3009 * The index of the receive queue from which to retrieve input packets.
3010 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3011 * to rte_eth_dev_configure().
3013 * - (0) if successful.
3014 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3016 * - (-ENODEV) if *port_id* invalid.
3018 int rte_eth_dev_rx_intr_disable(uint8_t port_id, uint16_t queue_id);
3021 * RX Interrupt control per port.
3024 * The port identifier of the Ethernet device.
3026 * Epoll instance fd which the intr vector associated to.
3027 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
3029 * The operation be performed for the vector.
3030 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
3034 * - On success, zero.
3035 * - On failure, a negative value.
3037 int rte_eth_dev_rx_intr_ctl(uint8_t port_id, int epfd, int op, void *data);
3040 * RX Interrupt control per queue.
3043 * The port identifier of the Ethernet device.
3045 * The index of the receive queue from which to retrieve input packets.
3046 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3047 * to rte_eth_dev_configure().
3049 * Epoll instance fd which the intr vector associated to.
3050 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
3052 * The operation be performed for the vector.
3053 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
3057 * - On success, zero.
3058 * - On failure, a negative value.
3060 int rte_eth_dev_rx_intr_ctl_q(uint8_t port_id, uint16_t queue_id,
3061 int epfd, int op, void *data);
3064 * Turn on the LED on the Ethernet device.
3065 * This function turns on the LED on the Ethernet device.
3068 * The port identifier of the Ethernet device.
3070 * - (0) if successful.
3071 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3073 * - (-ENODEV) if *port_id* invalid.
3075 int rte_eth_led_on(uint8_t port_id);
3078 * Turn off the LED on the Ethernet device.
3079 * This function turns off the LED on the Ethernet device.
3082 * The port identifier of the Ethernet device.
3084 * - (0) if successful.
3085 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3087 * - (-ENODEV) if *port_id* invalid.
3089 int rte_eth_led_off(uint8_t port_id);
3092 * Get current status of the Ethernet link flow control for Ethernet device
3095 * The port identifier of the Ethernet device.
3097 * The pointer to the structure where to store the flow control parameters.
3099 * - (0) if successful.
3100 * - (-ENOTSUP) if hardware doesn't support flow control.
3101 * - (-ENODEV) if *port_id* invalid.
3103 int rte_eth_dev_flow_ctrl_get(uint8_t port_id,
3104 struct rte_eth_fc_conf *fc_conf);
3107 * Configure the Ethernet link flow control for Ethernet device
3110 * The port identifier of the Ethernet device.
3112 * The pointer to the structure of the flow control parameters.
3114 * - (0) if successful.
3115 * - (-ENOTSUP) if hardware doesn't support flow control mode.
3116 * - (-ENODEV) if *port_id* invalid.
3117 * - (-EINVAL) if bad parameter
3118 * - (-EIO) if flow control setup failure
3120 int rte_eth_dev_flow_ctrl_set(uint8_t port_id,
3121 struct rte_eth_fc_conf *fc_conf);
3124 * Configure the Ethernet priority flow control under DCB environment
3125 * for Ethernet device.
3128 * The port identifier of the Ethernet device.
3130 * The pointer to the structure of the priority flow control parameters.
3132 * - (0) if successful.
3133 * - (-ENOTSUP) if hardware doesn't support priority flow control mode.
3134 * - (-ENODEV) if *port_id* invalid.
3135 * - (-EINVAL) if bad parameter
3136 * - (-EIO) if flow control setup failure
3138 int rte_eth_dev_priority_flow_ctrl_set(uint8_t port_id,
3139 struct rte_eth_pfc_conf *pfc_conf);
3142 * Add a MAC address to an internal array of addresses used to enable whitelist
3143 * filtering to accept packets only if the destination MAC address matches.
3146 * The port identifier of the Ethernet device.
3148 * The MAC address to add.
3150 * VMDq pool index to associate address with (if VMDq is enabled). If VMDq is
3151 * not enabled, this should be set to 0.
3153 * - (0) if successfully added or *mac_addr" was already added.
3154 * - (-ENOTSUP) if hardware doesn't support this feature.
3155 * - (-ENODEV) if *port* is invalid.
3156 * - (-ENOSPC) if no more MAC addresses can be added.
3157 * - (-EINVAL) if MAC address is invalid.
3159 int rte_eth_dev_mac_addr_add(uint8_t port, struct ether_addr *mac_addr,
3163 * Remove a MAC address from the internal array of addresses.
3166 * The port identifier of the Ethernet device.
3168 * MAC address to remove.
3170 * - (0) if successful, or *mac_addr* didn't exist.
3171 * - (-ENOTSUP) if hardware doesn't support.
3172 * - (-ENODEV) if *port* invalid.
3173 * - (-EADDRINUSE) if attempting to remove the default MAC address
3175 int rte_eth_dev_mac_addr_remove(uint8_t port, struct ether_addr *mac_addr);
3178 * Set the default MAC address.
3181 * The port identifier of the Ethernet device.
3183 * New default MAC address.
3185 * - (0) if successful, or *mac_addr* didn't exist.
3186 * - (-ENOTSUP) if hardware doesn't support.
3187 * - (-ENODEV) if *port* invalid.
3188 * - (-EINVAL) if MAC address is invalid.
3190 int rte_eth_dev_default_mac_addr_set(uint8_t port, struct ether_addr *mac_addr);
3194 * Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3197 * The port identifier of the Ethernet device.
3201 * Redirection table size. The table size can be queried by
3202 * rte_eth_dev_info_get().
3204 * - (0) if successful.
3205 * - (-ENOTSUP) if hardware doesn't support.
3206 * - (-EINVAL) if bad parameter.
3208 int rte_eth_dev_rss_reta_update(uint8_t port,
3209 struct rte_eth_rss_reta_entry64 *reta_conf,
3210 uint16_t reta_size);
3213 * Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3216 * The port identifier of the Ethernet device.
3220 * Redirection table size. The table size can be queried by
3221 * rte_eth_dev_info_get().
3223 * - (0) if successful.
3224 * - (-ENOTSUP) if hardware doesn't support.
3225 * - (-EINVAL) if bad parameter.
3227 int rte_eth_dev_rss_reta_query(uint8_t port,
3228 struct rte_eth_rss_reta_entry64 *reta_conf,
3229 uint16_t reta_size);
3232 * Updates unicast hash table for receiving packet with the given destination
3233 * MAC address, and the packet is routed to all VFs for which the RX mode is
3234 * accept packets that match the unicast hash table.
3237 * The port identifier of the Ethernet device.
3239 * Unicast MAC address.
3241 * 1 - Set an unicast hash bit for receiving packets with the MAC address.
3242 * 0 - Clear an unicast hash bit.
3244 * - (0) if successful.
3245 * - (-ENOTSUP) if hardware doesn't support.
3246 * - (-ENODEV) if *port_id* invalid.
3247 * - (-EINVAL) if bad parameter.
3249 int rte_eth_dev_uc_hash_table_set(uint8_t port,struct ether_addr *addr,
3253 * Updates all unicast hash bitmaps for receiving packet with any Unicast
3254 * Ethernet MAC addresses,the packet is routed to all VFs for which the RX
3255 * mode is accept packets that match the unicast hash table.
3258 * The port identifier of the Ethernet device.
3260 * 1 - Set all unicast hash bitmaps for receiving all the Ethernet
3262 * 0 - Clear all unicast hash bitmaps
3264 * - (0) if successful.
3265 * - (-ENOTSUP) if hardware doesn't support.
3266 * - (-ENODEV) if *port_id* invalid.
3267 * - (-EINVAL) if bad parameter.
3269 int rte_eth_dev_uc_all_hash_table_set(uint8_t port,uint8_t on);
3272 * Set RX L2 Filtering mode of a VF of an Ethernet device.
3275 * The port identifier of the Ethernet device.
3279 * The RX mode mask, which is one or more of accepting Untagged Packets,
3280 * packets that match the PFUTA table, Broadcast and Multicast Promiscuous.
3281 * ETH_VMDQ_ACCEPT_UNTAG,ETH_VMDQ_ACCEPT_HASH_UC,
3282 * ETH_VMDQ_ACCEPT_BROADCAST and ETH_VMDQ_ACCEPT_MULTICAST will be used
3285 * 1 - Enable a VF RX mode.
3286 * 0 - Disable a VF RX mode.
3288 * - (0) if successful.
3289 * - (-ENOTSUP) if hardware doesn't support.
3290 * - (-ENOTSUP) if hardware doesn't support.
3291 * - (-EINVAL) if bad parameter.
3293 int rte_eth_dev_set_vf_rxmode(uint8_t port, uint16_t vf, uint16_t rx_mode,
3297 * Enable or disable a VF traffic transmit of the Ethernet device.
3300 * The port identifier of the Ethernet device.
3304 * 1 - Enable a VF traffic transmit.
3305 * 0 - Disable a VF traffic transmit.
3307 * - (0) if successful.
3308 * - (-ENODEV) if *port_id* invalid.
3309 * - (-ENOTSUP) if hardware doesn't support.
3310 * - (-EINVAL) if bad parameter.
3313 rte_eth_dev_set_vf_tx(uint8_t port,uint16_t vf, uint8_t on);
3316 * Enable or disable a VF traffic receive of an Ethernet device.
3319 * The port identifier of the Ethernet device.
3323 * 1 - Enable a VF traffic receive.
3324 * 0 - Disable a VF traffic receive.
3326 * - (0) if successful.
3327 * - (-ENOTSUP) if hardware doesn't support.
3328 * - (-ENODEV) if *port_id* invalid.
3329 * - (-EINVAL) if bad parameter.
3332 rte_eth_dev_set_vf_rx(uint8_t port,uint16_t vf, uint8_t on);
3335 * Enable/Disable hardware VF VLAN filtering by an Ethernet device of
3336 * received VLAN packets tagged with a given VLAN Tag Identifier.
3339 * The port identifier of the Ethernet device.
3341 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
3343 * Bitmap listing which VFs participate in the VLAN filtering.
3345 * 1 - Enable VFs VLAN filtering.
3346 * 0 - Disable VFs VLAN filtering.
3348 * - (0) if successful.
3349 * - (-ENOTSUP) if hardware doesn't support.
3350 * - (-ENODEV) if *port_id* invalid.
3351 * - (-EINVAL) if bad parameter.
3354 rte_eth_dev_set_vf_vlan_filter(uint8_t port, uint16_t vlan_id,
3359 * Set a traffic mirroring rule on an Ethernet device
3362 * The port identifier of the Ethernet device.
3363 * @param mirror_conf
3364 * The pointer to the traffic mirroring structure describing the mirroring rule.
3365 * The *rte_eth_vm_mirror_conf* structure includes the type of mirroring rule,
3366 * destination pool and the value of rule if enable vlan or pool mirroring.
3369 * The index of traffic mirroring rule, we support four separated rules.
3371 * 1 - Enable a mirroring rule.
3372 * 0 - Disable a mirroring rule.
3374 * - (0) if successful.
3375 * - (-ENOTSUP) if hardware doesn't support this feature.
3376 * - (-ENODEV) if *port_id* invalid.
3377 * - (-EINVAL) if the mr_conf information is not correct.
3379 int rte_eth_mirror_rule_set(uint8_t port_id,
3380 struct rte_eth_mirror_conf *mirror_conf,
3385 * Reset a traffic mirroring rule on an Ethernet device.
3388 * The port identifier of the Ethernet device.
3390 * The index of traffic mirroring rule, we support four separated rules.
3392 * - (0) if successful.
3393 * - (-ENOTSUP) if hardware doesn't support this feature.
3394 * - (-ENODEV) if *port_id* invalid.
3395 * - (-EINVAL) if bad parameter.
3397 int rte_eth_mirror_rule_reset(uint8_t port_id,
3401 * Set the rate limitation for a queue on an Ethernet device.
3404 * The port identifier of the Ethernet device.
3408 * The tx rate allocated from the total link speed for this queue.
3410 * - (0) if successful.
3411 * - (-ENOTSUP) if hardware doesn't support this feature.
3412 * - (-ENODEV) if *port_id* invalid.
3413 * - (-EINVAL) if bad parameter.
3415 int rte_eth_set_queue_rate_limit(uint8_t port_id, uint16_t queue_idx,
3419 * Set the rate limitation for a vf on an Ethernet device.
3422 * The port identifier of the Ethernet device.
3426 * The tx rate allocated from the total link speed for this VF id.
3428 * The queue mask which need to set the rate.
3430 * - (0) if successful.
3431 * - (-ENOTSUP) if hardware doesn't support this feature.
3432 * - (-ENODEV) if *port_id* invalid.
3433 * - (-EINVAL) if bad parameter.
3435 int rte_eth_set_vf_rate_limit(uint8_t port_id, uint16_t vf,
3436 uint16_t tx_rate, uint64_t q_msk);
3439 * Initialize bypass logic. This function needs to be called before
3440 * executing any other bypass API.
3443 * The port identifier of the Ethernet device.
3445 * - (0) if successful.
3446 * - (-ENOTSUP) if hardware doesn't support.
3447 * - (-EINVAL) if bad parameter.
3449 int rte_eth_dev_bypass_init(uint8_t port);
3452 * Return bypass state.
3455 * The port identifier of the Ethernet device.
3457 * The return bypass state.
3460 * - (3) Isolate mode
3462 * - (0) if successful.
3463 * - (-ENOTSUP) if hardware doesn't support.
3464 * - (-EINVAL) if bad parameter.
3466 int rte_eth_dev_bypass_state_show(uint8_t port, uint32_t *state);
3472 * The port identifier of the Ethernet device.
3474 * The current bypass state.
3477 * - (3) Isolate mode
3479 * - (0) if successful.
3480 * - (-ENOTSUP) if hardware doesn't support.
3481 * - (-EINVAL) if bad parameter.
3483 int rte_eth_dev_bypass_state_set(uint8_t port, uint32_t *new_state);
3486 * Return bypass state when given event occurs.
3489 * The port identifier of the Ethernet device.
3492 * - (1) Main power on (power button is pushed)
3493 * - (2) Auxiliary power on (power supply is being plugged)
3494 * - (3) Main power off (system shutdown and power supply is left plugged in)
3495 * - (4) Auxiliary power off (power supply is being unplugged)
3496 * - (5) Display or set the watchdog timer
3498 * The bypass state when given event occurred.
3501 * - (3) Isolate mode
3503 * - (0) if successful.
3504 * - (-ENOTSUP) if hardware doesn't support.
3505 * - (-EINVAL) if bad parameter.
3507 int rte_eth_dev_bypass_event_show(uint8_t port, uint32_t event, uint32_t *state);
3510 * Set bypass state when given event occurs.
3513 * The port identifier of the Ethernet device.
3516 * - (1) Main power on (power button is pushed)
3517 * - (2) Auxiliary power on (power supply is being plugged)
3518 * - (3) Main power off (system shutdown and power supply is left plugged in)
3519 * - (4) Auxiliary power off (power supply is being unplugged)
3520 * - (5) Display or set the watchdog timer
3522 * The assigned state when given event occurs.
3525 * - (3) Isolate mode
3527 * - (0) if successful.
3528 * - (-ENOTSUP) if hardware doesn't support.
3529 * - (-EINVAL) if bad parameter.
3531 int rte_eth_dev_bypass_event_store(uint8_t port, uint32_t event, uint32_t state);
3534 * Set bypass watchdog timeout count.
3537 * The port identifier of the Ethernet device.
3539 * The timeout to be set.
3540 * - (0) 0 seconds (timer is off)
3549 * - (0) if successful.
3550 * - (-ENOTSUP) if hardware doesn't support.
3551 * - (-EINVAL) if bad parameter.
3553 int rte_eth_dev_wd_timeout_store(uint8_t port, uint32_t timeout);
3556 * Get bypass firmware version.
3559 * The port identifier of the Ethernet device.
3561 * The firmware version
3563 * - (0) if successful.
3564 * - (-ENOTSUP) if hardware doesn't support.
3565 * - (-EINVAL) if bad parameter.
3567 int rte_eth_dev_bypass_ver_show(uint8_t port, uint32_t *ver);
3570 * Return bypass watchdog timeout in seconds
3573 * The port identifier of the Ethernet device.
3575 * The return watchdog timeout. "0" represents timer expired
3576 * - (0) 0 seconds (timer is off)
3585 * - (0) if successful.
3586 * - (-ENOTSUP) if hardware doesn't support.
3587 * - (-EINVAL) if bad parameter.
3589 int rte_eth_dev_bypass_wd_timeout_show(uint8_t port, uint32_t *wd_timeout);
3592 * Reset bypass watchdog timer
3595 * The port identifier of the Ethernet device.
3597 * - (0) if successful.
3598 * - (-ENOTSUP) if hardware doesn't support.
3599 * - (-EINVAL) if bad parameter.
3601 int rte_eth_dev_bypass_wd_reset(uint8_t port);
3604 * Configuration of Receive Side Scaling hash computation of Ethernet device.
3607 * The port identifier of the Ethernet device.
3609 * The new configuration to use for RSS hash computation on the port.
3611 * - (0) if successful.
3612 * - (-ENODEV) if port identifier is invalid.
3613 * - (-ENOTSUP) if hardware doesn't support.
3614 * - (-EINVAL) if bad parameter.
3616 int rte_eth_dev_rss_hash_update(uint8_t port_id,
3617 struct rte_eth_rss_conf *rss_conf);
3620 * Retrieve current configuration of Receive Side Scaling hash computation
3621 * of Ethernet device.
3624 * The port identifier of the Ethernet device.
3626 * Where to store the current RSS hash configuration of the Ethernet device.
3628 * - (0) if successful.
3629 * - (-ENODEV) if port identifier is invalid.
3630 * - (-ENOTSUP) if hardware doesn't support RSS.
3633 rte_eth_dev_rss_hash_conf_get(uint8_t port_id,
3634 struct rte_eth_rss_conf *rss_conf);
3637 * Add UDP tunneling port of an Ethernet device for filtering a specific
3638 * tunneling packet by UDP port number.
3641 * The port identifier of the Ethernet device.
3643 * UDP tunneling configuration.
3646 * - (0) if successful.
3647 * - (-ENODEV) if port identifier is invalid.
3648 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3651 rte_eth_dev_udp_tunnel_add(uint8_t port_id,
3652 struct rte_eth_udp_tunnel *tunnel_udp);
3655 * Detete UDP tunneling port configuration of Ethernet device
3658 * The port identifier of the Ethernet device.
3660 * UDP tunneling configuration.
3663 * - (0) if successful.
3664 * - (-ENODEV) if port identifier is invalid.
3665 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3668 rte_eth_dev_udp_tunnel_delete(uint8_t port_id,
3669 struct rte_eth_udp_tunnel *tunnel_udp);
3672 * Check whether the filter type is supported on an Ethernet device.
3673 * All the supported filter types are defined in 'rte_eth_ctrl.h'.
3676 * The port identifier of the Ethernet device.
3677 * @param filter_type
3680 * - (0) if successful.
3681 * - (-ENOTSUP) if hardware doesn't support this filter type.
3682 * - (-ENODEV) if *port_id* invalid.
3684 int rte_eth_dev_filter_supported(uint8_t port_id, enum rte_filter_type filter_type);
3687 * Take operations to assigned filter type on an Ethernet device.
3688 * All the supported operations and filter types are defined in 'rte_eth_ctrl.h'.
3691 * The port identifier of the Ethernet device.
3692 * @param filter_type
3695 * Type of operation.
3697 * A pointer to arguments defined specifically for the operation.
3699 * - (0) if successful.
3700 * - (-ENOTSUP) if hardware doesn't support.
3701 * - (-ENODEV) if *port_id* invalid.
3702 * - others depends on the specific operations implementation.
3704 int rte_eth_dev_filter_ctrl(uint8_t port_id, enum rte_filter_type filter_type,
3705 enum rte_filter_op filter_op, void *arg);
3708 * Add a callback to be called on packet RX on a given port and queue.
3710 * This API configures a function to be called for each burst of
3711 * packets received on a given NIC port queue. The return value is a pointer
3712 * that can be used to later remove the callback using
3713 * rte_eth_remove_rx_callback().
3715 * Multiple functions are called in the order that they are added.
3718 * The port identifier of the Ethernet device.
3720 * The queue on the Ethernet device on which the callback is to be added.
3722 * The callback function
3724 * A generic pointer parameter which will be passed to each invocation of the
3725 * callback function on this port and queue.
3729 * On success, a pointer value which can later be used to remove the callback.
3731 void *rte_eth_add_rx_callback(uint8_t port_id, uint16_t queue_id,
3732 rte_rx_callback_fn fn, void *user_param);
3735 * Add a callback to be called on packet TX on a given port and queue.
3737 * This API configures a function to be called for each burst of
3738 * packets sent on a given NIC port queue. The return value is a pointer
3739 * that can be used to later remove the callback using
3740 * rte_eth_remove_tx_callback().
3742 * Multiple functions are called in the order that they are added.
3745 * The port identifier of the Ethernet device.
3747 * The queue on the Ethernet device on which the callback is to be added.
3749 * The callback function
3751 * A generic pointer parameter which will be passed to each invocation of the
3752 * callback function on this port and queue.
3756 * On success, a pointer value which can later be used to remove the callback.
3758 void *rte_eth_add_tx_callback(uint8_t port_id, uint16_t queue_id,
3759 rte_tx_callback_fn fn, void *user_param);
3762 * Remove an RX packet callback from a given port and queue.
3764 * This function is used to removed callbacks that were added to a NIC port
3765 * queue using rte_eth_add_rx_callback().
3767 * Note: the callback is removed from the callback list but it isn't freed
3768 * since the it may still be in use. The memory for the callback can be
3769 * subsequently freed back by the application by calling rte_free():
3771 * - Immediately - if the port is stopped, or the user knows that no
3772 * callbacks are in flight e.g. if called from the thread doing RX/TX
3775 * - After a short delay - where the delay is sufficient to allow any
3776 * in-flight callbacks to complete.
3779 * The port identifier of the Ethernet device.
3781 * The queue on the Ethernet device from which the callback is to be removed.
3783 * User supplied callback created via rte_eth_add_rx_callback().
3786 * - 0: Success. Callback was removed.
3787 * - -ENOTSUP: Callback support is not available.
3788 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
3789 * is NULL or not found for the port/queue.
3791 int rte_eth_remove_rx_callback(uint8_t port_id, uint16_t queue_id,
3792 struct rte_eth_rxtx_callback *user_cb);
3795 * Remove a TX packet callback from a given port and queue.
3797 * This function is used to removed callbacks that were added to a NIC port
3798 * queue using rte_eth_add_tx_callback().
3800 * Note: the callback is removed from the callback list but it isn't freed
3801 * since the it may still be in use. The memory for the callback can be
3802 * subsequently freed back by the application by calling rte_free():
3804 * - Immediately - if the port is stopped, or the user knows that no
3805 * callbacks are in flight e.g. if called from the thread doing RX/TX
3808 * - After a short delay - where the delay is sufficient to allow any
3809 * in-flight callbacks to complete.
3812 * The port identifier of the Ethernet device.
3814 * The queue on the Ethernet device from which the callback is to be removed.
3816 * User supplied callback created via rte_eth_add_tx_callback().
3819 * - 0: Success. Callback was removed.
3820 * - -ENOTSUP: Callback support is not available.
3821 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
3822 * is NULL or not found for the port/queue.
3824 int rte_eth_remove_tx_callback(uint8_t port_id, uint16_t queue_id,
3825 struct rte_eth_rxtx_callback *user_cb);
3828 * Retrieve number of available registers for access
3831 * The port identifier of the Ethernet device.
3833 * - (>=0) number of registers if successful.
3834 * - (-ENOTSUP) if hardware doesn't support.
3835 * - (-ENODEV) if *port_id* invalid.
3836 * - others depends on the specific operations implementation.
3838 int rte_eth_dev_get_reg_length(uint8_t port_id);
3841 * Retrieve device registers and register attributes
3844 * The port identifier of the Ethernet device.
3846 * The template includes buffer for register data and attribute to be filled.
3848 * - (0) if successful.
3849 * - (-ENOTSUP) if hardware doesn't support.
3850 * - (-ENODEV) if *port_id* invalid.
3851 * - others depends on the specific operations implementation.
3853 int rte_eth_dev_get_reg_info(uint8_t port_id, struct rte_dev_reg_info *info);
3856 * Retrieve size of device EEPROM
3859 * The port identifier of the Ethernet device.
3861 * - (>=0) EEPROM size if successful.
3862 * - (-ENOTSUP) if hardware doesn't support.
3863 * - (-ENODEV) if *port_id* invalid.
3864 * - others depends on the specific operations implementation.
3866 int rte_eth_dev_get_eeprom_length(uint8_t port_id);
3869 * Retrieve EEPROM and EEPROM attribute
3872 * The port identifier of the Ethernet device.
3874 * The template includes buffer for return EEPROM data and
3875 * EEPROM attributes to be filled.
3877 * - (0) if successful.
3878 * - (-ENOTSUP) if hardware doesn't support.
3879 * - (-ENODEV) if *port_id* invalid.
3880 * - others depends on the specific operations implementation.
3882 int rte_eth_dev_get_eeprom(uint8_t port_id, struct rte_dev_eeprom_info *info);
3885 * Program EEPROM with provided data
3888 * The port identifier of the Ethernet device.
3890 * The template includes EEPROM data for programming and
3891 * EEPROM attributes to be filled
3893 * - (0) if successful.
3894 * - (-ENOTSUP) if hardware doesn't support.
3895 * - (-ENODEV) if *port_id* invalid.
3896 * - others depends on the specific operations implementation.
3898 int rte_eth_dev_set_eeprom(uint8_t port_id, struct rte_dev_eeprom_info *info);
3901 * Set the list of multicast addresses to filter on an Ethernet device.
3904 * The port identifier of the Ethernet device.
3905 * @param mc_addr_set
3906 * The array of multicast addresses to set. Equal to NULL when the function
3907 * is invoked to flush the set of filtered addresses.
3909 * The number of multicast addresses in the *mc_addr_set* array. Equal to 0
3910 * when the function is invoked to flush the set of filtered addresses.
3912 * - (0) if successful.
3913 * - (-ENODEV) if *port_id* invalid.
3914 * - (-ENOTSUP) if PMD of *port_id* doesn't support multicast filtering.
3915 * - (-ENOSPC) if *port_id* has not enough multicast filtering resources.
3917 int rte_eth_dev_set_mc_addr_list(uint8_t port_id,
3918 struct ether_addr *mc_addr_set,
3919 uint32_t nb_mc_addr);
3922 * Enable IEEE1588/802.1AS timestamping for an Ethernet device.
3925 * The port identifier of the Ethernet device.
3929 * - -ENODEV: The port ID is invalid.
3930 * - -ENOTSUP: The function is not supported by the Ethernet driver.
3932 extern int rte_eth_timesync_enable(uint8_t port_id);
3935 * Disable IEEE1588/802.1AS timestamping for an Ethernet device.
3938 * The port identifier of the Ethernet device.
3942 * - -ENODEV: The port ID is invalid.
3943 * - -ENOTSUP: The function is not supported by the Ethernet driver.
3945 extern int rte_eth_timesync_disable(uint8_t port_id);
3948 * Read an IEEE1588/802.1AS RX timestamp from an Ethernet device.
3951 * The port identifier of the Ethernet device.
3953 * Pointer to the timestamp struct.
3955 * Device specific flags. Used to pass the RX timesync register index to
3956 * i40e. Unused in igb/ixgbe, pass 0 instead.
3960 * - -EINVAL: No timestamp is available.
3961 * - -ENODEV: The port ID is invalid.
3962 * - -ENOTSUP: The function is not supported by the Ethernet driver.
3964 extern int rte_eth_timesync_read_rx_timestamp(uint8_t port_id,
3965 struct timespec *timestamp,
3969 * Read an IEEE1588/802.1AS TX timestamp from an Ethernet device.
3972 * The port identifier of the Ethernet device.
3974 * Pointer to the timestamp struct.
3978 * - -EINVAL: No timestamp is available.
3979 * - -ENODEV: The port ID is invalid.
3980 * - -ENOTSUP: The function is not supported by the Ethernet driver.
3982 extern int rte_eth_timesync_read_tx_timestamp(uint8_t port_id,
3983 struct timespec *timestamp);
3989 #endif /* _RTE_ETHDEV_H_ */