4 * Copyright(c) 2010-2016 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 transmit 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.
177 /* Use this macro to check if LRO API is supported */
178 #define RTE_ETHDEV_HAS_LRO_SUPPORT
181 #include <rte_interrupts.h>
184 #include <rte_devargs.h>
185 #include <rte_errno.h>
186 #include "rte_ether.h"
187 #include "rte_eth_ctrl.h"
188 #include "rte_dev_info.h"
193 * A structure used to retrieve statistics for an Ethernet port.
194 * Not all statistics fields in struct rte_eth_stats are supported
195 * by any type of network interface card (NIC). If any statistics
196 * field is not supported, its value is 0.
198 struct rte_eth_stats {
199 uint64_t ipackets; /**< Total number of successfully received packets. */
200 uint64_t opackets; /**< Total number of successfully transmitted packets.*/
201 uint64_t ibytes; /**< Total number of successfully received bytes. */
202 uint64_t obytes; /**< Total number of successfully transmitted bytes. */
204 /**< Total of RX packets dropped by the HW,
205 * because there are no available buffer (i.e. RX queues are full).
207 uint64_t ierrors; /**< Total number of erroneous received packets. */
208 uint64_t oerrors; /**< Total number of failed transmitted packets. */
209 uint64_t rx_nombuf; /**< Total number of RX mbuf allocation failures. */
210 uint64_t q_ipackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
211 /**< Total number of queue RX packets. */
212 uint64_t q_opackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
213 /**< Total number of queue TX packets. */
214 uint64_t q_ibytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
215 /**< Total number of successfully received queue bytes. */
216 uint64_t q_obytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
217 /**< Total number of successfully transmitted queue bytes. */
218 uint64_t q_errors[RTE_ETHDEV_QUEUE_STAT_CNTRS];
219 /**< Total number of queue packets received that are dropped. */
223 * Device supported speeds bitmap flags
225 #define ETH_LINK_SPEED_AUTONEG (0 << 0) /**< Autonegotiate (all speeds) */
226 #define ETH_LINK_SPEED_FIXED (1 << 0) /**< Disable autoneg (fixed speed) */
227 #define ETH_LINK_SPEED_10M_HD (1 << 1) /**< 10 Mbps half-duplex */
228 #define ETH_LINK_SPEED_10M (1 << 2) /**< 10 Mbps full-duplex */
229 #define ETH_LINK_SPEED_100M_HD (1 << 3) /**< 100 Mbps half-duplex */
230 #define ETH_LINK_SPEED_100M (1 << 4) /**< 100 Mbps full-duplex */
231 #define ETH_LINK_SPEED_1G (1 << 5) /**< 1 Gbps */
232 #define ETH_LINK_SPEED_2_5G (1 << 6) /**< 2.5 Gbps */
233 #define ETH_LINK_SPEED_5G (1 << 7) /**< 5 Gbps */
234 #define ETH_LINK_SPEED_10G (1 << 8) /**< 10 Gbps */
235 #define ETH_LINK_SPEED_20G (1 << 9) /**< 20 Gbps */
236 #define ETH_LINK_SPEED_25G (1 << 10) /**< 25 Gbps */
237 #define ETH_LINK_SPEED_40G (1 << 11) /**< 40 Gbps */
238 #define ETH_LINK_SPEED_50G (1 << 12) /**< 50 Gbps */
239 #define ETH_LINK_SPEED_56G (1 << 13) /**< 56 Gbps */
240 #define ETH_LINK_SPEED_100G (1 << 14) /**< 100 Gbps */
243 * Ethernet numeric link speeds in Mbps
245 #define ETH_SPEED_NUM_NONE 0 /**< Not defined */
246 #define ETH_SPEED_NUM_10M 10 /**< 10 Mbps */
247 #define ETH_SPEED_NUM_100M 100 /**< 100 Mbps */
248 #define ETH_SPEED_NUM_1G 1000 /**< 1 Gbps */
249 #define ETH_SPEED_NUM_2_5G 2500 /**< 2.5 Gbps */
250 #define ETH_SPEED_NUM_5G 5000 /**< 5 Gbps */
251 #define ETH_SPEED_NUM_10G 10000 /**< 10 Gbps */
252 #define ETH_SPEED_NUM_20G 20000 /**< 20 Gbps */
253 #define ETH_SPEED_NUM_25G 25000 /**< 25 Gbps */
254 #define ETH_SPEED_NUM_40G 40000 /**< 40 Gbps */
255 #define ETH_SPEED_NUM_50G 50000 /**< 50 Gbps */
256 #define ETH_SPEED_NUM_56G 56000 /**< 56 Gbps */
257 #define ETH_SPEED_NUM_100G 100000 /**< 100 Gbps */
260 * A structure used to retrieve link-level information of an Ethernet port.
263 struct rte_eth_link {
264 uint32_t link_speed; /**< ETH_SPEED_NUM_ */
265 uint16_t link_duplex : 1; /**< ETH_LINK_[HALF/FULL]_DUPLEX */
266 uint16_t link_autoneg : 1; /**< ETH_LINK_SPEED_[AUTONEG/FIXED] */
267 uint16_t link_status : 1; /**< ETH_LINK_[DOWN/UP] */
268 } __attribute__((aligned(8))); /**< aligned for atomic64 read/write */
270 /* Utility constants */
271 #define ETH_LINK_HALF_DUPLEX 0 /**< Half-duplex connection. */
272 #define ETH_LINK_FULL_DUPLEX 1 /**< Full-duplex connection. */
273 #define ETH_LINK_DOWN 0 /**< Link is down. */
274 #define ETH_LINK_UP 1 /**< Link is up. */
275 #define ETH_LINK_FIXED 0 /**< No autonegotiation. */
276 #define ETH_LINK_AUTONEG 1 /**< Autonegotiated. */
279 * A structure used to configure the ring threshold registers of an RX/TX
280 * queue for an Ethernet port.
282 struct rte_eth_thresh {
283 uint8_t pthresh; /**< Ring prefetch threshold. */
284 uint8_t hthresh; /**< Ring host threshold. */
285 uint8_t wthresh; /**< Ring writeback threshold. */
289 * Simple flags are used for rte_eth_conf.rxmode.mq_mode.
291 #define ETH_MQ_RX_RSS_FLAG 0x1
292 #define ETH_MQ_RX_DCB_FLAG 0x2
293 #define ETH_MQ_RX_VMDQ_FLAG 0x4
296 * A set of values to identify what method is to be used to route
297 * packets to multiple queues.
299 enum rte_eth_rx_mq_mode {
300 /** None of DCB,RSS or VMDQ mode */
303 /** For RX side, only RSS is on */
304 ETH_MQ_RX_RSS = ETH_MQ_RX_RSS_FLAG,
305 /** For RX side,only DCB is on. */
306 ETH_MQ_RX_DCB = ETH_MQ_RX_DCB_FLAG,
307 /** Both DCB and RSS enable */
308 ETH_MQ_RX_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG,
310 /** Only VMDQ, no RSS nor DCB */
311 ETH_MQ_RX_VMDQ_ONLY = ETH_MQ_RX_VMDQ_FLAG,
312 /** RSS mode with VMDQ */
313 ETH_MQ_RX_VMDQ_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_VMDQ_FLAG,
314 /** Use VMDQ+DCB to route traffic to queues */
315 ETH_MQ_RX_VMDQ_DCB = ETH_MQ_RX_VMDQ_FLAG | ETH_MQ_RX_DCB_FLAG,
316 /** Enable both VMDQ and DCB in VMDq */
317 ETH_MQ_RX_VMDQ_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG |
322 * for rx mq mode backward compatible
324 #define ETH_RSS ETH_MQ_RX_RSS
325 #define VMDQ_DCB ETH_MQ_RX_VMDQ_DCB
326 #define ETH_DCB_RX ETH_MQ_RX_DCB
329 * A set of values to identify what method is to be used to transmit
330 * packets using multi-TCs.
332 enum rte_eth_tx_mq_mode {
333 ETH_MQ_TX_NONE = 0, /**< It is in neither DCB nor VT mode. */
334 ETH_MQ_TX_DCB, /**< For TX side,only DCB is on. */
335 ETH_MQ_TX_VMDQ_DCB, /**< For TX side,both DCB and VT is on. */
336 ETH_MQ_TX_VMDQ_ONLY, /**< Only VT on, no DCB */
340 * for tx mq mode backward compatible
342 #define ETH_DCB_NONE ETH_MQ_TX_NONE
343 #define ETH_VMDQ_DCB_TX ETH_MQ_TX_VMDQ_DCB
344 #define ETH_DCB_TX ETH_MQ_TX_DCB
347 * A structure used to configure the RX features of an Ethernet port.
349 struct rte_eth_rxmode {
350 /** The multi-queue packet distribution mode to be used, e.g. RSS. */
351 enum rte_eth_rx_mq_mode mq_mode;
352 uint32_t max_rx_pkt_len; /**< Only used if jumbo_frame enabled. */
353 uint16_t split_hdr_size; /**< hdr buf size (header_split enabled).*/
355 uint16_t header_split : 1, /**< Header Split enable. */
356 hw_ip_checksum : 1, /**< IP/UDP/TCP checksum offload enable. */
357 hw_vlan_filter : 1, /**< VLAN filter enable. */
358 hw_vlan_strip : 1, /**< VLAN strip enable. */
359 hw_vlan_extend : 1, /**< Extended VLAN enable. */
360 jumbo_frame : 1, /**< Jumbo Frame Receipt enable. */
361 hw_strip_crc : 1, /**< Enable CRC stripping by hardware. */
362 enable_scatter : 1, /**< Enable scatter packets rx handler */
363 enable_lro : 1; /**< Enable LRO */
367 * VLAN types to indicate if it is for single VLAN, inner VLAN or outer VLAN.
368 * Note that single VLAN is treated the same as inner VLAN.
371 ETH_VLAN_TYPE_UNKNOWN = 0,
372 ETH_VLAN_TYPE_INNER, /**< Inner VLAN. */
373 ETH_VLAN_TYPE_OUTER, /**< Single VLAN, or outer VLAN. */
378 * A structure used to configure the Receive Side Scaling (RSS) feature
379 * of an Ethernet port.
380 * If not NULL, the *rss_key* pointer of the *rss_conf* structure points
381 * to an array holding the RSS key to use for hashing specific header
382 * fields of received packets. The length of this array should be indicated
383 * by *rss_key_len* below. Otherwise, a default random hash key is used by
386 * The *rss_key_len* field of the *rss_conf* structure indicates the length
387 * in bytes of the array pointed by *rss_key*. To be compatible, this length
388 * will be checked in i40e only. Others assume 40 bytes to be used as before.
390 * The *rss_hf* field of the *rss_conf* structure indicates the different
391 * types of IPv4/IPv6 packets to which the RSS hashing must be applied.
392 * Supplying an *rss_hf* equal to zero disables the RSS feature.
394 struct rte_eth_rss_conf {
395 uint8_t *rss_key; /**< If not NULL, 40-byte hash key. */
396 uint8_t rss_key_len; /**< hash key length in bytes. */
397 uint64_t rss_hf; /**< Hash functions to apply - see below. */
401 * The RSS offload types are defined based on flow types which are defined
402 * in rte_eth_ctrl.h. Different NIC hardwares may support different RSS offload
403 * types. The supported flow types or RSS offload types can be queried by
404 * rte_eth_dev_info_get().
406 #define ETH_RSS_IPV4 (1ULL << RTE_ETH_FLOW_IPV4)
407 #define ETH_RSS_FRAG_IPV4 (1ULL << RTE_ETH_FLOW_FRAG_IPV4)
408 #define ETH_RSS_NONFRAG_IPV4_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_TCP)
409 #define ETH_RSS_NONFRAG_IPV4_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_UDP)
410 #define ETH_RSS_NONFRAG_IPV4_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_SCTP)
411 #define ETH_RSS_NONFRAG_IPV4_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_OTHER)
412 #define ETH_RSS_IPV6 (1ULL << RTE_ETH_FLOW_IPV6)
413 #define ETH_RSS_FRAG_IPV6 (1ULL << RTE_ETH_FLOW_FRAG_IPV6)
414 #define ETH_RSS_NONFRAG_IPV6_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_TCP)
415 #define ETH_RSS_NONFRAG_IPV6_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_UDP)
416 #define ETH_RSS_NONFRAG_IPV6_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_SCTP)
417 #define ETH_RSS_NONFRAG_IPV6_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_OTHER)
418 #define ETH_RSS_L2_PAYLOAD (1ULL << RTE_ETH_FLOW_L2_PAYLOAD)
419 #define ETH_RSS_IPV6_EX (1ULL << RTE_ETH_FLOW_IPV6_EX)
420 #define ETH_RSS_IPV6_TCP_EX (1ULL << RTE_ETH_FLOW_IPV6_TCP_EX)
421 #define ETH_RSS_IPV6_UDP_EX (1ULL << RTE_ETH_FLOW_IPV6_UDP_EX)
422 #define ETH_RSS_PORT (1ULL << RTE_ETH_FLOW_PORT)
423 #define ETH_RSS_VXLAN (1ULL << RTE_ETH_FLOW_VXLAN)
424 #define ETH_RSS_GENEVE (1ULL << RTE_ETH_FLOW_GENEVE)
425 #define ETH_RSS_NVGRE (1ULL << RTE_ETH_FLOW_NVGRE)
427 #define ETH_RSS_IP ( \
429 ETH_RSS_FRAG_IPV4 | \
430 ETH_RSS_NONFRAG_IPV4_OTHER | \
432 ETH_RSS_FRAG_IPV6 | \
433 ETH_RSS_NONFRAG_IPV6_OTHER | \
436 #define ETH_RSS_UDP ( \
437 ETH_RSS_NONFRAG_IPV4_UDP | \
438 ETH_RSS_NONFRAG_IPV6_UDP | \
441 #define ETH_RSS_TCP ( \
442 ETH_RSS_NONFRAG_IPV4_TCP | \
443 ETH_RSS_NONFRAG_IPV6_TCP | \
446 #define ETH_RSS_SCTP ( \
447 ETH_RSS_NONFRAG_IPV4_SCTP | \
448 ETH_RSS_NONFRAG_IPV6_SCTP)
450 #define ETH_RSS_TUNNEL ( \
456 /**< Mask of valid RSS hash protocols */
457 #define ETH_RSS_PROTO_MASK ( \
459 ETH_RSS_FRAG_IPV4 | \
460 ETH_RSS_NONFRAG_IPV4_TCP | \
461 ETH_RSS_NONFRAG_IPV4_UDP | \
462 ETH_RSS_NONFRAG_IPV4_SCTP | \
463 ETH_RSS_NONFRAG_IPV4_OTHER | \
465 ETH_RSS_FRAG_IPV6 | \
466 ETH_RSS_NONFRAG_IPV6_TCP | \
467 ETH_RSS_NONFRAG_IPV6_UDP | \
468 ETH_RSS_NONFRAG_IPV6_SCTP | \
469 ETH_RSS_NONFRAG_IPV6_OTHER | \
470 ETH_RSS_L2_PAYLOAD | \
472 ETH_RSS_IPV6_TCP_EX | \
473 ETH_RSS_IPV6_UDP_EX | \
480 * Definitions used for redirection table entry size.
481 * Some RSS RETA sizes may not be supported by some drivers, check the
482 * documentation or the description of relevant functions for more details.
484 #define ETH_RSS_RETA_SIZE_64 64
485 #define ETH_RSS_RETA_SIZE_128 128
486 #define ETH_RSS_RETA_SIZE_256 256
487 #define ETH_RSS_RETA_SIZE_512 512
488 #define RTE_RETA_GROUP_SIZE 64
490 /* Definitions used for VMDQ and DCB functionality */
491 #define ETH_VMDQ_MAX_VLAN_FILTERS 64 /**< Maximum nb. of VMDQ vlan filters. */
492 #define ETH_DCB_NUM_USER_PRIORITIES 8 /**< Maximum nb. of DCB priorities. */
493 #define ETH_VMDQ_DCB_NUM_QUEUES 128 /**< Maximum nb. of VMDQ DCB queues. */
494 #define ETH_DCB_NUM_QUEUES 128 /**< Maximum nb. of DCB queues. */
496 /* DCB capability defines */
497 #define ETH_DCB_PG_SUPPORT 0x00000001 /**< Priority Group(ETS) support. */
498 #define ETH_DCB_PFC_SUPPORT 0x00000002 /**< Priority Flow Control support. */
500 /* Definitions used for VLAN Offload functionality */
501 #define ETH_VLAN_STRIP_OFFLOAD 0x0001 /**< VLAN Strip On/Off */
502 #define ETH_VLAN_FILTER_OFFLOAD 0x0002 /**< VLAN Filter On/Off */
503 #define ETH_VLAN_EXTEND_OFFLOAD 0x0004 /**< VLAN Extend On/Off */
505 /* Definitions used for mask VLAN setting */
506 #define ETH_VLAN_STRIP_MASK 0x0001 /**< VLAN Strip setting mask */
507 #define ETH_VLAN_FILTER_MASK 0x0002 /**< VLAN Filter setting mask*/
508 #define ETH_VLAN_EXTEND_MASK 0x0004 /**< VLAN Extend setting mask*/
509 #define ETH_VLAN_ID_MAX 0x0FFF /**< VLAN ID is in lower 12 bits*/
511 /* Definitions used for receive MAC address */
512 #define ETH_NUM_RECEIVE_MAC_ADDR 128 /**< Maximum nb. of receive mac addr. */
514 /* Definitions used for unicast hash */
515 #define ETH_VMDQ_NUM_UC_HASH_ARRAY 128 /**< Maximum nb. of UC hash array. */
517 /* Definitions used for VMDQ pool rx mode setting */
518 #define ETH_VMDQ_ACCEPT_UNTAG 0x0001 /**< accept untagged packets. */
519 #define ETH_VMDQ_ACCEPT_HASH_MC 0x0002 /**< accept packets in multicast table . */
520 #define ETH_VMDQ_ACCEPT_HASH_UC 0x0004 /**< accept packets in unicast table. */
521 #define ETH_VMDQ_ACCEPT_BROADCAST 0x0008 /**< accept broadcast packets. */
522 #define ETH_VMDQ_ACCEPT_MULTICAST 0x0010 /**< multicast promiscuous. */
524 /** Maximum nb. of vlan per mirror rule */
525 #define ETH_MIRROR_MAX_VLANS 64
527 #define ETH_MIRROR_VIRTUAL_POOL_UP 0x01 /**< Virtual Pool uplink Mirroring. */
528 #define ETH_MIRROR_UPLINK_PORT 0x02 /**< Uplink Port Mirroring. */
529 #define ETH_MIRROR_DOWNLINK_PORT 0x04 /**< Downlink Port Mirroring. */
530 #define ETH_MIRROR_VLAN 0x08 /**< VLAN Mirroring. */
531 #define ETH_MIRROR_VIRTUAL_POOL_DOWN 0x10 /**< Virtual Pool downlink Mirroring. */
534 * A structure used to configure VLAN traffic mirror of an Ethernet port.
536 struct rte_eth_vlan_mirror {
537 uint64_t vlan_mask; /**< mask for valid VLAN ID. */
538 /** VLAN ID list for vlan mirroring. */
539 uint16_t vlan_id[ETH_MIRROR_MAX_VLANS];
543 * A structure used to configure traffic mirror of an Ethernet port.
545 struct rte_eth_mirror_conf {
546 uint8_t rule_type; /**< Mirroring rule type */
547 uint8_t dst_pool; /**< Destination pool for this mirror rule. */
548 uint64_t pool_mask; /**< Bitmap of pool for pool mirroring */
549 /** VLAN ID setting for VLAN mirroring. */
550 struct rte_eth_vlan_mirror vlan;
554 * A structure used to configure 64 entries of Redirection Table of the
555 * Receive Side Scaling (RSS) feature of an Ethernet port. To configure
556 * more than 64 entries supported by hardware, an array of this structure
559 struct rte_eth_rss_reta_entry64 {
561 /**< Mask bits indicate which entries need to be updated/queried. */
562 uint16_t reta[RTE_RETA_GROUP_SIZE];
563 /**< Group of 64 redirection table entries. */
567 * This enum indicates the possible number of traffic classes
568 * in DCB configratioins
570 enum rte_eth_nb_tcs {
571 ETH_4_TCS = 4, /**< 4 TCs with DCB. */
572 ETH_8_TCS = 8 /**< 8 TCs with DCB. */
576 * This enum indicates the possible number of queue pools
577 * in VMDQ configurations.
579 enum rte_eth_nb_pools {
580 ETH_8_POOLS = 8, /**< 8 VMDq pools. */
581 ETH_16_POOLS = 16, /**< 16 VMDq pools. */
582 ETH_32_POOLS = 32, /**< 32 VMDq pools. */
583 ETH_64_POOLS = 64 /**< 64 VMDq pools. */
586 /* This structure may be extended in future. */
587 struct rte_eth_dcb_rx_conf {
588 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs */
589 /** Traffic class each UP mapped to. */
590 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
593 struct rte_eth_vmdq_dcb_tx_conf {
594 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools. */
595 /** Traffic class each UP mapped to. */
596 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
599 struct rte_eth_dcb_tx_conf {
600 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs. */
601 /** Traffic class each UP mapped to. */
602 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
605 struct rte_eth_vmdq_tx_conf {
606 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq mode, 64 pools. */
610 * A structure used to configure the VMDQ+DCB feature
611 * of an Ethernet port.
613 * Using this feature, packets are routed to a pool of queues, based
614 * on the vlan id in the vlan tag, and then to a specific queue within
615 * that pool, using the user priority vlan tag field.
617 * A default pool may be used, if desired, to route all traffic which
618 * does not match the vlan filter rules.
620 struct rte_eth_vmdq_dcb_conf {
621 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools */
622 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
623 uint8_t default_pool; /**< The default pool, if applicable */
624 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
626 uint16_t vlan_id; /**< The vlan id of the received frame */
627 uint64_t pools; /**< Bitmask of pools for packet rx */
628 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
629 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
630 /**< Selects a queue in a pool */
633 struct rte_eth_vmdq_rx_conf {
634 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq only mode, 8 or 64 pools */
635 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
636 uint8_t default_pool; /**< The default pool, if applicable */
637 uint8_t enable_loop_back; /**< Enable VT loop back */
638 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
639 uint32_t rx_mode; /**< Flags from ETH_VMDQ_ACCEPT_* */
641 uint16_t vlan_id; /**< The vlan id of the received frame */
642 uint64_t pools; /**< Bitmask of pools for packet rx */
643 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
647 * A structure used to configure the TX features of an Ethernet port.
649 struct rte_eth_txmode {
650 enum rte_eth_tx_mq_mode mq_mode; /**< TX multi-queues mode. */
652 /* For i40e specifically */
655 uint8_t hw_vlan_reject_tagged : 1,
656 /**< If set, reject sending out tagged pkts */
657 hw_vlan_reject_untagged : 1,
658 /**< If set, reject sending out untagged pkts */
659 hw_vlan_insert_pvid : 1;
660 /**< If set, enable port based VLAN insertion */
664 * A structure used to configure an RX ring of an Ethernet port.
666 struct rte_eth_rxconf {
667 struct rte_eth_thresh rx_thresh; /**< RX ring threshold registers. */
668 uint16_t rx_free_thresh; /**< Drives the freeing of RX descriptors. */
669 uint8_t rx_drop_en; /**< Drop packets if no descriptors are available. */
670 uint8_t rx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
673 #define ETH_TXQ_FLAGS_NOMULTSEGS 0x0001 /**< nb_segs=1 for all mbufs */
674 #define ETH_TXQ_FLAGS_NOREFCOUNT 0x0002 /**< refcnt can be ignored */
675 #define ETH_TXQ_FLAGS_NOMULTMEMP 0x0004 /**< all bufs come from same mempool */
676 #define ETH_TXQ_FLAGS_NOVLANOFFL 0x0100 /**< disable VLAN offload */
677 #define ETH_TXQ_FLAGS_NOXSUMSCTP 0x0200 /**< disable SCTP checksum offload */
678 #define ETH_TXQ_FLAGS_NOXSUMUDP 0x0400 /**< disable UDP checksum offload */
679 #define ETH_TXQ_FLAGS_NOXSUMTCP 0x0800 /**< disable TCP checksum offload */
680 #define ETH_TXQ_FLAGS_NOOFFLOADS \
681 (ETH_TXQ_FLAGS_NOVLANOFFL | ETH_TXQ_FLAGS_NOXSUMSCTP | \
682 ETH_TXQ_FLAGS_NOXSUMUDP | ETH_TXQ_FLAGS_NOXSUMTCP)
683 #define ETH_TXQ_FLAGS_NOXSUMS \
684 (ETH_TXQ_FLAGS_NOXSUMSCTP | ETH_TXQ_FLAGS_NOXSUMUDP | \
685 ETH_TXQ_FLAGS_NOXSUMTCP)
687 * A structure used to configure a TX ring of an Ethernet port.
689 struct rte_eth_txconf {
690 struct rte_eth_thresh tx_thresh; /**< TX ring threshold registers. */
691 uint16_t tx_rs_thresh; /**< Drives the setting of RS bit on TXDs. */
692 uint16_t tx_free_thresh; /**< Start freeing TX buffers if there are
693 less free descriptors than this value. */
695 uint32_t txq_flags; /**< Set flags for the Tx queue */
696 uint8_t tx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
700 * A structure contains information about HW descriptor ring limitations.
702 struct rte_eth_desc_lim {
703 uint16_t nb_max; /**< Max allowed number of descriptors. */
704 uint16_t nb_min; /**< Min allowed number of descriptors. */
705 uint16_t nb_align; /**< Number of descriptors should be aligned to. */
708 * Max allowed number of segments per whole packet.
710 * - For TSO packet this is the total number of data descriptors allowed
713 * @see nb_mtu_seg_max
718 * Max number of segments per one MTU.
720 * - For non-TSO packet, this is the maximum allowed number of segments
721 * in a single transmit packet.
723 * - For TSO packet each segment within the TSO may span up to this
728 uint16_t nb_mtu_seg_max;
732 * This enum indicates the flow control mode
734 enum rte_eth_fc_mode {
735 RTE_FC_NONE = 0, /**< Disable flow control. */
736 RTE_FC_RX_PAUSE, /**< RX pause frame, enable flowctrl on TX side. */
737 RTE_FC_TX_PAUSE, /**< TX pause frame, enable flowctrl on RX side. */
738 RTE_FC_FULL /**< Enable flow control on both side. */
742 * A structure used to configure Ethernet flow control parameter.
743 * These parameters will be configured into the register of the NIC.
744 * Please refer to the corresponding data sheet for proper value.
746 struct rte_eth_fc_conf {
747 uint32_t high_water; /**< High threshold value to trigger XOFF */
748 uint32_t low_water; /**< Low threshold value to trigger XON */
749 uint16_t pause_time; /**< Pause quota in the Pause frame */
750 uint16_t send_xon; /**< Is XON frame need be sent */
751 enum rte_eth_fc_mode mode; /**< Link flow control mode */
752 uint8_t mac_ctrl_frame_fwd; /**< Forward MAC control frames */
753 uint8_t autoneg; /**< Use Pause autoneg */
757 * A structure used to configure Ethernet priority flow control parameter.
758 * These parameters will be configured into the register of the NIC.
759 * Please refer to the corresponding data sheet for proper value.
761 struct rte_eth_pfc_conf {
762 struct rte_eth_fc_conf fc; /**< General flow control parameter. */
763 uint8_t priority; /**< VLAN User Priority. */
767 * Memory space that can be configured to store Flow Director filters
768 * in the board memory.
770 enum rte_fdir_pballoc_type {
771 RTE_FDIR_PBALLOC_64K = 0, /**< 64k. */
772 RTE_FDIR_PBALLOC_128K, /**< 128k. */
773 RTE_FDIR_PBALLOC_256K, /**< 256k. */
777 * Select report mode of FDIR hash information in RX descriptors.
779 enum rte_fdir_status_mode {
780 RTE_FDIR_NO_REPORT_STATUS = 0, /**< Never report FDIR hash. */
781 RTE_FDIR_REPORT_STATUS, /**< Only report FDIR hash for matching pkts. */
782 RTE_FDIR_REPORT_STATUS_ALWAYS, /**< Always report FDIR hash. */
786 * A structure used to configure the Flow Director (FDIR) feature
787 * of an Ethernet port.
789 * If mode is RTE_FDIR_DISABLE, the pballoc value is ignored.
791 struct rte_fdir_conf {
792 enum rte_fdir_mode mode; /**< Flow Director mode. */
793 enum rte_fdir_pballoc_type pballoc; /**< Space for FDIR filters. */
794 enum rte_fdir_status_mode status; /**< How to report FDIR hash. */
795 /** RX queue of packets matching a "drop" filter in perfect mode. */
797 struct rte_eth_fdir_masks mask;
798 struct rte_eth_fdir_flex_conf flex_conf;
799 /**< Flex payload configuration. */
803 * UDP tunneling configuration.
804 * Used to config the UDP port for a type of tunnel.
805 * NICs need the UDP port to identify the tunnel type.
806 * Normally a type of tunnel has a default UDP port, this structure can be used
807 * in case if the users want to change or support more UDP port.
809 struct rte_eth_udp_tunnel {
810 uint16_t udp_port; /**< UDP port used for the tunnel. */
811 uint8_t prot_type; /**< Tunnel type. Defined in rte_eth_tunnel_type. */
815 * A structure used to enable/disable specific device interrupts.
817 struct rte_intr_conf {
818 /** enable/disable lsc interrupt. 0 (default) - disable, 1 enable */
820 /** enable/disable rxq interrupt. 0 (default) - disable, 1 enable */
825 * A structure used to configure an Ethernet port.
826 * Depending upon the RX multi-queue mode, extra advanced
827 * configuration settings may be needed.
829 struct rte_eth_conf {
830 uint32_t link_speeds; /**< bitmap of ETH_LINK_SPEED_XXX of speeds to be
831 used. ETH_LINK_SPEED_FIXED disables link
832 autonegotiation, and a unique speed shall be
833 set. Otherwise, the bitmap defines the set of
834 speeds to be advertised. If the special value
835 ETH_LINK_SPEED_AUTONEG (0) is used, all speeds
836 supported are advertised. */
837 struct rte_eth_rxmode rxmode; /**< Port RX configuration. */
838 struct rte_eth_txmode txmode; /**< Port TX configuration. */
839 uint32_t lpbk_mode; /**< Loopback operation mode. By default the value
840 is 0, meaning the loopback mode is disabled.
841 Read the datasheet of given ethernet controller
842 for details. The possible values of this field
843 are defined in implementation of each driver. */
845 struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
846 struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
847 /**< Port vmdq+dcb configuration. */
848 struct rte_eth_dcb_rx_conf dcb_rx_conf;
849 /**< Port dcb RX configuration. */
850 struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
851 /**< Port vmdq RX configuration. */
852 } rx_adv_conf; /**< Port RX filtering configuration (union). */
854 struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
855 /**< Port vmdq+dcb TX configuration. */
856 struct rte_eth_dcb_tx_conf dcb_tx_conf;
857 /**< Port dcb TX configuration. */
858 struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
859 /**< Port vmdq TX configuration. */
860 } tx_adv_conf; /**< Port TX DCB configuration (union). */
861 /** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
862 is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
863 uint32_t dcb_capability_en;
864 struct rte_fdir_conf fdir_conf; /**< FDIR configuration. */
865 struct rte_intr_conf intr_conf; /**< Interrupt mode configuration. */
869 * A structure used to retrieve the contextual information of
870 * an Ethernet device, such as the controlling driver of the device,
871 * its PCI context, etc...
875 * RX offload capabilities of a device.
877 #define DEV_RX_OFFLOAD_VLAN_STRIP 0x00000001
878 #define DEV_RX_OFFLOAD_IPV4_CKSUM 0x00000002
879 #define DEV_RX_OFFLOAD_UDP_CKSUM 0x00000004
880 #define DEV_RX_OFFLOAD_TCP_CKSUM 0x00000008
881 #define DEV_RX_OFFLOAD_TCP_LRO 0x00000010
882 #define DEV_RX_OFFLOAD_QINQ_STRIP 0x00000020
883 #define DEV_RX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000040
884 #define DEV_RX_OFFLOAD_MACSEC_STRIP 0x00000080
887 * TX offload capabilities of a device.
889 #define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001
890 #define DEV_TX_OFFLOAD_IPV4_CKSUM 0x00000002
891 #define DEV_TX_OFFLOAD_UDP_CKSUM 0x00000004
892 #define DEV_TX_OFFLOAD_TCP_CKSUM 0x00000008
893 #define DEV_TX_OFFLOAD_SCTP_CKSUM 0x00000010
894 #define DEV_TX_OFFLOAD_TCP_TSO 0x00000020
895 #define DEV_TX_OFFLOAD_UDP_TSO 0x00000040
896 #define DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000080 /**< Used for tunneling packet. */
897 #define DEV_TX_OFFLOAD_QINQ_INSERT 0x00000100
898 #define DEV_TX_OFFLOAD_VXLAN_TNL_TSO 0x00000200 /**< Used for tunneling packet. */
899 #define DEV_TX_OFFLOAD_GRE_TNL_TSO 0x00000400 /**< Used for tunneling packet. */
900 #define DEV_TX_OFFLOAD_IPIP_TNL_TSO 0x00000800 /**< Used for tunneling packet. */
901 #define DEV_TX_OFFLOAD_GENEVE_TNL_TSO 0x00001000 /**< Used for tunneling packet. */
902 #define DEV_TX_OFFLOAD_MACSEC_INSERT 0x00002000
905 * Ethernet device information
907 struct rte_eth_dev_info {
908 struct rte_pci_device *pci_dev; /**< Device PCI information. */
909 const char *driver_name; /**< Device Driver name. */
910 unsigned int if_index; /**< Index to bound host interface, or 0 if none.
911 Use if_indextoname() to translate into an interface name. */
912 uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
913 uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
914 uint16_t max_rx_queues; /**< Maximum number of RX queues. */
915 uint16_t max_tx_queues; /**< Maximum number of TX queues. */
916 uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
917 uint32_t max_hash_mac_addrs;
918 /** Maximum number of hash MAC addresses for MTA and UTA. */
919 uint16_t max_vfs; /**< Maximum number of VFs. */
920 uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
921 uint32_t rx_offload_capa; /**< Device RX offload capabilities. */
922 uint32_t tx_offload_capa; /**< Device TX offload capabilities. */
924 /**< Device redirection table size, the total number of entries. */
925 uint8_t hash_key_size; /**< Hash key size in bytes */
926 /** Bit mask of RSS offloads, the bit offset also means flow type */
927 uint64_t flow_type_rss_offloads;
928 struct rte_eth_rxconf default_rxconf; /**< Default RX configuration */
929 struct rte_eth_txconf default_txconf; /**< Default TX configuration */
930 uint16_t vmdq_queue_base; /**< First queue ID for VMDQ pools. */
931 uint16_t vmdq_queue_num; /**< Queue number for VMDQ pools. */
932 uint16_t vmdq_pool_base; /**< First ID of VMDQ pools. */
933 struct rte_eth_desc_lim rx_desc_lim; /**< RX descriptors limits */
934 struct rte_eth_desc_lim tx_desc_lim; /**< TX descriptors limits */
935 uint32_t speed_capa; /**< Supported speeds bitmap (ETH_LINK_SPEED_). */
936 /** Configured number of rx/tx queues */
937 uint16_t nb_rx_queues; /**< Number of RX queues. */
938 uint16_t nb_tx_queues; /**< Number of TX queues. */
942 * Ethernet device RX queue information structure.
943 * Used to retieve information about configured queue.
945 struct rte_eth_rxq_info {
946 struct rte_mempool *mp; /**< mempool used by that queue. */
947 struct rte_eth_rxconf conf; /**< queue config parameters. */
948 uint8_t scattered_rx; /**< scattered packets RX supported. */
949 uint16_t nb_desc; /**< configured number of RXDs. */
950 } __rte_cache_min_aligned;
953 * Ethernet device TX queue information structure.
954 * Used to retieve information about configured queue.
956 struct rte_eth_txq_info {
957 struct rte_eth_txconf conf; /**< queue config parameters. */
958 uint16_t nb_desc; /**< configured number of TXDs. */
959 } __rte_cache_min_aligned;
961 /** Maximum name length for extended statistics counters */
962 #define RTE_ETH_XSTATS_NAME_SIZE 64
965 * An Ethernet device extended statistic structure
967 * This structure is used by rte_eth_xstats_get() to provide
968 * statistics that are not provided in the generic *rte_eth_stats*
970 * It maps a name id, corresponding to an index in the array returned
971 * by rte_eth_xstats_get_names(), to a statistic value.
973 struct rte_eth_xstat {
974 uint64_t id; /**< The index in xstats name array. */
975 uint64_t value; /**< The statistic counter value. */
979 * A name element for extended statistics.
981 * An array of this structure is returned by rte_eth_xstats_get_names().
982 * It lists the names of extended statistics for a PMD. The *rte_eth_xstat*
983 * structure references these names by their array index.
985 struct rte_eth_xstat_name {
986 char name[RTE_ETH_XSTATS_NAME_SIZE]; /**< The statistic name. */
989 #define ETH_DCB_NUM_TCS 8
990 #define ETH_MAX_VMDQ_POOL 64
993 * A structure used to get the information of queue and
994 * TC mapping on both TX and RX paths.
996 struct rte_eth_dcb_tc_queue_mapping {
997 /** rx queues assigned to tc per Pool */
1001 } tc_rxq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
1002 /** rx queues assigned to tc per Pool */
1006 } tc_txq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
1010 * A structure used to get the information of DCB.
1011 * It includes TC UP mapping and queue TC mapping.
1013 struct rte_eth_dcb_info {
1014 uint8_t nb_tcs; /**< number of TCs */
1015 uint8_t prio_tc[ETH_DCB_NUM_USER_PRIORITIES]; /**< Priority to tc */
1016 uint8_t tc_bws[ETH_DCB_NUM_TCS]; /**< TX BW percentage for each TC */
1017 /** rx queues assigned to tc */
1018 struct rte_eth_dcb_tc_queue_mapping tc_queue;
1022 * RX/TX queue states
1024 #define RTE_ETH_QUEUE_STATE_STOPPED 0
1025 #define RTE_ETH_QUEUE_STATE_STARTED 1
1029 struct rte_eth_dev_callback;
1030 /** @internal Structure to keep track of registered callbacks */
1031 TAILQ_HEAD(rte_eth_dev_cb_list, rte_eth_dev_callback);
1034 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
1035 #define RTE_PMD_DEBUG_TRACE(...) \
1036 rte_pmd_debug_trace(__func__, __VA_ARGS__)
1038 #define RTE_PMD_DEBUG_TRACE(...)
1042 /* Macros to check for valid port */
1043 #define RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, retval) do { \
1044 if (!rte_eth_dev_is_valid_port(port_id)) { \
1045 RTE_PMD_DEBUG_TRACE("Invalid port_id=%d\n", port_id); \
1050 #define RTE_ETH_VALID_PORTID_OR_RET(port_id) do { \
1051 if (!rte_eth_dev_is_valid_port(port_id)) { \
1052 RTE_PMD_DEBUG_TRACE("Invalid port_id=%d\n", port_id); \
1058 * l2 tunnel configuration.
1061 /**< l2 tunnel enable mask */
1062 #define ETH_L2_TUNNEL_ENABLE_MASK 0x00000001
1063 /**< l2 tunnel insertion mask */
1064 #define ETH_L2_TUNNEL_INSERTION_MASK 0x00000002
1065 /**< l2 tunnel stripping mask */
1066 #define ETH_L2_TUNNEL_STRIPPING_MASK 0x00000004
1067 /**< l2 tunnel forwarding mask */
1068 #define ETH_L2_TUNNEL_FORWARDING_MASK 0x00000008
1071 * Definitions of all functions exported by an Ethernet driver through the
1072 * the generic structure of type *eth_dev_ops* supplied in the *rte_eth_dev*
1073 * structure associated with an Ethernet device.
1076 typedef int (*eth_dev_configure_t)(struct rte_eth_dev *dev);
1077 /**< @internal Ethernet device configuration. */
1079 typedef int (*eth_dev_start_t)(struct rte_eth_dev *dev);
1080 /**< @internal Function used to start a configured Ethernet device. */
1082 typedef void (*eth_dev_stop_t)(struct rte_eth_dev *dev);
1083 /**< @internal Function used to stop a configured Ethernet device. */
1085 typedef int (*eth_dev_set_link_up_t)(struct rte_eth_dev *dev);
1086 /**< @internal Function used to link up a configured Ethernet device. */
1088 typedef int (*eth_dev_set_link_down_t)(struct rte_eth_dev *dev);
1089 /**< @internal Function used to link down a configured Ethernet device. */
1091 typedef void (*eth_dev_close_t)(struct rte_eth_dev *dev);
1092 /**< @internal Function used to close a configured Ethernet device. */
1094 typedef void (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev);
1095 /**< @internal Function used to enable the RX promiscuous mode of an Ethernet device. */
1097 typedef void (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev);
1098 /**< @internal Function used to disable the RX promiscuous mode of an Ethernet device. */
1100 typedef void (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
1101 /**< @internal Enable the receipt of all multicast packets by an Ethernet device. */
1103 typedef void (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
1104 /**< @internal Disable the receipt of all multicast packets by an Ethernet device. */
1106 typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
1107 int wait_to_complete);
1108 /**< @internal Get link speed, duplex mode and state (up/down) of an Ethernet device. */
1110 typedef void (*eth_stats_get_t)(struct rte_eth_dev *dev,
1111 struct rte_eth_stats *igb_stats);
1112 /**< @internal Get global I/O statistics of an Ethernet device. */
1114 typedef void (*eth_stats_reset_t)(struct rte_eth_dev *dev);
1115 /**< @internal Reset global I/O statistics of an Ethernet device to 0. */
1117 typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev,
1118 struct rte_eth_xstat *stats, unsigned n);
1119 /**< @internal Get extended stats of an Ethernet device. */
1121 typedef void (*eth_xstats_reset_t)(struct rte_eth_dev *dev);
1122 /**< @internal Reset extended stats of an Ethernet device. */
1124 typedef int (*eth_xstats_get_names_t)(struct rte_eth_dev *dev,
1125 struct rte_eth_xstat_name *xstats_names, unsigned size);
1126 /**< @internal Get names of extended stats of an Ethernet device. */
1128 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
1132 /**< @internal Set a queue statistics mapping for a tx/rx queue of an Ethernet device. */
1134 typedef void (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
1135 struct rte_eth_dev_info *dev_info);
1136 /**< @internal Get specific informations of an Ethernet device. */
1138 typedef const uint32_t *(*eth_dev_supported_ptypes_get_t)(struct rte_eth_dev *dev);
1139 /**< @internal Get supported ptypes of an Ethernet device. */
1141 typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
1143 /**< @internal Start rx and tx of a queue of an Ethernet device. */
1145 typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
1147 /**< @internal Stop rx and tx of a queue of an Ethernet device. */
1149 typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
1150 uint16_t rx_queue_id,
1151 uint16_t nb_rx_desc,
1152 unsigned int socket_id,
1153 const struct rte_eth_rxconf *rx_conf,
1154 struct rte_mempool *mb_pool);
1155 /**< @internal Set up a receive queue of an Ethernet device. */
1157 typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
1158 uint16_t tx_queue_id,
1159 uint16_t nb_tx_desc,
1160 unsigned int socket_id,
1161 const struct rte_eth_txconf *tx_conf);
1162 /**< @internal Setup a transmit queue of an Ethernet device. */
1164 typedef int (*eth_rx_enable_intr_t)(struct rte_eth_dev *dev,
1165 uint16_t rx_queue_id);
1166 /**< @internal Enable interrupt of a receive queue of an Ethernet device. */
1168 typedef int (*eth_rx_disable_intr_t)(struct rte_eth_dev *dev,
1169 uint16_t rx_queue_id);
1170 /**< @internal Disable interrupt of a receive queue of an Ethernet device. */
1172 typedef void (*eth_queue_release_t)(void *queue);
1173 /**< @internal Release memory resources allocated by given RX/TX queue. */
1175 typedef uint32_t (*eth_rx_queue_count_t)(struct rte_eth_dev *dev,
1176 uint16_t rx_queue_id);
1177 /**< @internal Get number of used descriptors on a receive queue. */
1179 typedef int (*eth_rx_descriptor_done_t)(void *rxq, uint16_t offset);
1180 /**< @internal Check DD bit of specific RX descriptor */
1182 typedef int (*eth_rx_descriptor_status_t)(void *rxq, uint16_t offset);
1183 /**< @internal Check the status of a Rx descriptor */
1185 typedef int (*eth_tx_descriptor_status_t)(void *txq, uint16_t offset);
1186 /**< @internal Check the status of a Tx descriptor */
1188 typedef int (*eth_fw_version_get_t)(struct rte_eth_dev *dev,
1189 char *fw_version, size_t fw_size);
1190 /**< @internal Get firmware information of an Ethernet device. */
1192 typedef int (*eth_tx_done_cleanup_t)(void *txq, uint32_t free_cnt);
1193 /**< @internal Force mbufs to be from TX ring. */
1195 typedef void (*eth_rxq_info_get_t)(struct rte_eth_dev *dev,
1196 uint16_t rx_queue_id, struct rte_eth_rxq_info *qinfo);
1198 typedef void (*eth_txq_info_get_t)(struct rte_eth_dev *dev,
1199 uint16_t tx_queue_id, struct rte_eth_txq_info *qinfo);
1201 typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);
1202 /**< @internal Set MTU. */
1204 typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
1207 /**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */
1209 typedef int (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
1210 enum rte_vlan_type type, uint16_t tpid);
1211 /**< @internal set the outer/inner VLAN-TPID by an Ethernet device. */
1213 typedef void (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
1214 /**< @internal set VLAN offload function by an Ethernet device. */
1216 typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
1219 /**< @internal set port based TX VLAN insertion by an Ethernet device. */
1221 typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
1222 uint16_t rx_queue_id,
1224 /**< @internal VLAN stripping enable/disable by an queue of Ethernet device. */
1226 typedef uint16_t (*eth_rx_burst_t)(void *rxq,
1227 struct rte_mbuf **rx_pkts,
1229 /**< @internal Retrieve input packets from a receive queue of an Ethernet device. */
1231 typedef uint16_t (*eth_tx_burst_t)(void *txq,
1232 struct rte_mbuf **tx_pkts,
1234 /**< @internal Send output packets on a transmit queue of an Ethernet device. */
1236 typedef uint16_t (*eth_tx_prep_t)(void *txq,
1237 struct rte_mbuf **tx_pkts,
1239 /**< @internal Prepare output packets on a transmit queue of an Ethernet device. */
1241 typedef int (*flow_ctrl_get_t)(struct rte_eth_dev *dev,
1242 struct rte_eth_fc_conf *fc_conf);
1243 /**< @internal Get current flow control parameter on an Ethernet device */
1245 typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
1246 struct rte_eth_fc_conf *fc_conf);
1247 /**< @internal Setup flow control parameter on an Ethernet device */
1249 typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
1250 struct rte_eth_pfc_conf *pfc_conf);
1251 /**< @internal Setup priority flow control parameter on an Ethernet device */
1253 typedef int (*reta_update_t)(struct rte_eth_dev *dev,
1254 struct rte_eth_rss_reta_entry64 *reta_conf,
1255 uint16_t reta_size);
1256 /**< @internal Update RSS redirection table on an Ethernet device */
1258 typedef int (*reta_query_t)(struct rte_eth_dev *dev,
1259 struct rte_eth_rss_reta_entry64 *reta_conf,
1260 uint16_t reta_size);
1261 /**< @internal Query RSS redirection table on an Ethernet device */
1263 typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
1264 struct rte_eth_rss_conf *rss_conf);
1265 /**< @internal Update RSS hash configuration of an Ethernet device */
1267 typedef int (*rss_hash_conf_get_t)(struct rte_eth_dev *dev,
1268 struct rte_eth_rss_conf *rss_conf);
1269 /**< @internal Get current RSS hash configuration of an Ethernet device */
1271 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
1272 /**< @internal Turn on SW controllable LED on an Ethernet device */
1274 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
1275 /**< @internal Turn off SW controllable LED on an Ethernet device */
1277 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
1278 /**< @internal Remove MAC address from receive address register */
1280 typedef void (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
1281 struct ether_addr *mac_addr,
1284 /**< @internal Set a MAC address into Receive Address Address Register */
1286 typedef void (*eth_mac_addr_set_t)(struct rte_eth_dev *dev,
1287 struct ether_addr *mac_addr);
1288 /**< @internal Set a MAC address into Receive Address Address Register */
1290 typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
1291 struct ether_addr *mac_addr,
1293 /**< @internal Set a Unicast Hash bitmap */
1295 typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
1297 /**< @internal Set all Unicast Hash bitmap */
1299 typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
1302 /**< @internal Set queue TX rate */
1304 typedef int (*eth_mirror_rule_set_t)(struct rte_eth_dev *dev,
1305 struct rte_eth_mirror_conf *mirror_conf,
1308 /**< @internal Add a traffic mirroring rule on an Ethernet device */
1310 typedef int (*eth_mirror_rule_reset_t)(struct rte_eth_dev *dev,
1312 /**< @internal Remove a traffic mirroring rule on an Ethernet device */
1314 typedef int (*eth_udp_tunnel_port_add_t)(struct rte_eth_dev *dev,
1315 struct rte_eth_udp_tunnel *tunnel_udp);
1316 /**< @internal Add tunneling UDP port */
1318 typedef int (*eth_udp_tunnel_port_del_t)(struct rte_eth_dev *dev,
1319 struct rte_eth_udp_tunnel *tunnel_udp);
1320 /**< @internal Delete tunneling UDP port */
1322 typedef int (*eth_set_mc_addr_list_t)(struct rte_eth_dev *dev,
1323 struct ether_addr *mc_addr_set,
1324 uint32_t nb_mc_addr);
1325 /**< @internal set the list of multicast addresses on an Ethernet device */
1327 typedef int (*eth_timesync_enable_t)(struct rte_eth_dev *dev);
1328 /**< @internal Function used to enable IEEE1588/802.1AS timestamping. */
1330 typedef int (*eth_timesync_disable_t)(struct rte_eth_dev *dev);
1331 /**< @internal Function used to disable IEEE1588/802.1AS timestamping. */
1333 typedef int (*eth_timesync_read_rx_timestamp_t)(struct rte_eth_dev *dev,
1334 struct timespec *timestamp,
1336 /**< @internal Function used to read an RX IEEE1588/802.1AS timestamp. */
1338 typedef int (*eth_timesync_read_tx_timestamp_t)(struct rte_eth_dev *dev,
1339 struct timespec *timestamp);
1340 /**< @internal Function used to read a TX IEEE1588/802.1AS timestamp. */
1342 typedef int (*eth_timesync_adjust_time)(struct rte_eth_dev *dev, int64_t);
1343 /**< @internal Function used to adjust the device clock */
1345 typedef int (*eth_timesync_read_time)(struct rte_eth_dev *dev,
1346 struct timespec *timestamp);
1347 /**< @internal Function used to get time from the device clock. */
1349 typedef int (*eth_timesync_write_time)(struct rte_eth_dev *dev,
1350 const struct timespec *timestamp);
1351 /**< @internal Function used to get time from the device clock */
1353 typedef int (*eth_get_reg_t)(struct rte_eth_dev *dev,
1354 struct rte_dev_reg_info *info);
1355 /**< @internal Retrieve registers */
1357 typedef int (*eth_get_eeprom_length_t)(struct rte_eth_dev *dev);
1358 /**< @internal Retrieve eeprom size */
1360 typedef int (*eth_get_eeprom_t)(struct rte_eth_dev *dev,
1361 struct rte_dev_eeprom_info *info);
1362 /**< @internal Retrieve eeprom data */
1364 typedef int (*eth_set_eeprom_t)(struct rte_eth_dev *dev,
1365 struct rte_dev_eeprom_info *info);
1366 /**< @internal Program eeprom data */
1368 typedef int (*eth_l2_tunnel_eth_type_conf_t)
1369 (struct rte_eth_dev *dev, struct rte_eth_l2_tunnel_conf *l2_tunnel);
1370 /**< @internal config l2 tunnel ether type */
1372 typedef int (*eth_l2_tunnel_offload_set_t)
1373 (struct rte_eth_dev *dev,
1374 struct rte_eth_l2_tunnel_conf *l2_tunnel,
1377 /**< @internal enable/disable the l2 tunnel offload functions */
1379 #ifdef RTE_NIC_BYPASS
1382 RTE_BYPASS_MODE_NONE,
1383 RTE_BYPASS_MODE_NORMAL,
1384 RTE_BYPASS_MODE_BYPASS,
1385 RTE_BYPASS_MODE_ISOLATE,
1386 RTE_BYPASS_MODE_NUM,
1389 #define RTE_BYPASS_MODE_VALID(x) \
1390 ((x) > RTE_BYPASS_MODE_NONE && (x) < RTE_BYPASS_MODE_NUM)
1393 RTE_BYPASS_EVENT_NONE,
1394 RTE_BYPASS_EVENT_START,
1395 RTE_BYPASS_EVENT_OS_ON = RTE_BYPASS_EVENT_START,
1396 RTE_BYPASS_EVENT_POWER_ON,
1397 RTE_BYPASS_EVENT_OS_OFF,
1398 RTE_BYPASS_EVENT_POWER_OFF,
1399 RTE_BYPASS_EVENT_TIMEOUT,
1400 RTE_BYPASS_EVENT_NUM
1403 #define RTE_BYPASS_EVENT_VALID(x) \
1404 ((x) > RTE_BYPASS_EVENT_NONE && (x) < RTE_BYPASS_MODE_NUM)
1407 RTE_BYPASS_TMT_OFF, /* timeout disabled. */
1408 RTE_BYPASS_TMT_1_5_SEC, /* timeout for 1.5 seconds */
1409 RTE_BYPASS_TMT_2_SEC, /* timeout for 2 seconds */
1410 RTE_BYPASS_TMT_3_SEC, /* timeout for 3 seconds */
1411 RTE_BYPASS_TMT_4_SEC, /* timeout for 4 seconds */
1412 RTE_BYPASS_TMT_8_SEC, /* timeout for 8 seconds */
1413 RTE_BYPASS_TMT_16_SEC, /* timeout for 16 seconds */
1414 RTE_BYPASS_TMT_32_SEC, /* timeout for 32 seconds */
1418 #define RTE_BYPASS_TMT_VALID(x) \
1419 ((x) == RTE_BYPASS_TMT_OFF || \
1420 ((x) > RTE_BYPASS_TMT_OFF && (x) < RTE_BYPASS_TMT_NUM))
1422 typedef void (*bypass_init_t)(struct rte_eth_dev *dev);
1423 typedef int32_t (*bypass_state_set_t)(struct rte_eth_dev *dev, uint32_t *new_state);
1424 typedef int32_t (*bypass_state_show_t)(struct rte_eth_dev *dev, uint32_t *state);
1425 typedef int32_t (*bypass_event_set_t)(struct rte_eth_dev *dev, uint32_t state, uint32_t event);
1426 typedef int32_t (*bypass_event_show_t)(struct rte_eth_dev *dev, uint32_t event_shift, uint32_t *event);
1427 typedef int32_t (*bypass_wd_timeout_set_t)(struct rte_eth_dev *dev, uint32_t timeout);
1428 typedef int32_t (*bypass_wd_timeout_show_t)(struct rte_eth_dev *dev, uint32_t *wd_timeout);
1429 typedef int32_t (*bypass_ver_show_t)(struct rte_eth_dev *dev, uint32_t *ver);
1430 typedef int32_t (*bypass_wd_reset_t)(struct rte_eth_dev *dev);
1433 typedef int (*eth_filter_ctrl_t)(struct rte_eth_dev *dev,
1434 enum rte_filter_type filter_type,
1435 enum rte_filter_op filter_op,
1437 /**< @internal Take operations to assigned filter type on an Ethernet device */
1439 typedef int (*eth_get_dcb_info)(struct rte_eth_dev *dev,
1440 struct rte_eth_dcb_info *dcb_info);
1441 /**< @internal Get dcb information on an Ethernet device */
1444 * @internal A structure containing the functions exported by an Ethernet driver.
1446 struct eth_dev_ops {
1447 eth_dev_configure_t dev_configure; /**< Configure device. */
1448 eth_dev_start_t dev_start; /**< Start device. */
1449 eth_dev_stop_t dev_stop; /**< Stop device. */
1450 eth_dev_set_link_up_t dev_set_link_up; /**< Device link up. */
1451 eth_dev_set_link_down_t dev_set_link_down; /**< Device link down. */
1452 eth_dev_close_t dev_close; /**< Close device. */
1453 eth_link_update_t link_update; /**< Get device link state. */
1455 eth_promiscuous_enable_t promiscuous_enable; /**< Promiscuous ON. */
1456 eth_promiscuous_disable_t promiscuous_disable;/**< Promiscuous OFF. */
1457 eth_allmulticast_enable_t allmulticast_enable;/**< RX multicast ON. */
1458 eth_allmulticast_disable_t allmulticast_disable;/**< RX multicast OF. */
1459 eth_mac_addr_remove_t mac_addr_remove; /**< Remove MAC address. */
1460 eth_mac_addr_add_t mac_addr_add; /**< Add a MAC address. */
1461 eth_mac_addr_set_t mac_addr_set; /**< Set a MAC address. */
1462 eth_set_mc_addr_list_t set_mc_addr_list; /**< set list of mcast addrs. */
1463 mtu_set_t mtu_set; /**< Set MTU. */
1465 eth_stats_get_t stats_get; /**< Get generic device statistics. */
1466 eth_stats_reset_t stats_reset; /**< Reset generic device statistics. */
1467 eth_xstats_get_t xstats_get; /**< Get extended device statistics. */
1468 eth_xstats_reset_t xstats_reset; /**< Reset extended device statistics. */
1469 eth_xstats_get_names_t xstats_get_names;
1470 /**< Get names of extended statistics. */
1471 eth_queue_stats_mapping_set_t queue_stats_mapping_set;
1472 /**< Configure per queue stat counter mapping. */
1474 eth_dev_infos_get_t dev_infos_get; /**< Get device info. */
1475 eth_rxq_info_get_t rxq_info_get; /**< retrieve RX queue information. */
1476 eth_txq_info_get_t txq_info_get; /**< retrieve TX queue information. */
1477 eth_fw_version_get_t fw_version_get; /**< Get firmware version. */
1478 eth_dev_supported_ptypes_get_t dev_supported_ptypes_get;
1479 /**< Get packet types supported and identified by device. */
1481 vlan_filter_set_t vlan_filter_set; /**< Filter VLAN Setup. */
1482 vlan_tpid_set_t vlan_tpid_set; /**< Outer/Inner VLAN TPID Setup. */
1483 vlan_strip_queue_set_t vlan_strip_queue_set; /**< VLAN Stripping on queue. */
1484 vlan_offload_set_t vlan_offload_set; /**< Set VLAN Offload. */
1485 vlan_pvid_set_t vlan_pvid_set; /**< Set port based TX VLAN insertion. */
1487 eth_queue_start_t rx_queue_start;/**< Start RX for a queue. */
1488 eth_queue_stop_t rx_queue_stop; /**< Stop RX for a queue. */
1489 eth_queue_start_t tx_queue_start;/**< Start TX for a queue. */
1490 eth_queue_stop_t tx_queue_stop; /**< Stop TX for a queue. */
1491 eth_rx_queue_setup_t rx_queue_setup;/**< Set up device RX queue. */
1492 eth_queue_release_t rx_queue_release; /**< Release RX queue. */
1493 eth_rx_queue_count_t rx_queue_count;
1494 /**< Get the number of used RX descriptors. */
1495 eth_rx_descriptor_done_t rx_descriptor_done; /**< Check rxd DD bit. */
1496 eth_rx_descriptor_status_t rx_descriptor_status;
1497 /**< Check the status of a Rx descriptor. */
1498 eth_tx_descriptor_status_t tx_descriptor_status;
1499 /**< Check the status of a Tx descriptor. */
1500 eth_rx_enable_intr_t rx_queue_intr_enable; /**< Enable Rx queue interrupt. */
1501 eth_rx_disable_intr_t rx_queue_intr_disable; /**< Disable Rx queue interrupt. */
1502 eth_tx_queue_setup_t tx_queue_setup;/**< Set up device TX queue. */
1503 eth_queue_release_t tx_queue_release; /**< Release TX queue. */
1504 eth_tx_done_cleanup_t tx_done_cleanup;/**< Free tx ring mbufs */
1506 eth_dev_led_on_t dev_led_on; /**< Turn on LED. */
1507 eth_dev_led_off_t dev_led_off; /**< Turn off LED. */
1509 flow_ctrl_get_t flow_ctrl_get; /**< Get flow control. */
1510 flow_ctrl_set_t flow_ctrl_set; /**< Setup flow control. */
1511 priority_flow_ctrl_set_t priority_flow_ctrl_set; /**< Setup priority flow control. */
1513 eth_uc_hash_table_set_t uc_hash_table_set; /**< Set Unicast Table Array. */
1514 eth_uc_all_hash_table_set_t uc_all_hash_table_set; /**< Set Unicast hash bitmap. */
1516 eth_mirror_rule_set_t mirror_rule_set; /**< Add a traffic mirror rule. */
1517 eth_mirror_rule_reset_t mirror_rule_reset; /**< reset a traffic mirror rule. */
1519 eth_udp_tunnel_port_add_t udp_tunnel_port_add; /** Add UDP tunnel port. */
1520 eth_udp_tunnel_port_del_t udp_tunnel_port_del; /** Del UDP tunnel port. */
1521 eth_l2_tunnel_eth_type_conf_t l2_tunnel_eth_type_conf;
1522 /** Config ether type of l2 tunnel. */
1523 eth_l2_tunnel_offload_set_t l2_tunnel_offload_set;
1524 /** Enable/disable l2 tunnel offload functions. */
1526 eth_set_queue_rate_limit_t set_queue_rate_limit; /**< Set queue rate limit. */
1528 rss_hash_update_t rss_hash_update; /** Configure RSS hash protocols. */
1529 rss_hash_conf_get_t rss_hash_conf_get; /** Get current RSS hash configuration. */
1530 reta_update_t reta_update; /** Update redirection table. */
1531 reta_query_t reta_query; /** Query redirection table. */
1533 eth_get_reg_t get_reg; /**< Get registers. */
1534 eth_get_eeprom_length_t get_eeprom_length; /**< Get eeprom length. */
1535 eth_get_eeprom_t get_eeprom; /**< Get eeprom data. */
1536 eth_set_eeprom_t set_eeprom; /**< Set eeprom. */
1538 /* bypass control */
1539 #ifdef RTE_NIC_BYPASS
1540 bypass_init_t bypass_init;
1541 bypass_state_set_t bypass_state_set;
1542 bypass_state_show_t bypass_state_show;
1543 bypass_event_set_t bypass_event_set;
1544 bypass_event_show_t bypass_event_show;
1545 bypass_wd_timeout_set_t bypass_wd_timeout_set;
1546 bypass_wd_timeout_show_t bypass_wd_timeout_show;
1547 bypass_ver_show_t bypass_ver_show;
1548 bypass_wd_reset_t bypass_wd_reset;
1551 eth_filter_ctrl_t filter_ctrl; /**< common filter control. */
1553 eth_get_dcb_info get_dcb_info; /** Get DCB information. */
1555 eth_timesync_enable_t timesync_enable;
1556 /** Turn IEEE1588/802.1AS timestamping on. */
1557 eth_timesync_disable_t timesync_disable;
1558 /** Turn IEEE1588/802.1AS timestamping off. */
1559 eth_timesync_read_rx_timestamp_t timesync_read_rx_timestamp;
1560 /** Read the IEEE1588/802.1AS RX timestamp. */
1561 eth_timesync_read_tx_timestamp_t timesync_read_tx_timestamp;
1562 /** Read the IEEE1588/802.1AS TX timestamp. */
1563 eth_timesync_adjust_time timesync_adjust_time; /** Adjust the device clock. */
1564 eth_timesync_read_time timesync_read_time; /** Get the device clock time. */
1565 eth_timesync_write_time timesync_write_time; /** Set the device clock time. */
1569 * Function type used for RX packet processing packet callbacks.
1571 * The callback function is called on RX with a burst of packets that have
1572 * been received on the given port and queue.
1575 * The Ethernet port on which RX is being performed.
1577 * The queue on the Ethernet port which is being used to receive the packets.
1579 * The burst of packets that have just been received.
1581 * The number of packets in the burst pointed to by "pkts".
1583 * The max number of packets that can be stored in the "pkts" array.
1585 * The arbitrary user parameter passed in by the application when the callback
1586 * was originally configured.
1588 * The number of packets returned to the user.
1590 typedef uint16_t (*rte_rx_callback_fn)(uint8_t port, uint16_t queue,
1591 struct rte_mbuf *pkts[], uint16_t nb_pkts, uint16_t max_pkts,
1595 * Function type used for TX packet processing packet callbacks.
1597 * The callback function is called on TX with a burst of packets immediately
1598 * before the packets are put onto the hardware queue for transmission.
1601 * The Ethernet port on which TX is being performed.
1603 * The queue on the Ethernet port which is being used to transmit the packets.
1605 * The burst of packets that are about to be transmitted.
1607 * The number of packets in the burst pointed to by "pkts".
1609 * The arbitrary user parameter passed in by the application when the callback
1610 * was originally configured.
1612 * The number of packets to be written to the NIC.
1614 typedef uint16_t (*rte_tx_callback_fn)(uint8_t port, uint16_t queue,
1615 struct rte_mbuf *pkts[], uint16_t nb_pkts, void *user_param);
1619 * Structure used to hold information about the callbacks to be called for a
1620 * queue on RX and TX.
1622 struct rte_eth_rxtx_callback {
1623 struct rte_eth_rxtx_callback *next;
1625 rte_rx_callback_fn rx;
1626 rte_tx_callback_fn tx;
1632 * A set of values to describe the possible states of an eth device.
1634 enum rte_eth_dev_state {
1635 RTE_ETH_DEV_UNUSED = 0,
1636 RTE_ETH_DEV_ATTACHED,
1641 * The generic data structure associated with each ethernet device.
1643 * Pointers to burst-oriented packet receive and transmit functions are
1644 * located at the beginning of the structure, along with the pointer to
1645 * where all the data elements for the particular device are stored in shared
1646 * memory. This split allows the function pointer and driver data to be per-
1647 * process, while the actual configuration data for the device is shared.
1649 struct rte_eth_dev {
1650 eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
1651 eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
1652 eth_tx_prep_t tx_pkt_prepare; /**< Pointer to PMD transmit prepare function. */
1653 struct rte_eth_dev_data *data; /**< Pointer to device data */
1654 const struct eth_driver *driver;/**< Driver for this device */
1655 const struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
1656 struct rte_device *device; /**< Backing device */
1657 struct rte_intr_handle *intr_handle; /**< Device interrupt handle */
1658 /** User application callbacks for NIC interrupts */
1659 struct rte_eth_dev_cb_list link_intr_cbs;
1661 * User-supplied functions called from rx_burst to post-process
1662 * received packets before passing them to the user
1664 struct rte_eth_rxtx_callback *post_rx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
1666 * User-supplied functions called from tx_burst to pre-process
1667 * received packets before passing them to the driver for transmission.
1669 struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
1670 enum rte_eth_dev_state state:8; /**< Flag indicating the port state */
1671 } __rte_cache_aligned;
1673 struct rte_eth_dev_sriov {
1674 uint8_t active; /**< SRIOV is active with 16, 32 or 64 pools */
1675 uint8_t nb_q_per_pool; /**< rx queue number per pool */
1676 uint16_t def_vmdq_idx; /**< Default pool num used for PF */
1677 uint16_t def_pool_q_idx; /**< Default pool queue start reg index */
1679 #define RTE_ETH_DEV_SRIOV(dev) ((dev)->data->sriov)
1681 #define RTE_ETH_NAME_MAX_LEN (32)
1685 * The data part, with no function pointers, associated with each ethernet device.
1687 * This structure is safe to place in shared memory to be common among different
1688 * processes in a multi-process configuration.
1690 struct rte_eth_dev_data {
1691 char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
1693 void **rx_queues; /**< Array of pointers to RX queues. */
1694 void **tx_queues; /**< Array of pointers to TX queues. */
1695 uint16_t nb_rx_queues; /**< Number of RX queues. */
1696 uint16_t nb_tx_queues; /**< Number of TX queues. */
1698 struct rte_eth_dev_sriov sriov; /**< SRIOV data */
1700 void *dev_private; /**< PMD-specific private data */
1702 struct rte_eth_link dev_link;
1703 /**< Link-level information & status */
1705 struct rte_eth_conf dev_conf; /**< Configuration applied to device. */
1706 uint16_t mtu; /**< Maximum Transmission Unit. */
1708 uint32_t min_rx_buf_size;
1709 /**< Common rx buffer size handled by all queues */
1711 uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
1712 struct ether_addr* mac_addrs;/**< Device Ethernet Link address. */
1713 uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
1714 /** bitmap array of associating Ethernet MAC addresses to pools */
1715 struct ether_addr* hash_mac_addrs;
1716 /** Device Ethernet MAC addresses of hash filtering. */
1717 uint8_t port_id; /**< Device [external] port identifier. */
1719 uint8_t promiscuous : 1, /**< RX promiscuous mode ON(1) / OFF(0). */
1720 scattered_rx : 1, /**< RX of scattered packets is ON(1) / OFF(0) */
1721 all_multicast : 1, /**< RX all multicast mode ON(1) / OFF(0). */
1722 dev_started : 1, /**< Device state: STARTED(1) / STOPPED(0). */
1723 lro : 1; /**< RX LRO is ON(1) / OFF(0) */
1724 uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT];
1725 /** Queues state: STARTED(1) / STOPPED(0) */
1726 uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
1727 /** Queues state: STARTED(1) / STOPPED(0) */
1728 uint32_t dev_flags; /**< Capabilities */
1729 enum rte_kernel_driver kdrv; /**< Kernel driver passthrough */
1730 int numa_node; /**< NUMA node connection */
1731 const char *drv_name; /**< Driver name */
1734 /** Device supports hotplug detach */
1735 #define RTE_ETH_DEV_DETACHABLE 0x0001
1736 /** Device supports link state interrupt */
1737 #define RTE_ETH_DEV_INTR_LSC 0x0002
1738 /** Device is a bonded slave */
1739 #define RTE_ETH_DEV_BONDED_SLAVE 0x0004
1743 * The pool of *rte_eth_dev* structures. The size of the pool
1744 * is configured at compile-time in the <rte_ethdev.c> file.
1746 extern struct rte_eth_dev rte_eth_devices[];
1749 * Iterates over valid ethdev ports.
1752 * The id of the next possible valid port.
1754 * Next valid port id, RTE_MAX_ETHPORTS if there is none.
1756 uint8_t rte_eth_find_next(uint8_t port_id);
1759 * Macro to iterate over all enabled ethdev ports.
1761 #define RTE_ETH_FOREACH_DEV(p) \
1762 for (p = rte_eth_find_next(0); \
1763 (unsigned int)p < (unsigned int)RTE_MAX_ETHPORTS; \
1764 p = rte_eth_find_next(p + 1))
1768 * Get the total number of Ethernet devices that have been successfully
1769 * initialized by the [matching] Ethernet driver during the PCI probing phase.
1770 * All devices whose port identifier is in the range
1771 * [0, rte_eth_dev_count() - 1] can be operated on by network applications
1772 * immediately after invoking rte_eal_init().
1773 * If the application unplugs a port using hotplug function, The enabled port
1774 * numbers may be noncontiguous. In the case, the applications need to manage
1775 * enabled port by using the ``RTE_ETH_FOREACH_DEV()`` macro.
1778 * - The total number of usable Ethernet devices.
1780 uint8_t rte_eth_dev_count(void);
1784 * Returns a ethdev slot specified by the unique identifier name.
1787 * The pointer to the Unique identifier name for each Ethernet device
1789 * - The pointer to the ethdev slot, on success. NULL on error
1791 struct rte_eth_dev *rte_eth_dev_allocated(const char *name);
1795 * Allocates a new ethdev slot for an ethernet device and returns the pointer
1796 * to that slot for the driver to use.
1798 * @param name Unique identifier name for each Ethernet device
1799 * @param type Device type of this Ethernet device
1801 * - Slot in the rte_dev_devices array for a new device;
1803 struct rte_eth_dev *rte_eth_dev_allocate(const char *name);
1807 * Release the specified ethdev port.
1810 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure.
1812 * - 0 on success, negative on error
1814 int rte_eth_dev_release_port(struct rte_eth_dev *eth_dev);
1817 * Attach a new Ethernet device specified by aruguments.
1820 * A pointer to a strings array describing the new device
1821 * to be attached. The strings should be a pci address like
1822 * '0000:01:00.0' or virtual device name like 'net_pcap0'.
1824 * A pointer to a port identifier actually attached.
1826 * 0 on success and port_id is filled, negative on error
1828 int rte_eth_dev_attach(const char *devargs, uint8_t *port_id);
1831 * Detach a Ethernet device specified by port identifier.
1832 * This function must be called when the device is in the
1836 * The port identifier of the device to detach.
1838 * A pointer to a device name actually detached.
1840 * 0 on success and devname is filled, negative on error
1842 int rte_eth_dev_detach(uint8_t port_id, char *devname);
1847 * Initialization function of an Ethernet driver invoked for each matching
1848 * Ethernet PCI device detected during the PCI probing phase.
1851 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1852 * associated with the matching device and which have been [automatically]
1853 * allocated in the *rte_eth_devices* array.
1854 * The *eth_dev* structure is supplied to the driver initialization function
1855 * with the following fields already initialized:
1857 * - *pci_dev*: Holds the pointers to the *rte_pci_device* structure which
1858 * contains the generic PCI information of the matching device.
1860 * - *driver*: Holds the pointer to the *eth_driver* structure.
1862 * - *dev_private*: Holds a pointer to the device private data structure.
1864 * - *mtu*: Contains the default Ethernet maximum frame length (1500).
1866 * - *port_id*: Contains the port index of the device (actually the index
1867 * of the *eth_dev* structure in the *rte_eth_devices* array).
1870 * - 0: Success, the device is properly initialized by the driver.
1871 * In particular, the driver MUST have set up the *dev_ops* pointer
1872 * of the *eth_dev* structure.
1873 * - <0: Error code of the device initialization failure.
1875 typedef int (*eth_dev_init_t)(struct rte_eth_dev *eth_dev);
1879 * Finalization function of an Ethernet driver invoked for each matching
1880 * Ethernet PCI device detected during the PCI closing phase.
1883 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1884 * associated with the matching device and which have been [automatically]
1885 * allocated in the *rte_eth_devices* array.
1887 * - 0: Success, the device is properly finalized by the driver.
1888 * In particular, the driver MUST free the *dev_ops* pointer
1889 * of the *eth_dev* structure.
1890 * - <0: Error code of the device initialization failure.
1892 typedef int (*eth_dev_uninit_t)(struct rte_eth_dev *eth_dev);
1896 * The structure associated with a PMD Ethernet driver.
1898 * Each Ethernet driver acts as a PCI driver and is represented by a generic
1899 * *eth_driver* structure that holds:
1901 * - An *rte_pci_driver* structure (which must be the first field).
1903 * - The *eth_dev_init* function invoked for each matching PCI device.
1905 * - The *eth_dev_uninit* function invoked for each matching PCI device.
1907 * - The size of the private data to allocate for each matching device.
1910 struct rte_pci_driver pci_drv; /**< The PMD is also a PCI driver. */
1911 eth_dev_init_t eth_dev_init; /**< Device init function. */
1912 eth_dev_uninit_t eth_dev_uninit; /**< Device uninit function. */
1913 unsigned int dev_private_size; /**< Size of device private data. */
1917 * Convert a numerical speed in Mbps to a bitmap flag that can be used in
1918 * the bitmap link_speeds of the struct rte_eth_conf
1921 * Numerical speed value in Mbps
1923 * ETH_LINK_[HALF/FULL]_DUPLEX (only for 10/100M speeds)
1925 * 0 if the speed cannot be mapped
1927 uint32_t rte_eth_speed_bitflag(uint32_t speed, int duplex);
1930 * Configure an Ethernet device.
1931 * This function must be invoked first before any other function in the
1932 * Ethernet API. This function can also be re-invoked when a device is in the
1936 * The port identifier of the Ethernet device to configure.
1937 * @param nb_rx_queue
1938 * The number of receive queues to set up for the Ethernet device.
1939 * @param nb_tx_queue
1940 * The number of transmit queues to set up for the Ethernet device.
1942 * The pointer to the configuration data to be used for the Ethernet device.
1943 * The *rte_eth_conf* structure includes:
1944 * - the hardware offload features to activate, with dedicated fields for
1945 * each statically configurable offload hardware feature provided by
1946 * Ethernet devices, such as IP checksum or VLAN tag stripping for
1948 * - the Receive Side Scaling (RSS) configuration when using multiple RX
1951 * Embedding all configuration information in a single data structure
1952 * is the more flexible method that allows the addition of new features
1953 * without changing the syntax of the API.
1955 * - 0: Success, device configured.
1956 * - <0: Error code returned by the driver configuration function.
1958 int rte_eth_dev_configure(uint8_t port_id, uint16_t nb_rx_queue,
1959 uint16_t nb_tx_queue, const struct rte_eth_conf *eth_conf);
1963 * Release device queues and clear its configuration to force the user
1964 * application to reconfigure it. It is for internal use only.
1967 * Pointer to struct rte_eth_dev.
1972 void _rte_eth_dev_reset(struct rte_eth_dev *dev);
1975 * Allocate and set up a receive queue for an Ethernet device.
1977 * The function allocates a contiguous block of memory for *nb_rx_desc*
1978 * receive descriptors from a memory zone associated with *socket_id*
1979 * and initializes each receive descriptor with a network buffer allocated
1980 * from the memory pool *mb_pool*.
1983 * The port identifier of the Ethernet device.
1984 * @param rx_queue_id
1985 * The index of the receive queue to set up.
1986 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1987 * to rte_eth_dev_configure().
1989 * The number of receive descriptors to allocate for the receive ring.
1991 * The *socket_id* argument is the socket identifier in case of NUMA.
1992 * The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1993 * the DMA memory allocated for the receive descriptors of the ring.
1995 * The pointer to the configuration data to be used for the receive queue.
1996 * NULL value is allowed, in which case default RX configuration
1998 * The *rx_conf* structure contains an *rx_thresh* structure with the values
1999 * of the Prefetch, Host, and Write-Back threshold registers of the receive
2002 * The pointer to the memory pool from which to allocate *rte_mbuf* network
2003 * memory buffers to populate each descriptor of the receive ring.
2005 * - 0: Success, receive queue correctly set up.
2006 * - -EINVAL: The size of network buffers which can be allocated from the
2007 * memory pool does not fit the various buffer sizes allowed by the
2008 * device controller.
2009 * - -ENOMEM: Unable to allocate the receive ring descriptors or to
2010 * allocate network memory buffers from the memory pool when
2011 * initializing receive descriptors.
2013 int rte_eth_rx_queue_setup(uint8_t port_id, uint16_t rx_queue_id,
2014 uint16_t nb_rx_desc, unsigned int socket_id,
2015 const struct rte_eth_rxconf *rx_conf,
2016 struct rte_mempool *mb_pool);
2019 * Allocate and set up a transmit queue for an Ethernet device.
2022 * The port identifier of the Ethernet device.
2023 * @param tx_queue_id
2024 * The index of the transmit queue to set up.
2025 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2026 * to rte_eth_dev_configure().
2028 * The number of transmit descriptors to allocate for the transmit ring.
2030 * The *socket_id* argument is the socket identifier in case of NUMA.
2031 * Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
2032 * the DMA memory allocated for the transmit descriptors of the ring.
2034 * The pointer to the configuration data to be used for the transmit queue.
2035 * NULL value is allowed, in which case default RX configuration
2037 * The *tx_conf* structure contains the following data:
2038 * - The *tx_thresh* structure with the values of the Prefetch, Host, and
2039 * Write-Back threshold registers of the transmit ring.
2040 * When setting Write-Back threshold to the value greater then zero,
2041 * *tx_rs_thresh* value should be explicitly set to one.
2042 * - The *tx_free_thresh* value indicates the [minimum] number of network
2043 * buffers that must be pending in the transmit ring to trigger their
2044 * [implicit] freeing by the driver transmit function.
2045 * - The *tx_rs_thresh* value indicates the [minimum] number of transmit
2046 * descriptors that must be pending in the transmit ring before setting the
2047 * RS bit on a descriptor by the driver transmit function.
2048 * The *tx_rs_thresh* value should be less or equal then
2049 * *tx_free_thresh* value, and both of them should be less then
2051 * - The *txq_flags* member contains flags to pass to the TX queue setup
2052 * function to configure the behavior of the TX queue. This should be set
2053 * to 0 if no special configuration is required.
2055 * Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces
2056 * the transmit function to use default values.
2058 * - 0: Success, the transmit queue is correctly set up.
2059 * - -ENOMEM: Unable to allocate the transmit ring descriptors.
2061 int rte_eth_tx_queue_setup(uint8_t port_id, uint16_t tx_queue_id,
2062 uint16_t nb_tx_desc, unsigned int socket_id,
2063 const struct rte_eth_txconf *tx_conf);
2066 * Return the NUMA socket to which an Ethernet device is connected
2069 * The port identifier of the Ethernet device
2071 * The NUMA socket id to which the Ethernet device is connected or
2072 * a default of zero if the socket could not be determined.
2073 * -1 is returned is the port_id value is out of range.
2075 int rte_eth_dev_socket_id(uint8_t port_id);
2078 * Check if port_id of device is attached
2081 * The port identifier of the Ethernet device
2083 * - 0 if port is out of range or not attached
2084 * - 1 if device is attached
2086 int rte_eth_dev_is_valid_port(uint8_t port_id);
2089 * Start specified RX queue of a port. It is used when rx_deferred_start
2090 * flag of the specified queue is true.
2093 * The port identifier of the Ethernet device
2094 * @param rx_queue_id
2095 * The index of the rx queue to update the ring.
2096 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2097 * to rte_eth_dev_configure().
2099 * - 0: Success, the receive queue is started.
2100 * - -EINVAL: The port_id or the queue_id out of range.
2101 * - -ENOTSUP: The function not supported in PMD driver.
2103 int rte_eth_dev_rx_queue_start(uint8_t port_id, uint16_t rx_queue_id);
2106 * Stop specified RX queue of a port
2109 * The port identifier of the Ethernet device
2110 * @param rx_queue_id
2111 * The index of the rx queue to update the ring.
2112 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2113 * to rte_eth_dev_configure().
2115 * - 0: Success, the receive queue is stopped.
2116 * - -EINVAL: The port_id or the queue_id out of range.
2117 * - -ENOTSUP: The function not supported in PMD driver.
2119 int rte_eth_dev_rx_queue_stop(uint8_t port_id, uint16_t rx_queue_id);
2122 * Start TX for specified queue of a port. It is used when tx_deferred_start
2123 * flag of the specified queue is true.
2126 * The port identifier of the Ethernet device
2127 * @param tx_queue_id
2128 * The index of the tx queue to update the ring.
2129 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2130 * to rte_eth_dev_configure().
2132 * - 0: Success, the transmit queue is started.
2133 * - -EINVAL: The port_id or the queue_id out of range.
2134 * - -ENOTSUP: The function not supported in PMD driver.
2136 int rte_eth_dev_tx_queue_start(uint8_t port_id, uint16_t tx_queue_id);
2139 * Stop specified TX queue of a port
2142 * The port identifier of the Ethernet device
2143 * @param tx_queue_id
2144 * The index of the tx queue to update the ring.
2145 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2146 * to rte_eth_dev_configure().
2148 * - 0: Success, the transmit queue is stopped.
2149 * - -EINVAL: The port_id or the queue_id out of range.
2150 * - -ENOTSUP: The function not supported in PMD driver.
2152 int rte_eth_dev_tx_queue_stop(uint8_t port_id, uint16_t tx_queue_id);
2157 * Start an Ethernet device.
2159 * The device start step is the last one and consists of setting the configured
2160 * offload features and in starting the transmit and the receive units of the
2162 * On success, all basic functions exported by the Ethernet API (link status,
2163 * receive/transmit, and so on) can be invoked.
2166 * The port identifier of the Ethernet device.
2168 * - 0: Success, Ethernet device started.
2169 * - <0: Error code of the driver device start function.
2171 int rte_eth_dev_start(uint8_t port_id);
2174 * Stop an Ethernet device. The device can be restarted with a call to
2175 * rte_eth_dev_start()
2178 * The port identifier of the Ethernet device.
2180 void rte_eth_dev_stop(uint8_t port_id);
2184 * Link up an Ethernet device.
2186 * Set device link up will re-enable the device rx/tx
2187 * functionality after it is previously set device linked down.
2190 * The port identifier of the Ethernet device.
2192 * - 0: Success, Ethernet device linked up.
2193 * - <0: Error code of the driver device link up function.
2195 int rte_eth_dev_set_link_up(uint8_t port_id);
2198 * Link down an Ethernet device.
2199 * The device rx/tx functionality will be disabled if success,
2200 * and it can be re-enabled with a call to
2201 * rte_eth_dev_set_link_up()
2204 * The port identifier of the Ethernet device.
2206 int rte_eth_dev_set_link_down(uint8_t port_id);
2209 * Close a stopped Ethernet device. The device cannot be restarted!
2210 * The function frees all resources except for needed by the
2211 * closed state. To free these resources, call rte_eth_dev_detach().
2214 * The port identifier of the Ethernet device.
2216 void rte_eth_dev_close(uint8_t port_id);
2219 * Enable receipt in promiscuous mode for an Ethernet device.
2222 * The port identifier of the Ethernet device.
2224 void rte_eth_promiscuous_enable(uint8_t port_id);
2227 * Disable receipt in promiscuous mode for an Ethernet device.
2230 * The port identifier of the Ethernet device.
2232 void rte_eth_promiscuous_disable(uint8_t port_id);
2235 * Return the value of promiscuous mode for an Ethernet device.
2238 * The port identifier of the Ethernet device.
2240 * - (1) if promiscuous is enabled
2241 * - (0) if promiscuous is disabled.
2244 int rte_eth_promiscuous_get(uint8_t port_id);
2247 * Enable the receipt of any multicast frame by an Ethernet device.
2250 * The port identifier of the Ethernet device.
2252 void rte_eth_allmulticast_enable(uint8_t port_id);
2255 * Disable the receipt of all multicast frames by an Ethernet device.
2258 * The port identifier of the Ethernet device.
2260 void rte_eth_allmulticast_disable(uint8_t port_id);
2263 * Return the value of allmulticast mode for an Ethernet device.
2266 * The port identifier of the Ethernet device.
2268 * - (1) if allmulticast is enabled
2269 * - (0) if allmulticast is disabled.
2272 int rte_eth_allmulticast_get(uint8_t port_id);
2275 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2276 * or FULL-DUPLEX) of the physical link of an Ethernet device. It might need
2277 * to wait up to 9 seconds in it.
2280 * The port identifier of the Ethernet device.
2282 * A pointer to an *rte_eth_link* structure to be filled with
2283 * the status, the speed and the mode of the Ethernet device link.
2285 void rte_eth_link_get(uint8_t port_id, struct rte_eth_link *link);
2288 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2289 * or FULL-DUPLEX) of the physical link of an Ethernet device. It is a no-wait
2290 * version of rte_eth_link_get().
2293 * The port identifier of the Ethernet device.
2295 * A pointer to an *rte_eth_link* structure to be filled with
2296 * the status, the speed and the mode of the Ethernet device link.
2298 void rte_eth_link_get_nowait(uint8_t port_id, struct rte_eth_link *link);
2301 * Retrieve the general I/O statistics of an Ethernet device.
2304 * The port identifier of the Ethernet device.
2306 * A pointer to a structure of type *rte_eth_stats* to be filled with
2307 * the values of device counters for the following set of statistics:
2308 * - *ipackets* with the total of successfully received packets.
2309 * - *opackets* with the total of successfully transmitted packets.
2310 * - *ibytes* with the total of successfully received bytes.
2311 * - *obytes* with the total of successfully transmitted bytes.
2312 * - *ierrors* with the total of erroneous received packets.
2313 * - *oerrors* with the total of failed transmitted packets.
2315 * Zero if successful. Non-zero otherwise.
2317 int rte_eth_stats_get(uint8_t port_id, struct rte_eth_stats *stats);
2320 * Reset the general I/O statistics of an Ethernet device.
2323 * The port identifier of the Ethernet device.
2325 void rte_eth_stats_reset(uint8_t port_id);
2328 * Retrieve names of extended statistics of an Ethernet device.
2331 * The port identifier of the Ethernet device.
2332 * @param xstats_names
2333 * An rte_eth_xstat_name array of at least *size* elements to
2334 * be filled. If set to NULL, the function returns the required number
2337 * The size of the xstats_names array (number of elements).
2339 * - A positive value lower or equal to size: success. The return value
2340 * is the number of entries filled in the stats table.
2341 * - A positive value higher than size: error, the given statistics table
2342 * is too small. The return value corresponds to the size that should
2343 * be given to succeed. The entries in the table are not valid and
2344 * shall not be used by the caller.
2345 * - A negative value on error (invalid port id).
2347 int rte_eth_xstats_get_names(uint8_t port_id,
2348 struct rte_eth_xstat_name *xstats_names,
2352 * Retrieve extended statistics of an Ethernet device.
2355 * The port identifier of the Ethernet device.
2357 * A pointer to a table of structure of type *rte_eth_xstat*
2358 * to be filled with device statistics ids and values: id is the
2359 * index of the name string in xstats_names (see rte_eth_xstats_get_names()),
2360 * and value is the statistic counter.
2361 * This parameter can be set to NULL if n is 0.
2363 * The size of the xstats array (number of elements).
2365 * - A positive value lower or equal to n: success. The return value
2366 * is the number of entries filled in the stats table.
2367 * - A positive value higher than n: error, the given statistics table
2368 * is too small. The return value corresponds to the size that should
2369 * be given to succeed. The entries in the table are not valid and
2370 * shall not be used by the caller.
2371 * - A negative value on error (invalid port id).
2373 int rte_eth_xstats_get(uint8_t port_id, struct rte_eth_xstat *xstats,
2377 * Reset extended statistics of an Ethernet device.
2380 * The port identifier of the Ethernet device.
2382 void rte_eth_xstats_reset(uint8_t port_id);
2385 * Set a mapping for the specified transmit queue to the specified per-queue
2386 * statistics counter.
2389 * The port identifier of the Ethernet device.
2390 * @param tx_queue_id
2391 * The index of the transmit queue for which a queue stats mapping is required.
2392 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2393 * to rte_eth_dev_configure().
2395 * The per-queue packet statistics functionality number that the transmit
2396 * queue is to be assigned.
2397 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2399 * Zero if successful. Non-zero otherwise.
2401 int rte_eth_dev_set_tx_queue_stats_mapping(uint8_t port_id,
2402 uint16_t tx_queue_id, uint8_t stat_idx);
2405 * Set a mapping for the specified receive queue to the specified per-queue
2406 * statistics counter.
2409 * The port identifier of the Ethernet device.
2410 * @param rx_queue_id
2411 * The index of the receive queue for which a queue stats mapping is required.
2412 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2413 * to rte_eth_dev_configure().
2415 * The per-queue packet statistics functionality number that the receive
2416 * queue is to be assigned.
2417 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2419 * Zero if successful. Non-zero otherwise.
2421 int rte_eth_dev_set_rx_queue_stats_mapping(uint8_t port_id,
2422 uint16_t rx_queue_id,
2426 * Retrieve the Ethernet address of an Ethernet device.
2429 * The port identifier of the Ethernet device.
2431 * A pointer to a structure of type *ether_addr* to be filled with
2432 * the Ethernet address of the Ethernet device.
2434 void rte_eth_macaddr_get(uint8_t port_id, struct ether_addr *mac_addr);
2437 * Retrieve the contextual information of an Ethernet device.
2440 * The port identifier of the Ethernet device.
2442 * A pointer to a structure of type *rte_eth_dev_info* to be filled with
2443 * the contextual information of the Ethernet device.
2445 void rte_eth_dev_info_get(uint8_t port_id, struct rte_eth_dev_info *dev_info);
2448 * Retrieve the firmware version of a device.
2451 * The port identifier of the device.
2453 * A pointer to a string array storing the firmware version of a device,
2454 * the string includes terminating null. This pointer is allocated by caller.
2456 * The size of the string array pointed by fw_version, which should be
2457 * large enough to store firmware version of the device.
2459 * - (0) if successful.
2460 * - (-ENOTSUP) if operation is not supported.
2461 * - (-ENODEV) if *port_id* invalid.
2462 * - (>0) if *fw_size* is not enough to store firmware version, return
2463 * the size of the non truncated string.
2465 int rte_eth_dev_fw_version_get(uint8_t port_id,
2466 char *fw_version, size_t fw_size);
2469 * Retrieve the supported packet types of an Ethernet device.
2471 * When a packet type is announced as supported, it *must* be recognized by
2472 * the PMD. For instance, if RTE_PTYPE_L2_ETHER, RTE_PTYPE_L2_ETHER_VLAN
2473 * and RTE_PTYPE_L3_IPV4 are announced, the PMD must return the following
2474 * packet types for these packets:
2475 * - Ether/IPv4 -> RTE_PTYPE_L2_ETHER | RTE_PTYPE_L3_IPV4
2476 * - Ether/Vlan/IPv4 -> RTE_PTYPE_L2_ETHER_VLAN | RTE_PTYPE_L3_IPV4
2477 * - Ether/[anything else] -> RTE_PTYPE_L2_ETHER
2478 * - Ether/Vlan/[anything else] -> RTE_PTYPE_L2_ETHER_VLAN
2480 * When a packet is received by a PMD, the most precise type must be
2481 * returned among the ones supported. However a PMD is allowed to set
2482 * packet type that is not in the supported list, at the condition that it
2483 * is more precise. Therefore, a PMD announcing no supported packet types
2484 * can still set a matching packet type in a received packet.
2487 * Better to invoke this API after the device is already started or rx burst
2488 * function is decided, to obtain correct supported ptypes.
2490 * if a given PMD does not report what ptypes it supports, then the supported
2491 * ptype count is reported as 0.
2493 * The port identifier of the Ethernet device.
2495 * A hint of what kind of packet type which the caller is interested in.
2497 * An array pointer to store adequent packet types, allocated by caller.
2499 * Size of the array pointed by param ptypes.
2501 * - (>=0) Number of supported ptypes. If the number of types exceeds num,
2502 * only num entries will be filled into the ptypes array, but the full
2503 * count of supported ptypes will be returned.
2504 * - (-ENODEV) if *port_id* invalid.
2506 int rte_eth_dev_get_supported_ptypes(uint8_t port_id, uint32_t ptype_mask,
2507 uint32_t *ptypes, int num);
2510 * Retrieve the MTU of an Ethernet device.
2513 * The port identifier of the Ethernet device.
2515 * A pointer to a uint16_t where the retrieved MTU is to be stored.
2517 * - (0) if successful.
2518 * - (-ENODEV) if *port_id* invalid.
2520 int rte_eth_dev_get_mtu(uint8_t port_id, uint16_t *mtu);
2523 * Change the MTU of an Ethernet device.
2526 * The port identifier of the Ethernet device.
2528 * A uint16_t for the MTU to be applied.
2530 * - (0) if successful.
2531 * - (-ENOTSUP) if operation is not supported.
2532 * - (-ENODEV) if *port_id* invalid.
2533 * - (-EINVAL) if *mtu* invalid.
2534 * - (-EBUSY) if operation is not allowed when the port is running
2536 int rte_eth_dev_set_mtu(uint8_t port_id, uint16_t mtu);
2539 * Enable/Disable hardware filtering by an Ethernet device of received
2540 * VLAN packets tagged with a given VLAN Tag Identifier.
2543 * The port identifier of the Ethernet device.
2545 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
2547 * If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*.
2548 * Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*.
2550 * - (0) if successful.
2551 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2552 * - (-ENODEV) if *port_id* invalid.
2553 * - (-ENOSYS) if VLAN filtering on *port_id* disabled.
2554 * - (-EINVAL) if *vlan_id* > 4095.
2556 int rte_eth_dev_vlan_filter(uint8_t port_id, uint16_t vlan_id, int on);
2559 * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
2560 * 82599/X540/X550 can support VLAN stripping at the rx queue level
2563 * The port identifier of the Ethernet device.
2564 * @param rx_queue_id
2565 * The index of the receive queue for which a queue stats mapping is required.
2566 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2567 * to rte_eth_dev_configure().
2569 * If 1, Enable VLAN Stripping of the receive queue of the Ethernet port.
2570 * If 0, Disable VLAN Stripping of the receive queue of the Ethernet port.
2572 * - (0) if successful.
2573 * - (-ENOSUP) if hardware-assisted VLAN stripping not configured.
2574 * - (-ENODEV) if *port_id* invalid.
2575 * - (-EINVAL) if *rx_queue_id* invalid.
2577 int rte_eth_dev_set_vlan_strip_on_queue(uint8_t port_id, uint16_t rx_queue_id,
2581 * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
2582 * the VLAN Header. This is a register setup available on some Intel NIC, not
2583 * but all, please check the data sheet for availability.
2586 * The port identifier of the Ethernet device.
2590 * The Tag Protocol ID
2592 * - (0) if successful.
2593 * - (-ENOSUP) if hardware-assisted VLAN TPID setup is not supported.
2594 * - (-ENODEV) if *port_id* invalid.
2596 int rte_eth_dev_set_vlan_ether_type(uint8_t port_id,
2597 enum rte_vlan_type vlan_type,
2601 * Set VLAN offload configuration on an Ethernet device
2602 * Enable/Disable Extended VLAN by an Ethernet device, This is a register setup
2603 * available on some Intel NIC, not but all, please check the data sheet for
2605 * Enable/Disable VLAN Strip can be done on rx queue for certain NIC, but here
2606 * the configuration is applied on the port level.
2609 * The port identifier of the Ethernet device.
2610 * @param offload_mask
2611 * The VLAN Offload bit mask can be mixed use with "OR"
2612 * ETH_VLAN_STRIP_OFFLOAD
2613 * ETH_VLAN_FILTER_OFFLOAD
2614 * ETH_VLAN_EXTEND_OFFLOAD
2616 * - (0) if successful.
2617 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2618 * - (-ENODEV) if *port_id* invalid.
2620 int rte_eth_dev_set_vlan_offload(uint8_t port_id, int offload_mask);
2623 * Read VLAN Offload configuration from an Ethernet device
2626 * The port identifier of the Ethernet device.
2628 * - (>0) if successful. Bit mask to indicate
2629 * ETH_VLAN_STRIP_OFFLOAD
2630 * ETH_VLAN_FILTER_OFFLOAD
2631 * ETH_VLAN_EXTEND_OFFLOAD
2632 * - (-ENODEV) if *port_id* invalid.
2634 int rte_eth_dev_get_vlan_offload(uint8_t port_id);
2637 * Set port based TX VLAN insersion on or off.
2640 * The port identifier of the Ethernet device.
2642 * Port based TX VLAN identifier togeth with user priority.
2644 * Turn on or off the port based TX VLAN insertion.
2647 * - (0) if successful.
2648 * - negative if failed.
2650 int rte_eth_dev_set_vlan_pvid(uint8_t port_id, uint16_t pvid, int on);
2654 * Retrieve a burst of input packets from a receive queue of an Ethernet
2655 * device. The retrieved packets are stored in *rte_mbuf* structures whose
2656 * pointers are supplied in the *rx_pkts* array.
2658 * The rte_eth_rx_burst() function loops, parsing the RX ring of the
2659 * receive queue, up to *nb_pkts* packets, and for each completed RX
2660 * descriptor in the ring, it performs the following operations:
2662 * - Initialize the *rte_mbuf* data structure associated with the
2663 * RX descriptor according to the information provided by the NIC into
2664 * that RX descriptor.
2666 * - Store the *rte_mbuf* data structure into the next entry of the
2669 * - Replenish the RX descriptor with a new *rte_mbuf* buffer
2670 * allocated from the memory pool associated with the receive queue at
2671 * initialization time.
2673 * When retrieving an input packet that was scattered by the controller
2674 * into multiple receive descriptors, the rte_eth_rx_burst() function
2675 * appends the associated *rte_mbuf* buffers to the first buffer of the
2678 * The rte_eth_rx_burst() function returns the number of packets
2679 * actually retrieved, which is the number of *rte_mbuf* data structures
2680 * effectively supplied into the *rx_pkts* array.
2681 * A return value equal to *nb_pkts* indicates that the RX queue contained
2682 * at least *rx_pkts* packets, and this is likely to signify that other
2683 * received packets remain in the input queue. Applications implementing
2684 * a "retrieve as much received packets as possible" policy can check this
2685 * specific case and keep invoking the rte_eth_rx_burst() function until
2686 * a value less than *nb_pkts* is returned.
2688 * This receive method has the following advantages:
2690 * - It allows a run-to-completion network stack engine to retrieve and
2691 * to immediately process received packets in a fast burst-oriented
2692 * approach, avoiding the overhead of unnecessary intermediate packet
2693 * queue/dequeue operations.
2695 * - Conversely, it also allows an asynchronous-oriented processing
2696 * method to retrieve bursts of received packets and to immediately
2697 * queue them for further parallel processing by another logical core,
2698 * for instance. However, instead of having received packets being
2699 * individually queued by the driver, this approach allows the invoker
2700 * of the rte_eth_rx_burst() function to queue a burst of retrieved
2701 * packets at a time and therefore dramatically reduce the cost of
2702 * enqueue/dequeue operations per packet.
2704 * - It allows the rte_eth_rx_burst() function of the driver to take
2705 * advantage of burst-oriented hardware features (CPU cache,
2706 * prefetch instructions, and so on) to minimize the number of CPU
2707 * cycles per packet.
2709 * To summarize, the proposed receive API enables many
2710 * burst-oriented optimizations in both synchronous and asynchronous
2711 * packet processing environments with no overhead in both cases.
2713 * The rte_eth_rx_burst() function does not provide any error
2714 * notification to avoid the corresponding overhead. As a hint, the
2715 * upper-level application might check the status of the device link once
2716 * being systematically returned a 0 value for a given number of tries.
2719 * The port identifier of the Ethernet device.
2721 * The index of the receive queue from which to retrieve input packets.
2722 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2723 * to rte_eth_dev_configure().
2725 * The address of an array of pointers to *rte_mbuf* structures that
2726 * must be large enough to store *nb_pkts* pointers in it.
2728 * The maximum number of packets to retrieve.
2730 * The number of packets actually retrieved, which is the number
2731 * of pointers to *rte_mbuf* structures effectively supplied to the
2734 static inline uint16_t
2735 rte_eth_rx_burst(uint8_t port_id, uint16_t queue_id,
2736 struct rte_mbuf **rx_pkts, const uint16_t nb_pkts)
2738 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2740 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2741 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
2742 RTE_FUNC_PTR_OR_ERR_RET(*dev->rx_pkt_burst, 0);
2744 if (queue_id >= dev->data->nb_rx_queues) {
2745 RTE_PMD_DEBUG_TRACE("Invalid RX queue_id=%d\n", queue_id);
2749 int16_t nb_rx = (*dev->rx_pkt_burst)(dev->data->rx_queues[queue_id],
2752 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
2753 struct rte_eth_rxtx_callback *cb = dev->post_rx_burst_cbs[queue_id];
2755 if (unlikely(cb != NULL)) {
2757 nb_rx = cb->fn.rx(port_id, queue_id, rx_pkts, nb_rx,
2758 nb_pkts, cb->param);
2760 } while (cb != NULL);
2768 * Get the number of used descriptors of a rx queue
2771 * The port identifier of the Ethernet device.
2773 * The queue id on the specific port.
2775 * The number of used descriptors in the specific queue, or:
2776 * (-EINVAL) if *port_id* or *queue_id* is invalid
2777 * (-ENOTSUP) if the device does not support this function
2780 rte_eth_rx_queue_count(uint8_t port_id, uint16_t queue_id)
2782 struct rte_eth_dev *dev;
2784 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -EINVAL);
2785 dev = &rte_eth_devices[port_id];
2786 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_queue_count, -ENOTSUP);
2787 if (queue_id >= dev->data->nb_rx_queues)
2790 return (*dev->dev_ops->rx_queue_count)(dev, queue_id);
2794 * Check if the DD bit of the specific RX descriptor in the queue has been set
2797 * The port identifier of the Ethernet device.
2799 * The queue id on the specific port.
2801 * The offset of the descriptor ID from tail.
2803 * - (1) if the specific DD bit is set.
2804 * - (0) if the specific DD bit is not set.
2805 * - (-ENODEV) if *port_id* invalid.
2806 * - (-ENOTSUP) if the device does not support this function
2809 rte_eth_rx_descriptor_done(uint8_t port_id, uint16_t queue_id, uint16_t offset)
2811 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2812 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
2813 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_descriptor_done, -ENOTSUP);
2814 return (*dev->dev_ops->rx_descriptor_done)( \
2815 dev->data->rx_queues[queue_id], offset);
2818 #define RTE_ETH_RX_DESC_AVAIL 0 /**< Desc available for hw. */
2819 #define RTE_ETH_RX_DESC_DONE 1 /**< Desc done, filled by hw. */
2820 #define RTE_ETH_RX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */
2823 * Check the status of a Rx descriptor in the queue
2825 * It should be called in a similar context than the Rx function:
2826 * - on a dataplane core
2827 * - not concurrently on the same queue
2829 * Since it's a dataplane function, no check is performed on port_id and
2830 * queue_id. The caller must therefore ensure that the port is enabled
2831 * and the queue is configured and running.
2833 * Note: accessing to a random descriptor in the ring may trigger cache
2834 * misses and have a performance impact.
2837 * A valid port identifier of the Ethernet device which.
2839 * A valid Rx queue identifier on this port.
2841 * The offset of the descriptor starting from tail (0 is the next
2842 * packet to be received by the driver).
2845 * - (RTE_ETH_RX_DESC_AVAIL): Descriptor is available for the hardware to
2847 * - (RTE_ETH_RX_DESC_DONE): Descriptor is done, it is filled by hw, but
2848 * not yet processed by the driver (i.e. in the receive queue).
2849 * - (RTE_ETH_RX_DESC_UNAVAIL): Descriptor is unavailable, either hold by
2850 * the driver and not yet returned to hw, or reserved by the hw.
2851 * - (-EINVAL) bad descriptor offset.
2852 * - (-ENOTSUP) if the device does not support this function.
2853 * - (-ENODEV) bad port or queue (only if compiled with debug).
2856 rte_eth_rx_descriptor_status(uint8_t port_id, uint16_t queue_id,
2859 struct rte_eth_dev *dev;
2862 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2863 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
2865 dev = &rte_eth_devices[port_id];
2866 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2867 if (queue_id >= dev->data->nb_rx_queues)
2870 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_descriptor_status, -ENOTSUP);
2871 rxq = dev->data->rx_queues[queue_id];
2873 return (*dev->dev_ops->rx_descriptor_status)(rxq, offset);
2876 #define RTE_ETH_TX_DESC_FULL 0 /**< Desc filled for hw, waiting xmit. */
2877 #define RTE_ETH_TX_DESC_DONE 1 /**< Desc done, packet is transmitted. */
2878 #define RTE_ETH_TX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */
2881 * Check the status of a Tx descriptor in the queue.
2883 * It should be called in a similar context than the Tx function:
2884 * - on a dataplane core
2885 * - not concurrently on the same queue
2887 * Since it's a dataplane function, no check is performed on port_id and
2888 * queue_id. The caller must therefore ensure that the port is enabled
2889 * and the queue is configured and running.
2891 * Note: accessing to a random descriptor in the ring may trigger cache
2892 * misses and have a performance impact.
2895 * A valid port identifier of the Ethernet device which.
2897 * A valid Tx queue identifier on this port.
2899 * The offset of the descriptor starting from tail (0 is the place where
2900 * the next packet will be send).
2903 * - (RTE_ETH_TX_DESC_FULL) Descriptor is being processed by the hw, i.e.
2904 * in the transmit queue.
2905 * - (RTE_ETH_TX_DESC_DONE) Hardware is done with this descriptor, it can
2906 * be reused by the driver.
2907 * - (RTE_ETH_TX_DESC_UNAVAIL): Descriptor is unavailable, reserved by the
2908 * driver or the hardware.
2909 * - (-EINVAL) bad descriptor offset.
2910 * - (-ENOTSUP) if the device does not support this function.
2911 * - (-ENODEV) bad port or queue (only if compiled with debug).
2913 static inline int rte_eth_tx_descriptor_status(uint8_t port_id,
2914 uint16_t queue_id, uint16_t offset)
2916 struct rte_eth_dev *dev;
2919 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2920 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
2922 dev = &rte_eth_devices[port_id];
2923 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2924 if (queue_id >= dev->data->nb_tx_queues)
2927 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->tx_descriptor_status, -ENOTSUP);
2928 txq = dev->data->tx_queues[queue_id];
2930 return (*dev->dev_ops->tx_descriptor_status)(txq, offset);
2934 * Send a burst of output packets on a transmit queue of an Ethernet device.
2936 * The rte_eth_tx_burst() function is invoked to transmit output packets
2937 * on the output queue *queue_id* of the Ethernet device designated by its
2939 * The *nb_pkts* parameter is the number of packets to send which are
2940 * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
2941 * allocated from a pool created with rte_pktmbuf_pool_create().
2942 * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
2943 * up to the number of transmit descriptors available in the TX ring of the
2945 * For each packet to send, the rte_eth_tx_burst() function performs
2946 * the following operations:
2948 * - Pick up the next available descriptor in the transmit ring.
2950 * - Free the network buffer previously sent with that descriptor, if any.
2952 * - Initialize the transmit descriptor with the information provided
2953 * in the *rte_mbuf data structure.
2955 * In the case of a segmented packet composed of a list of *rte_mbuf* buffers,
2956 * the rte_eth_tx_burst() function uses several transmit descriptors
2959 * The rte_eth_tx_burst() function returns the number of packets it
2960 * actually sent. A return value equal to *nb_pkts* means that all packets
2961 * have been sent, and this is likely to signify that other output packets
2962 * could be immediately transmitted again. Applications that implement a
2963 * "send as many packets to transmit as possible" policy can check this
2964 * specific case and keep invoking the rte_eth_tx_burst() function until
2965 * a value less than *nb_pkts* is returned.
2967 * It is the responsibility of the rte_eth_tx_burst() function to
2968 * transparently free the memory buffers of packets previously sent.
2969 * This feature is driven by the *tx_free_thresh* value supplied to the
2970 * rte_eth_dev_configure() function at device configuration time.
2971 * When the number of free TX descriptors drops below this threshold, the
2972 * rte_eth_tx_burst() function must [attempt to] free the *rte_mbuf* buffers
2973 * of those packets whose transmission was effectively completed.
2976 * The port identifier of the Ethernet device.
2978 * The index of the transmit queue through which output packets must be
2980 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2981 * to rte_eth_dev_configure().
2983 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
2984 * which contain the output packets.
2986 * The maximum number of packets to transmit.
2988 * The number of output packets actually stored in transmit descriptors of
2989 * the transmit ring. The return value can be less than the value of the
2990 * *tx_pkts* parameter when the transmit ring is full or has been filled up.
2992 static inline uint16_t
2993 rte_eth_tx_burst(uint8_t port_id, uint16_t queue_id,
2994 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
2996 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2998 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2999 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
3000 RTE_FUNC_PTR_OR_ERR_RET(*dev->tx_pkt_burst, 0);
3002 if (queue_id >= dev->data->nb_tx_queues) {
3003 RTE_PMD_DEBUG_TRACE("Invalid TX queue_id=%d\n", queue_id);
3008 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
3009 struct rte_eth_rxtx_callback *cb = dev->pre_tx_burst_cbs[queue_id];
3011 if (unlikely(cb != NULL)) {
3013 nb_pkts = cb->fn.tx(port_id, queue_id, tx_pkts, nb_pkts,
3016 } while (cb != NULL);
3020 return (*dev->tx_pkt_burst)(dev->data->tx_queues[queue_id], tx_pkts, nb_pkts);
3025 * @b EXPERIMENTAL: this API may change without prior notice
3027 * Process a burst of output packets on a transmit queue of an Ethernet device.
3029 * The rte_eth_tx_prepare() function is invoked to prepare output packets to be
3030 * transmitted on the output queue *queue_id* of the Ethernet device designated
3032 * The *nb_pkts* parameter is the number of packets to be prepared which are
3033 * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
3034 * allocated from a pool created with rte_pktmbuf_pool_create().
3035 * For each packet to send, the rte_eth_tx_prepare() function performs
3036 * the following operations:
3038 * - Check if packet meets devices requirements for tx offloads.
3040 * - Check limitations about number of segments.
3042 * - Check additional requirements when debug is enabled.
3044 * - Update and/or reset required checksums when tx offload is set for packet.
3046 * Since this function can modify packet data, provided mbufs must be safely
3047 * writable (e.g. modified data cannot be in shared segment).
3049 * The rte_eth_tx_prepare() function returns the number of packets ready to be
3050 * sent. A return value equal to *nb_pkts* means that all packets are valid and
3051 * ready to be sent, otherwise stops processing on the first invalid packet and
3052 * leaves the rest packets untouched.
3054 * When this functionality is not implemented in the driver, all packets are
3055 * are returned untouched.
3058 * The port identifier of the Ethernet device.
3059 * The value must be a valid port id.
3061 * The index of the transmit queue through which output packets must be
3063 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3064 * to rte_eth_dev_configure().
3066 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
3067 * which contain the output packets.
3069 * The maximum number of packets to process.
3071 * The number of packets correct and ready to be sent. The return value can be
3072 * less than the value of the *tx_pkts* parameter when some packet doesn't
3073 * meet devices requirements with rte_errno set appropriately:
3074 * - -EINVAL: offload flags are not correctly set
3075 * - -ENOTSUP: the offload feature is not supported by the hardware
3079 #ifndef RTE_ETHDEV_TX_PREPARE_NOOP
3081 static inline uint16_t
3082 rte_eth_tx_prepare(uint8_t port_id, uint16_t queue_id,
3083 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
3085 struct rte_eth_dev *dev;
3087 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3088 if (!rte_eth_dev_is_valid_port(port_id)) {
3089 RTE_PMD_DEBUG_TRACE("Invalid TX port_id=%d\n", port_id);
3090 rte_errno = -EINVAL;
3095 dev = &rte_eth_devices[port_id];
3097 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3098 if (queue_id >= dev->data->nb_tx_queues) {
3099 RTE_PMD_DEBUG_TRACE("Invalid TX queue_id=%d\n", queue_id);
3100 rte_errno = -EINVAL;
3105 if (!dev->tx_pkt_prepare)
3108 return (*dev->tx_pkt_prepare)(dev->data->tx_queues[queue_id],
3115 * Native NOOP operation for compilation targets which doesn't require any
3116 * preparations steps, and functional NOOP may introduce unnecessary performance
3119 * Generally this is not a good idea to turn it on globally and didn't should
3120 * be used if behavior of tx_preparation can change.
3123 static inline uint16_t
3124 rte_eth_tx_prepare(__rte_unused uint8_t port_id, __rte_unused uint16_t queue_id,
3125 __rte_unused struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
3132 typedef void (*buffer_tx_error_fn)(struct rte_mbuf **unsent, uint16_t count,
3136 * Structure used to buffer packets for future TX
3137 * Used by APIs rte_eth_tx_buffer and rte_eth_tx_buffer_flush
3139 struct rte_eth_dev_tx_buffer {
3140 buffer_tx_error_fn error_callback;
3141 void *error_userdata;
3142 uint16_t size; /**< Size of buffer for buffered tx */
3143 uint16_t length; /**< Number of packets in the array */
3144 struct rte_mbuf *pkts[];
3145 /**< Pending packets to be sent on explicit flush or when full */
3149 * Calculate the size of the tx buffer.
3152 * Number of stored packets.
3154 #define RTE_ETH_TX_BUFFER_SIZE(sz) \
3155 (sizeof(struct rte_eth_dev_tx_buffer) + (sz) * sizeof(struct rte_mbuf *))
3158 * Initialize default values for buffered transmitting
3161 * Tx buffer to be initialized.
3168 rte_eth_tx_buffer_init(struct rte_eth_dev_tx_buffer *buffer, uint16_t size);
3171 * Send any packets queued up for transmission on a port and HW queue
3173 * This causes an explicit flush of packets previously buffered via the
3174 * rte_eth_tx_buffer() function. It returns the number of packets successfully
3175 * sent to the NIC, and calls the error callback for any unsent packets. Unless
3176 * explicitly set up otherwise, the default callback simply frees the unsent
3177 * packets back to the owning mempool.
3180 * The port identifier of the Ethernet device.
3182 * The index of the transmit queue through which output packets must be
3184 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3185 * to rte_eth_dev_configure().
3187 * Buffer of packets to be transmit.
3189 * The number of packets successfully sent to the Ethernet device. The error
3190 * callback is called for any packets which could not be sent.
3192 static inline uint16_t
3193 rte_eth_tx_buffer_flush(uint8_t port_id, uint16_t queue_id,
3194 struct rte_eth_dev_tx_buffer *buffer)
3197 uint16_t to_send = buffer->length;
3202 sent = rte_eth_tx_burst(port_id, queue_id, buffer->pkts, to_send);
3206 /* All packets sent, or to be dealt with by callback below */
3207 if (unlikely(sent != to_send))
3208 buffer->error_callback(&buffer->pkts[sent], to_send - sent,
3209 buffer->error_userdata);
3215 * Buffer a single packet for future transmission on a port and queue
3217 * This function takes a single mbuf/packet and buffers it for later
3218 * transmission on the particular port and queue specified. Once the buffer is
3219 * full of packets, an attempt will be made to transmit all the buffered
3220 * packets. In case of error, where not all packets can be transmitted, a
3221 * callback is called with the unsent packets as a parameter. If no callback
3222 * is explicitly set up, the unsent packets are just freed back to the owning
3223 * mempool. The function returns the number of packets actually sent i.e.
3224 * 0 if no buffer flush occurred, otherwise the number of packets successfully
3228 * The port identifier of the Ethernet device.
3230 * The index of the transmit queue through which output packets must be
3232 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3233 * to rte_eth_dev_configure().
3235 * Buffer used to collect packets to be sent.
3237 * Pointer to the packet mbuf to be sent.
3239 * 0 = packet has been buffered for later transmission
3240 * N > 0 = packet has been buffered, and the buffer was subsequently flushed,
3241 * causing N packets to be sent, and the error callback to be called for
3244 static inline uint16_t __attribute__((always_inline))
3245 rte_eth_tx_buffer(uint8_t port_id, uint16_t queue_id,
3246 struct rte_eth_dev_tx_buffer *buffer, struct rte_mbuf *tx_pkt)
3248 buffer->pkts[buffer->length++] = tx_pkt;
3249 if (buffer->length < buffer->size)
3252 return rte_eth_tx_buffer_flush(port_id, queue_id, buffer);
3256 * Configure a callback for buffered packets which cannot be sent
3258 * Register a specific callback to be called when an attempt is made to send
3259 * all packets buffered on an ethernet port, but not all packets can
3260 * successfully be sent. The callback registered here will be called only
3261 * from calls to rte_eth_tx_buffer() and rte_eth_tx_buffer_flush() APIs.
3262 * The default callback configured for each queue by default just frees the
3263 * packets back to the calling mempool. If additional behaviour is required,
3264 * for example, to count dropped packets, or to retry transmission of packets
3265 * which cannot be sent, this function should be used to register a suitable
3266 * callback function to implement the desired behaviour.
3267 * The example callback "rte_eth_count_unsent_packet_callback()" is also
3268 * provided as reference.
3271 * The port identifier of the Ethernet device.
3273 * The function to be used as the callback.
3275 * Arbitrary parameter to be passed to the callback function
3277 * 0 on success, or -1 on error with rte_errno set appropriately
3280 rte_eth_tx_buffer_set_err_callback(struct rte_eth_dev_tx_buffer *buffer,
3281 buffer_tx_error_fn callback, void *userdata);
3284 * Callback function for silently dropping unsent buffered packets.
3286 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
3287 * adjust the default behavior when buffered packets cannot be sent. This
3288 * function drops any unsent packets silently and is used by tx buffered
3289 * operations as default behavior.
3291 * NOTE: this function should not be called directly, instead it should be used
3292 * as a callback for packet buffering.
3294 * NOTE: when configuring this function as a callback with
3295 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
3296 * should point to an uint64_t value.
3299 * The previously buffered packets which could not be sent
3301 * The number of unsent packets in the pkts array
3306 rte_eth_tx_buffer_drop_callback(struct rte_mbuf **pkts, uint16_t unsent,
3310 * Callback function for tracking unsent buffered packets.
3312 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
3313 * adjust the default behavior when buffered packets cannot be sent. This
3314 * function drops any unsent packets, but also updates a user-supplied counter
3315 * to track the overall number of packets dropped. The counter should be an
3316 * uint64_t variable.
3318 * NOTE: this function should not be called directly, instead it should be used
3319 * as a callback for packet buffering.
3321 * NOTE: when configuring this function as a callback with
3322 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
3323 * should point to an uint64_t value.
3326 * The previously buffered packets which could not be sent
3328 * The number of unsent packets in the pkts array
3330 * Pointer to an uint64_t value, which will be incremented by unsent
3333 rte_eth_tx_buffer_count_callback(struct rte_mbuf **pkts, uint16_t unsent,
3337 * Request the driver to free mbufs currently cached by the driver. The
3338 * driver will only free the mbuf if it is no longer in use. It is the
3339 * application's responsibity to ensure rte_eth_tx_buffer_flush(..) is
3343 * The port identifier of the Ethernet device.
3345 * The index of the transmit queue through which output packets must be
3347 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3348 * to rte_eth_dev_configure().
3350 * Maximum number of packets to free. Use 0 to indicate all possible packets
3351 * should be freed. Note that a packet may be using multiple mbufs.
3354 * -ENODEV: Invalid interface
3355 * -ENOTSUP: Driver does not support function
3357 * 0-n: Number of packets freed. More packets may still remain in ring that
3361 rte_eth_tx_done_cleanup(uint8_t port_id, uint16_t queue_id, uint32_t free_cnt);
3364 * The eth device event type for interrupt, and maybe others in the future.
3366 enum rte_eth_event_type {
3367 RTE_ETH_EVENT_UNKNOWN, /**< unknown event type */
3368 RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
3369 RTE_ETH_EVENT_QUEUE_STATE,
3370 /**< queue state event (enabled/disabled) */
3371 RTE_ETH_EVENT_INTR_RESET,
3372 /**< reset interrupt event, sent to VF on PF reset */
3373 RTE_ETH_EVENT_VF_MBOX, /**< message from the VF received by PF */
3374 RTE_ETH_EVENT_MACSEC, /**< MACsec offload related event */
3375 RTE_ETH_EVENT_MAX /**< max value of this enum */
3378 typedef void (*rte_eth_dev_cb_fn)(uint8_t port_id, \
3379 enum rte_eth_event_type event, void *cb_arg);
3380 /**< user application callback to be registered for interrupts */
3385 * Register a callback function for specific port id.
3392 * User supplied callback function to be called.
3394 * Pointer to the parameters for the registered callback.
3396 * The user data is overwritten in the case of RTE_ETH_EVENT_VF_MBOX.
3397 * This even occurs when a message from the VF is received by the PF.
3398 * The user data is overwritten with struct rte_pmd_ixgbe_mb_event_param.
3399 * This struct is defined in rte_pmd_ixgbe.h.
3402 * - On success, zero.
3403 * - On failure, a negative value.
3405 int rte_eth_dev_callback_register(uint8_t port_id,
3406 enum rte_eth_event_type event,
3407 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
3410 * Unregister a callback function for specific port id.
3417 * User supplied callback function to be called.
3419 * Pointer to the parameters for the registered callback. -1 means to
3420 * remove all for the same callback address and same event.
3423 * - On success, zero.
3424 * - On failure, a negative value.
3426 int rte_eth_dev_callback_unregister(uint8_t port_id,
3427 enum rte_eth_event_type event,
3428 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
3431 * @internal Executes all the user application registered callbacks for
3432 * the specific device. It is for DPDK internal user only. User
3433 * application should not call it directly.
3436 * Pointer to struct rte_eth_dev.
3438 * Eth device interrupt event type.
3440 * Update callback parameter to pass data back to user application.
3441 * This allows the user application to decide if a particular function
3442 * is permitted or not.
3447 void _rte_eth_dev_callback_process(struct rte_eth_dev *dev,
3448 enum rte_eth_event_type event, void *cb_arg);
3451 * When there is no rx packet coming in Rx Queue for a long time, we can
3452 * sleep lcore related to RX Queue for power saving, and enable rx interrupt
3453 * to be triggered when rx packect arrives.
3455 * The rte_eth_dev_rx_intr_enable() function enables rx queue
3456 * interrupt on specific rx queue of a port.
3459 * The port identifier of the Ethernet device.
3461 * The index of the receive queue from which to retrieve input packets.
3462 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3463 * to rte_eth_dev_configure().
3465 * - (0) if successful.
3466 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3468 * - (-ENODEV) if *port_id* invalid.
3470 int rte_eth_dev_rx_intr_enable(uint8_t port_id, uint16_t queue_id);
3473 * When lcore wakes up from rx interrupt indicating packet coming, disable rx
3474 * interrupt and returns to polling mode.
3476 * The rte_eth_dev_rx_intr_disable() function disables rx queue
3477 * interrupt on specific rx queue of a port.
3480 * The port identifier of the Ethernet device.
3482 * The index of the receive queue from which to retrieve input packets.
3483 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3484 * to rte_eth_dev_configure().
3486 * - (0) if successful.
3487 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3489 * - (-ENODEV) if *port_id* invalid.
3491 int rte_eth_dev_rx_intr_disable(uint8_t port_id, uint16_t queue_id);
3494 * RX Interrupt control per port.
3497 * The port identifier of the Ethernet device.
3499 * Epoll instance fd which the intr vector associated to.
3500 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
3502 * The operation be performed for the vector.
3503 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
3507 * - On success, zero.
3508 * - On failure, a negative value.
3510 int rte_eth_dev_rx_intr_ctl(uint8_t port_id, int epfd, int op, void *data);
3513 * RX Interrupt control per queue.
3516 * The port identifier of the Ethernet device.
3518 * The index of the receive queue from which to retrieve input packets.
3519 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3520 * to rte_eth_dev_configure().
3522 * Epoll instance fd which the intr vector associated to.
3523 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
3525 * The operation be performed for the vector.
3526 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
3530 * - On success, zero.
3531 * - On failure, a negative value.
3533 int rte_eth_dev_rx_intr_ctl_q(uint8_t port_id, uint16_t queue_id,
3534 int epfd, int op, void *data);
3537 * Turn on the LED on the Ethernet device.
3538 * This function turns on the LED on the Ethernet device.
3541 * The port identifier of the Ethernet device.
3543 * - (0) if successful.
3544 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3546 * - (-ENODEV) if *port_id* invalid.
3548 int rte_eth_led_on(uint8_t port_id);
3551 * Turn off the LED on the Ethernet device.
3552 * This function turns off the LED on the Ethernet device.
3555 * The port identifier of the Ethernet device.
3557 * - (0) if successful.
3558 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3560 * - (-ENODEV) if *port_id* invalid.
3562 int rte_eth_led_off(uint8_t port_id);
3565 * Get current status of the Ethernet link flow control for Ethernet device
3568 * The port identifier of the Ethernet device.
3570 * The pointer to the structure where to store the flow control parameters.
3572 * - (0) if successful.
3573 * - (-ENOTSUP) if hardware doesn't support flow control.
3574 * - (-ENODEV) if *port_id* invalid.
3576 int rte_eth_dev_flow_ctrl_get(uint8_t port_id,
3577 struct rte_eth_fc_conf *fc_conf);
3580 * Configure the Ethernet link flow control for Ethernet device
3583 * The port identifier of the Ethernet device.
3585 * The pointer to the structure of the flow control parameters.
3587 * - (0) if successful.
3588 * - (-ENOTSUP) if hardware doesn't support flow control mode.
3589 * - (-ENODEV) if *port_id* invalid.
3590 * - (-EINVAL) if bad parameter
3591 * - (-EIO) if flow control setup failure
3593 int rte_eth_dev_flow_ctrl_set(uint8_t port_id,
3594 struct rte_eth_fc_conf *fc_conf);
3597 * Configure the Ethernet priority flow control under DCB environment
3598 * for Ethernet device.
3601 * The port identifier of the Ethernet device.
3603 * The pointer to the structure of the priority flow control parameters.
3605 * - (0) if successful.
3606 * - (-ENOTSUP) if hardware doesn't support priority flow control mode.
3607 * - (-ENODEV) if *port_id* invalid.
3608 * - (-EINVAL) if bad parameter
3609 * - (-EIO) if flow control setup failure
3611 int rte_eth_dev_priority_flow_ctrl_set(uint8_t port_id,
3612 struct rte_eth_pfc_conf *pfc_conf);
3615 * Add a MAC address to an internal array of addresses used to enable whitelist
3616 * filtering to accept packets only if the destination MAC address matches.
3619 * The port identifier of the Ethernet device.
3621 * The MAC address to add.
3623 * VMDq pool index to associate address with (if VMDq is enabled). If VMDq is
3624 * not enabled, this should be set to 0.
3626 * - (0) if successfully added or *mac_addr" was already added.
3627 * - (-ENOTSUP) if hardware doesn't support this feature.
3628 * - (-ENODEV) if *port* is invalid.
3629 * - (-ENOSPC) if no more MAC addresses can be added.
3630 * - (-EINVAL) if MAC address is invalid.
3632 int rte_eth_dev_mac_addr_add(uint8_t port, struct ether_addr *mac_addr,
3636 * Remove a MAC address from the internal array of addresses.
3639 * The port identifier of the Ethernet device.
3641 * MAC address to remove.
3643 * - (0) if successful, or *mac_addr* didn't exist.
3644 * - (-ENOTSUP) if hardware doesn't support.
3645 * - (-ENODEV) if *port* invalid.
3646 * - (-EADDRINUSE) if attempting to remove the default MAC address
3648 int rte_eth_dev_mac_addr_remove(uint8_t port, struct ether_addr *mac_addr);
3651 * Set the default MAC address.
3654 * The port identifier of the Ethernet device.
3656 * New default MAC address.
3658 * - (0) if successful, or *mac_addr* didn't exist.
3659 * - (-ENOTSUP) if hardware doesn't support.
3660 * - (-ENODEV) if *port* invalid.
3661 * - (-EINVAL) if MAC address is invalid.
3663 int rte_eth_dev_default_mac_addr_set(uint8_t port, struct ether_addr *mac_addr);
3667 * Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3670 * The port identifier of the Ethernet device.
3674 * Redirection table size. The table size can be queried by
3675 * rte_eth_dev_info_get().
3677 * - (0) if successful.
3678 * - (-ENOTSUP) if hardware doesn't support.
3679 * - (-EINVAL) if bad parameter.
3681 int rte_eth_dev_rss_reta_update(uint8_t port,
3682 struct rte_eth_rss_reta_entry64 *reta_conf,
3683 uint16_t reta_size);
3686 * Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3689 * The port identifier of the Ethernet device.
3693 * Redirection table size. The table size can be queried by
3694 * rte_eth_dev_info_get().
3696 * - (0) if successful.
3697 * - (-ENOTSUP) if hardware doesn't support.
3698 * - (-EINVAL) if bad parameter.
3700 int rte_eth_dev_rss_reta_query(uint8_t port,
3701 struct rte_eth_rss_reta_entry64 *reta_conf,
3702 uint16_t reta_size);
3705 * Updates unicast hash table for receiving packet with the given destination
3706 * MAC address, and the packet is routed to all VFs for which the RX mode is
3707 * accept packets that match the unicast hash table.
3710 * The port identifier of the Ethernet device.
3712 * Unicast MAC address.
3714 * 1 - Set an unicast hash bit for receiving packets with the MAC address.
3715 * 0 - Clear an unicast hash bit.
3717 * - (0) if successful.
3718 * - (-ENOTSUP) if hardware doesn't support.
3719 * - (-ENODEV) if *port_id* invalid.
3720 * - (-EINVAL) if bad parameter.
3722 int rte_eth_dev_uc_hash_table_set(uint8_t port,struct ether_addr *addr,
3726 * Updates all unicast hash bitmaps for receiving packet with any Unicast
3727 * Ethernet MAC addresses,the packet is routed to all VFs for which the RX
3728 * mode is accept packets that match the unicast hash table.
3731 * The port identifier of the Ethernet device.
3733 * 1 - Set all unicast hash bitmaps for receiving all the Ethernet
3735 * 0 - Clear all unicast hash bitmaps
3737 * - (0) if successful.
3738 * - (-ENOTSUP) if hardware doesn't support.
3739 * - (-ENODEV) if *port_id* invalid.
3740 * - (-EINVAL) if bad parameter.
3742 int rte_eth_dev_uc_all_hash_table_set(uint8_t port,uint8_t on);
3745 * Set a traffic mirroring rule on an Ethernet device
3748 * The port identifier of the Ethernet device.
3749 * @param mirror_conf
3750 * The pointer to the traffic mirroring structure describing the mirroring rule.
3751 * The *rte_eth_vm_mirror_conf* structure includes the type of mirroring rule,
3752 * destination pool and the value of rule if enable vlan or pool mirroring.
3755 * The index of traffic mirroring rule, we support four separated rules.
3757 * 1 - Enable a mirroring rule.
3758 * 0 - Disable a mirroring rule.
3760 * - (0) if successful.
3761 * - (-ENOTSUP) if hardware doesn't support this feature.
3762 * - (-ENODEV) if *port_id* invalid.
3763 * - (-EINVAL) if the mr_conf information is not correct.
3765 int rte_eth_mirror_rule_set(uint8_t port_id,
3766 struct rte_eth_mirror_conf *mirror_conf,
3771 * Reset a traffic mirroring rule on an Ethernet device.
3774 * The port identifier of the Ethernet device.
3776 * The index of traffic mirroring rule, we support four separated rules.
3778 * - (0) if successful.
3779 * - (-ENOTSUP) if hardware doesn't support this feature.
3780 * - (-ENODEV) if *port_id* invalid.
3781 * - (-EINVAL) if bad parameter.
3783 int rte_eth_mirror_rule_reset(uint8_t port_id,
3787 * Set the rate limitation for a queue on an Ethernet device.
3790 * The port identifier of the Ethernet device.
3794 * The tx rate in Mbps. Allocated from the total port link speed.
3796 * - (0) if successful.
3797 * - (-ENOTSUP) if hardware doesn't support this feature.
3798 * - (-ENODEV) if *port_id* invalid.
3799 * - (-EINVAL) if bad parameter.
3801 int rte_eth_set_queue_rate_limit(uint8_t port_id, uint16_t queue_idx,
3805 * Initialize bypass logic. This function needs to be called before
3806 * executing any other bypass API.
3809 * The port identifier of the Ethernet device.
3811 * - (0) if successful.
3812 * - (-ENOTSUP) if hardware doesn't support.
3813 * - (-EINVAL) if bad parameter.
3815 int rte_eth_dev_bypass_init(uint8_t port);
3818 * Return bypass state.
3821 * The port identifier of the Ethernet device.
3823 * The return bypass state.
3826 * - (3) Isolate mode
3828 * - (0) if successful.
3829 * - (-ENOTSUP) if hardware doesn't support.
3830 * - (-EINVAL) if bad parameter.
3832 int rte_eth_dev_bypass_state_show(uint8_t port, uint32_t *state);
3838 * The port identifier of the Ethernet device.
3840 * The current bypass state.
3843 * - (3) Isolate mode
3845 * - (0) if successful.
3846 * - (-ENOTSUP) if hardware doesn't support.
3847 * - (-EINVAL) if bad parameter.
3849 int rte_eth_dev_bypass_state_set(uint8_t port, uint32_t *new_state);
3852 * Return bypass state when given event occurs.
3855 * The port identifier of the Ethernet device.
3858 * - (1) Main power on (power button is pushed)
3859 * - (2) Auxiliary power on (power supply is being plugged)
3860 * - (3) Main power off (system shutdown and power supply is left plugged in)
3861 * - (4) Auxiliary power off (power supply is being unplugged)
3862 * - (5) Display or set the watchdog timer
3864 * The bypass state when given event occurred.
3867 * - (3) Isolate mode
3869 * - (0) if successful.
3870 * - (-ENOTSUP) if hardware doesn't support.
3871 * - (-EINVAL) if bad parameter.
3873 int rte_eth_dev_bypass_event_show(uint8_t port, uint32_t event, uint32_t *state);
3876 * Set bypass state when given event occurs.
3879 * The port identifier of the Ethernet device.
3882 * - (1) Main power on (power button is pushed)
3883 * - (2) Auxiliary power on (power supply is being plugged)
3884 * - (3) Main power off (system shutdown and power supply is left plugged in)
3885 * - (4) Auxiliary power off (power supply is being unplugged)
3886 * - (5) Display or set the watchdog timer
3888 * The assigned state when given event occurs.
3891 * - (3) Isolate mode
3893 * - (0) if successful.
3894 * - (-ENOTSUP) if hardware doesn't support.
3895 * - (-EINVAL) if bad parameter.
3897 int rte_eth_dev_bypass_event_store(uint8_t port, uint32_t event, uint32_t state);
3900 * Set bypass watchdog timeout count.
3903 * The port identifier of the Ethernet device.
3905 * The timeout to be set.
3906 * - (0) 0 seconds (timer is off)
3915 * - (0) if successful.
3916 * - (-ENOTSUP) if hardware doesn't support.
3917 * - (-EINVAL) if bad parameter.
3919 int rte_eth_dev_wd_timeout_store(uint8_t port, uint32_t timeout);
3922 * Get bypass firmware version.
3925 * The port identifier of the Ethernet device.
3927 * The firmware version
3929 * - (0) if successful.
3930 * - (-ENOTSUP) if hardware doesn't support.
3931 * - (-EINVAL) if bad parameter.
3933 int rte_eth_dev_bypass_ver_show(uint8_t port, uint32_t *ver);
3936 * Return bypass watchdog timeout in seconds
3939 * The port identifier of the Ethernet device.
3941 * The return watchdog timeout. "0" represents timer expired
3942 * - (0) 0 seconds (timer is off)
3951 * - (0) if successful.
3952 * - (-ENOTSUP) if hardware doesn't support.
3953 * - (-EINVAL) if bad parameter.
3955 int rte_eth_dev_bypass_wd_timeout_show(uint8_t port, uint32_t *wd_timeout);
3958 * Reset bypass watchdog timer
3961 * The port identifier of the Ethernet device.
3963 * - (0) if successful.
3964 * - (-ENOTSUP) if hardware doesn't support.
3965 * - (-EINVAL) if bad parameter.
3967 int rte_eth_dev_bypass_wd_reset(uint8_t port);
3970 * Configuration of Receive Side Scaling hash computation of Ethernet device.
3973 * The port identifier of the Ethernet device.
3975 * The new configuration to use for RSS hash computation on the port.
3977 * - (0) if successful.
3978 * - (-ENODEV) if port identifier is invalid.
3979 * - (-ENOTSUP) if hardware doesn't support.
3980 * - (-EINVAL) if bad parameter.
3982 int rte_eth_dev_rss_hash_update(uint8_t port_id,
3983 struct rte_eth_rss_conf *rss_conf);
3986 * Retrieve current configuration of Receive Side Scaling hash computation
3987 * of Ethernet device.
3990 * The port identifier of the Ethernet device.
3992 * Where to store the current RSS hash configuration of the Ethernet device.
3994 * - (0) if successful.
3995 * - (-ENODEV) if port identifier is invalid.
3996 * - (-ENOTSUP) if hardware doesn't support RSS.
3999 rte_eth_dev_rss_hash_conf_get(uint8_t port_id,
4000 struct rte_eth_rss_conf *rss_conf);
4003 * Add UDP tunneling port for a specific type of tunnel.
4004 * The packets with this UDP port will be identified as this type of tunnel.
4005 * Before enabling any offloading function for a tunnel, users can call this API
4006 * to change or add more UDP port for the tunnel. So the offloading function
4007 * can take effect on the packets with the specific UDP port.
4010 * The port identifier of the Ethernet device.
4012 * UDP tunneling configuration.
4015 * - (0) if successful.
4016 * - (-ENODEV) if port identifier is invalid.
4017 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4020 rte_eth_dev_udp_tunnel_port_add(uint8_t port_id,
4021 struct rte_eth_udp_tunnel *tunnel_udp);
4024 * Delete UDP tunneling port a specific type of tunnel.
4025 * The packets with this UDP port will not be identified as this type of tunnel
4027 * Before enabling any offloading function for a tunnel, users can call this API
4028 * to delete a UDP port for the tunnel. So the offloading function will not take
4029 * effect on the packets with the specific UDP port.
4032 * The port identifier of the Ethernet device.
4034 * UDP tunneling configuration.
4037 * - (0) if successful.
4038 * - (-ENODEV) if port identifier is invalid.
4039 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4042 rte_eth_dev_udp_tunnel_port_delete(uint8_t port_id,
4043 struct rte_eth_udp_tunnel *tunnel_udp);
4046 * Check whether the filter type is supported on an Ethernet device.
4047 * All the supported filter types are defined in 'rte_eth_ctrl.h'.
4050 * The port identifier of the Ethernet device.
4051 * @param filter_type
4054 * - (0) if successful.
4055 * - (-ENOTSUP) if hardware doesn't support this filter type.
4056 * - (-ENODEV) if *port_id* invalid.
4058 int rte_eth_dev_filter_supported(uint8_t port_id, enum rte_filter_type filter_type);
4061 * Take operations to assigned filter type on an Ethernet device.
4062 * All the supported operations and filter types are defined in 'rte_eth_ctrl.h'.
4065 * The port identifier of the Ethernet device.
4066 * @param filter_type
4069 * Type of operation.
4071 * A pointer to arguments defined specifically for the operation.
4073 * - (0) if successful.
4074 * - (-ENOTSUP) if hardware doesn't support.
4075 * - (-ENODEV) if *port_id* invalid.
4076 * - others depends on the specific operations implementation.
4078 int rte_eth_dev_filter_ctrl(uint8_t port_id, enum rte_filter_type filter_type,
4079 enum rte_filter_op filter_op, void *arg);
4082 * Get DCB information on an Ethernet device.
4085 * The port identifier of the Ethernet device.
4089 * - (0) if successful.
4090 * - (-ENODEV) if port identifier is invalid.
4091 * - (-ENOTSUP) if hardware doesn't support.
4093 int rte_eth_dev_get_dcb_info(uint8_t port_id,
4094 struct rte_eth_dcb_info *dcb_info);
4097 * Add a callback to be called on packet RX on a given port and queue.
4099 * This API configures a function to be called for each burst of
4100 * packets received on a given NIC port queue. The return value is a pointer
4101 * that can be used to later remove the callback using
4102 * rte_eth_remove_rx_callback().
4104 * Multiple functions are called in the order that they are added.
4107 * The port identifier of the Ethernet device.
4109 * The queue on the Ethernet device on which the callback is to be added.
4111 * The callback function
4113 * A generic pointer parameter which will be passed to each invocation of the
4114 * callback function on this port and queue.
4118 * On success, a pointer value which can later be used to remove the callback.
4120 void *rte_eth_add_rx_callback(uint8_t port_id, uint16_t queue_id,
4121 rte_rx_callback_fn fn, void *user_param);
4124 * Add a callback that must be called first on packet RX on a given port
4127 * This API configures a first function to be called for each burst of
4128 * packets received on a given NIC port queue. The return value is a pointer
4129 * that can be used to later remove the callback using
4130 * rte_eth_remove_rx_callback().
4132 * Multiple functions are called in the order that they are added.
4135 * The port identifier of the Ethernet device.
4137 * The queue on the Ethernet device on which the callback is to be added.
4139 * The callback function
4141 * A generic pointer parameter which will be passed to each invocation of the
4142 * callback function on this port and queue.
4146 * On success, a pointer value which can later be used to remove the callback.
4148 void *rte_eth_add_first_rx_callback(uint8_t port_id, uint16_t queue_id,
4149 rte_rx_callback_fn fn, void *user_param);
4152 * Add a callback to be called on packet TX on a given port and queue.
4154 * This API configures a function to be called for each burst of
4155 * packets sent on a given NIC port queue. The return value is a pointer
4156 * that can be used to later remove the callback using
4157 * rte_eth_remove_tx_callback().
4159 * Multiple functions are called in the order that they are added.
4162 * The port identifier of the Ethernet device.
4164 * The queue on the Ethernet device on which the callback is to be added.
4166 * The callback function
4168 * A generic pointer parameter which will be passed to each invocation of the
4169 * callback function on this port and queue.
4173 * On success, a pointer value which can later be used to remove the callback.
4175 void *rte_eth_add_tx_callback(uint8_t port_id, uint16_t queue_id,
4176 rte_tx_callback_fn fn, void *user_param);
4179 * Remove an RX packet callback from a given port and queue.
4181 * This function is used to removed callbacks that were added to a NIC port
4182 * queue using rte_eth_add_rx_callback().
4184 * Note: the callback is removed from the callback list but it isn't freed
4185 * since the it may still be in use. The memory for the callback can be
4186 * subsequently freed back by the application by calling rte_free():
4188 * - Immediately - if the port is stopped, or the user knows that no
4189 * callbacks are in flight e.g. if called from the thread doing RX/TX
4192 * - After a short delay - where the delay is sufficient to allow any
4193 * in-flight callbacks to complete.
4196 * The port identifier of the Ethernet device.
4198 * The queue on the Ethernet device from which the callback is to be removed.
4200 * User supplied callback created via rte_eth_add_rx_callback().
4203 * - 0: Success. Callback was removed.
4204 * - -ENOTSUP: Callback support is not available.
4205 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
4206 * is NULL or not found for the port/queue.
4208 int rte_eth_remove_rx_callback(uint8_t port_id, uint16_t queue_id,
4209 struct rte_eth_rxtx_callback *user_cb);
4212 * Remove a TX packet callback from a given port and queue.
4214 * This function is used to removed callbacks that were added to a NIC port
4215 * queue using rte_eth_add_tx_callback().
4217 * Note: the callback is removed from the callback list but it isn't freed
4218 * since the it may still be in use. The memory for the callback can be
4219 * subsequently freed back by the application by calling rte_free():
4221 * - Immediately - if the port is stopped, or the user knows that no
4222 * callbacks are in flight e.g. if called from the thread doing RX/TX
4225 * - After a short delay - where the delay is sufficient to allow any
4226 * in-flight callbacks to complete.
4229 * The port identifier of the Ethernet device.
4231 * The queue on the Ethernet device from which the callback is to be removed.
4233 * User supplied callback created via rte_eth_add_tx_callback().
4236 * - 0: Success. Callback was removed.
4237 * - -ENOTSUP: Callback support is not available.
4238 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
4239 * is NULL or not found for the port/queue.
4241 int rte_eth_remove_tx_callback(uint8_t port_id, uint16_t queue_id,
4242 struct rte_eth_rxtx_callback *user_cb);
4245 * Retrieve information about given port's RX queue.
4248 * The port identifier of the Ethernet device.
4250 * The RX queue on the Ethernet device for which information
4251 * will be retrieved.
4253 * A pointer to a structure of type *rte_eth_rxq_info_info* to be filled with
4254 * the information of the Ethernet device.
4258 * - -ENOTSUP: routine is not supported by the device PMD.
4259 * - -EINVAL: The port_id or the queue_id is out of range.
4261 int rte_eth_rx_queue_info_get(uint8_t port_id, uint16_t queue_id,
4262 struct rte_eth_rxq_info *qinfo);
4265 * Retrieve information about given port's TX queue.
4268 * The port identifier of the Ethernet device.
4270 * The TX queue on the Ethernet device for which information
4271 * will be retrieved.
4273 * A pointer to a structure of type *rte_eth_txq_info_info* to be filled with
4274 * the information of the Ethernet device.
4278 * - -ENOTSUP: routine is not supported by the device PMD.
4279 * - -EINVAL: The port_id or the queue_id is out of range.
4281 int rte_eth_tx_queue_info_get(uint8_t port_id, uint16_t queue_id,
4282 struct rte_eth_txq_info *qinfo);
4285 * Retrieve device registers and register attributes (number of registers and
4289 * The port identifier of the Ethernet device.
4291 * Pointer to rte_dev_reg_info structure to fill in. If info->data is
4292 * NULL the function fills in the width and length fields. If non-NULL
4293 * the registers are put into the buffer pointed at by the data field.
4295 * - (0) if successful.
4296 * - (-ENOTSUP) if hardware doesn't support.
4297 * - (-ENODEV) if *port_id* invalid.
4298 * - others depends on the specific operations implementation.
4300 int rte_eth_dev_get_reg_info(uint8_t port_id, struct rte_dev_reg_info *info);
4303 * Retrieve size of device EEPROM
4306 * The port identifier of the Ethernet device.
4308 * - (>=0) EEPROM size if successful.
4309 * - (-ENOTSUP) if hardware doesn't support.
4310 * - (-ENODEV) if *port_id* invalid.
4311 * - others depends on the specific operations implementation.
4313 int rte_eth_dev_get_eeprom_length(uint8_t port_id);
4316 * Retrieve EEPROM and EEPROM attribute
4319 * The port identifier of the Ethernet device.
4321 * The template includes buffer for return EEPROM data and
4322 * EEPROM attributes to be filled.
4324 * - (0) if successful.
4325 * - (-ENOTSUP) if hardware doesn't support.
4326 * - (-ENODEV) if *port_id* invalid.
4327 * - others depends on the specific operations implementation.
4329 int rte_eth_dev_get_eeprom(uint8_t port_id, struct rte_dev_eeprom_info *info);
4332 * Program EEPROM with provided data
4335 * The port identifier of the Ethernet device.
4337 * The template includes EEPROM data for programming and
4338 * EEPROM attributes to be filled
4340 * - (0) if successful.
4341 * - (-ENOTSUP) if hardware doesn't support.
4342 * - (-ENODEV) if *port_id* invalid.
4343 * - others depends on the specific operations implementation.
4345 int rte_eth_dev_set_eeprom(uint8_t port_id, struct rte_dev_eeprom_info *info);
4348 * Set the list of multicast addresses to filter on an Ethernet device.
4351 * The port identifier of the Ethernet device.
4352 * @param mc_addr_set
4353 * The array of multicast addresses to set. Equal to NULL when the function
4354 * is invoked to flush the set of filtered addresses.
4356 * The number of multicast addresses in the *mc_addr_set* array. Equal to 0
4357 * when the function is invoked to flush the set of filtered addresses.
4359 * - (0) if successful.
4360 * - (-ENODEV) if *port_id* invalid.
4361 * - (-ENOTSUP) if PMD of *port_id* doesn't support multicast filtering.
4362 * - (-ENOSPC) if *port_id* has not enough multicast filtering resources.
4364 int rte_eth_dev_set_mc_addr_list(uint8_t port_id,
4365 struct ether_addr *mc_addr_set,
4366 uint32_t nb_mc_addr);
4369 * Enable IEEE1588/802.1AS timestamping for an Ethernet device.
4372 * The port identifier of the Ethernet device.
4376 * - -ENODEV: The port ID is invalid.
4377 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4379 int rte_eth_timesync_enable(uint8_t port_id);
4382 * Disable IEEE1588/802.1AS timestamping for an Ethernet device.
4385 * The port identifier of the Ethernet device.
4389 * - -ENODEV: The port ID is invalid.
4390 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4392 int rte_eth_timesync_disable(uint8_t port_id);
4395 * Read an IEEE1588/802.1AS RX timestamp from an Ethernet device.
4398 * The port identifier of the Ethernet device.
4400 * Pointer to the timestamp struct.
4402 * Device specific flags. Used to pass the RX timesync register index to
4403 * i40e. Unused in igb/ixgbe, pass 0 instead.
4407 * - -EINVAL: No timestamp is available.
4408 * - -ENODEV: The port ID is invalid.
4409 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4411 int rte_eth_timesync_read_rx_timestamp(uint8_t port_id,
4412 struct timespec *timestamp, uint32_t flags);
4415 * Read an IEEE1588/802.1AS TX timestamp from an Ethernet device.
4418 * The port identifier of the Ethernet device.
4420 * Pointer to the timestamp struct.
4424 * - -EINVAL: No timestamp is available.
4425 * - -ENODEV: The port ID is invalid.
4426 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4428 int rte_eth_timesync_read_tx_timestamp(uint8_t port_id,
4429 struct timespec *timestamp);
4432 * Adjust the timesync clock on an Ethernet device.
4434 * This is usually used in conjunction with other Ethdev timesync functions to
4435 * synchronize the device time using the IEEE1588/802.1AS protocol.
4438 * The port identifier of the Ethernet device.
4440 * The adjustment in nanoseconds.
4444 * - -ENODEV: The port ID is invalid.
4445 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4447 int rte_eth_timesync_adjust_time(uint8_t port_id, int64_t delta);
4450 * Read the time from the timesync clock on an Ethernet device.
4452 * This is usually used in conjunction with other Ethdev timesync functions to
4453 * synchronize the device time using the IEEE1588/802.1AS protocol.
4456 * The port identifier of the Ethernet device.
4458 * Pointer to the timespec struct that holds the time.
4463 int rte_eth_timesync_read_time(uint8_t port_id, struct timespec *time);
4466 * Set the time of the timesync clock on an Ethernet device.
4468 * This is usually used in conjunction with other Ethdev timesync functions to
4469 * synchronize the device time using the IEEE1588/802.1AS protocol.
4472 * The port identifier of the Ethernet device.
4474 * Pointer to the timespec struct that holds the time.
4478 * - -EINVAL: No timestamp is available.
4479 * - -ENODEV: The port ID is invalid.
4480 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4482 int rte_eth_timesync_write_time(uint8_t port_id, const struct timespec *time);
4485 * Copy pci device info to the Ethernet device data.
4488 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure.
4490 * The *pci_dev* pointer is the address of the *rte_pci_device* structure.
4493 * - 0 on success, negative on error
4495 void rte_eth_copy_pci_info(struct rte_eth_dev *eth_dev,
4496 struct rte_pci_device *pci_dev);
4499 * Create memzone for HW rings.
4500 * malloc can't be used as the physical address is needed.
4501 * If the memzone is already created, then this function returns a ptr
4505 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
4507 * The name of the memory zone
4509 * The index of the queue to add to name
4511 * The sizeof of the memory area
4513 * Alignment for resulting memzone. Must be a power of 2.
4515 * The *socket_id* argument is the socket identifier in case of NUMA.
4517 const struct rte_memzone *
4518 rte_eth_dma_zone_reserve(const struct rte_eth_dev *eth_dev, const char *name,
4519 uint16_t queue_id, size_t size,
4520 unsigned align, int socket_id);
4523 * Config l2 tunnel ether type of an Ethernet device for filtering specific
4524 * tunnel packets by ether type.
4527 * The port identifier of the Ethernet device.
4529 * l2 tunnel configuration.
4532 * - (0) if successful.
4533 * - (-ENODEV) if port identifier is invalid.
4534 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4537 rte_eth_dev_l2_tunnel_eth_type_conf(uint8_t port_id,
4538 struct rte_eth_l2_tunnel_conf *l2_tunnel);
4541 * Enable/disable l2 tunnel offload functions. Include,
4542 * 1, The ability of parsing a type of l2 tunnel of an Ethernet device.
4543 * Filtering, forwarding and offloading this type of tunnel packets depend on
4545 * 2, Stripping the l2 tunnel tag.
4546 * 3, Insertion of the l2 tunnel tag.
4547 * 4, Forwarding the packets based on the l2 tunnel tag.
4550 * The port identifier of the Ethernet device.
4552 * l2 tunnel parameters.
4554 * Indicate the offload function.
4556 * Enable or disable this function.
4559 * - (0) if successful.
4560 * - (-ENODEV) if port identifier is invalid.
4561 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4564 rte_eth_dev_l2_tunnel_offload_set(uint8_t port_id,
4565 struct rte_eth_l2_tunnel_conf *l2_tunnel,
4570 * Get the port id from pci adrress or device name
4571 * Ex: 0000:2:00.0 or vdev name net_pcap0
4574 * pci address or name of the device
4576 * pointer to port identifier of the device
4578 * - (0) if successful.
4579 * - (-ENODEV or -EINVAL) on failure.
4582 rte_eth_dev_get_port_by_name(const char *name, uint8_t *port_id);
4585 * Get the device name from port id
4588 * pointer to port identifier of the device
4590 * pci address or name of the device
4592 * - (0) if successful.
4593 * - (-EINVAL) on failure.
4596 rte_eth_dev_get_name_by_port(uint8_t port_id, char *name);
4600 * Wrapper for use by pci drivers as a .probe function to attach to a ethdev
4603 int rte_eth_dev_pci_probe(struct rte_pci_driver *pci_drv,
4604 struct rte_pci_device *pci_dev);
4608 * Wrapper for use by pci drivers as a .remove function to detach a ethdev
4611 int rte_eth_dev_pci_remove(struct rte_pci_device *pci_dev);
4617 #endif /* _RTE_ETHDEV_H_ */