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>
183 #include <rte_devargs.h>
184 #include <rte_errno.h>
185 #include "rte_ether.h"
186 #include "rte_eth_ctrl.h"
187 #include "rte_dev_info.h"
192 * A structure used to retrieve statistics for an Ethernet port.
193 * Not all statistics fields in struct rte_eth_stats are supported
194 * by any type of network interface card (NIC). If any statistics
195 * field is not supported, its value is 0.
197 struct rte_eth_stats {
198 uint64_t ipackets; /**< Total number of successfully received packets. */
199 uint64_t opackets; /**< Total number of successfully transmitted packets.*/
200 uint64_t ibytes; /**< Total number of successfully received bytes. */
201 uint64_t obytes; /**< Total number of successfully transmitted bytes. */
203 /**< Total of RX packets dropped by the HW,
204 * because there are no available buffer (i.e. RX queues are full).
206 uint64_t ierrors; /**< Total number of erroneous received packets. */
207 uint64_t oerrors; /**< Total number of failed transmitted packets. */
208 uint64_t rx_nombuf; /**< Total number of RX mbuf allocation failures. */
209 uint64_t q_ipackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
210 /**< Total number of queue RX packets. */
211 uint64_t q_opackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
212 /**< Total number of queue TX packets. */
213 uint64_t q_ibytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
214 /**< Total number of successfully received queue bytes. */
215 uint64_t q_obytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
216 /**< Total number of successfully transmitted queue bytes. */
217 uint64_t q_errors[RTE_ETHDEV_QUEUE_STAT_CNTRS];
218 /**< Total number of queue packets received that are dropped. */
222 * Device supported speeds bitmap flags
224 #define ETH_LINK_SPEED_AUTONEG (0 << 0) /**< Autonegotiate (all speeds) */
225 #define ETH_LINK_SPEED_FIXED (1 << 0) /**< Disable autoneg (fixed speed) */
226 #define ETH_LINK_SPEED_10M_HD (1 << 1) /**< 10 Mbps half-duplex */
227 #define ETH_LINK_SPEED_10M (1 << 2) /**< 10 Mbps full-duplex */
228 #define ETH_LINK_SPEED_100M_HD (1 << 3) /**< 100 Mbps half-duplex */
229 #define ETH_LINK_SPEED_100M (1 << 4) /**< 100 Mbps full-duplex */
230 #define ETH_LINK_SPEED_1G (1 << 5) /**< 1 Gbps */
231 #define ETH_LINK_SPEED_2_5G (1 << 6) /**< 2.5 Gbps */
232 #define ETH_LINK_SPEED_5G (1 << 7) /**< 5 Gbps */
233 #define ETH_LINK_SPEED_10G (1 << 8) /**< 10 Gbps */
234 #define ETH_LINK_SPEED_20G (1 << 9) /**< 20 Gbps */
235 #define ETH_LINK_SPEED_25G (1 << 10) /**< 25 Gbps */
236 #define ETH_LINK_SPEED_40G (1 << 11) /**< 40 Gbps */
237 #define ETH_LINK_SPEED_50G (1 << 12) /**< 50 Gbps */
238 #define ETH_LINK_SPEED_56G (1 << 13) /**< 56 Gbps */
239 #define ETH_LINK_SPEED_100G (1 << 14) /**< 100 Gbps */
242 * Ethernet numeric link speeds in Mbps
244 #define ETH_SPEED_NUM_NONE 0 /**< Not defined */
245 #define ETH_SPEED_NUM_10M 10 /**< 10 Mbps */
246 #define ETH_SPEED_NUM_100M 100 /**< 100 Mbps */
247 #define ETH_SPEED_NUM_1G 1000 /**< 1 Gbps */
248 #define ETH_SPEED_NUM_2_5G 2500 /**< 2.5 Gbps */
249 #define ETH_SPEED_NUM_5G 5000 /**< 5 Gbps */
250 #define ETH_SPEED_NUM_10G 10000 /**< 10 Gbps */
251 #define ETH_SPEED_NUM_20G 20000 /**< 20 Gbps */
252 #define ETH_SPEED_NUM_25G 25000 /**< 25 Gbps */
253 #define ETH_SPEED_NUM_40G 40000 /**< 40 Gbps */
254 #define ETH_SPEED_NUM_50G 50000 /**< 50 Gbps */
255 #define ETH_SPEED_NUM_56G 56000 /**< 56 Gbps */
256 #define ETH_SPEED_NUM_100G 100000 /**< 100 Gbps */
259 * A structure used to retrieve link-level information of an Ethernet port.
262 struct rte_eth_link {
263 uint32_t link_speed; /**< ETH_SPEED_NUM_ */
264 uint16_t link_duplex : 1; /**< ETH_LINK_[HALF/FULL]_DUPLEX */
265 uint16_t link_autoneg : 1; /**< ETH_LINK_SPEED_[AUTONEG/FIXED] */
266 uint16_t link_status : 1; /**< ETH_LINK_[DOWN/UP] */
267 } __attribute__((aligned(8))); /**< aligned for atomic64 read/write */
269 /* Utility constants */
270 #define ETH_LINK_HALF_DUPLEX 0 /**< Half-duplex connection. */
271 #define ETH_LINK_FULL_DUPLEX 1 /**< Full-duplex connection. */
272 #define ETH_LINK_DOWN 0 /**< Link is down. */
273 #define ETH_LINK_UP 1 /**< Link is up. */
274 #define ETH_LINK_FIXED 0 /**< No autonegotiation. */
275 #define ETH_LINK_AUTONEG 1 /**< Autonegotiated. */
278 * A structure used to configure the ring threshold registers of an RX/TX
279 * queue for an Ethernet port.
281 struct rte_eth_thresh {
282 uint8_t pthresh; /**< Ring prefetch threshold. */
283 uint8_t hthresh; /**< Ring host threshold. */
284 uint8_t wthresh; /**< Ring writeback threshold. */
288 * Simple flags are used for rte_eth_conf.rxmode.mq_mode.
290 #define ETH_MQ_RX_RSS_FLAG 0x1
291 #define ETH_MQ_RX_DCB_FLAG 0x2
292 #define ETH_MQ_RX_VMDQ_FLAG 0x4
295 * A set of values to identify what method is to be used to route
296 * packets to multiple queues.
298 enum rte_eth_rx_mq_mode {
299 /** None of DCB,RSS or VMDQ mode */
302 /** For RX side, only RSS is on */
303 ETH_MQ_RX_RSS = ETH_MQ_RX_RSS_FLAG,
304 /** For RX side,only DCB is on. */
305 ETH_MQ_RX_DCB = ETH_MQ_RX_DCB_FLAG,
306 /** Both DCB and RSS enable */
307 ETH_MQ_RX_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG,
309 /** Only VMDQ, no RSS nor DCB */
310 ETH_MQ_RX_VMDQ_ONLY = ETH_MQ_RX_VMDQ_FLAG,
311 /** RSS mode with VMDQ */
312 ETH_MQ_RX_VMDQ_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_VMDQ_FLAG,
313 /** Use VMDQ+DCB to route traffic to queues */
314 ETH_MQ_RX_VMDQ_DCB = ETH_MQ_RX_VMDQ_FLAG | ETH_MQ_RX_DCB_FLAG,
315 /** Enable both VMDQ and DCB in VMDq */
316 ETH_MQ_RX_VMDQ_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG |
321 * for rx mq mode backward compatible
323 #define ETH_RSS ETH_MQ_RX_RSS
324 #define VMDQ_DCB ETH_MQ_RX_VMDQ_DCB
325 #define ETH_DCB_RX ETH_MQ_RX_DCB
328 * A set of values to identify what method is to be used to transmit
329 * packets using multi-TCs.
331 enum rte_eth_tx_mq_mode {
332 ETH_MQ_TX_NONE = 0, /**< It is in neither DCB nor VT mode. */
333 ETH_MQ_TX_DCB, /**< For TX side,only DCB is on. */
334 ETH_MQ_TX_VMDQ_DCB, /**< For TX side,both DCB and VT is on. */
335 ETH_MQ_TX_VMDQ_ONLY, /**< Only VT on, no DCB */
339 * for tx mq mode backward compatible
341 #define ETH_DCB_NONE ETH_MQ_TX_NONE
342 #define ETH_VMDQ_DCB_TX ETH_MQ_TX_VMDQ_DCB
343 #define ETH_DCB_TX ETH_MQ_TX_DCB
346 * A structure used to configure the RX features of an Ethernet port.
348 struct rte_eth_rxmode {
349 /** The multi-queue packet distribution mode to be used, e.g. RSS. */
350 enum rte_eth_rx_mq_mode mq_mode;
351 uint32_t max_rx_pkt_len; /**< Only used if jumbo_frame enabled. */
352 uint16_t split_hdr_size; /**< hdr buf size (header_split enabled).*/
354 uint16_t header_split : 1, /**< Header Split enable. */
355 hw_ip_checksum : 1, /**< IP/UDP/TCP checksum offload enable. */
356 hw_vlan_filter : 1, /**< VLAN filter enable. */
357 hw_vlan_strip : 1, /**< VLAN strip enable. */
358 hw_vlan_extend : 1, /**< Extended VLAN enable. */
359 jumbo_frame : 1, /**< Jumbo Frame Receipt enable. */
360 hw_strip_crc : 1, /**< Enable CRC stripping by hardware. */
361 enable_scatter : 1, /**< Enable scatter packets rx handler */
362 enable_lro : 1; /**< Enable LRO */
366 * VLAN types to indicate if it is for single VLAN, inner VLAN or outer VLAN.
367 * Note that single VLAN is treated the same as inner VLAN.
370 ETH_VLAN_TYPE_UNKNOWN = 0,
371 ETH_VLAN_TYPE_INNER, /**< Inner VLAN. */
372 ETH_VLAN_TYPE_OUTER, /**< Single VLAN, or outer VLAN. */
377 * A structure used to configure the Receive Side Scaling (RSS) feature
378 * of an Ethernet port.
379 * If not NULL, the *rss_key* pointer of the *rss_conf* structure points
380 * to an array holding the RSS key to use for hashing specific header
381 * fields of received packets. The length of this array should be indicated
382 * by *rss_key_len* below. Otherwise, a default random hash key is used by
385 * The *rss_key_len* field of the *rss_conf* structure indicates the length
386 * in bytes of the array pointed by *rss_key*. To be compatible, this length
387 * will be checked in i40e only. Others assume 40 bytes to be used as before.
389 * The *rss_hf* field of the *rss_conf* structure indicates the different
390 * types of IPv4/IPv6 packets to which the RSS hashing must be applied.
391 * Supplying an *rss_hf* equal to zero disables the RSS feature.
393 struct rte_eth_rss_conf {
394 uint8_t *rss_key; /**< If not NULL, 40-byte hash key. */
395 uint8_t rss_key_len; /**< hash key length in bytes. */
396 uint64_t rss_hf; /**< Hash functions to apply - see below. */
400 * The RSS offload types are defined based on flow types which are defined
401 * in rte_eth_ctrl.h. Different NIC hardwares may support different RSS offload
402 * types. The supported flow types or RSS offload types can be queried by
403 * rte_eth_dev_info_get().
405 #define ETH_RSS_IPV4 (1ULL << RTE_ETH_FLOW_IPV4)
406 #define ETH_RSS_FRAG_IPV4 (1ULL << RTE_ETH_FLOW_FRAG_IPV4)
407 #define ETH_RSS_NONFRAG_IPV4_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_TCP)
408 #define ETH_RSS_NONFRAG_IPV4_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_UDP)
409 #define ETH_RSS_NONFRAG_IPV4_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_SCTP)
410 #define ETH_RSS_NONFRAG_IPV4_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_OTHER)
411 #define ETH_RSS_IPV6 (1ULL << RTE_ETH_FLOW_IPV6)
412 #define ETH_RSS_FRAG_IPV6 (1ULL << RTE_ETH_FLOW_FRAG_IPV6)
413 #define ETH_RSS_NONFRAG_IPV6_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_TCP)
414 #define ETH_RSS_NONFRAG_IPV6_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_UDP)
415 #define ETH_RSS_NONFRAG_IPV6_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_SCTP)
416 #define ETH_RSS_NONFRAG_IPV6_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_OTHER)
417 #define ETH_RSS_L2_PAYLOAD (1ULL << RTE_ETH_FLOW_L2_PAYLOAD)
418 #define ETH_RSS_IPV6_EX (1ULL << RTE_ETH_FLOW_IPV6_EX)
419 #define ETH_RSS_IPV6_TCP_EX (1ULL << RTE_ETH_FLOW_IPV6_TCP_EX)
420 #define ETH_RSS_IPV6_UDP_EX (1ULL << RTE_ETH_FLOW_IPV6_UDP_EX)
421 #define ETH_RSS_PORT (1ULL << RTE_ETH_FLOW_PORT)
422 #define ETH_RSS_VXLAN (1ULL << RTE_ETH_FLOW_VXLAN)
423 #define ETH_RSS_GENEVE (1ULL << RTE_ETH_FLOW_GENEVE)
424 #define ETH_RSS_NVGRE (1ULL << RTE_ETH_FLOW_NVGRE)
426 #define ETH_RSS_IP ( \
428 ETH_RSS_FRAG_IPV4 | \
429 ETH_RSS_NONFRAG_IPV4_OTHER | \
431 ETH_RSS_FRAG_IPV6 | \
432 ETH_RSS_NONFRAG_IPV6_OTHER | \
435 #define ETH_RSS_UDP ( \
436 ETH_RSS_NONFRAG_IPV4_UDP | \
437 ETH_RSS_NONFRAG_IPV6_UDP | \
440 #define ETH_RSS_TCP ( \
441 ETH_RSS_NONFRAG_IPV4_TCP | \
442 ETH_RSS_NONFRAG_IPV6_TCP | \
445 #define ETH_RSS_SCTP ( \
446 ETH_RSS_NONFRAG_IPV4_SCTP | \
447 ETH_RSS_NONFRAG_IPV6_SCTP)
449 #define ETH_RSS_TUNNEL ( \
455 /**< Mask of valid RSS hash protocols */
456 #define ETH_RSS_PROTO_MASK ( \
458 ETH_RSS_FRAG_IPV4 | \
459 ETH_RSS_NONFRAG_IPV4_TCP | \
460 ETH_RSS_NONFRAG_IPV4_UDP | \
461 ETH_RSS_NONFRAG_IPV4_SCTP | \
462 ETH_RSS_NONFRAG_IPV4_OTHER | \
464 ETH_RSS_FRAG_IPV6 | \
465 ETH_RSS_NONFRAG_IPV6_TCP | \
466 ETH_RSS_NONFRAG_IPV6_UDP | \
467 ETH_RSS_NONFRAG_IPV6_SCTP | \
468 ETH_RSS_NONFRAG_IPV6_OTHER | \
469 ETH_RSS_L2_PAYLOAD | \
471 ETH_RSS_IPV6_TCP_EX | \
472 ETH_RSS_IPV6_UDP_EX | \
479 * Definitions used for redirection table entry size.
480 * Some RSS RETA sizes may not be supported by some drivers, check the
481 * documentation or the description of relevant functions for more details.
483 #define ETH_RSS_RETA_SIZE_64 64
484 #define ETH_RSS_RETA_SIZE_128 128
485 #define ETH_RSS_RETA_SIZE_256 256
486 #define ETH_RSS_RETA_SIZE_512 512
487 #define RTE_RETA_GROUP_SIZE 64
489 /* Definitions used for VMDQ and DCB functionality */
490 #define ETH_VMDQ_MAX_VLAN_FILTERS 64 /**< Maximum nb. of VMDQ vlan filters. */
491 #define ETH_DCB_NUM_USER_PRIORITIES 8 /**< Maximum nb. of DCB priorities. */
492 #define ETH_VMDQ_DCB_NUM_QUEUES 128 /**< Maximum nb. of VMDQ DCB queues. */
493 #define ETH_DCB_NUM_QUEUES 128 /**< Maximum nb. of DCB queues. */
495 /* DCB capability defines */
496 #define ETH_DCB_PG_SUPPORT 0x00000001 /**< Priority Group(ETS) support. */
497 #define ETH_DCB_PFC_SUPPORT 0x00000002 /**< Priority Flow Control support. */
499 /* Definitions used for VLAN Offload functionality */
500 #define ETH_VLAN_STRIP_OFFLOAD 0x0001 /**< VLAN Strip On/Off */
501 #define ETH_VLAN_FILTER_OFFLOAD 0x0002 /**< VLAN Filter On/Off */
502 #define ETH_VLAN_EXTEND_OFFLOAD 0x0004 /**< VLAN Extend On/Off */
504 /* Definitions used for mask VLAN setting */
505 #define ETH_VLAN_STRIP_MASK 0x0001 /**< VLAN Strip setting mask */
506 #define ETH_VLAN_FILTER_MASK 0x0002 /**< VLAN Filter setting mask*/
507 #define ETH_VLAN_EXTEND_MASK 0x0004 /**< VLAN Extend setting mask*/
508 #define ETH_VLAN_ID_MAX 0x0FFF /**< VLAN ID is in lower 12 bits*/
510 /* Definitions used for receive MAC address */
511 #define ETH_NUM_RECEIVE_MAC_ADDR 128 /**< Maximum nb. of receive mac addr. */
513 /* Definitions used for unicast hash */
514 #define ETH_VMDQ_NUM_UC_HASH_ARRAY 128 /**< Maximum nb. of UC hash array. */
516 /* Definitions used for VMDQ pool rx mode setting */
517 #define ETH_VMDQ_ACCEPT_UNTAG 0x0001 /**< accept untagged packets. */
518 #define ETH_VMDQ_ACCEPT_HASH_MC 0x0002 /**< accept packets in multicast table . */
519 #define ETH_VMDQ_ACCEPT_HASH_UC 0x0004 /**< accept packets in unicast table. */
520 #define ETH_VMDQ_ACCEPT_BROADCAST 0x0008 /**< accept broadcast packets. */
521 #define ETH_VMDQ_ACCEPT_MULTICAST 0x0010 /**< multicast promiscuous. */
523 /** Maximum nb. of vlan per mirror rule */
524 #define ETH_MIRROR_MAX_VLANS 64
526 #define ETH_MIRROR_VIRTUAL_POOL_UP 0x01 /**< Virtual Pool uplink Mirroring. */
527 #define ETH_MIRROR_UPLINK_PORT 0x02 /**< Uplink Port Mirroring. */
528 #define ETH_MIRROR_DOWNLINK_PORT 0x04 /**< Downlink Port Mirroring. */
529 #define ETH_MIRROR_VLAN 0x08 /**< VLAN Mirroring. */
530 #define ETH_MIRROR_VIRTUAL_POOL_DOWN 0x10 /**< Virtual Pool downlink Mirroring. */
533 * A structure used to configure VLAN traffic mirror of an Ethernet port.
535 struct rte_eth_vlan_mirror {
536 uint64_t vlan_mask; /**< mask for valid VLAN ID. */
537 /** VLAN ID list for vlan mirroring. */
538 uint16_t vlan_id[ETH_MIRROR_MAX_VLANS];
542 * A structure used to configure traffic mirror of an Ethernet port.
544 struct rte_eth_mirror_conf {
545 uint8_t rule_type; /**< Mirroring rule type */
546 uint8_t dst_pool; /**< Destination pool for this mirror rule. */
547 uint64_t pool_mask; /**< Bitmap of pool for pool mirroring */
548 /** VLAN ID setting for VLAN mirroring. */
549 struct rte_eth_vlan_mirror vlan;
553 * A structure used to configure 64 entries of Redirection Table of the
554 * Receive Side Scaling (RSS) feature of an Ethernet port. To configure
555 * more than 64 entries supported by hardware, an array of this structure
558 struct rte_eth_rss_reta_entry64 {
560 /**< Mask bits indicate which entries need to be updated/queried. */
561 uint16_t reta[RTE_RETA_GROUP_SIZE];
562 /**< Group of 64 redirection table entries. */
566 * This enum indicates the possible number of traffic classes
567 * in DCB configratioins
569 enum rte_eth_nb_tcs {
570 ETH_4_TCS = 4, /**< 4 TCs with DCB. */
571 ETH_8_TCS = 8 /**< 8 TCs with DCB. */
575 * This enum indicates the possible number of queue pools
576 * in VMDQ configurations.
578 enum rte_eth_nb_pools {
579 ETH_8_POOLS = 8, /**< 8 VMDq pools. */
580 ETH_16_POOLS = 16, /**< 16 VMDq pools. */
581 ETH_32_POOLS = 32, /**< 32 VMDq pools. */
582 ETH_64_POOLS = 64 /**< 64 VMDq pools. */
585 /* This structure may be extended in future. */
586 struct rte_eth_dcb_rx_conf {
587 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs */
588 /** Traffic class each UP mapped to. */
589 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
592 struct rte_eth_vmdq_dcb_tx_conf {
593 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools. */
594 /** Traffic class each UP mapped to. */
595 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
598 struct rte_eth_dcb_tx_conf {
599 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs. */
600 /** Traffic class each UP mapped to. */
601 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
604 struct rte_eth_vmdq_tx_conf {
605 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq mode, 64 pools. */
609 * A structure used to configure the VMDQ+DCB feature
610 * of an Ethernet port.
612 * Using this feature, packets are routed to a pool of queues, based
613 * on the vlan id in the vlan tag, and then to a specific queue within
614 * that pool, using the user priority vlan tag field.
616 * A default pool may be used, if desired, to route all traffic which
617 * does not match the vlan filter rules.
619 struct rte_eth_vmdq_dcb_conf {
620 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools */
621 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
622 uint8_t default_pool; /**< The default pool, if applicable */
623 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
625 uint16_t vlan_id; /**< The vlan id of the received frame */
626 uint64_t pools; /**< Bitmask of pools for packet rx */
627 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
628 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
629 /**< Selects a queue in a pool */
632 struct rte_eth_vmdq_rx_conf {
633 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq only mode, 8 or 64 pools */
634 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
635 uint8_t default_pool; /**< The default pool, if applicable */
636 uint8_t enable_loop_back; /**< Enable VT loop back */
637 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
638 uint32_t rx_mode; /**< Flags from ETH_VMDQ_ACCEPT_* */
640 uint16_t vlan_id; /**< The vlan id of the received frame */
641 uint64_t pools; /**< Bitmask of pools for packet rx */
642 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
646 * A structure used to configure the TX features of an Ethernet port.
648 struct rte_eth_txmode {
649 enum rte_eth_tx_mq_mode mq_mode; /**< TX multi-queues mode. */
651 /* For i40e specifically */
654 uint8_t hw_vlan_reject_tagged : 1,
655 /**< If set, reject sending out tagged pkts */
656 hw_vlan_reject_untagged : 1,
657 /**< If set, reject sending out untagged pkts */
658 hw_vlan_insert_pvid : 1;
659 /**< If set, enable port based VLAN insertion */
663 * A structure used to configure an RX ring of an Ethernet port.
665 struct rte_eth_rxconf {
666 struct rte_eth_thresh rx_thresh; /**< RX ring threshold registers. */
667 uint16_t rx_free_thresh; /**< Drives the freeing of RX descriptors. */
668 uint8_t rx_drop_en; /**< Drop packets if no descriptors are available. */
669 uint8_t rx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
672 #define ETH_TXQ_FLAGS_NOMULTSEGS 0x0001 /**< nb_segs=1 for all mbufs */
673 #define ETH_TXQ_FLAGS_NOREFCOUNT 0x0002 /**< refcnt can be ignored */
674 #define ETH_TXQ_FLAGS_NOMULTMEMP 0x0004 /**< all bufs come from same mempool */
675 #define ETH_TXQ_FLAGS_NOVLANOFFL 0x0100 /**< disable VLAN offload */
676 #define ETH_TXQ_FLAGS_NOXSUMSCTP 0x0200 /**< disable SCTP checksum offload */
677 #define ETH_TXQ_FLAGS_NOXSUMUDP 0x0400 /**< disable UDP checksum offload */
678 #define ETH_TXQ_FLAGS_NOXSUMTCP 0x0800 /**< disable TCP checksum offload */
679 #define ETH_TXQ_FLAGS_NOOFFLOADS \
680 (ETH_TXQ_FLAGS_NOVLANOFFL | ETH_TXQ_FLAGS_NOXSUMSCTP | \
681 ETH_TXQ_FLAGS_NOXSUMUDP | ETH_TXQ_FLAGS_NOXSUMTCP)
682 #define ETH_TXQ_FLAGS_NOXSUMS \
683 (ETH_TXQ_FLAGS_NOXSUMSCTP | ETH_TXQ_FLAGS_NOXSUMUDP | \
684 ETH_TXQ_FLAGS_NOXSUMTCP)
686 * A structure used to configure a TX ring of an Ethernet port.
688 struct rte_eth_txconf {
689 struct rte_eth_thresh tx_thresh; /**< TX ring threshold registers. */
690 uint16_t tx_rs_thresh; /**< Drives the setting of RS bit on TXDs. */
691 uint16_t tx_free_thresh; /**< Start freeing TX buffers if there are
692 less free descriptors than this value. */
694 uint32_t txq_flags; /**< Set flags for the Tx queue */
695 uint8_t tx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
699 * A structure contains information about HW descriptor ring limitations.
701 struct rte_eth_desc_lim {
702 uint16_t nb_max; /**< Max allowed number of descriptors. */
703 uint16_t nb_min; /**< Min allowed number of descriptors. */
704 uint16_t nb_align; /**< Number of descriptors should be aligned to. */
707 * Max allowed number of segments per whole packet.
709 * - For TSO packet this is the total number of data descriptors allowed
712 * @see nb_mtu_seg_max
717 * Max number of segments per one MTU.
719 * - For non-TSO packet, this is the maximum allowed number of segments
720 * in a single transmit packet.
722 * - For TSO packet each segment within the TSO may span up to this
727 uint16_t nb_mtu_seg_max;
731 * This enum indicates the flow control mode
733 enum rte_eth_fc_mode {
734 RTE_FC_NONE = 0, /**< Disable flow control. */
735 RTE_FC_RX_PAUSE, /**< RX pause frame, enable flowctrl on TX side. */
736 RTE_FC_TX_PAUSE, /**< TX pause frame, enable flowctrl on RX side. */
737 RTE_FC_FULL /**< Enable flow control on both side. */
741 * A structure used to configure Ethernet flow control parameter.
742 * These parameters will be configured into the register of the NIC.
743 * Please refer to the corresponding data sheet for proper value.
745 struct rte_eth_fc_conf {
746 uint32_t high_water; /**< High threshold value to trigger XOFF */
747 uint32_t low_water; /**< Low threshold value to trigger XON */
748 uint16_t pause_time; /**< Pause quota in the Pause frame */
749 uint16_t send_xon; /**< Is XON frame need be sent */
750 enum rte_eth_fc_mode mode; /**< Link flow control mode */
751 uint8_t mac_ctrl_frame_fwd; /**< Forward MAC control frames */
752 uint8_t autoneg; /**< Use Pause autoneg */
756 * A structure used to configure Ethernet priority flow control parameter.
757 * These parameters will be configured into the register of the NIC.
758 * Please refer to the corresponding data sheet for proper value.
760 struct rte_eth_pfc_conf {
761 struct rte_eth_fc_conf fc; /**< General flow control parameter. */
762 uint8_t priority; /**< VLAN User Priority. */
766 * Memory space that can be configured to store Flow Director filters
767 * in the board memory.
769 enum rte_fdir_pballoc_type {
770 RTE_FDIR_PBALLOC_64K = 0, /**< 64k. */
771 RTE_FDIR_PBALLOC_128K, /**< 128k. */
772 RTE_FDIR_PBALLOC_256K, /**< 256k. */
776 * Select report mode of FDIR hash information in RX descriptors.
778 enum rte_fdir_status_mode {
779 RTE_FDIR_NO_REPORT_STATUS = 0, /**< Never report FDIR hash. */
780 RTE_FDIR_REPORT_STATUS, /**< Only report FDIR hash for matching pkts. */
781 RTE_FDIR_REPORT_STATUS_ALWAYS, /**< Always report FDIR hash. */
785 * A structure used to configure the Flow Director (FDIR) feature
786 * of an Ethernet port.
788 * If mode is RTE_FDIR_DISABLE, the pballoc value is ignored.
790 struct rte_fdir_conf {
791 enum rte_fdir_mode mode; /**< Flow Director mode. */
792 enum rte_fdir_pballoc_type pballoc; /**< Space for FDIR filters. */
793 enum rte_fdir_status_mode status; /**< How to report FDIR hash. */
794 /** RX queue of packets matching a "drop" filter in perfect mode. */
796 struct rte_eth_fdir_masks mask;
797 struct rte_eth_fdir_flex_conf flex_conf;
798 /**< Flex payload configuration. */
802 * UDP tunneling configuration.
803 * Used to config the UDP port for a type of tunnel.
804 * NICs need the UDP port to identify the tunnel type.
805 * Normally a type of tunnel has a default UDP port, this structure can be used
806 * in case if the users want to change or support more UDP port.
808 struct rte_eth_udp_tunnel {
809 uint16_t udp_port; /**< UDP port used for the tunnel. */
810 uint8_t prot_type; /**< Tunnel type. Defined in rte_eth_tunnel_type. */
814 * A structure used to enable/disable specific device interrupts.
816 struct rte_intr_conf {
817 /** enable/disable lsc interrupt. 0 (default) - disable, 1 enable */
819 /** enable/disable rxq interrupt. 0 (default) - disable, 1 enable */
824 * A structure used to configure an Ethernet port.
825 * Depending upon the RX multi-queue mode, extra advanced
826 * configuration settings may be needed.
828 struct rte_eth_conf {
829 uint32_t link_speeds; /**< bitmap of ETH_LINK_SPEED_XXX of speeds to be
830 used. ETH_LINK_SPEED_FIXED disables link
831 autonegotiation, and a unique speed shall be
832 set. Otherwise, the bitmap defines the set of
833 speeds to be advertised. If the special value
834 ETH_LINK_SPEED_AUTONEG (0) is used, all speeds
835 supported are advertised. */
836 struct rte_eth_rxmode rxmode; /**< Port RX configuration. */
837 struct rte_eth_txmode txmode; /**< Port TX configuration. */
838 uint32_t lpbk_mode; /**< Loopback operation mode. By default the value
839 is 0, meaning the loopback mode is disabled.
840 Read the datasheet of given ethernet controller
841 for details. The possible values of this field
842 are defined in implementation of each driver. */
844 struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
845 struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
846 /**< Port vmdq+dcb configuration. */
847 struct rte_eth_dcb_rx_conf dcb_rx_conf;
848 /**< Port dcb RX configuration. */
849 struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
850 /**< Port vmdq RX configuration. */
851 } rx_adv_conf; /**< Port RX filtering configuration (union). */
853 struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
854 /**< Port vmdq+dcb TX configuration. */
855 struct rte_eth_dcb_tx_conf dcb_tx_conf;
856 /**< Port dcb TX configuration. */
857 struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
858 /**< Port vmdq TX configuration. */
859 } tx_adv_conf; /**< Port TX DCB configuration (union). */
860 /** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
861 is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
862 uint32_t dcb_capability_en;
863 struct rte_fdir_conf fdir_conf; /**< FDIR configuration. */
864 struct rte_intr_conf intr_conf; /**< Interrupt mode configuration. */
868 * A structure used to retrieve the contextual information of
869 * an Ethernet device, such as the controlling driver of the device,
870 * its PCI context, etc...
874 * RX offload capabilities of a device.
876 #define DEV_RX_OFFLOAD_VLAN_STRIP 0x00000001
877 #define DEV_RX_OFFLOAD_IPV4_CKSUM 0x00000002
878 #define DEV_RX_OFFLOAD_UDP_CKSUM 0x00000004
879 #define DEV_RX_OFFLOAD_TCP_CKSUM 0x00000008
880 #define DEV_RX_OFFLOAD_TCP_LRO 0x00000010
881 #define DEV_RX_OFFLOAD_QINQ_STRIP 0x00000020
882 #define DEV_RX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000040
883 #define DEV_RX_OFFLOAD_MACSEC_STRIP 0x00000080
886 * TX offload capabilities of a device.
888 #define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001
889 #define DEV_TX_OFFLOAD_IPV4_CKSUM 0x00000002
890 #define DEV_TX_OFFLOAD_UDP_CKSUM 0x00000004
891 #define DEV_TX_OFFLOAD_TCP_CKSUM 0x00000008
892 #define DEV_TX_OFFLOAD_SCTP_CKSUM 0x00000010
893 #define DEV_TX_OFFLOAD_TCP_TSO 0x00000020
894 #define DEV_TX_OFFLOAD_UDP_TSO 0x00000040
895 #define DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000080 /**< Used for tunneling packet. */
896 #define DEV_TX_OFFLOAD_QINQ_INSERT 0x00000100
897 #define DEV_TX_OFFLOAD_VXLAN_TNL_TSO 0x00000200 /**< Used for tunneling packet. */
898 #define DEV_TX_OFFLOAD_GRE_TNL_TSO 0x00000400 /**< Used for tunneling packet. */
899 #define DEV_TX_OFFLOAD_IPIP_TNL_TSO 0x00000800 /**< Used for tunneling packet. */
900 #define DEV_TX_OFFLOAD_GENEVE_TNL_TSO 0x00001000 /**< Used for tunneling packet. */
901 #define DEV_TX_OFFLOAD_MACSEC_INSERT 0x00002000
903 struct rte_pci_device;
906 * Ethernet device information
908 struct rte_eth_dev_info {
909 struct rte_pci_device *pci_dev; /**< Device PCI information. */
910 const char *driver_name; /**< Device Driver name. */
911 unsigned int if_index; /**< Index to bound host interface, or 0 if none.
912 Use if_indextoname() to translate into an interface name. */
913 uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
914 uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
915 uint16_t max_rx_queues; /**< Maximum number of RX queues. */
916 uint16_t max_tx_queues; /**< Maximum number of TX queues. */
917 uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
918 uint32_t max_hash_mac_addrs;
919 /** Maximum number of hash MAC addresses for MTA and UTA. */
920 uint16_t max_vfs; /**< Maximum number of VFs. */
921 uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
922 uint32_t rx_offload_capa; /**< Device RX offload capabilities. */
923 uint32_t tx_offload_capa; /**< Device TX offload capabilities. */
925 /**< Device redirection table size, the total number of entries. */
926 uint8_t hash_key_size; /**< Hash key size in bytes */
927 /** Bit mask of RSS offloads, the bit offset also means flow type */
928 uint64_t flow_type_rss_offloads;
929 struct rte_eth_rxconf default_rxconf; /**< Default RX configuration */
930 struct rte_eth_txconf default_txconf; /**< Default TX configuration */
931 uint16_t vmdq_queue_base; /**< First queue ID for VMDQ pools. */
932 uint16_t vmdq_queue_num; /**< Queue number for VMDQ pools. */
933 uint16_t vmdq_pool_base; /**< First ID of VMDQ pools. */
934 struct rte_eth_desc_lim rx_desc_lim; /**< RX descriptors limits */
935 struct rte_eth_desc_lim tx_desc_lim; /**< TX descriptors limits */
936 uint32_t speed_capa; /**< Supported speeds bitmap (ETH_LINK_SPEED_). */
937 /** Configured number of rx/tx queues */
938 uint16_t nb_rx_queues; /**< Number of RX queues. */
939 uint16_t nb_tx_queues; /**< Number of TX queues. */
943 * Ethernet device RX queue information structure.
944 * Used to retieve information about configured queue.
946 struct rte_eth_rxq_info {
947 struct rte_mempool *mp; /**< mempool used by that queue. */
948 struct rte_eth_rxconf conf; /**< queue config parameters. */
949 uint8_t scattered_rx; /**< scattered packets RX supported. */
950 uint16_t nb_desc; /**< configured number of RXDs. */
951 } __rte_cache_min_aligned;
954 * Ethernet device TX queue information structure.
955 * Used to retieve information about configured queue.
957 struct rte_eth_txq_info {
958 struct rte_eth_txconf conf; /**< queue config parameters. */
959 uint16_t nb_desc; /**< configured number of TXDs. */
960 } __rte_cache_min_aligned;
962 /** Maximum name length for extended statistics counters */
963 #define RTE_ETH_XSTATS_NAME_SIZE 64
966 * An Ethernet device extended statistic structure
968 * This structure is used by rte_eth_xstats_get() to provide
969 * statistics that are not provided in the generic *rte_eth_stats*
971 * It maps a name id, corresponding to an index in the array returned
972 * by rte_eth_xstats_get_names(), to a statistic value.
974 struct rte_eth_xstat {
975 uint64_t id; /**< The index in xstats name array. */
976 uint64_t value; /**< The statistic counter value. */
980 * A name element for extended statistics.
982 * An array of this structure is returned by rte_eth_xstats_get_names().
983 * It lists the names of extended statistics for a PMD. The *rte_eth_xstat*
984 * structure references these names by their array index.
986 struct rte_eth_xstat_name {
987 char name[RTE_ETH_XSTATS_NAME_SIZE]; /**< The statistic name. */
990 #define ETH_DCB_NUM_TCS 8
991 #define ETH_MAX_VMDQ_POOL 64
994 * A structure used to get the information of queue and
995 * TC mapping on both TX and RX paths.
997 struct rte_eth_dcb_tc_queue_mapping {
998 /** rx queues assigned to tc per Pool */
1002 } tc_rxq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
1003 /** rx queues assigned to tc per Pool */
1007 } tc_txq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
1011 * A structure used to get the information of DCB.
1012 * It includes TC UP mapping and queue TC mapping.
1014 struct rte_eth_dcb_info {
1015 uint8_t nb_tcs; /**< number of TCs */
1016 uint8_t prio_tc[ETH_DCB_NUM_USER_PRIORITIES]; /**< Priority to tc */
1017 uint8_t tc_bws[ETH_DCB_NUM_TCS]; /**< TX BW percentage for each TC */
1018 /** rx queues assigned to tc */
1019 struct rte_eth_dcb_tc_queue_mapping tc_queue;
1023 * RX/TX queue states
1025 #define RTE_ETH_QUEUE_STATE_STOPPED 0
1026 #define RTE_ETH_QUEUE_STATE_STARTED 1
1030 struct rte_eth_dev_callback;
1031 /** @internal Structure to keep track of registered callbacks */
1032 TAILQ_HEAD(rte_eth_dev_cb_list, rte_eth_dev_callback);
1035 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
1036 #define RTE_PMD_DEBUG_TRACE(...) \
1037 rte_pmd_debug_trace(__func__, __VA_ARGS__)
1039 #define RTE_PMD_DEBUG_TRACE(...)
1043 /* Macros to check for valid port */
1044 #define RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, retval) do { \
1045 if (!rte_eth_dev_is_valid_port(port_id)) { \
1046 RTE_PMD_DEBUG_TRACE("Invalid port_id=%d\n", port_id); \
1051 #define RTE_ETH_VALID_PORTID_OR_RET(port_id) do { \
1052 if (!rte_eth_dev_is_valid_port(port_id)) { \
1053 RTE_PMD_DEBUG_TRACE("Invalid port_id=%d\n", port_id); \
1059 * l2 tunnel configuration.
1062 /**< l2 tunnel enable mask */
1063 #define ETH_L2_TUNNEL_ENABLE_MASK 0x00000001
1064 /**< l2 tunnel insertion mask */
1065 #define ETH_L2_TUNNEL_INSERTION_MASK 0x00000002
1066 /**< l2 tunnel stripping mask */
1067 #define ETH_L2_TUNNEL_STRIPPING_MASK 0x00000004
1068 /**< l2 tunnel forwarding mask */
1069 #define ETH_L2_TUNNEL_FORWARDING_MASK 0x00000008
1072 * Definitions of all functions exported by an Ethernet driver through the
1073 * the generic structure of type *eth_dev_ops* supplied in the *rte_eth_dev*
1074 * structure associated with an Ethernet device.
1077 typedef int (*eth_dev_configure_t)(struct rte_eth_dev *dev);
1078 /**< @internal Ethernet device configuration. */
1080 typedef int (*eth_dev_start_t)(struct rte_eth_dev *dev);
1081 /**< @internal Function used to start a configured Ethernet device. */
1083 typedef void (*eth_dev_stop_t)(struct rte_eth_dev *dev);
1084 /**< @internal Function used to stop a configured Ethernet device. */
1086 typedef int (*eth_dev_set_link_up_t)(struct rte_eth_dev *dev);
1087 /**< @internal Function used to link up a configured Ethernet device. */
1089 typedef int (*eth_dev_set_link_down_t)(struct rte_eth_dev *dev);
1090 /**< @internal Function used to link down a configured Ethernet device. */
1092 typedef void (*eth_dev_close_t)(struct rte_eth_dev *dev);
1093 /**< @internal Function used to close a configured Ethernet device. */
1095 typedef void (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev);
1096 /**< @internal Function used to enable the RX promiscuous mode of an Ethernet device. */
1098 typedef void (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev);
1099 /**< @internal Function used to disable the RX promiscuous mode of an Ethernet device. */
1101 typedef void (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
1102 /**< @internal Enable the receipt of all multicast packets by an Ethernet device. */
1104 typedef void (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
1105 /**< @internal Disable the receipt of all multicast packets by an Ethernet device. */
1107 typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
1108 int wait_to_complete);
1109 /**< @internal Get link speed, duplex mode and state (up/down) of an Ethernet device. */
1111 typedef void (*eth_stats_get_t)(struct rte_eth_dev *dev,
1112 struct rte_eth_stats *igb_stats);
1113 /**< @internal Get global I/O statistics of an Ethernet device. */
1115 typedef void (*eth_stats_reset_t)(struct rte_eth_dev *dev);
1116 /**< @internal Reset global I/O statistics of an Ethernet device to 0. */
1118 typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev,
1119 struct rte_eth_xstat *stats, unsigned n);
1120 /**< @internal Get extended stats of an Ethernet device. */
1122 typedef void (*eth_xstats_reset_t)(struct rte_eth_dev *dev);
1123 /**< @internal Reset extended stats of an Ethernet device. */
1125 typedef int (*eth_xstats_get_names_t)(struct rte_eth_dev *dev,
1126 struct rte_eth_xstat_name *xstats_names, unsigned size);
1127 /**< @internal Get names of extended stats of an Ethernet device. */
1129 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
1133 /**< @internal Set a queue statistics mapping for a tx/rx queue of an Ethernet device. */
1135 typedef void (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
1136 struct rte_eth_dev_info *dev_info);
1137 /**< @internal Get specific informations of an Ethernet device. */
1139 typedef const uint32_t *(*eth_dev_supported_ptypes_get_t)(struct rte_eth_dev *dev);
1140 /**< @internal Get supported ptypes of an Ethernet device. */
1142 typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
1144 /**< @internal Start rx and tx of a queue of an Ethernet device. */
1146 typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
1148 /**< @internal Stop rx and tx of a queue of an Ethernet device. */
1150 typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
1151 uint16_t rx_queue_id,
1152 uint16_t nb_rx_desc,
1153 unsigned int socket_id,
1154 const struct rte_eth_rxconf *rx_conf,
1155 struct rte_mempool *mb_pool);
1156 /**< @internal Set up a receive queue of an Ethernet device. */
1158 typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
1159 uint16_t tx_queue_id,
1160 uint16_t nb_tx_desc,
1161 unsigned int socket_id,
1162 const struct rte_eth_txconf *tx_conf);
1163 /**< @internal Setup a transmit queue of an Ethernet device. */
1165 typedef int (*eth_rx_enable_intr_t)(struct rte_eth_dev *dev,
1166 uint16_t rx_queue_id);
1167 /**< @internal Enable interrupt of a receive queue of an Ethernet device. */
1169 typedef int (*eth_rx_disable_intr_t)(struct rte_eth_dev *dev,
1170 uint16_t rx_queue_id);
1171 /**< @internal Disable interrupt of a receive queue of an Ethernet device. */
1173 typedef void (*eth_queue_release_t)(void *queue);
1174 /**< @internal Release memory resources allocated by given RX/TX queue. */
1176 typedef uint32_t (*eth_rx_queue_count_t)(struct rte_eth_dev *dev,
1177 uint16_t rx_queue_id);
1178 /**< @internal Get number of used descriptors on a receive queue. */
1180 typedef int (*eth_rx_descriptor_done_t)(void *rxq, uint16_t offset);
1181 /**< @internal Check DD bit of specific RX descriptor */
1183 typedef int (*eth_rx_descriptor_status_t)(void *rxq, uint16_t offset);
1184 /**< @internal Check the status of a Rx descriptor */
1186 typedef int (*eth_tx_descriptor_status_t)(void *txq, uint16_t offset);
1187 /**< @internal Check the status of a Tx descriptor */
1189 typedef int (*eth_fw_version_get_t)(struct rte_eth_dev *dev,
1190 char *fw_version, size_t fw_size);
1191 /**< @internal Get firmware information of an Ethernet device. */
1193 typedef int (*eth_tx_done_cleanup_t)(void *txq, uint32_t free_cnt);
1194 /**< @internal Force mbufs to be from TX ring. */
1196 typedef void (*eth_rxq_info_get_t)(struct rte_eth_dev *dev,
1197 uint16_t rx_queue_id, struct rte_eth_rxq_info *qinfo);
1199 typedef void (*eth_txq_info_get_t)(struct rte_eth_dev *dev,
1200 uint16_t tx_queue_id, struct rte_eth_txq_info *qinfo);
1202 typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);
1203 /**< @internal Set MTU. */
1205 typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
1208 /**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */
1210 typedef int (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
1211 enum rte_vlan_type type, uint16_t tpid);
1212 /**< @internal set the outer/inner VLAN-TPID by an Ethernet device. */
1214 typedef void (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
1215 /**< @internal set VLAN offload function by an Ethernet device. */
1217 typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
1220 /**< @internal set port based TX VLAN insertion by an Ethernet device. */
1222 typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
1223 uint16_t rx_queue_id,
1225 /**< @internal VLAN stripping enable/disable by an queue of Ethernet device. */
1227 typedef uint16_t (*eth_rx_burst_t)(void *rxq,
1228 struct rte_mbuf **rx_pkts,
1230 /**< @internal Retrieve input packets from a receive queue of an Ethernet device. */
1232 typedef uint16_t (*eth_tx_burst_t)(void *txq,
1233 struct rte_mbuf **tx_pkts,
1235 /**< @internal Send output packets on a transmit queue of an Ethernet device. */
1237 typedef uint16_t (*eth_tx_prep_t)(void *txq,
1238 struct rte_mbuf **tx_pkts,
1240 /**< @internal Prepare output packets on a transmit queue of an Ethernet device. */
1242 typedef int (*flow_ctrl_get_t)(struct rte_eth_dev *dev,
1243 struct rte_eth_fc_conf *fc_conf);
1244 /**< @internal Get current flow control parameter on an Ethernet device */
1246 typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
1247 struct rte_eth_fc_conf *fc_conf);
1248 /**< @internal Setup flow control parameter on an Ethernet device */
1250 typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
1251 struct rte_eth_pfc_conf *pfc_conf);
1252 /**< @internal Setup priority flow control parameter on an Ethernet device */
1254 typedef int (*reta_update_t)(struct rte_eth_dev *dev,
1255 struct rte_eth_rss_reta_entry64 *reta_conf,
1256 uint16_t reta_size);
1257 /**< @internal Update RSS redirection table on an Ethernet device */
1259 typedef int (*reta_query_t)(struct rte_eth_dev *dev,
1260 struct rte_eth_rss_reta_entry64 *reta_conf,
1261 uint16_t reta_size);
1262 /**< @internal Query RSS redirection table on an Ethernet device */
1264 typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
1265 struct rte_eth_rss_conf *rss_conf);
1266 /**< @internal Update RSS hash configuration of an Ethernet device */
1268 typedef int (*rss_hash_conf_get_t)(struct rte_eth_dev *dev,
1269 struct rte_eth_rss_conf *rss_conf);
1270 /**< @internal Get current RSS hash configuration of an Ethernet device */
1272 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
1273 /**< @internal Turn on SW controllable LED on an Ethernet device */
1275 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
1276 /**< @internal Turn off SW controllable LED on an Ethernet device */
1278 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
1279 /**< @internal Remove MAC address from receive address register */
1281 typedef void (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
1282 struct ether_addr *mac_addr,
1285 /**< @internal Set a MAC address into Receive Address Address Register */
1287 typedef void (*eth_mac_addr_set_t)(struct rte_eth_dev *dev,
1288 struct ether_addr *mac_addr);
1289 /**< @internal Set a MAC address into Receive Address Address Register */
1291 typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
1292 struct ether_addr *mac_addr,
1294 /**< @internal Set a Unicast Hash bitmap */
1296 typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
1298 /**< @internal Set all Unicast Hash bitmap */
1300 typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
1303 /**< @internal Set queue TX rate */
1305 typedef int (*eth_mirror_rule_set_t)(struct rte_eth_dev *dev,
1306 struct rte_eth_mirror_conf *mirror_conf,
1309 /**< @internal Add a traffic mirroring rule on an Ethernet device */
1311 typedef int (*eth_mirror_rule_reset_t)(struct rte_eth_dev *dev,
1313 /**< @internal Remove a traffic mirroring rule on an Ethernet device */
1315 typedef int (*eth_udp_tunnel_port_add_t)(struct rte_eth_dev *dev,
1316 struct rte_eth_udp_tunnel *tunnel_udp);
1317 /**< @internal Add tunneling UDP port */
1319 typedef int (*eth_udp_tunnel_port_del_t)(struct rte_eth_dev *dev,
1320 struct rte_eth_udp_tunnel *tunnel_udp);
1321 /**< @internal Delete tunneling UDP port */
1323 typedef int (*eth_set_mc_addr_list_t)(struct rte_eth_dev *dev,
1324 struct ether_addr *mc_addr_set,
1325 uint32_t nb_mc_addr);
1326 /**< @internal set the list of multicast addresses on an Ethernet device */
1328 typedef int (*eth_timesync_enable_t)(struct rte_eth_dev *dev);
1329 /**< @internal Function used to enable IEEE1588/802.1AS timestamping. */
1331 typedef int (*eth_timesync_disable_t)(struct rte_eth_dev *dev);
1332 /**< @internal Function used to disable IEEE1588/802.1AS timestamping. */
1334 typedef int (*eth_timesync_read_rx_timestamp_t)(struct rte_eth_dev *dev,
1335 struct timespec *timestamp,
1337 /**< @internal Function used to read an RX IEEE1588/802.1AS timestamp. */
1339 typedef int (*eth_timesync_read_tx_timestamp_t)(struct rte_eth_dev *dev,
1340 struct timespec *timestamp);
1341 /**< @internal Function used to read a TX IEEE1588/802.1AS timestamp. */
1343 typedef int (*eth_timesync_adjust_time)(struct rte_eth_dev *dev, int64_t);
1344 /**< @internal Function used to adjust the device clock */
1346 typedef int (*eth_timesync_read_time)(struct rte_eth_dev *dev,
1347 struct timespec *timestamp);
1348 /**< @internal Function used to get time from the device clock. */
1350 typedef int (*eth_timesync_write_time)(struct rte_eth_dev *dev,
1351 const struct timespec *timestamp);
1352 /**< @internal Function used to get time from the device clock */
1354 typedef int (*eth_get_reg_t)(struct rte_eth_dev *dev,
1355 struct rte_dev_reg_info *info);
1356 /**< @internal Retrieve registers */
1358 typedef int (*eth_get_eeprom_length_t)(struct rte_eth_dev *dev);
1359 /**< @internal Retrieve eeprom size */
1361 typedef int (*eth_get_eeprom_t)(struct rte_eth_dev *dev,
1362 struct rte_dev_eeprom_info *info);
1363 /**< @internal Retrieve eeprom data */
1365 typedef int (*eth_set_eeprom_t)(struct rte_eth_dev *dev,
1366 struct rte_dev_eeprom_info *info);
1367 /**< @internal Program eeprom data */
1369 typedef int (*eth_l2_tunnel_eth_type_conf_t)
1370 (struct rte_eth_dev *dev, struct rte_eth_l2_tunnel_conf *l2_tunnel);
1371 /**< @internal config l2 tunnel ether type */
1373 typedef int (*eth_l2_tunnel_offload_set_t)
1374 (struct rte_eth_dev *dev,
1375 struct rte_eth_l2_tunnel_conf *l2_tunnel,
1378 /**< @internal enable/disable the l2 tunnel offload functions */
1380 #ifdef RTE_NIC_BYPASS
1383 RTE_BYPASS_MODE_NONE,
1384 RTE_BYPASS_MODE_NORMAL,
1385 RTE_BYPASS_MODE_BYPASS,
1386 RTE_BYPASS_MODE_ISOLATE,
1387 RTE_BYPASS_MODE_NUM,
1390 #define RTE_BYPASS_MODE_VALID(x) \
1391 ((x) > RTE_BYPASS_MODE_NONE && (x) < RTE_BYPASS_MODE_NUM)
1394 RTE_BYPASS_EVENT_NONE,
1395 RTE_BYPASS_EVENT_START,
1396 RTE_BYPASS_EVENT_OS_ON = RTE_BYPASS_EVENT_START,
1397 RTE_BYPASS_EVENT_POWER_ON,
1398 RTE_BYPASS_EVENT_OS_OFF,
1399 RTE_BYPASS_EVENT_POWER_OFF,
1400 RTE_BYPASS_EVENT_TIMEOUT,
1401 RTE_BYPASS_EVENT_NUM
1404 #define RTE_BYPASS_EVENT_VALID(x) \
1405 ((x) > RTE_BYPASS_EVENT_NONE && (x) < RTE_BYPASS_MODE_NUM)
1408 RTE_BYPASS_TMT_OFF, /* timeout disabled. */
1409 RTE_BYPASS_TMT_1_5_SEC, /* timeout for 1.5 seconds */
1410 RTE_BYPASS_TMT_2_SEC, /* timeout for 2 seconds */
1411 RTE_BYPASS_TMT_3_SEC, /* timeout for 3 seconds */
1412 RTE_BYPASS_TMT_4_SEC, /* timeout for 4 seconds */
1413 RTE_BYPASS_TMT_8_SEC, /* timeout for 8 seconds */
1414 RTE_BYPASS_TMT_16_SEC, /* timeout for 16 seconds */
1415 RTE_BYPASS_TMT_32_SEC, /* timeout for 32 seconds */
1419 #define RTE_BYPASS_TMT_VALID(x) \
1420 ((x) == RTE_BYPASS_TMT_OFF || \
1421 ((x) > RTE_BYPASS_TMT_OFF && (x) < RTE_BYPASS_TMT_NUM))
1423 typedef void (*bypass_init_t)(struct rte_eth_dev *dev);
1424 typedef int32_t (*bypass_state_set_t)(struct rte_eth_dev *dev, uint32_t *new_state);
1425 typedef int32_t (*bypass_state_show_t)(struct rte_eth_dev *dev, uint32_t *state);
1426 typedef int32_t (*bypass_event_set_t)(struct rte_eth_dev *dev, uint32_t state, uint32_t event);
1427 typedef int32_t (*bypass_event_show_t)(struct rte_eth_dev *dev, uint32_t event_shift, uint32_t *event);
1428 typedef int32_t (*bypass_wd_timeout_set_t)(struct rte_eth_dev *dev, uint32_t timeout);
1429 typedef int32_t (*bypass_wd_timeout_show_t)(struct rte_eth_dev *dev, uint32_t *wd_timeout);
1430 typedef int32_t (*bypass_ver_show_t)(struct rte_eth_dev *dev, uint32_t *ver);
1431 typedef int32_t (*bypass_wd_reset_t)(struct rte_eth_dev *dev);
1434 typedef int (*eth_filter_ctrl_t)(struct rte_eth_dev *dev,
1435 enum rte_filter_type filter_type,
1436 enum rte_filter_op filter_op,
1438 /**< @internal Take operations to assigned filter type on an Ethernet device */
1440 typedef int (*eth_get_dcb_info)(struct rte_eth_dev *dev,
1441 struct rte_eth_dcb_info *dcb_info);
1442 /**< @internal Get dcb information on an Ethernet device */
1445 * @internal A structure containing the functions exported by an Ethernet driver.
1447 struct eth_dev_ops {
1448 eth_dev_configure_t dev_configure; /**< Configure device. */
1449 eth_dev_start_t dev_start; /**< Start device. */
1450 eth_dev_stop_t dev_stop; /**< Stop device. */
1451 eth_dev_set_link_up_t dev_set_link_up; /**< Device link up. */
1452 eth_dev_set_link_down_t dev_set_link_down; /**< Device link down. */
1453 eth_dev_close_t dev_close; /**< Close device. */
1454 eth_link_update_t link_update; /**< Get device link state. */
1456 eth_promiscuous_enable_t promiscuous_enable; /**< Promiscuous ON. */
1457 eth_promiscuous_disable_t promiscuous_disable;/**< Promiscuous OFF. */
1458 eth_allmulticast_enable_t allmulticast_enable;/**< RX multicast ON. */
1459 eth_allmulticast_disable_t allmulticast_disable;/**< RX multicast OF. */
1460 eth_mac_addr_remove_t mac_addr_remove; /**< Remove MAC address. */
1461 eth_mac_addr_add_t mac_addr_add; /**< Add a MAC address. */
1462 eth_mac_addr_set_t mac_addr_set; /**< Set a MAC address. */
1463 eth_set_mc_addr_list_t set_mc_addr_list; /**< set list of mcast addrs. */
1464 mtu_set_t mtu_set; /**< Set MTU. */
1466 eth_stats_get_t stats_get; /**< Get generic device statistics. */
1467 eth_stats_reset_t stats_reset; /**< Reset generic device statistics. */
1468 eth_xstats_get_t xstats_get; /**< Get extended device statistics. */
1469 eth_xstats_reset_t xstats_reset; /**< Reset extended device statistics. */
1470 eth_xstats_get_names_t xstats_get_names;
1471 /**< Get names of extended statistics. */
1472 eth_queue_stats_mapping_set_t queue_stats_mapping_set;
1473 /**< Configure per queue stat counter mapping. */
1475 eth_dev_infos_get_t dev_infos_get; /**< Get device info. */
1476 eth_rxq_info_get_t rxq_info_get; /**< retrieve RX queue information. */
1477 eth_txq_info_get_t txq_info_get; /**< retrieve TX queue information. */
1478 eth_fw_version_get_t fw_version_get; /**< Get firmware version. */
1479 eth_dev_supported_ptypes_get_t dev_supported_ptypes_get;
1480 /**< Get packet types supported and identified by device. */
1482 vlan_filter_set_t vlan_filter_set; /**< Filter VLAN Setup. */
1483 vlan_tpid_set_t vlan_tpid_set; /**< Outer/Inner VLAN TPID Setup. */
1484 vlan_strip_queue_set_t vlan_strip_queue_set; /**< VLAN Stripping on queue. */
1485 vlan_offload_set_t vlan_offload_set; /**< Set VLAN Offload. */
1486 vlan_pvid_set_t vlan_pvid_set; /**< Set port based TX VLAN insertion. */
1488 eth_queue_start_t rx_queue_start;/**< Start RX for a queue. */
1489 eth_queue_stop_t rx_queue_stop; /**< Stop RX for a queue. */
1490 eth_queue_start_t tx_queue_start;/**< Start TX for a queue. */
1491 eth_queue_stop_t tx_queue_stop; /**< Stop TX for a queue. */
1492 eth_rx_queue_setup_t rx_queue_setup;/**< Set up device RX queue. */
1493 eth_queue_release_t rx_queue_release; /**< Release RX queue. */
1494 eth_rx_queue_count_t rx_queue_count;
1495 /**< Get the number of used RX descriptors. */
1496 eth_rx_descriptor_done_t rx_descriptor_done; /**< Check rxd DD bit. */
1497 eth_rx_descriptor_status_t rx_descriptor_status;
1498 /**< Check the status of a Rx descriptor. */
1499 eth_tx_descriptor_status_t tx_descriptor_status;
1500 /**< Check the status of a Tx descriptor. */
1501 eth_rx_enable_intr_t rx_queue_intr_enable; /**< Enable Rx queue interrupt. */
1502 eth_rx_disable_intr_t rx_queue_intr_disable; /**< Disable Rx queue interrupt. */
1503 eth_tx_queue_setup_t tx_queue_setup;/**< Set up device TX queue. */
1504 eth_queue_release_t tx_queue_release; /**< Release TX queue. */
1505 eth_tx_done_cleanup_t tx_done_cleanup;/**< Free tx ring mbufs */
1507 eth_dev_led_on_t dev_led_on; /**< Turn on LED. */
1508 eth_dev_led_off_t dev_led_off; /**< Turn off LED. */
1510 flow_ctrl_get_t flow_ctrl_get; /**< Get flow control. */
1511 flow_ctrl_set_t flow_ctrl_set; /**< Setup flow control. */
1512 priority_flow_ctrl_set_t priority_flow_ctrl_set; /**< Setup priority flow control. */
1514 eth_uc_hash_table_set_t uc_hash_table_set; /**< Set Unicast Table Array. */
1515 eth_uc_all_hash_table_set_t uc_all_hash_table_set; /**< Set Unicast hash bitmap. */
1517 eth_mirror_rule_set_t mirror_rule_set; /**< Add a traffic mirror rule. */
1518 eth_mirror_rule_reset_t mirror_rule_reset; /**< reset a traffic mirror rule. */
1520 eth_udp_tunnel_port_add_t udp_tunnel_port_add; /** Add UDP tunnel port. */
1521 eth_udp_tunnel_port_del_t udp_tunnel_port_del; /** Del UDP tunnel port. */
1522 eth_l2_tunnel_eth_type_conf_t l2_tunnel_eth_type_conf;
1523 /** Config ether type of l2 tunnel. */
1524 eth_l2_tunnel_offload_set_t l2_tunnel_offload_set;
1525 /** Enable/disable l2 tunnel offload functions. */
1527 eth_set_queue_rate_limit_t set_queue_rate_limit; /**< Set queue rate limit. */
1529 rss_hash_update_t rss_hash_update; /** Configure RSS hash protocols. */
1530 rss_hash_conf_get_t rss_hash_conf_get; /** Get current RSS hash configuration. */
1531 reta_update_t reta_update; /** Update redirection table. */
1532 reta_query_t reta_query; /** Query redirection table. */
1534 eth_get_reg_t get_reg; /**< Get registers. */
1535 eth_get_eeprom_length_t get_eeprom_length; /**< Get eeprom length. */
1536 eth_get_eeprom_t get_eeprom; /**< Get eeprom data. */
1537 eth_set_eeprom_t set_eeprom; /**< Set eeprom. */
1539 /* bypass control */
1540 #ifdef RTE_NIC_BYPASS
1541 bypass_init_t bypass_init;
1542 bypass_state_set_t bypass_state_set;
1543 bypass_state_show_t bypass_state_show;
1544 bypass_event_set_t bypass_event_set;
1545 bypass_event_show_t bypass_event_show;
1546 bypass_wd_timeout_set_t bypass_wd_timeout_set;
1547 bypass_wd_timeout_show_t bypass_wd_timeout_show;
1548 bypass_ver_show_t bypass_ver_show;
1549 bypass_wd_reset_t bypass_wd_reset;
1552 eth_filter_ctrl_t filter_ctrl; /**< common filter control. */
1554 eth_get_dcb_info get_dcb_info; /** Get DCB information. */
1556 eth_timesync_enable_t timesync_enable;
1557 /** Turn IEEE1588/802.1AS timestamping on. */
1558 eth_timesync_disable_t timesync_disable;
1559 /** Turn IEEE1588/802.1AS timestamping off. */
1560 eth_timesync_read_rx_timestamp_t timesync_read_rx_timestamp;
1561 /** Read the IEEE1588/802.1AS RX timestamp. */
1562 eth_timesync_read_tx_timestamp_t timesync_read_tx_timestamp;
1563 /** Read the IEEE1588/802.1AS TX timestamp. */
1564 eth_timesync_adjust_time timesync_adjust_time; /** Adjust the device clock. */
1565 eth_timesync_read_time timesync_read_time; /** Get the device clock time. */
1566 eth_timesync_write_time timesync_write_time; /** Set the device clock time. */
1570 * Function type used for RX packet processing packet callbacks.
1572 * The callback function is called on RX with a burst of packets that have
1573 * been received on the given port and queue.
1576 * The Ethernet port on which RX is being performed.
1578 * The queue on the Ethernet port which is being used to receive the packets.
1580 * The burst of packets that have just been received.
1582 * The number of packets in the burst pointed to by "pkts".
1584 * The max number of packets that can be stored in the "pkts" array.
1586 * The arbitrary user parameter passed in by the application when the callback
1587 * was originally configured.
1589 * The number of packets returned to the user.
1591 typedef uint16_t (*rte_rx_callback_fn)(uint8_t port, uint16_t queue,
1592 struct rte_mbuf *pkts[], uint16_t nb_pkts, uint16_t max_pkts,
1596 * Function type used for TX packet processing packet callbacks.
1598 * The callback function is called on TX with a burst of packets immediately
1599 * before the packets are put onto the hardware queue for transmission.
1602 * The Ethernet port on which TX is being performed.
1604 * The queue on the Ethernet port which is being used to transmit the packets.
1606 * The burst of packets that are about to be transmitted.
1608 * The number of packets in the burst pointed to by "pkts".
1610 * The arbitrary user parameter passed in by the application when the callback
1611 * was originally configured.
1613 * The number of packets to be written to the NIC.
1615 typedef uint16_t (*rte_tx_callback_fn)(uint8_t port, uint16_t queue,
1616 struct rte_mbuf *pkts[], uint16_t nb_pkts, void *user_param);
1620 * Structure used to hold information about the callbacks to be called for a
1621 * queue on RX and TX.
1623 struct rte_eth_rxtx_callback {
1624 struct rte_eth_rxtx_callback *next;
1626 rte_rx_callback_fn rx;
1627 rte_tx_callback_fn tx;
1633 * A set of values to describe the possible states of an eth device.
1635 enum rte_eth_dev_state {
1636 RTE_ETH_DEV_UNUSED = 0,
1637 RTE_ETH_DEV_ATTACHED,
1642 * The generic data structure associated with each ethernet device.
1644 * Pointers to burst-oriented packet receive and transmit functions are
1645 * located at the beginning of the structure, along with the pointer to
1646 * where all the data elements for the particular device are stored in shared
1647 * memory. This split allows the function pointer and driver data to be per-
1648 * process, while the actual configuration data for the device is shared.
1650 struct rte_eth_dev {
1651 eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
1652 eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
1653 eth_tx_prep_t tx_pkt_prepare; /**< Pointer to PMD transmit prepare function. */
1654 struct rte_eth_dev_data *data; /**< Pointer to device data */
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; /**< 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 * Attach to the ethdev already initialized by the primary
1810 * @param name Ethernet device's name.
1812 * - Success: Slot in the rte_dev_devices array for attached
1814 * - Error: Null pointer.
1816 struct rte_eth_dev *rte_eth_dev_attach_secondary(const char *name);
1820 * Release the specified ethdev port.
1823 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure.
1825 * - 0 on success, negative on error
1827 int rte_eth_dev_release_port(struct rte_eth_dev *eth_dev);
1830 * Attach a new Ethernet device specified by aruguments.
1833 * A pointer to a strings array describing the new device
1834 * to be attached. The strings should be a pci address like
1835 * '0000:01:00.0' or virtual device name like 'net_pcap0'.
1837 * A pointer to a port identifier actually attached.
1839 * 0 on success and port_id is filled, negative on error
1841 int rte_eth_dev_attach(const char *devargs, uint8_t *port_id);
1844 * Detach a Ethernet device specified by port identifier.
1845 * This function must be called when the device is in the
1849 * The port identifier of the device to detach.
1851 * A pointer to a device name actually detached.
1853 * 0 on success and devname is filled, negative on error
1855 int rte_eth_dev_detach(uint8_t port_id, char *devname);
1858 * Convert a numerical speed in Mbps to a bitmap flag that can be used in
1859 * the bitmap link_speeds of the struct rte_eth_conf
1862 * Numerical speed value in Mbps
1864 * ETH_LINK_[HALF/FULL]_DUPLEX (only for 10/100M speeds)
1866 * 0 if the speed cannot be mapped
1868 uint32_t rte_eth_speed_bitflag(uint32_t speed, int duplex);
1871 * Configure an Ethernet device.
1872 * This function must be invoked first before any other function in the
1873 * Ethernet API. This function can also be re-invoked when a device is in the
1877 * The port identifier of the Ethernet device to configure.
1878 * @param nb_rx_queue
1879 * The number of receive queues to set up for the Ethernet device.
1880 * @param nb_tx_queue
1881 * The number of transmit queues to set up for the Ethernet device.
1883 * The pointer to the configuration data to be used for the Ethernet device.
1884 * The *rte_eth_conf* structure includes:
1885 * - the hardware offload features to activate, with dedicated fields for
1886 * each statically configurable offload hardware feature provided by
1887 * Ethernet devices, such as IP checksum or VLAN tag stripping for
1889 * - the Receive Side Scaling (RSS) configuration when using multiple RX
1892 * Embedding all configuration information in a single data structure
1893 * is the more flexible method that allows the addition of new features
1894 * without changing the syntax of the API.
1896 * - 0: Success, device configured.
1897 * - <0: Error code returned by the driver configuration function.
1899 int rte_eth_dev_configure(uint8_t port_id, uint16_t nb_rx_queue,
1900 uint16_t nb_tx_queue, const struct rte_eth_conf *eth_conf);
1904 * Release device queues and clear its configuration to force the user
1905 * application to reconfigure it. It is for internal use only.
1908 * Pointer to struct rte_eth_dev.
1913 void _rte_eth_dev_reset(struct rte_eth_dev *dev);
1916 * Allocate and set up a receive queue for an Ethernet device.
1918 * The function allocates a contiguous block of memory for *nb_rx_desc*
1919 * receive descriptors from a memory zone associated with *socket_id*
1920 * and initializes each receive descriptor with a network buffer allocated
1921 * from the memory pool *mb_pool*.
1924 * The port identifier of the Ethernet device.
1925 * @param rx_queue_id
1926 * The index of the receive queue to set up.
1927 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1928 * to rte_eth_dev_configure().
1930 * The number of receive descriptors to allocate for the receive ring.
1932 * The *socket_id* argument is the socket identifier in case of NUMA.
1933 * The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1934 * the DMA memory allocated for the receive descriptors of the ring.
1936 * The pointer to the configuration data to be used for the receive queue.
1937 * NULL value is allowed, in which case default RX configuration
1939 * The *rx_conf* structure contains an *rx_thresh* structure with the values
1940 * of the Prefetch, Host, and Write-Back threshold registers of the receive
1943 * The pointer to the memory pool from which to allocate *rte_mbuf* network
1944 * memory buffers to populate each descriptor of the receive ring.
1946 * - 0: Success, receive queue correctly set up.
1947 * - -EINVAL: The size of network buffers which can be allocated from the
1948 * memory pool does not fit the various buffer sizes allowed by the
1949 * device controller.
1950 * - -ENOMEM: Unable to allocate the receive ring descriptors or to
1951 * allocate network memory buffers from the memory pool when
1952 * initializing receive descriptors.
1954 int rte_eth_rx_queue_setup(uint8_t port_id, uint16_t rx_queue_id,
1955 uint16_t nb_rx_desc, unsigned int socket_id,
1956 const struct rte_eth_rxconf *rx_conf,
1957 struct rte_mempool *mb_pool);
1960 * Allocate and set up a transmit queue for an Ethernet device.
1963 * The port identifier of the Ethernet device.
1964 * @param tx_queue_id
1965 * The index of the transmit queue to set up.
1966 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1967 * to rte_eth_dev_configure().
1969 * The number of transmit descriptors to allocate for the transmit ring.
1971 * The *socket_id* argument is the socket identifier in case of NUMA.
1972 * Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1973 * the DMA memory allocated for the transmit descriptors of the ring.
1975 * The pointer to the configuration data to be used for the transmit queue.
1976 * NULL value is allowed, in which case default RX configuration
1978 * The *tx_conf* structure contains the following data:
1979 * - The *tx_thresh* structure with the values of the Prefetch, Host, and
1980 * Write-Back threshold registers of the transmit ring.
1981 * When setting Write-Back threshold to the value greater then zero,
1982 * *tx_rs_thresh* value should be explicitly set to one.
1983 * - The *tx_free_thresh* value indicates the [minimum] number of network
1984 * buffers that must be pending in the transmit ring to trigger their
1985 * [implicit] freeing by the driver transmit function.
1986 * - The *tx_rs_thresh* value indicates the [minimum] number of transmit
1987 * descriptors that must be pending in the transmit ring before setting the
1988 * RS bit on a descriptor by the driver transmit function.
1989 * The *tx_rs_thresh* value should be less or equal then
1990 * *tx_free_thresh* value, and both of them should be less then
1992 * - The *txq_flags* member contains flags to pass to the TX queue setup
1993 * function to configure the behavior of the TX queue. This should be set
1994 * to 0 if no special configuration is required.
1996 * Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces
1997 * the transmit function to use default values.
1999 * - 0: Success, the transmit queue is correctly set up.
2000 * - -ENOMEM: Unable to allocate the transmit ring descriptors.
2002 int rte_eth_tx_queue_setup(uint8_t port_id, uint16_t tx_queue_id,
2003 uint16_t nb_tx_desc, unsigned int socket_id,
2004 const struct rte_eth_txconf *tx_conf);
2007 * Return the NUMA socket to which an Ethernet device is connected
2010 * The port identifier of the Ethernet device
2012 * The NUMA socket id to which the Ethernet device is connected or
2013 * a default of zero if the socket could not be determined.
2014 * -1 is returned is the port_id value is out of range.
2016 int rte_eth_dev_socket_id(uint8_t port_id);
2019 * Check if port_id of device is attached
2022 * The port identifier of the Ethernet device
2024 * - 0 if port is out of range or not attached
2025 * - 1 if device is attached
2027 int rte_eth_dev_is_valid_port(uint8_t port_id);
2030 * Start specified RX queue of a port. It is used when rx_deferred_start
2031 * flag of the specified queue is true.
2034 * The port identifier of the Ethernet device
2035 * @param rx_queue_id
2036 * The index of the rx queue to update the ring.
2037 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2038 * to rte_eth_dev_configure().
2040 * - 0: Success, the receive queue is started.
2041 * - -EINVAL: The port_id or the queue_id out of range.
2042 * - -ENOTSUP: The function not supported in PMD driver.
2044 int rte_eth_dev_rx_queue_start(uint8_t port_id, uint16_t rx_queue_id);
2047 * Stop specified RX queue of a port
2050 * The port identifier of the Ethernet device
2051 * @param rx_queue_id
2052 * The index of the rx queue to update the ring.
2053 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2054 * to rte_eth_dev_configure().
2056 * - 0: Success, the receive queue is stopped.
2057 * - -EINVAL: The port_id or the queue_id out of range.
2058 * - -ENOTSUP: The function not supported in PMD driver.
2060 int rte_eth_dev_rx_queue_stop(uint8_t port_id, uint16_t rx_queue_id);
2063 * Start TX for specified queue of a port. It is used when tx_deferred_start
2064 * flag of the specified queue is true.
2067 * The port identifier of the Ethernet device
2068 * @param tx_queue_id
2069 * The index of the tx queue to update the ring.
2070 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2071 * to rte_eth_dev_configure().
2073 * - 0: Success, the transmit queue is started.
2074 * - -EINVAL: The port_id or the queue_id out of range.
2075 * - -ENOTSUP: The function not supported in PMD driver.
2077 int rte_eth_dev_tx_queue_start(uint8_t port_id, uint16_t tx_queue_id);
2080 * Stop specified TX queue of a port
2083 * The port identifier of the Ethernet device
2084 * @param tx_queue_id
2085 * The index of the tx queue to update the ring.
2086 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2087 * to rte_eth_dev_configure().
2089 * - 0: Success, the transmit queue is stopped.
2090 * - -EINVAL: The port_id or the queue_id out of range.
2091 * - -ENOTSUP: The function not supported in PMD driver.
2093 int rte_eth_dev_tx_queue_stop(uint8_t port_id, uint16_t tx_queue_id);
2098 * Start an Ethernet device.
2100 * The device start step is the last one and consists of setting the configured
2101 * offload features and in starting the transmit and the receive units of the
2103 * On success, all basic functions exported by the Ethernet API (link status,
2104 * receive/transmit, and so on) can be invoked.
2107 * The port identifier of the Ethernet device.
2109 * - 0: Success, Ethernet device started.
2110 * - <0: Error code of the driver device start function.
2112 int rte_eth_dev_start(uint8_t port_id);
2115 * Stop an Ethernet device. The device can be restarted with a call to
2116 * rte_eth_dev_start()
2119 * The port identifier of the Ethernet device.
2121 void rte_eth_dev_stop(uint8_t port_id);
2125 * Link up an Ethernet device.
2127 * Set device link up will re-enable the device rx/tx
2128 * functionality after it is previously set device linked down.
2131 * The port identifier of the Ethernet device.
2133 * - 0: Success, Ethernet device linked up.
2134 * - <0: Error code of the driver device link up function.
2136 int rte_eth_dev_set_link_up(uint8_t port_id);
2139 * Link down an Ethernet device.
2140 * The device rx/tx functionality will be disabled if success,
2141 * and it can be re-enabled with a call to
2142 * rte_eth_dev_set_link_up()
2145 * The port identifier of the Ethernet device.
2147 int rte_eth_dev_set_link_down(uint8_t port_id);
2150 * Close a stopped Ethernet device. The device cannot be restarted!
2151 * The function frees all resources except for needed by the
2152 * closed state. To free these resources, call rte_eth_dev_detach().
2155 * The port identifier of the Ethernet device.
2157 void rte_eth_dev_close(uint8_t port_id);
2160 * Enable receipt in promiscuous mode for an Ethernet device.
2163 * The port identifier of the Ethernet device.
2165 void rte_eth_promiscuous_enable(uint8_t port_id);
2168 * Disable receipt in promiscuous mode for an Ethernet device.
2171 * The port identifier of the Ethernet device.
2173 void rte_eth_promiscuous_disable(uint8_t port_id);
2176 * Return the value of promiscuous mode for an Ethernet device.
2179 * The port identifier of the Ethernet device.
2181 * - (1) if promiscuous is enabled
2182 * - (0) if promiscuous is disabled.
2185 int rte_eth_promiscuous_get(uint8_t port_id);
2188 * Enable the receipt of any multicast frame by an Ethernet device.
2191 * The port identifier of the Ethernet device.
2193 void rte_eth_allmulticast_enable(uint8_t port_id);
2196 * Disable the receipt of all multicast frames by an Ethernet device.
2199 * The port identifier of the Ethernet device.
2201 void rte_eth_allmulticast_disable(uint8_t port_id);
2204 * Return the value of allmulticast mode for an Ethernet device.
2207 * The port identifier of the Ethernet device.
2209 * - (1) if allmulticast is enabled
2210 * - (0) if allmulticast is disabled.
2213 int rte_eth_allmulticast_get(uint8_t port_id);
2216 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2217 * or FULL-DUPLEX) of the physical link of an Ethernet device. It might need
2218 * to wait up to 9 seconds in it.
2221 * The port identifier of the Ethernet device.
2223 * A pointer to an *rte_eth_link* structure to be filled with
2224 * the status, the speed and the mode of the Ethernet device link.
2226 void rte_eth_link_get(uint8_t port_id, struct rte_eth_link *link);
2229 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2230 * or FULL-DUPLEX) of the physical link of an Ethernet device. It is a no-wait
2231 * version of rte_eth_link_get().
2234 * The port identifier of the Ethernet device.
2236 * A pointer to an *rte_eth_link* structure to be filled with
2237 * the status, the speed and the mode of the Ethernet device link.
2239 void rte_eth_link_get_nowait(uint8_t port_id, struct rte_eth_link *link);
2242 * Retrieve the general I/O statistics of an Ethernet device.
2245 * The port identifier of the Ethernet device.
2247 * A pointer to a structure of type *rte_eth_stats* to be filled with
2248 * the values of device counters for the following set of statistics:
2249 * - *ipackets* with the total of successfully received packets.
2250 * - *opackets* with the total of successfully transmitted packets.
2251 * - *ibytes* with the total of successfully received bytes.
2252 * - *obytes* with the total of successfully transmitted bytes.
2253 * - *ierrors* with the total of erroneous received packets.
2254 * - *oerrors* with the total of failed transmitted packets.
2256 * Zero if successful. Non-zero otherwise.
2258 int rte_eth_stats_get(uint8_t port_id, struct rte_eth_stats *stats);
2261 * Reset the general I/O statistics of an Ethernet device.
2264 * The port identifier of the Ethernet device.
2266 void rte_eth_stats_reset(uint8_t port_id);
2269 * Retrieve names of extended statistics of an Ethernet device.
2272 * The port identifier of the Ethernet device.
2273 * @param xstats_names
2274 * An rte_eth_xstat_name array of at least *size* elements to
2275 * be filled. If set to NULL, the function returns the required number
2278 * The size of the xstats_names array (number of elements).
2280 * - A positive value lower or equal to size: success. The return value
2281 * is the number of entries filled in the stats table.
2282 * - A positive value higher than size: error, the given statistics table
2283 * is too small. The return value corresponds to the size that should
2284 * be given to succeed. The entries in the table are not valid and
2285 * shall not be used by the caller.
2286 * - A negative value on error (invalid port id).
2288 int rte_eth_xstats_get_names(uint8_t port_id,
2289 struct rte_eth_xstat_name *xstats_names,
2293 * Retrieve extended statistics of an Ethernet device.
2296 * The port identifier of the Ethernet device.
2298 * A pointer to a table of structure of type *rte_eth_xstat*
2299 * to be filled with device statistics ids and values: id is the
2300 * index of the name string in xstats_names (see rte_eth_xstats_get_names()),
2301 * and value is the statistic counter.
2302 * This parameter can be set to NULL if n is 0.
2304 * The size of the xstats array (number of elements).
2306 * - A positive value lower or equal to n: success. The return value
2307 * is the number of entries filled in the stats table.
2308 * - A positive value higher than n: error, the given statistics table
2309 * is too small. The return value corresponds to the size that should
2310 * be given to succeed. The entries in the table are not valid and
2311 * shall not be used by the caller.
2312 * - A negative value on error (invalid port id).
2314 int rte_eth_xstats_get(uint8_t port_id, struct rte_eth_xstat *xstats,
2318 * Reset extended statistics of an Ethernet device.
2321 * The port identifier of the Ethernet device.
2323 void rte_eth_xstats_reset(uint8_t port_id);
2326 * Set a mapping for the specified transmit queue to the specified per-queue
2327 * statistics counter.
2330 * The port identifier of the Ethernet device.
2331 * @param tx_queue_id
2332 * The index of the transmit queue for which a queue stats mapping is required.
2333 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2334 * to rte_eth_dev_configure().
2336 * The per-queue packet statistics functionality number that the transmit
2337 * queue is to be assigned.
2338 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2340 * Zero if successful. Non-zero otherwise.
2342 int rte_eth_dev_set_tx_queue_stats_mapping(uint8_t port_id,
2343 uint16_t tx_queue_id, uint8_t stat_idx);
2346 * Set a mapping for the specified receive queue to the specified per-queue
2347 * statistics counter.
2350 * The port identifier of the Ethernet device.
2351 * @param rx_queue_id
2352 * The index of the receive queue for which a queue stats mapping is required.
2353 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2354 * to rte_eth_dev_configure().
2356 * The per-queue packet statistics functionality number that the receive
2357 * queue is to be assigned.
2358 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2360 * Zero if successful. Non-zero otherwise.
2362 int rte_eth_dev_set_rx_queue_stats_mapping(uint8_t port_id,
2363 uint16_t rx_queue_id,
2367 * Retrieve the Ethernet address of an Ethernet device.
2370 * The port identifier of the Ethernet device.
2372 * A pointer to a structure of type *ether_addr* to be filled with
2373 * the Ethernet address of the Ethernet device.
2375 void rte_eth_macaddr_get(uint8_t port_id, struct ether_addr *mac_addr);
2378 * Retrieve the contextual information of an Ethernet device.
2381 * The port identifier of the Ethernet device.
2383 * A pointer to a structure of type *rte_eth_dev_info* to be filled with
2384 * the contextual information of the Ethernet device.
2386 void rte_eth_dev_info_get(uint8_t port_id, struct rte_eth_dev_info *dev_info);
2389 * Retrieve the firmware version of a device.
2392 * The port identifier of the device.
2394 * A pointer to a string array storing the firmware version of a device,
2395 * the string includes terminating null. This pointer is allocated by caller.
2397 * The size of the string array pointed by fw_version, which should be
2398 * large enough to store firmware version of the device.
2400 * - (0) if successful.
2401 * - (-ENOTSUP) if operation is not supported.
2402 * - (-ENODEV) if *port_id* invalid.
2403 * - (>0) if *fw_size* is not enough to store firmware version, return
2404 * the size of the non truncated string.
2406 int rte_eth_dev_fw_version_get(uint8_t port_id,
2407 char *fw_version, size_t fw_size);
2410 * Retrieve the supported packet types of an Ethernet device.
2412 * When a packet type is announced as supported, it *must* be recognized by
2413 * the PMD. For instance, if RTE_PTYPE_L2_ETHER, RTE_PTYPE_L2_ETHER_VLAN
2414 * and RTE_PTYPE_L3_IPV4 are announced, the PMD must return the following
2415 * packet types for these packets:
2416 * - Ether/IPv4 -> RTE_PTYPE_L2_ETHER | RTE_PTYPE_L3_IPV4
2417 * - Ether/Vlan/IPv4 -> RTE_PTYPE_L2_ETHER_VLAN | RTE_PTYPE_L3_IPV4
2418 * - Ether/[anything else] -> RTE_PTYPE_L2_ETHER
2419 * - Ether/Vlan/[anything else] -> RTE_PTYPE_L2_ETHER_VLAN
2421 * When a packet is received by a PMD, the most precise type must be
2422 * returned among the ones supported. However a PMD is allowed to set
2423 * packet type that is not in the supported list, at the condition that it
2424 * is more precise. Therefore, a PMD announcing no supported packet types
2425 * can still set a matching packet type in a received packet.
2428 * Better to invoke this API after the device is already started or rx burst
2429 * function is decided, to obtain correct supported ptypes.
2431 * if a given PMD does not report what ptypes it supports, then the supported
2432 * ptype count is reported as 0.
2434 * The port identifier of the Ethernet device.
2436 * A hint of what kind of packet type which the caller is interested in.
2438 * An array pointer to store adequent packet types, allocated by caller.
2440 * Size of the array pointed by param ptypes.
2442 * - (>=0) Number of supported ptypes. If the number of types exceeds num,
2443 * only num entries will be filled into the ptypes array, but the full
2444 * count of supported ptypes will be returned.
2445 * - (-ENODEV) if *port_id* invalid.
2447 int rte_eth_dev_get_supported_ptypes(uint8_t port_id, uint32_t ptype_mask,
2448 uint32_t *ptypes, int num);
2451 * Retrieve the MTU of an Ethernet device.
2454 * The port identifier of the Ethernet device.
2456 * A pointer to a uint16_t where the retrieved MTU is to be stored.
2458 * - (0) if successful.
2459 * - (-ENODEV) if *port_id* invalid.
2461 int rte_eth_dev_get_mtu(uint8_t port_id, uint16_t *mtu);
2464 * Change the MTU of an Ethernet device.
2467 * The port identifier of the Ethernet device.
2469 * A uint16_t for the MTU to be applied.
2471 * - (0) if successful.
2472 * - (-ENOTSUP) if operation is not supported.
2473 * - (-ENODEV) if *port_id* invalid.
2474 * - (-EINVAL) if *mtu* invalid.
2475 * - (-EBUSY) if operation is not allowed when the port is running
2477 int rte_eth_dev_set_mtu(uint8_t port_id, uint16_t mtu);
2480 * Enable/Disable hardware filtering by an Ethernet device of received
2481 * VLAN packets tagged with a given VLAN Tag Identifier.
2484 * The port identifier of the Ethernet device.
2486 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
2488 * If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*.
2489 * Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*.
2491 * - (0) if successful.
2492 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2493 * - (-ENODEV) if *port_id* invalid.
2494 * - (-ENOSYS) if VLAN filtering on *port_id* disabled.
2495 * - (-EINVAL) if *vlan_id* > 4095.
2497 int rte_eth_dev_vlan_filter(uint8_t port_id, uint16_t vlan_id, int on);
2500 * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
2501 * 82599/X540/X550 can support VLAN stripping at the rx queue level
2504 * The port identifier of the Ethernet device.
2505 * @param rx_queue_id
2506 * The index of the receive queue for which a queue stats mapping is required.
2507 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2508 * to rte_eth_dev_configure().
2510 * If 1, Enable VLAN Stripping of the receive queue of the Ethernet port.
2511 * If 0, Disable VLAN Stripping of the receive queue of the Ethernet port.
2513 * - (0) if successful.
2514 * - (-ENOSUP) if hardware-assisted VLAN stripping not configured.
2515 * - (-ENODEV) if *port_id* invalid.
2516 * - (-EINVAL) if *rx_queue_id* invalid.
2518 int rte_eth_dev_set_vlan_strip_on_queue(uint8_t port_id, uint16_t rx_queue_id,
2522 * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
2523 * the VLAN Header. This is a register setup available on some Intel NIC, not
2524 * but all, please check the data sheet for availability.
2527 * The port identifier of the Ethernet device.
2531 * The Tag Protocol ID
2533 * - (0) if successful.
2534 * - (-ENOSUP) if hardware-assisted VLAN TPID setup is not supported.
2535 * - (-ENODEV) if *port_id* invalid.
2537 int rte_eth_dev_set_vlan_ether_type(uint8_t port_id,
2538 enum rte_vlan_type vlan_type,
2542 * Set VLAN offload configuration on an Ethernet device
2543 * Enable/Disable Extended VLAN by an Ethernet device, This is a register setup
2544 * available on some Intel NIC, not but all, please check the data sheet for
2546 * Enable/Disable VLAN Strip can be done on rx queue for certain NIC, but here
2547 * the configuration is applied on the port level.
2550 * The port identifier of the Ethernet device.
2551 * @param offload_mask
2552 * The VLAN Offload bit mask can be mixed use with "OR"
2553 * ETH_VLAN_STRIP_OFFLOAD
2554 * ETH_VLAN_FILTER_OFFLOAD
2555 * ETH_VLAN_EXTEND_OFFLOAD
2557 * - (0) if successful.
2558 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2559 * - (-ENODEV) if *port_id* invalid.
2561 int rte_eth_dev_set_vlan_offload(uint8_t port_id, int offload_mask);
2564 * Read VLAN Offload configuration from an Ethernet device
2567 * The port identifier of the Ethernet device.
2569 * - (>0) if successful. Bit mask to indicate
2570 * ETH_VLAN_STRIP_OFFLOAD
2571 * ETH_VLAN_FILTER_OFFLOAD
2572 * ETH_VLAN_EXTEND_OFFLOAD
2573 * - (-ENODEV) if *port_id* invalid.
2575 int rte_eth_dev_get_vlan_offload(uint8_t port_id);
2578 * Set port based TX VLAN insersion on or off.
2581 * The port identifier of the Ethernet device.
2583 * Port based TX VLAN identifier togeth with user priority.
2585 * Turn on or off the port based TX VLAN insertion.
2588 * - (0) if successful.
2589 * - negative if failed.
2591 int rte_eth_dev_set_vlan_pvid(uint8_t port_id, uint16_t pvid, int on);
2595 * Retrieve a burst of input packets from a receive queue of an Ethernet
2596 * device. The retrieved packets are stored in *rte_mbuf* structures whose
2597 * pointers are supplied in the *rx_pkts* array.
2599 * The rte_eth_rx_burst() function loops, parsing the RX ring of the
2600 * receive queue, up to *nb_pkts* packets, and for each completed RX
2601 * descriptor in the ring, it performs the following operations:
2603 * - Initialize the *rte_mbuf* data structure associated with the
2604 * RX descriptor according to the information provided by the NIC into
2605 * that RX descriptor.
2607 * - Store the *rte_mbuf* data structure into the next entry of the
2610 * - Replenish the RX descriptor with a new *rte_mbuf* buffer
2611 * allocated from the memory pool associated with the receive queue at
2612 * initialization time.
2614 * When retrieving an input packet that was scattered by the controller
2615 * into multiple receive descriptors, the rte_eth_rx_burst() function
2616 * appends the associated *rte_mbuf* buffers to the first buffer of the
2619 * The rte_eth_rx_burst() function returns the number of packets
2620 * actually retrieved, which is the number of *rte_mbuf* data structures
2621 * effectively supplied into the *rx_pkts* array.
2622 * A return value equal to *nb_pkts* indicates that the RX queue contained
2623 * at least *rx_pkts* packets, and this is likely to signify that other
2624 * received packets remain in the input queue. Applications implementing
2625 * a "retrieve as much received packets as possible" policy can check this
2626 * specific case and keep invoking the rte_eth_rx_burst() function until
2627 * a value less than *nb_pkts* is returned.
2629 * This receive method has the following advantages:
2631 * - It allows a run-to-completion network stack engine to retrieve and
2632 * to immediately process received packets in a fast burst-oriented
2633 * approach, avoiding the overhead of unnecessary intermediate packet
2634 * queue/dequeue operations.
2636 * - Conversely, it also allows an asynchronous-oriented processing
2637 * method to retrieve bursts of received packets and to immediately
2638 * queue them for further parallel processing by another logical core,
2639 * for instance. However, instead of having received packets being
2640 * individually queued by the driver, this approach allows the invoker
2641 * of the rte_eth_rx_burst() function to queue a burst of retrieved
2642 * packets at a time and therefore dramatically reduce the cost of
2643 * enqueue/dequeue operations per packet.
2645 * - It allows the rte_eth_rx_burst() function of the driver to take
2646 * advantage of burst-oriented hardware features (CPU cache,
2647 * prefetch instructions, and so on) to minimize the number of CPU
2648 * cycles per packet.
2650 * To summarize, the proposed receive API enables many
2651 * burst-oriented optimizations in both synchronous and asynchronous
2652 * packet processing environments with no overhead in both cases.
2654 * The rte_eth_rx_burst() function does not provide any error
2655 * notification to avoid the corresponding overhead. As a hint, the
2656 * upper-level application might check the status of the device link once
2657 * being systematically returned a 0 value for a given number of tries.
2660 * The port identifier of the Ethernet device.
2662 * The index of the receive queue from which to retrieve input packets.
2663 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2664 * to rte_eth_dev_configure().
2666 * The address of an array of pointers to *rte_mbuf* structures that
2667 * must be large enough to store *nb_pkts* pointers in it.
2669 * The maximum number of packets to retrieve.
2671 * The number of packets actually retrieved, which is the number
2672 * of pointers to *rte_mbuf* structures effectively supplied to the
2675 static inline uint16_t
2676 rte_eth_rx_burst(uint8_t port_id, uint16_t queue_id,
2677 struct rte_mbuf **rx_pkts, const uint16_t nb_pkts)
2679 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2681 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2682 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
2683 RTE_FUNC_PTR_OR_ERR_RET(*dev->rx_pkt_burst, 0);
2685 if (queue_id >= dev->data->nb_rx_queues) {
2686 RTE_PMD_DEBUG_TRACE("Invalid RX queue_id=%d\n", queue_id);
2690 int16_t nb_rx = (*dev->rx_pkt_burst)(dev->data->rx_queues[queue_id],
2693 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
2694 struct rte_eth_rxtx_callback *cb = dev->post_rx_burst_cbs[queue_id];
2696 if (unlikely(cb != NULL)) {
2698 nb_rx = cb->fn.rx(port_id, queue_id, rx_pkts, nb_rx,
2699 nb_pkts, cb->param);
2701 } while (cb != NULL);
2709 * Get the number of used descriptors of a rx queue
2712 * The port identifier of the Ethernet device.
2714 * The queue id on the specific port.
2716 * The number of used descriptors in the specific queue, or:
2717 * (-EINVAL) if *port_id* or *queue_id* is invalid
2718 * (-ENOTSUP) if the device does not support this function
2721 rte_eth_rx_queue_count(uint8_t port_id, uint16_t queue_id)
2723 struct rte_eth_dev *dev;
2725 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -EINVAL);
2726 dev = &rte_eth_devices[port_id];
2727 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_queue_count, -ENOTSUP);
2728 if (queue_id >= dev->data->nb_rx_queues)
2731 return (*dev->dev_ops->rx_queue_count)(dev, queue_id);
2735 * Check if the DD bit of the specific RX descriptor in the queue has been set
2738 * The port identifier of the Ethernet device.
2740 * The queue id on the specific port.
2742 * The offset of the descriptor ID from tail.
2744 * - (1) if the specific DD bit is set.
2745 * - (0) if the specific DD bit is not set.
2746 * - (-ENODEV) if *port_id* invalid.
2747 * - (-ENOTSUP) if the device does not support this function
2750 rte_eth_rx_descriptor_done(uint8_t port_id, uint16_t queue_id, uint16_t offset)
2752 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2753 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
2754 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_descriptor_done, -ENOTSUP);
2755 return (*dev->dev_ops->rx_descriptor_done)( \
2756 dev->data->rx_queues[queue_id], offset);
2759 #define RTE_ETH_RX_DESC_AVAIL 0 /**< Desc available for hw. */
2760 #define RTE_ETH_RX_DESC_DONE 1 /**< Desc done, filled by hw. */
2761 #define RTE_ETH_RX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */
2764 * Check the status of a Rx descriptor in the queue
2766 * It should be called in a similar context than the Rx function:
2767 * - on a dataplane core
2768 * - not concurrently on the same queue
2770 * Since it's a dataplane function, no check is performed on port_id and
2771 * queue_id. The caller must therefore ensure that the port is enabled
2772 * and the queue is configured and running.
2774 * Note: accessing to a random descriptor in the ring may trigger cache
2775 * misses and have a performance impact.
2778 * A valid port identifier of the Ethernet device which.
2780 * A valid Rx queue identifier on this port.
2782 * The offset of the descriptor starting from tail (0 is the next
2783 * packet to be received by the driver).
2786 * - (RTE_ETH_RX_DESC_AVAIL): Descriptor is available for the hardware to
2788 * - (RTE_ETH_RX_DESC_DONE): Descriptor is done, it is filled by hw, but
2789 * not yet processed by the driver (i.e. in the receive queue).
2790 * - (RTE_ETH_RX_DESC_UNAVAIL): Descriptor is unavailable, either hold by
2791 * the driver and not yet returned to hw, or reserved by the hw.
2792 * - (-EINVAL) bad descriptor offset.
2793 * - (-ENOTSUP) if the device does not support this function.
2794 * - (-ENODEV) bad port or queue (only if compiled with debug).
2797 rte_eth_rx_descriptor_status(uint8_t port_id, uint16_t queue_id,
2800 struct rte_eth_dev *dev;
2803 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2804 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
2806 dev = &rte_eth_devices[port_id];
2807 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2808 if (queue_id >= dev->data->nb_rx_queues)
2811 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_descriptor_status, -ENOTSUP);
2812 rxq = dev->data->rx_queues[queue_id];
2814 return (*dev->dev_ops->rx_descriptor_status)(rxq, offset);
2817 #define RTE_ETH_TX_DESC_FULL 0 /**< Desc filled for hw, waiting xmit. */
2818 #define RTE_ETH_TX_DESC_DONE 1 /**< Desc done, packet is transmitted. */
2819 #define RTE_ETH_TX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */
2822 * Check the status of a Tx descriptor in the queue.
2824 * It should be called in a similar context than the Tx function:
2825 * - on a dataplane core
2826 * - not concurrently on the same queue
2828 * Since it's a dataplane function, no check is performed on port_id and
2829 * queue_id. The caller must therefore ensure that the port is enabled
2830 * and the queue is configured and running.
2832 * Note: accessing to a random descriptor in the ring may trigger cache
2833 * misses and have a performance impact.
2836 * A valid port identifier of the Ethernet device which.
2838 * A valid Tx queue identifier on this port.
2840 * The offset of the descriptor starting from tail (0 is the place where
2841 * the next packet will be send).
2844 * - (RTE_ETH_TX_DESC_FULL) Descriptor is being processed by the hw, i.e.
2845 * in the transmit queue.
2846 * - (RTE_ETH_TX_DESC_DONE) Hardware is done with this descriptor, it can
2847 * be reused by the driver.
2848 * - (RTE_ETH_TX_DESC_UNAVAIL): Descriptor is unavailable, reserved by the
2849 * driver or the hardware.
2850 * - (-EINVAL) bad descriptor offset.
2851 * - (-ENOTSUP) if the device does not support this function.
2852 * - (-ENODEV) bad port or queue (only if compiled with debug).
2854 static inline int rte_eth_tx_descriptor_status(uint8_t port_id,
2855 uint16_t queue_id, uint16_t offset)
2857 struct rte_eth_dev *dev;
2860 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2861 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
2863 dev = &rte_eth_devices[port_id];
2864 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2865 if (queue_id >= dev->data->nb_tx_queues)
2868 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->tx_descriptor_status, -ENOTSUP);
2869 txq = dev->data->tx_queues[queue_id];
2871 return (*dev->dev_ops->tx_descriptor_status)(txq, offset);
2875 * Send a burst of output packets on a transmit queue of an Ethernet device.
2877 * The rte_eth_tx_burst() function is invoked to transmit output packets
2878 * on the output queue *queue_id* of the Ethernet device designated by its
2880 * The *nb_pkts* parameter is the number of packets to send which are
2881 * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
2882 * allocated from a pool created with rte_pktmbuf_pool_create().
2883 * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
2884 * up to the number of transmit descriptors available in the TX ring of the
2886 * For each packet to send, the rte_eth_tx_burst() function performs
2887 * the following operations:
2889 * - Pick up the next available descriptor in the transmit ring.
2891 * - Free the network buffer previously sent with that descriptor, if any.
2893 * - Initialize the transmit descriptor with the information provided
2894 * in the *rte_mbuf data structure.
2896 * In the case of a segmented packet composed of a list of *rte_mbuf* buffers,
2897 * the rte_eth_tx_burst() function uses several transmit descriptors
2900 * The rte_eth_tx_burst() function returns the number of packets it
2901 * actually sent. A return value equal to *nb_pkts* means that all packets
2902 * have been sent, and this is likely to signify that other output packets
2903 * could be immediately transmitted again. Applications that implement a
2904 * "send as many packets to transmit as possible" policy can check this
2905 * specific case and keep invoking the rte_eth_tx_burst() function until
2906 * a value less than *nb_pkts* is returned.
2908 * It is the responsibility of the rte_eth_tx_burst() function to
2909 * transparently free the memory buffers of packets previously sent.
2910 * This feature is driven by the *tx_free_thresh* value supplied to the
2911 * rte_eth_dev_configure() function at device configuration time.
2912 * When the number of free TX descriptors drops below this threshold, the
2913 * rte_eth_tx_burst() function must [attempt to] free the *rte_mbuf* buffers
2914 * of those packets whose transmission was effectively completed.
2917 * The port identifier of the Ethernet device.
2919 * The index of the transmit queue through which output packets must be
2921 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2922 * to rte_eth_dev_configure().
2924 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
2925 * which contain the output packets.
2927 * The maximum number of packets to transmit.
2929 * The number of output packets actually stored in transmit descriptors of
2930 * the transmit ring. The return value can be less than the value of the
2931 * *tx_pkts* parameter when the transmit ring is full or has been filled up.
2933 static inline uint16_t
2934 rte_eth_tx_burst(uint8_t port_id, uint16_t queue_id,
2935 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
2937 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2939 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2940 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
2941 RTE_FUNC_PTR_OR_ERR_RET(*dev->tx_pkt_burst, 0);
2943 if (queue_id >= dev->data->nb_tx_queues) {
2944 RTE_PMD_DEBUG_TRACE("Invalid TX queue_id=%d\n", queue_id);
2949 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
2950 struct rte_eth_rxtx_callback *cb = dev->pre_tx_burst_cbs[queue_id];
2952 if (unlikely(cb != NULL)) {
2954 nb_pkts = cb->fn.tx(port_id, queue_id, tx_pkts, nb_pkts,
2957 } while (cb != NULL);
2961 return (*dev->tx_pkt_burst)(dev->data->tx_queues[queue_id], tx_pkts, nb_pkts);
2966 * @b EXPERIMENTAL: this API may change without prior notice
2968 * Process a burst of output packets on a transmit queue of an Ethernet device.
2970 * The rte_eth_tx_prepare() function is invoked to prepare output packets to be
2971 * transmitted on the output queue *queue_id* of the Ethernet device designated
2973 * The *nb_pkts* parameter is the number of packets to be prepared which are
2974 * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
2975 * allocated from a pool created with rte_pktmbuf_pool_create().
2976 * For each packet to send, the rte_eth_tx_prepare() function performs
2977 * the following operations:
2979 * - Check if packet meets devices requirements for tx offloads.
2981 * - Check limitations about number of segments.
2983 * - Check additional requirements when debug is enabled.
2985 * - Update and/or reset required checksums when tx offload is set for packet.
2987 * Since this function can modify packet data, provided mbufs must be safely
2988 * writable (e.g. modified data cannot be in shared segment).
2990 * The rte_eth_tx_prepare() function returns the number of packets ready to be
2991 * sent. A return value equal to *nb_pkts* means that all packets are valid and
2992 * ready to be sent, otherwise stops processing on the first invalid packet and
2993 * leaves the rest packets untouched.
2995 * When this functionality is not implemented in the driver, all packets are
2996 * are returned untouched.
2999 * The port identifier of the Ethernet device.
3000 * The value must be a valid port id.
3002 * The index of the transmit queue through which output packets must be
3004 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3005 * to rte_eth_dev_configure().
3007 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
3008 * which contain the output packets.
3010 * The maximum number of packets to process.
3012 * The number of packets correct and ready to be sent. The return value can be
3013 * less than the value of the *tx_pkts* parameter when some packet doesn't
3014 * meet devices requirements with rte_errno set appropriately:
3015 * - -EINVAL: offload flags are not correctly set
3016 * - -ENOTSUP: the offload feature is not supported by the hardware
3020 #ifndef RTE_ETHDEV_TX_PREPARE_NOOP
3022 static inline uint16_t
3023 rte_eth_tx_prepare(uint8_t port_id, uint16_t queue_id,
3024 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
3026 struct rte_eth_dev *dev;
3028 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3029 if (!rte_eth_dev_is_valid_port(port_id)) {
3030 RTE_PMD_DEBUG_TRACE("Invalid TX port_id=%d\n", port_id);
3031 rte_errno = -EINVAL;
3036 dev = &rte_eth_devices[port_id];
3038 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3039 if (queue_id >= dev->data->nb_tx_queues) {
3040 RTE_PMD_DEBUG_TRACE("Invalid TX queue_id=%d\n", queue_id);
3041 rte_errno = -EINVAL;
3046 if (!dev->tx_pkt_prepare)
3049 return (*dev->tx_pkt_prepare)(dev->data->tx_queues[queue_id],
3056 * Native NOOP operation for compilation targets which doesn't require any
3057 * preparations steps, and functional NOOP may introduce unnecessary performance
3060 * Generally this is not a good idea to turn it on globally and didn't should
3061 * be used if behavior of tx_preparation can change.
3064 static inline uint16_t
3065 rte_eth_tx_prepare(__rte_unused uint8_t port_id, __rte_unused uint16_t queue_id,
3066 __rte_unused struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
3073 typedef void (*buffer_tx_error_fn)(struct rte_mbuf **unsent, uint16_t count,
3077 * Structure used to buffer packets for future TX
3078 * Used by APIs rte_eth_tx_buffer and rte_eth_tx_buffer_flush
3080 struct rte_eth_dev_tx_buffer {
3081 buffer_tx_error_fn error_callback;
3082 void *error_userdata;
3083 uint16_t size; /**< Size of buffer for buffered tx */
3084 uint16_t length; /**< Number of packets in the array */
3085 struct rte_mbuf *pkts[];
3086 /**< Pending packets to be sent on explicit flush or when full */
3090 * Calculate the size of the tx buffer.
3093 * Number of stored packets.
3095 #define RTE_ETH_TX_BUFFER_SIZE(sz) \
3096 (sizeof(struct rte_eth_dev_tx_buffer) + (sz) * sizeof(struct rte_mbuf *))
3099 * Initialize default values for buffered transmitting
3102 * Tx buffer to be initialized.
3109 rte_eth_tx_buffer_init(struct rte_eth_dev_tx_buffer *buffer, uint16_t size);
3112 * Send any packets queued up for transmission on a port and HW queue
3114 * This causes an explicit flush of packets previously buffered via the
3115 * rte_eth_tx_buffer() function. It returns the number of packets successfully
3116 * sent to the NIC, and calls the error callback for any unsent packets. Unless
3117 * explicitly set up otherwise, the default callback simply frees the unsent
3118 * packets back to the owning mempool.
3121 * The port identifier of the Ethernet device.
3123 * The index of the transmit queue through which output packets must be
3125 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3126 * to rte_eth_dev_configure().
3128 * Buffer of packets to be transmit.
3130 * The number of packets successfully sent to the Ethernet device. The error
3131 * callback is called for any packets which could not be sent.
3133 static inline uint16_t
3134 rte_eth_tx_buffer_flush(uint8_t port_id, uint16_t queue_id,
3135 struct rte_eth_dev_tx_buffer *buffer)
3138 uint16_t to_send = buffer->length;
3143 sent = rte_eth_tx_burst(port_id, queue_id, buffer->pkts, to_send);
3147 /* All packets sent, or to be dealt with by callback below */
3148 if (unlikely(sent != to_send))
3149 buffer->error_callback(&buffer->pkts[sent], to_send - sent,
3150 buffer->error_userdata);
3156 * Buffer a single packet for future transmission on a port and queue
3158 * This function takes a single mbuf/packet and buffers it for later
3159 * transmission on the particular port and queue specified. Once the buffer is
3160 * full of packets, an attempt will be made to transmit all the buffered
3161 * packets. In case of error, where not all packets can be transmitted, a
3162 * callback is called with the unsent packets as a parameter. If no callback
3163 * is explicitly set up, the unsent packets are just freed back to the owning
3164 * mempool. The function returns the number of packets actually sent i.e.
3165 * 0 if no buffer flush occurred, otherwise the number of packets successfully
3169 * The port identifier of the Ethernet device.
3171 * The index of the transmit queue through which output packets must be
3173 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3174 * to rte_eth_dev_configure().
3176 * Buffer used to collect packets to be sent.
3178 * Pointer to the packet mbuf to be sent.
3180 * 0 = packet has been buffered for later transmission
3181 * N > 0 = packet has been buffered, and the buffer was subsequently flushed,
3182 * causing N packets to be sent, and the error callback to be called for
3185 static inline uint16_t __attribute__((always_inline))
3186 rte_eth_tx_buffer(uint8_t port_id, uint16_t queue_id,
3187 struct rte_eth_dev_tx_buffer *buffer, struct rte_mbuf *tx_pkt)
3189 buffer->pkts[buffer->length++] = tx_pkt;
3190 if (buffer->length < buffer->size)
3193 return rte_eth_tx_buffer_flush(port_id, queue_id, buffer);
3197 * Configure a callback for buffered packets which cannot be sent
3199 * Register a specific callback to be called when an attempt is made to send
3200 * all packets buffered on an ethernet port, but not all packets can
3201 * successfully be sent. The callback registered here will be called only
3202 * from calls to rte_eth_tx_buffer() and rte_eth_tx_buffer_flush() APIs.
3203 * The default callback configured for each queue by default just frees the
3204 * packets back to the calling mempool. If additional behaviour is required,
3205 * for example, to count dropped packets, or to retry transmission of packets
3206 * which cannot be sent, this function should be used to register a suitable
3207 * callback function to implement the desired behaviour.
3208 * The example callback "rte_eth_count_unsent_packet_callback()" is also
3209 * provided as reference.
3212 * The port identifier of the Ethernet device.
3214 * The function to be used as the callback.
3216 * Arbitrary parameter to be passed to the callback function
3218 * 0 on success, or -1 on error with rte_errno set appropriately
3221 rte_eth_tx_buffer_set_err_callback(struct rte_eth_dev_tx_buffer *buffer,
3222 buffer_tx_error_fn callback, void *userdata);
3225 * Callback function for silently dropping unsent buffered packets.
3227 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
3228 * adjust the default behavior when buffered packets cannot be sent. This
3229 * function drops any unsent packets silently and is used by tx buffered
3230 * operations as default behavior.
3232 * NOTE: this function should not be called directly, instead it should be used
3233 * as a callback for packet buffering.
3235 * NOTE: when configuring this function as a callback with
3236 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
3237 * should point to an uint64_t value.
3240 * The previously buffered packets which could not be sent
3242 * The number of unsent packets in the pkts array
3247 rte_eth_tx_buffer_drop_callback(struct rte_mbuf **pkts, uint16_t unsent,
3251 * Callback function for tracking unsent buffered packets.
3253 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
3254 * adjust the default behavior when buffered packets cannot be sent. This
3255 * function drops any unsent packets, but also updates a user-supplied counter
3256 * to track the overall number of packets dropped. The counter should be an
3257 * uint64_t variable.
3259 * NOTE: this function should not be called directly, instead it should be used
3260 * as a callback for packet buffering.
3262 * NOTE: when configuring this function as a callback with
3263 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
3264 * should point to an uint64_t value.
3267 * The previously buffered packets which could not be sent
3269 * The number of unsent packets in the pkts array
3271 * Pointer to an uint64_t value, which will be incremented by unsent
3274 rte_eth_tx_buffer_count_callback(struct rte_mbuf **pkts, uint16_t unsent,
3278 * Request the driver to free mbufs currently cached by the driver. The
3279 * driver will only free the mbuf if it is no longer in use. It is the
3280 * application's responsibity to ensure rte_eth_tx_buffer_flush(..) is
3284 * The port identifier of the Ethernet device.
3286 * The index of the transmit queue through which output packets must be
3288 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3289 * to rte_eth_dev_configure().
3291 * Maximum number of packets to free. Use 0 to indicate all possible packets
3292 * should be freed. Note that a packet may be using multiple mbufs.
3295 * -ENODEV: Invalid interface
3296 * -ENOTSUP: Driver does not support function
3298 * 0-n: Number of packets freed. More packets may still remain in ring that
3302 rte_eth_tx_done_cleanup(uint8_t port_id, uint16_t queue_id, uint32_t free_cnt);
3305 * The eth device event type for interrupt, and maybe others in the future.
3307 enum rte_eth_event_type {
3308 RTE_ETH_EVENT_UNKNOWN, /**< unknown event type */
3309 RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
3310 RTE_ETH_EVENT_QUEUE_STATE,
3311 /**< queue state event (enabled/disabled) */
3312 RTE_ETH_EVENT_INTR_RESET,
3313 /**< reset interrupt event, sent to VF on PF reset */
3314 RTE_ETH_EVENT_VF_MBOX, /**< message from the VF received by PF */
3315 RTE_ETH_EVENT_MACSEC, /**< MACsec offload related event */
3316 RTE_ETH_EVENT_MAX /**< max value of this enum */
3319 typedef void (*rte_eth_dev_cb_fn)(uint8_t port_id, \
3320 enum rte_eth_event_type event, void *cb_arg);
3321 /**< user application callback to be registered for interrupts */
3326 * Register a callback function for specific port id.
3333 * User supplied callback function to be called.
3335 * Pointer to the parameters for the registered callback.
3337 * The user data is overwritten in the case of RTE_ETH_EVENT_VF_MBOX.
3338 * This even occurs when a message from the VF is received by the PF.
3339 * The user data is overwritten with struct rte_pmd_ixgbe_mb_event_param.
3340 * This struct is defined in rte_pmd_ixgbe.h.
3343 * - On success, zero.
3344 * - On failure, a negative value.
3346 int rte_eth_dev_callback_register(uint8_t port_id,
3347 enum rte_eth_event_type event,
3348 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
3351 * Unregister a callback function for specific port id.
3358 * User supplied callback function to be called.
3360 * Pointer to the parameters for the registered callback. -1 means to
3361 * remove all for the same callback address and same event.
3364 * - On success, zero.
3365 * - On failure, a negative value.
3367 int rte_eth_dev_callback_unregister(uint8_t port_id,
3368 enum rte_eth_event_type event,
3369 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
3372 * @internal Executes all the user application registered callbacks for
3373 * the specific device. It is for DPDK internal user only. User
3374 * application should not call it directly.
3377 * Pointer to struct rte_eth_dev.
3379 * Eth device interrupt event type.
3381 * Update callback parameter to pass data back to user application.
3382 * This allows the user application to decide if a particular function
3383 * is permitted or not.
3388 void _rte_eth_dev_callback_process(struct rte_eth_dev *dev,
3389 enum rte_eth_event_type event, void *cb_arg);
3392 * When there is no rx packet coming in Rx Queue for a long time, we can
3393 * sleep lcore related to RX Queue for power saving, and enable rx interrupt
3394 * to be triggered when rx packect arrives.
3396 * The rte_eth_dev_rx_intr_enable() function enables rx queue
3397 * interrupt on specific rx queue of a port.
3400 * The port identifier of the Ethernet device.
3402 * The index of the receive queue from which to retrieve input packets.
3403 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3404 * to rte_eth_dev_configure().
3406 * - (0) if successful.
3407 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3409 * - (-ENODEV) if *port_id* invalid.
3411 int rte_eth_dev_rx_intr_enable(uint8_t port_id, uint16_t queue_id);
3414 * When lcore wakes up from rx interrupt indicating packet coming, disable rx
3415 * interrupt and returns to polling mode.
3417 * The rte_eth_dev_rx_intr_disable() function disables rx queue
3418 * interrupt on specific rx queue of a port.
3421 * The port identifier of the Ethernet device.
3423 * The index of the receive queue from which to retrieve input packets.
3424 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3425 * to rte_eth_dev_configure().
3427 * - (0) if successful.
3428 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3430 * - (-ENODEV) if *port_id* invalid.
3432 int rte_eth_dev_rx_intr_disable(uint8_t port_id, uint16_t queue_id);
3435 * RX Interrupt control per port.
3438 * The port identifier of the Ethernet device.
3440 * Epoll instance fd which the intr vector associated to.
3441 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
3443 * The operation be performed for the vector.
3444 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
3448 * - On success, zero.
3449 * - On failure, a negative value.
3451 int rte_eth_dev_rx_intr_ctl(uint8_t port_id, int epfd, int op, void *data);
3454 * RX Interrupt control per queue.
3457 * The port identifier of the Ethernet device.
3459 * The index of the receive queue from which to retrieve input packets.
3460 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3461 * to rte_eth_dev_configure().
3463 * Epoll instance fd which the intr vector associated to.
3464 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
3466 * The operation be performed for the vector.
3467 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
3471 * - On success, zero.
3472 * - On failure, a negative value.
3474 int rte_eth_dev_rx_intr_ctl_q(uint8_t port_id, uint16_t queue_id,
3475 int epfd, int op, void *data);
3478 * Turn on the LED on the Ethernet device.
3479 * This function turns on the LED on the Ethernet device.
3482 * The port identifier of the Ethernet device.
3484 * - (0) if successful.
3485 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3487 * - (-ENODEV) if *port_id* invalid.
3489 int rte_eth_led_on(uint8_t port_id);
3492 * Turn off the LED on the Ethernet device.
3493 * This function turns off the LED on the Ethernet device.
3496 * The port identifier of the Ethernet device.
3498 * - (0) if successful.
3499 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3501 * - (-ENODEV) if *port_id* invalid.
3503 int rte_eth_led_off(uint8_t port_id);
3506 * Get current status of the Ethernet link flow control for Ethernet device
3509 * The port identifier of the Ethernet device.
3511 * The pointer to the structure where to store the flow control parameters.
3513 * - (0) if successful.
3514 * - (-ENOTSUP) if hardware doesn't support flow control.
3515 * - (-ENODEV) if *port_id* invalid.
3517 int rte_eth_dev_flow_ctrl_get(uint8_t port_id,
3518 struct rte_eth_fc_conf *fc_conf);
3521 * Configure the Ethernet link flow control for Ethernet device
3524 * The port identifier of the Ethernet device.
3526 * The pointer to the structure of the flow control parameters.
3528 * - (0) if successful.
3529 * - (-ENOTSUP) if hardware doesn't support flow control mode.
3530 * - (-ENODEV) if *port_id* invalid.
3531 * - (-EINVAL) if bad parameter
3532 * - (-EIO) if flow control setup failure
3534 int rte_eth_dev_flow_ctrl_set(uint8_t port_id,
3535 struct rte_eth_fc_conf *fc_conf);
3538 * Configure the Ethernet priority flow control under DCB environment
3539 * for Ethernet device.
3542 * The port identifier of the Ethernet device.
3544 * The pointer to the structure of the priority flow control parameters.
3546 * - (0) if successful.
3547 * - (-ENOTSUP) if hardware doesn't support priority flow control mode.
3548 * - (-ENODEV) if *port_id* invalid.
3549 * - (-EINVAL) if bad parameter
3550 * - (-EIO) if flow control setup failure
3552 int rte_eth_dev_priority_flow_ctrl_set(uint8_t port_id,
3553 struct rte_eth_pfc_conf *pfc_conf);
3556 * Add a MAC address to an internal array of addresses used to enable whitelist
3557 * filtering to accept packets only if the destination MAC address matches.
3560 * The port identifier of the Ethernet device.
3562 * The MAC address to add.
3564 * VMDq pool index to associate address with (if VMDq is enabled). If VMDq is
3565 * not enabled, this should be set to 0.
3567 * - (0) if successfully added or *mac_addr" was already added.
3568 * - (-ENOTSUP) if hardware doesn't support this feature.
3569 * - (-ENODEV) if *port* is invalid.
3570 * - (-ENOSPC) if no more MAC addresses can be added.
3571 * - (-EINVAL) if MAC address is invalid.
3573 int rte_eth_dev_mac_addr_add(uint8_t port, struct ether_addr *mac_addr,
3577 * Remove a MAC address from the internal array of addresses.
3580 * The port identifier of the Ethernet device.
3582 * MAC address to remove.
3584 * - (0) if successful, or *mac_addr* didn't exist.
3585 * - (-ENOTSUP) if hardware doesn't support.
3586 * - (-ENODEV) if *port* invalid.
3587 * - (-EADDRINUSE) if attempting to remove the default MAC address
3589 int rte_eth_dev_mac_addr_remove(uint8_t port, struct ether_addr *mac_addr);
3592 * Set the default MAC address.
3595 * The port identifier of the Ethernet device.
3597 * New default MAC address.
3599 * - (0) if successful, or *mac_addr* didn't exist.
3600 * - (-ENOTSUP) if hardware doesn't support.
3601 * - (-ENODEV) if *port* invalid.
3602 * - (-EINVAL) if MAC address is invalid.
3604 int rte_eth_dev_default_mac_addr_set(uint8_t port, struct ether_addr *mac_addr);
3608 * Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3611 * The port identifier of the Ethernet device.
3615 * Redirection table size. The table size can be queried by
3616 * rte_eth_dev_info_get().
3618 * - (0) if successful.
3619 * - (-ENOTSUP) if hardware doesn't support.
3620 * - (-EINVAL) if bad parameter.
3622 int rte_eth_dev_rss_reta_update(uint8_t port,
3623 struct rte_eth_rss_reta_entry64 *reta_conf,
3624 uint16_t reta_size);
3627 * Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3630 * The port identifier of the Ethernet device.
3634 * Redirection table size. The table size can be queried by
3635 * rte_eth_dev_info_get().
3637 * - (0) if successful.
3638 * - (-ENOTSUP) if hardware doesn't support.
3639 * - (-EINVAL) if bad parameter.
3641 int rte_eth_dev_rss_reta_query(uint8_t port,
3642 struct rte_eth_rss_reta_entry64 *reta_conf,
3643 uint16_t reta_size);
3646 * Updates unicast hash table for receiving packet with the given destination
3647 * MAC address, and the packet is routed to all VFs for which the RX mode is
3648 * accept packets that match the unicast hash table.
3651 * The port identifier of the Ethernet device.
3653 * Unicast MAC address.
3655 * 1 - Set an unicast hash bit for receiving packets with the MAC address.
3656 * 0 - Clear an unicast hash bit.
3658 * - (0) if successful.
3659 * - (-ENOTSUP) if hardware doesn't support.
3660 * - (-ENODEV) if *port_id* invalid.
3661 * - (-EINVAL) if bad parameter.
3663 int rte_eth_dev_uc_hash_table_set(uint8_t port,struct ether_addr *addr,
3667 * Updates all unicast hash bitmaps for receiving packet with any Unicast
3668 * Ethernet MAC addresses,the packet is routed to all VFs for which the RX
3669 * mode is accept packets that match the unicast hash table.
3672 * The port identifier of the Ethernet device.
3674 * 1 - Set all unicast hash bitmaps for receiving all the Ethernet
3676 * 0 - Clear all unicast hash bitmaps
3678 * - (0) if successful.
3679 * - (-ENOTSUP) if hardware doesn't support.
3680 * - (-ENODEV) if *port_id* invalid.
3681 * - (-EINVAL) if bad parameter.
3683 int rte_eth_dev_uc_all_hash_table_set(uint8_t port,uint8_t on);
3686 * Set a traffic mirroring rule on an Ethernet device
3689 * The port identifier of the Ethernet device.
3690 * @param mirror_conf
3691 * The pointer to the traffic mirroring structure describing the mirroring rule.
3692 * The *rte_eth_vm_mirror_conf* structure includes the type of mirroring rule,
3693 * destination pool and the value of rule if enable vlan or pool mirroring.
3696 * The index of traffic mirroring rule, we support four separated rules.
3698 * 1 - Enable a mirroring rule.
3699 * 0 - Disable a mirroring rule.
3701 * - (0) if successful.
3702 * - (-ENOTSUP) if hardware doesn't support this feature.
3703 * - (-ENODEV) if *port_id* invalid.
3704 * - (-EINVAL) if the mr_conf information is not correct.
3706 int rte_eth_mirror_rule_set(uint8_t port_id,
3707 struct rte_eth_mirror_conf *mirror_conf,
3712 * Reset a traffic mirroring rule on an Ethernet device.
3715 * The port identifier of the Ethernet device.
3717 * The index of traffic mirroring rule, we support four separated rules.
3719 * - (0) if successful.
3720 * - (-ENOTSUP) if hardware doesn't support this feature.
3721 * - (-ENODEV) if *port_id* invalid.
3722 * - (-EINVAL) if bad parameter.
3724 int rte_eth_mirror_rule_reset(uint8_t port_id,
3728 * Set the rate limitation for a queue on an Ethernet device.
3731 * The port identifier of the Ethernet device.
3735 * The tx rate in Mbps. Allocated from the total port link speed.
3737 * - (0) if successful.
3738 * - (-ENOTSUP) if hardware doesn't support this feature.
3739 * - (-ENODEV) if *port_id* invalid.
3740 * - (-EINVAL) if bad parameter.
3742 int rte_eth_set_queue_rate_limit(uint8_t port_id, uint16_t queue_idx,
3746 * Initialize bypass logic. This function needs to be called before
3747 * executing any other bypass API.
3750 * The port identifier of the Ethernet device.
3752 * - (0) if successful.
3753 * - (-ENOTSUP) if hardware doesn't support.
3754 * - (-EINVAL) if bad parameter.
3756 int rte_eth_dev_bypass_init(uint8_t port);
3759 * Return bypass state.
3762 * The port identifier of the Ethernet device.
3764 * The return bypass state.
3767 * - (3) Isolate mode
3769 * - (0) if successful.
3770 * - (-ENOTSUP) if hardware doesn't support.
3771 * - (-EINVAL) if bad parameter.
3773 int rte_eth_dev_bypass_state_show(uint8_t port, uint32_t *state);
3779 * The port identifier of the Ethernet device.
3781 * The current bypass state.
3784 * - (3) Isolate mode
3786 * - (0) if successful.
3787 * - (-ENOTSUP) if hardware doesn't support.
3788 * - (-EINVAL) if bad parameter.
3790 int rte_eth_dev_bypass_state_set(uint8_t port, uint32_t *new_state);
3793 * Return bypass state when given event occurs.
3796 * The port identifier of the Ethernet device.
3799 * - (1) Main power on (power button is pushed)
3800 * - (2) Auxiliary power on (power supply is being plugged)
3801 * - (3) Main power off (system shutdown and power supply is left plugged in)
3802 * - (4) Auxiliary power off (power supply is being unplugged)
3803 * - (5) Display or set the watchdog timer
3805 * The bypass state when given event occurred.
3808 * - (3) Isolate mode
3810 * - (0) if successful.
3811 * - (-ENOTSUP) if hardware doesn't support.
3812 * - (-EINVAL) if bad parameter.
3814 int rte_eth_dev_bypass_event_show(uint8_t port, uint32_t event, uint32_t *state);
3817 * Set bypass state when given event occurs.
3820 * The port identifier of the Ethernet device.
3823 * - (1) Main power on (power button is pushed)
3824 * - (2) Auxiliary power on (power supply is being plugged)
3825 * - (3) Main power off (system shutdown and power supply is left plugged in)
3826 * - (4) Auxiliary power off (power supply is being unplugged)
3827 * - (5) Display or set the watchdog timer
3829 * The assigned state when given event occurs.
3832 * - (3) Isolate mode
3834 * - (0) if successful.
3835 * - (-ENOTSUP) if hardware doesn't support.
3836 * - (-EINVAL) if bad parameter.
3838 int rte_eth_dev_bypass_event_store(uint8_t port, uint32_t event, uint32_t state);
3841 * Set bypass watchdog timeout count.
3844 * The port identifier of the Ethernet device.
3846 * The timeout to be set.
3847 * - (0) 0 seconds (timer is off)
3856 * - (0) if successful.
3857 * - (-ENOTSUP) if hardware doesn't support.
3858 * - (-EINVAL) if bad parameter.
3860 int rte_eth_dev_wd_timeout_store(uint8_t port, uint32_t timeout);
3863 * Get bypass firmware version.
3866 * The port identifier of the Ethernet device.
3868 * The firmware version
3870 * - (0) if successful.
3871 * - (-ENOTSUP) if hardware doesn't support.
3872 * - (-EINVAL) if bad parameter.
3874 int rte_eth_dev_bypass_ver_show(uint8_t port, uint32_t *ver);
3877 * Return bypass watchdog timeout in seconds
3880 * The port identifier of the Ethernet device.
3882 * The return watchdog timeout. "0" represents timer expired
3883 * - (0) 0 seconds (timer is off)
3892 * - (0) if successful.
3893 * - (-ENOTSUP) if hardware doesn't support.
3894 * - (-EINVAL) if bad parameter.
3896 int rte_eth_dev_bypass_wd_timeout_show(uint8_t port, uint32_t *wd_timeout);
3899 * Reset bypass watchdog timer
3902 * The port identifier of the Ethernet device.
3904 * - (0) if successful.
3905 * - (-ENOTSUP) if hardware doesn't support.
3906 * - (-EINVAL) if bad parameter.
3908 int rte_eth_dev_bypass_wd_reset(uint8_t port);
3911 * Configuration of Receive Side Scaling hash computation of Ethernet device.
3914 * The port identifier of the Ethernet device.
3916 * The new configuration to use for RSS hash computation on the port.
3918 * - (0) if successful.
3919 * - (-ENODEV) if port identifier is invalid.
3920 * - (-ENOTSUP) if hardware doesn't support.
3921 * - (-EINVAL) if bad parameter.
3923 int rte_eth_dev_rss_hash_update(uint8_t port_id,
3924 struct rte_eth_rss_conf *rss_conf);
3927 * Retrieve current configuration of Receive Side Scaling hash computation
3928 * of Ethernet device.
3931 * The port identifier of the Ethernet device.
3933 * Where to store the current RSS hash configuration of the Ethernet device.
3935 * - (0) if successful.
3936 * - (-ENODEV) if port identifier is invalid.
3937 * - (-ENOTSUP) if hardware doesn't support RSS.
3940 rte_eth_dev_rss_hash_conf_get(uint8_t port_id,
3941 struct rte_eth_rss_conf *rss_conf);
3944 * Add UDP tunneling port for a specific type of tunnel.
3945 * The packets with this UDP port will be identified as this type of tunnel.
3946 * Before enabling any offloading function for a tunnel, users can call this API
3947 * to change or add more UDP port for the tunnel. So the offloading function
3948 * can take effect on the packets with the specific UDP port.
3951 * The port identifier of the Ethernet device.
3953 * UDP tunneling configuration.
3956 * - (0) if successful.
3957 * - (-ENODEV) if port identifier is invalid.
3958 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3961 rte_eth_dev_udp_tunnel_port_add(uint8_t port_id,
3962 struct rte_eth_udp_tunnel *tunnel_udp);
3965 * Delete UDP tunneling port a specific type of tunnel.
3966 * The packets with this UDP port will not be identified as this type of tunnel
3968 * Before enabling any offloading function for a tunnel, users can call this API
3969 * to delete a UDP port for the tunnel. So the offloading function will not take
3970 * effect on the packets with the specific UDP port.
3973 * The port identifier of the Ethernet device.
3975 * UDP tunneling configuration.
3978 * - (0) if successful.
3979 * - (-ENODEV) if port identifier is invalid.
3980 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3983 rte_eth_dev_udp_tunnel_port_delete(uint8_t port_id,
3984 struct rte_eth_udp_tunnel *tunnel_udp);
3987 * Check whether the filter type is supported on an Ethernet device.
3988 * All the supported filter types are defined in 'rte_eth_ctrl.h'.
3991 * The port identifier of the Ethernet device.
3992 * @param filter_type
3995 * - (0) if successful.
3996 * - (-ENOTSUP) if hardware doesn't support this filter type.
3997 * - (-ENODEV) if *port_id* invalid.
3999 int rte_eth_dev_filter_supported(uint8_t port_id, enum rte_filter_type filter_type);
4002 * Take operations to assigned filter type on an Ethernet device.
4003 * All the supported operations and filter types are defined in 'rte_eth_ctrl.h'.
4006 * The port identifier of the Ethernet device.
4007 * @param filter_type
4010 * Type of operation.
4012 * A pointer to arguments defined specifically for the operation.
4014 * - (0) if successful.
4015 * - (-ENOTSUP) if hardware doesn't support.
4016 * - (-ENODEV) if *port_id* invalid.
4017 * - others depends on the specific operations implementation.
4019 int rte_eth_dev_filter_ctrl(uint8_t port_id, enum rte_filter_type filter_type,
4020 enum rte_filter_op filter_op, void *arg);
4023 * Get DCB information on an Ethernet device.
4026 * The port identifier of the Ethernet device.
4030 * - (0) if successful.
4031 * - (-ENODEV) if port identifier is invalid.
4032 * - (-ENOTSUP) if hardware doesn't support.
4034 int rte_eth_dev_get_dcb_info(uint8_t port_id,
4035 struct rte_eth_dcb_info *dcb_info);
4038 * Add a callback to be called on packet RX on a given port and queue.
4040 * This API configures a function to be called for each burst of
4041 * packets received on a given NIC port queue. The return value is a pointer
4042 * that can be used to later remove the callback using
4043 * rte_eth_remove_rx_callback().
4045 * Multiple functions are called in the order that they are added.
4048 * The port identifier of the Ethernet device.
4050 * The queue on the Ethernet device on which the callback is to be added.
4052 * The callback function
4054 * A generic pointer parameter which will be passed to each invocation of the
4055 * callback function on this port and queue.
4059 * On success, a pointer value which can later be used to remove the callback.
4061 void *rte_eth_add_rx_callback(uint8_t port_id, uint16_t queue_id,
4062 rte_rx_callback_fn fn, void *user_param);
4065 * Add a callback that must be called first on packet RX on a given port
4068 * This API configures a first function to be called for each burst of
4069 * packets received on a given NIC port queue. The return value is a pointer
4070 * that can be used to later remove the callback using
4071 * rte_eth_remove_rx_callback().
4073 * Multiple functions are called in the order that they are added.
4076 * The port identifier of the Ethernet device.
4078 * The queue on the Ethernet device on which the callback is to be added.
4080 * The callback function
4082 * A generic pointer parameter which will be passed to each invocation of the
4083 * callback function on this port and queue.
4087 * On success, a pointer value which can later be used to remove the callback.
4089 void *rte_eth_add_first_rx_callback(uint8_t port_id, uint16_t queue_id,
4090 rte_rx_callback_fn fn, void *user_param);
4093 * Add a callback to be called on packet TX on a given port and queue.
4095 * This API configures a function to be called for each burst of
4096 * packets sent on a given NIC port queue. The return value is a pointer
4097 * that can be used to later remove the callback using
4098 * rte_eth_remove_tx_callback().
4100 * Multiple functions are called in the order that they are added.
4103 * The port identifier of the Ethernet device.
4105 * The queue on the Ethernet device on which the callback is to be added.
4107 * The callback function
4109 * A generic pointer parameter which will be passed to each invocation of the
4110 * callback function on this port and queue.
4114 * On success, a pointer value which can later be used to remove the callback.
4116 void *rte_eth_add_tx_callback(uint8_t port_id, uint16_t queue_id,
4117 rte_tx_callback_fn fn, void *user_param);
4120 * Remove an RX packet callback from a given port and queue.
4122 * This function is used to removed callbacks that were added to a NIC port
4123 * queue using rte_eth_add_rx_callback().
4125 * Note: the callback is removed from the callback list but it isn't freed
4126 * since the it may still be in use. The memory for the callback can be
4127 * subsequently freed back by the application by calling rte_free():
4129 * - Immediately - if the port is stopped, or the user knows that no
4130 * callbacks are in flight e.g. if called from the thread doing RX/TX
4133 * - After a short delay - where the delay is sufficient to allow any
4134 * in-flight callbacks to complete.
4137 * The port identifier of the Ethernet device.
4139 * The queue on the Ethernet device from which the callback is to be removed.
4141 * User supplied callback created via rte_eth_add_rx_callback().
4144 * - 0: Success. Callback was removed.
4145 * - -ENOTSUP: Callback support is not available.
4146 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
4147 * is NULL or not found for the port/queue.
4149 int rte_eth_remove_rx_callback(uint8_t port_id, uint16_t queue_id,
4150 struct rte_eth_rxtx_callback *user_cb);
4153 * Remove a TX packet callback from a given port and queue.
4155 * This function is used to removed callbacks that were added to a NIC port
4156 * queue using rte_eth_add_tx_callback().
4158 * Note: the callback is removed from the callback list but it isn't freed
4159 * since the it may still be in use. The memory for the callback can be
4160 * subsequently freed back by the application by calling rte_free():
4162 * - Immediately - if the port is stopped, or the user knows that no
4163 * callbacks are in flight e.g. if called from the thread doing RX/TX
4166 * - After a short delay - where the delay is sufficient to allow any
4167 * in-flight callbacks to complete.
4170 * The port identifier of the Ethernet device.
4172 * The queue on the Ethernet device from which the callback is to be removed.
4174 * User supplied callback created via rte_eth_add_tx_callback().
4177 * - 0: Success. Callback was removed.
4178 * - -ENOTSUP: Callback support is not available.
4179 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
4180 * is NULL or not found for the port/queue.
4182 int rte_eth_remove_tx_callback(uint8_t port_id, uint16_t queue_id,
4183 struct rte_eth_rxtx_callback *user_cb);
4186 * Retrieve information about given port's RX queue.
4189 * The port identifier of the Ethernet device.
4191 * The RX queue on the Ethernet device for which information
4192 * will be retrieved.
4194 * A pointer to a structure of type *rte_eth_rxq_info_info* to be filled with
4195 * the information of the Ethernet device.
4199 * - -ENOTSUP: routine is not supported by the device PMD.
4200 * - -EINVAL: The port_id or the queue_id is out of range.
4202 int rte_eth_rx_queue_info_get(uint8_t port_id, uint16_t queue_id,
4203 struct rte_eth_rxq_info *qinfo);
4206 * Retrieve information about given port's TX queue.
4209 * The port identifier of the Ethernet device.
4211 * The TX queue on the Ethernet device for which information
4212 * will be retrieved.
4214 * A pointer to a structure of type *rte_eth_txq_info_info* to be filled with
4215 * the information of the Ethernet device.
4219 * - -ENOTSUP: routine is not supported by the device PMD.
4220 * - -EINVAL: The port_id or the queue_id is out of range.
4222 int rte_eth_tx_queue_info_get(uint8_t port_id, uint16_t queue_id,
4223 struct rte_eth_txq_info *qinfo);
4226 * Retrieve device registers and register attributes (number of registers and
4230 * The port identifier of the Ethernet device.
4232 * Pointer to rte_dev_reg_info structure to fill in. If info->data is
4233 * NULL the function fills in the width and length fields. If non-NULL
4234 * the registers are put into the buffer pointed at by the data field.
4236 * - (0) if successful.
4237 * - (-ENOTSUP) if hardware doesn't support.
4238 * - (-ENODEV) if *port_id* invalid.
4239 * - others depends on the specific operations implementation.
4241 int rte_eth_dev_get_reg_info(uint8_t port_id, struct rte_dev_reg_info *info);
4244 * Retrieve size of device EEPROM
4247 * The port identifier of the Ethernet device.
4249 * - (>=0) EEPROM size if successful.
4250 * - (-ENOTSUP) if hardware doesn't support.
4251 * - (-ENODEV) if *port_id* invalid.
4252 * - others depends on the specific operations implementation.
4254 int rte_eth_dev_get_eeprom_length(uint8_t port_id);
4257 * Retrieve EEPROM and EEPROM attribute
4260 * The port identifier of the Ethernet device.
4262 * The template includes buffer for return EEPROM data and
4263 * EEPROM attributes to be filled.
4265 * - (0) if successful.
4266 * - (-ENOTSUP) if hardware doesn't support.
4267 * - (-ENODEV) if *port_id* invalid.
4268 * - others depends on the specific operations implementation.
4270 int rte_eth_dev_get_eeprom(uint8_t port_id, struct rte_dev_eeprom_info *info);
4273 * Program EEPROM with provided data
4276 * The port identifier of the Ethernet device.
4278 * The template includes EEPROM data for programming and
4279 * EEPROM attributes to be filled
4281 * - (0) if successful.
4282 * - (-ENOTSUP) if hardware doesn't support.
4283 * - (-ENODEV) if *port_id* invalid.
4284 * - others depends on the specific operations implementation.
4286 int rte_eth_dev_set_eeprom(uint8_t port_id, struct rte_dev_eeprom_info *info);
4289 * Set the list of multicast addresses to filter on an Ethernet device.
4292 * The port identifier of the Ethernet device.
4293 * @param mc_addr_set
4294 * The array of multicast addresses to set. Equal to NULL when the function
4295 * is invoked to flush the set of filtered addresses.
4297 * The number of multicast addresses in the *mc_addr_set* array. Equal to 0
4298 * when the function is invoked to flush the set of filtered addresses.
4300 * - (0) if successful.
4301 * - (-ENODEV) if *port_id* invalid.
4302 * - (-ENOTSUP) if PMD of *port_id* doesn't support multicast filtering.
4303 * - (-ENOSPC) if *port_id* has not enough multicast filtering resources.
4305 int rte_eth_dev_set_mc_addr_list(uint8_t port_id,
4306 struct ether_addr *mc_addr_set,
4307 uint32_t nb_mc_addr);
4310 * Enable IEEE1588/802.1AS timestamping for an Ethernet device.
4313 * The port identifier of the Ethernet device.
4317 * - -ENODEV: The port ID is invalid.
4318 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4320 int rte_eth_timesync_enable(uint8_t port_id);
4323 * Disable IEEE1588/802.1AS timestamping for an Ethernet device.
4326 * The port identifier of the Ethernet device.
4330 * - -ENODEV: The port ID is invalid.
4331 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4333 int rte_eth_timesync_disable(uint8_t port_id);
4336 * Read an IEEE1588/802.1AS RX timestamp from an Ethernet device.
4339 * The port identifier of the Ethernet device.
4341 * Pointer to the timestamp struct.
4343 * Device specific flags. Used to pass the RX timesync register index to
4344 * i40e. Unused in igb/ixgbe, pass 0 instead.
4348 * - -EINVAL: No timestamp is available.
4349 * - -ENODEV: The port ID is invalid.
4350 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4352 int rte_eth_timesync_read_rx_timestamp(uint8_t port_id,
4353 struct timespec *timestamp, uint32_t flags);
4356 * Read an IEEE1588/802.1AS TX timestamp from an Ethernet device.
4359 * The port identifier of the Ethernet device.
4361 * Pointer to the timestamp struct.
4365 * - -EINVAL: No timestamp is available.
4366 * - -ENODEV: The port ID is invalid.
4367 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4369 int rte_eth_timesync_read_tx_timestamp(uint8_t port_id,
4370 struct timespec *timestamp);
4373 * Adjust the timesync clock on an Ethernet device.
4375 * This is usually used in conjunction with other Ethdev timesync functions to
4376 * synchronize the device time using the IEEE1588/802.1AS protocol.
4379 * The port identifier of the Ethernet device.
4381 * The adjustment in nanoseconds.
4385 * - -ENODEV: The port ID is invalid.
4386 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4388 int rte_eth_timesync_adjust_time(uint8_t port_id, int64_t delta);
4391 * Read the time from the timesync clock on an Ethernet device.
4393 * This is usually used in conjunction with other Ethdev timesync functions to
4394 * synchronize the device time using the IEEE1588/802.1AS protocol.
4397 * The port identifier of the Ethernet device.
4399 * Pointer to the timespec struct that holds the time.
4404 int rte_eth_timesync_read_time(uint8_t port_id, struct timespec *time);
4407 * Set the time of the timesync clock on an Ethernet device.
4409 * This is usually used in conjunction with other Ethdev timesync functions to
4410 * synchronize the device time using the IEEE1588/802.1AS protocol.
4413 * The port identifier of the Ethernet device.
4415 * Pointer to the timespec struct that holds the time.
4419 * - -EINVAL: No timestamp is available.
4420 * - -ENODEV: The port ID is invalid.
4421 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4423 int rte_eth_timesync_write_time(uint8_t port_id, const struct timespec *time);
4426 * Create memzone for HW rings.
4427 * malloc can't be used as the physical address is needed.
4428 * If the memzone is already created, then this function returns a ptr
4432 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
4434 * The name of the memory zone
4436 * The index of the queue to add to name
4438 * The sizeof of the memory area
4440 * Alignment for resulting memzone. Must be a power of 2.
4442 * The *socket_id* argument is the socket identifier in case of NUMA.
4444 const struct rte_memzone *
4445 rte_eth_dma_zone_reserve(const struct rte_eth_dev *eth_dev, const char *name,
4446 uint16_t queue_id, size_t size,
4447 unsigned align, int socket_id);
4450 * Config l2 tunnel ether type of an Ethernet device for filtering specific
4451 * tunnel packets by ether type.
4454 * The port identifier of the Ethernet device.
4456 * l2 tunnel configuration.
4459 * - (0) if successful.
4460 * - (-ENODEV) if port identifier is invalid.
4461 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4464 rte_eth_dev_l2_tunnel_eth_type_conf(uint8_t port_id,
4465 struct rte_eth_l2_tunnel_conf *l2_tunnel);
4468 * Enable/disable l2 tunnel offload functions. Include,
4469 * 1, The ability of parsing a type of l2 tunnel of an Ethernet device.
4470 * Filtering, forwarding and offloading this type of tunnel packets depend on
4472 * 2, Stripping the l2 tunnel tag.
4473 * 3, Insertion of the l2 tunnel tag.
4474 * 4, Forwarding the packets based on the l2 tunnel tag.
4477 * The port identifier of the Ethernet device.
4479 * l2 tunnel parameters.
4481 * Indicate the offload function.
4483 * Enable or disable this function.
4486 * - (0) if successful.
4487 * - (-ENODEV) if port identifier is invalid.
4488 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4491 rte_eth_dev_l2_tunnel_offload_set(uint8_t port_id,
4492 struct rte_eth_l2_tunnel_conf *l2_tunnel,
4497 * Get the port id from pci adrress or device name
4498 * Ex: 0000:2:00.0 or vdev name net_pcap0
4501 * pci address or name of the device
4503 * pointer to port identifier of the device
4505 * - (0) if successful.
4506 * - (-ENODEV or -EINVAL) on failure.
4509 rte_eth_dev_get_port_by_name(const char *name, uint8_t *port_id);
4512 * Get the device name from port id
4515 * pointer to port identifier of the device
4517 * pci address or name of the device
4519 * - (0) if successful.
4520 * - (-EINVAL) on failure.
4523 rte_eth_dev_get_name_by_port(uint8_t port_id, char *name);
4529 #endif /* _RTE_ETHDEV_H_ */