4 * Copyright(c) 2010-2017 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 * before 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 describe a vlan filter.
378 * If the bit corresponding to a VID is set, such VID is on.
380 struct rte_vlan_filter_conf {
385 * A structure used to configure the Receive Side Scaling (RSS) feature
386 * of an Ethernet port.
387 * If not NULL, the *rss_key* pointer of the *rss_conf* structure points
388 * to an array holding the RSS key to use for hashing specific header
389 * fields of received packets. The length of this array should be indicated
390 * by *rss_key_len* below. Otherwise, a default random hash key is used by
393 * The *rss_key_len* field of the *rss_conf* structure indicates the length
394 * in bytes of the array pointed by *rss_key*. To be compatible, this length
395 * will be checked in i40e only. Others assume 40 bytes to be used as before.
397 * The *rss_hf* field of the *rss_conf* structure indicates the different
398 * types of IPv4/IPv6 packets to which the RSS hashing must be applied.
399 * Supplying an *rss_hf* equal to zero disables the RSS feature.
401 struct rte_eth_rss_conf {
402 uint8_t *rss_key; /**< If not NULL, 40-byte hash key. */
403 uint8_t rss_key_len; /**< hash key length in bytes. */
404 uint64_t rss_hf; /**< Hash functions to apply - see below. */
408 * The RSS offload types are defined based on flow types which are defined
409 * in rte_eth_ctrl.h. Different NIC hardwares may support different RSS offload
410 * types. The supported flow types or RSS offload types can be queried by
411 * rte_eth_dev_info_get().
413 #define ETH_RSS_IPV4 (1ULL << RTE_ETH_FLOW_IPV4)
414 #define ETH_RSS_FRAG_IPV4 (1ULL << RTE_ETH_FLOW_FRAG_IPV4)
415 #define ETH_RSS_NONFRAG_IPV4_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_TCP)
416 #define ETH_RSS_NONFRAG_IPV4_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_UDP)
417 #define ETH_RSS_NONFRAG_IPV4_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_SCTP)
418 #define ETH_RSS_NONFRAG_IPV4_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_OTHER)
419 #define ETH_RSS_IPV6 (1ULL << RTE_ETH_FLOW_IPV6)
420 #define ETH_RSS_FRAG_IPV6 (1ULL << RTE_ETH_FLOW_FRAG_IPV6)
421 #define ETH_RSS_NONFRAG_IPV6_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_TCP)
422 #define ETH_RSS_NONFRAG_IPV6_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_UDP)
423 #define ETH_RSS_NONFRAG_IPV6_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_SCTP)
424 #define ETH_RSS_NONFRAG_IPV6_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_OTHER)
425 #define ETH_RSS_L2_PAYLOAD (1ULL << RTE_ETH_FLOW_L2_PAYLOAD)
426 #define ETH_RSS_IPV6_EX (1ULL << RTE_ETH_FLOW_IPV6_EX)
427 #define ETH_RSS_IPV6_TCP_EX (1ULL << RTE_ETH_FLOW_IPV6_TCP_EX)
428 #define ETH_RSS_IPV6_UDP_EX (1ULL << RTE_ETH_FLOW_IPV6_UDP_EX)
429 #define ETH_RSS_PORT (1ULL << RTE_ETH_FLOW_PORT)
430 #define ETH_RSS_VXLAN (1ULL << RTE_ETH_FLOW_VXLAN)
431 #define ETH_RSS_GENEVE (1ULL << RTE_ETH_FLOW_GENEVE)
432 #define ETH_RSS_NVGRE (1ULL << RTE_ETH_FLOW_NVGRE)
434 #define ETH_RSS_IP ( \
436 ETH_RSS_FRAG_IPV4 | \
437 ETH_RSS_NONFRAG_IPV4_OTHER | \
439 ETH_RSS_FRAG_IPV6 | \
440 ETH_RSS_NONFRAG_IPV6_OTHER | \
443 #define ETH_RSS_UDP ( \
444 ETH_RSS_NONFRAG_IPV4_UDP | \
445 ETH_RSS_NONFRAG_IPV6_UDP | \
448 #define ETH_RSS_TCP ( \
449 ETH_RSS_NONFRAG_IPV4_TCP | \
450 ETH_RSS_NONFRAG_IPV6_TCP | \
453 #define ETH_RSS_SCTP ( \
454 ETH_RSS_NONFRAG_IPV4_SCTP | \
455 ETH_RSS_NONFRAG_IPV6_SCTP)
457 #define ETH_RSS_TUNNEL ( \
463 /**< Mask of valid RSS hash protocols */
464 #define ETH_RSS_PROTO_MASK ( \
466 ETH_RSS_FRAG_IPV4 | \
467 ETH_RSS_NONFRAG_IPV4_TCP | \
468 ETH_RSS_NONFRAG_IPV4_UDP | \
469 ETH_RSS_NONFRAG_IPV4_SCTP | \
470 ETH_RSS_NONFRAG_IPV4_OTHER | \
472 ETH_RSS_FRAG_IPV6 | \
473 ETH_RSS_NONFRAG_IPV6_TCP | \
474 ETH_RSS_NONFRAG_IPV6_UDP | \
475 ETH_RSS_NONFRAG_IPV6_SCTP | \
476 ETH_RSS_NONFRAG_IPV6_OTHER | \
477 ETH_RSS_L2_PAYLOAD | \
479 ETH_RSS_IPV6_TCP_EX | \
480 ETH_RSS_IPV6_UDP_EX | \
487 * Definitions used for redirection table entry size.
488 * Some RSS RETA sizes may not be supported by some drivers, check the
489 * documentation or the description of relevant functions for more details.
491 #define ETH_RSS_RETA_SIZE_64 64
492 #define ETH_RSS_RETA_SIZE_128 128
493 #define ETH_RSS_RETA_SIZE_256 256
494 #define ETH_RSS_RETA_SIZE_512 512
495 #define RTE_RETA_GROUP_SIZE 64
497 /* Definitions used for VMDQ and DCB functionality */
498 #define ETH_VMDQ_MAX_VLAN_FILTERS 64 /**< Maximum nb. of VMDQ vlan filters. */
499 #define ETH_DCB_NUM_USER_PRIORITIES 8 /**< Maximum nb. of DCB priorities. */
500 #define ETH_VMDQ_DCB_NUM_QUEUES 128 /**< Maximum nb. of VMDQ DCB queues. */
501 #define ETH_DCB_NUM_QUEUES 128 /**< Maximum nb. of DCB queues. */
503 /* DCB capability defines */
504 #define ETH_DCB_PG_SUPPORT 0x00000001 /**< Priority Group(ETS) support. */
505 #define ETH_DCB_PFC_SUPPORT 0x00000002 /**< Priority Flow Control support. */
507 /* Definitions used for VLAN Offload functionality */
508 #define ETH_VLAN_STRIP_OFFLOAD 0x0001 /**< VLAN Strip On/Off */
509 #define ETH_VLAN_FILTER_OFFLOAD 0x0002 /**< VLAN Filter On/Off */
510 #define ETH_VLAN_EXTEND_OFFLOAD 0x0004 /**< VLAN Extend On/Off */
512 /* Definitions used for mask VLAN setting */
513 #define ETH_VLAN_STRIP_MASK 0x0001 /**< VLAN Strip setting mask */
514 #define ETH_VLAN_FILTER_MASK 0x0002 /**< VLAN Filter setting mask*/
515 #define ETH_VLAN_EXTEND_MASK 0x0004 /**< VLAN Extend setting mask*/
516 #define ETH_VLAN_ID_MAX 0x0FFF /**< VLAN ID is in lower 12 bits*/
518 /* Definitions used for receive MAC address */
519 #define ETH_NUM_RECEIVE_MAC_ADDR 128 /**< Maximum nb. of receive mac addr. */
521 /* Definitions used for unicast hash */
522 #define ETH_VMDQ_NUM_UC_HASH_ARRAY 128 /**< Maximum nb. of UC hash array. */
524 /* Definitions used for VMDQ pool rx mode setting */
525 #define ETH_VMDQ_ACCEPT_UNTAG 0x0001 /**< accept untagged packets. */
526 #define ETH_VMDQ_ACCEPT_HASH_MC 0x0002 /**< accept packets in multicast table . */
527 #define ETH_VMDQ_ACCEPT_HASH_UC 0x0004 /**< accept packets in unicast table. */
528 #define ETH_VMDQ_ACCEPT_BROADCAST 0x0008 /**< accept broadcast packets. */
529 #define ETH_VMDQ_ACCEPT_MULTICAST 0x0010 /**< multicast promiscuous. */
531 /** Maximum nb. of vlan per mirror rule */
532 #define ETH_MIRROR_MAX_VLANS 64
534 #define ETH_MIRROR_VIRTUAL_POOL_UP 0x01 /**< Virtual Pool uplink Mirroring. */
535 #define ETH_MIRROR_UPLINK_PORT 0x02 /**< Uplink Port Mirroring. */
536 #define ETH_MIRROR_DOWNLINK_PORT 0x04 /**< Downlink Port Mirroring. */
537 #define ETH_MIRROR_VLAN 0x08 /**< VLAN Mirroring. */
538 #define ETH_MIRROR_VIRTUAL_POOL_DOWN 0x10 /**< Virtual Pool downlink Mirroring. */
541 * A structure used to configure VLAN traffic mirror of an Ethernet port.
543 struct rte_eth_vlan_mirror {
544 uint64_t vlan_mask; /**< mask for valid VLAN ID. */
545 /** VLAN ID list for vlan mirroring. */
546 uint16_t vlan_id[ETH_MIRROR_MAX_VLANS];
550 * A structure used to configure traffic mirror of an Ethernet port.
552 struct rte_eth_mirror_conf {
553 uint8_t rule_type; /**< Mirroring rule type */
554 uint8_t dst_pool; /**< Destination pool for this mirror rule. */
555 uint64_t pool_mask; /**< Bitmap of pool for pool mirroring */
556 /** VLAN ID setting for VLAN mirroring. */
557 struct rte_eth_vlan_mirror vlan;
561 * A structure used to configure 64 entries of Redirection Table of the
562 * Receive Side Scaling (RSS) feature of an Ethernet port. To configure
563 * more than 64 entries supported by hardware, an array of this structure
566 struct rte_eth_rss_reta_entry64 {
568 /**< Mask bits indicate which entries need to be updated/queried. */
569 uint16_t reta[RTE_RETA_GROUP_SIZE];
570 /**< Group of 64 redirection table entries. */
574 * This enum indicates the possible number of traffic classes
575 * in DCB configurations
577 enum rte_eth_nb_tcs {
578 ETH_4_TCS = 4, /**< 4 TCs with DCB. */
579 ETH_8_TCS = 8 /**< 8 TCs with DCB. */
583 * This enum indicates the possible number of queue pools
584 * in VMDQ configurations.
586 enum rte_eth_nb_pools {
587 ETH_8_POOLS = 8, /**< 8 VMDq pools. */
588 ETH_16_POOLS = 16, /**< 16 VMDq pools. */
589 ETH_32_POOLS = 32, /**< 32 VMDq pools. */
590 ETH_64_POOLS = 64 /**< 64 VMDq pools. */
593 /* This structure may be extended in future. */
594 struct rte_eth_dcb_rx_conf {
595 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs */
596 /** Traffic class each UP mapped to. */
597 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
600 struct rte_eth_vmdq_dcb_tx_conf {
601 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools. */
602 /** Traffic class each UP mapped to. */
603 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
606 struct rte_eth_dcb_tx_conf {
607 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs. */
608 /** Traffic class each UP mapped to. */
609 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
612 struct rte_eth_vmdq_tx_conf {
613 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq mode, 64 pools. */
617 * A structure used to configure the VMDQ+DCB feature
618 * of an Ethernet port.
620 * Using this feature, packets are routed to a pool of queues, based
621 * on the vlan id in the vlan tag, and then to a specific queue within
622 * that pool, using the user priority vlan tag field.
624 * A default pool may be used, if desired, to route all traffic which
625 * does not match the vlan filter rules.
627 struct rte_eth_vmdq_dcb_conf {
628 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools */
629 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
630 uint8_t default_pool; /**< The default pool, if applicable */
631 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
633 uint16_t vlan_id; /**< The vlan id of the received frame */
634 uint64_t pools; /**< Bitmask of pools for packet rx */
635 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
636 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
637 /**< Selects a queue in a pool */
640 struct rte_eth_vmdq_rx_conf {
641 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq only mode, 8 or 64 pools */
642 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
643 uint8_t default_pool; /**< The default pool, if applicable */
644 uint8_t enable_loop_back; /**< Enable VT loop back */
645 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
646 uint32_t rx_mode; /**< Flags from ETH_VMDQ_ACCEPT_* */
648 uint16_t vlan_id; /**< The vlan id of the received frame */
649 uint64_t pools; /**< Bitmask of pools for packet rx */
650 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
654 * A structure used to configure the TX features of an Ethernet port.
656 struct rte_eth_txmode {
657 enum rte_eth_tx_mq_mode mq_mode; /**< TX multi-queues mode. */
659 /* For i40e specifically */
662 uint8_t hw_vlan_reject_tagged : 1,
663 /**< If set, reject sending out tagged pkts */
664 hw_vlan_reject_untagged : 1,
665 /**< If set, reject sending out untagged pkts */
666 hw_vlan_insert_pvid : 1;
667 /**< If set, enable port based VLAN insertion */
671 * A structure used to configure an RX ring of an Ethernet port.
673 struct rte_eth_rxconf {
674 struct rte_eth_thresh rx_thresh; /**< RX ring threshold registers. */
675 uint16_t rx_free_thresh; /**< Drives the freeing of RX descriptors. */
676 uint8_t rx_drop_en; /**< Drop packets if no descriptors are available. */
677 uint8_t rx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
680 #define ETH_TXQ_FLAGS_NOMULTSEGS 0x0001 /**< nb_segs=1 for all mbufs */
681 #define ETH_TXQ_FLAGS_NOREFCOUNT 0x0002 /**< refcnt can be ignored */
682 #define ETH_TXQ_FLAGS_NOMULTMEMP 0x0004 /**< all bufs come from same mempool */
683 #define ETH_TXQ_FLAGS_NOVLANOFFL 0x0100 /**< disable VLAN offload */
684 #define ETH_TXQ_FLAGS_NOXSUMSCTP 0x0200 /**< disable SCTP checksum offload */
685 #define ETH_TXQ_FLAGS_NOXSUMUDP 0x0400 /**< disable UDP checksum offload */
686 #define ETH_TXQ_FLAGS_NOXSUMTCP 0x0800 /**< disable TCP checksum offload */
687 #define ETH_TXQ_FLAGS_NOOFFLOADS \
688 (ETH_TXQ_FLAGS_NOVLANOFFL | ETH_TXQ_FLAGS_NOXSUMSCTP | \
689 ETH_TXQ_FLAGS_NOXSUMUDP | ETH_TXQ_FLAGS_NOXSUMTCP)
690 #define ETH_TXQ_FLAGS_NOXSUMS \
691 (ETH_TXQ_FLAGS_NOXSUMSCTP | ETH_TXQ_FLAGS_NOXSUMUDP | \
692 ETH_TXQ_FLAGS_NOXSUMTCP)
694 * A structure used to configure a TX ring of an Ethernet port.
696 struct rte_eth_txconf {
697 struct rte_eth_thresh tx_thresh; /**< TX ring threshold registers. */
698 uint16_t tx_rs_thresh; /**< Drives the setting of RS bit on TXDs. */
699 uint16_t tx_free_thresh; /**< Start freeing TX buffers if there are
700 less free descriptors than this value. */
702 uint32_t txq_flags; /**< Set flags for the Tx queue */
703 uint8_t tx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
707 * A structure contains information about HW descriptor ring limitations.
709 struct rte_eth_desc_lim {
710 uint16_t nb_max; /**< Max allowed number of descriptors. */
711 uint16_t nb_min; /**< Min allowed number of descriptors. */
712 uint16_t nb_align; /**< Number of descriptors should be aligned to. */
715 * Max allowed number of segments per whole packet.
717 * - For TSO packet this is the total number of data descriptors allowed
720 * @see nb_mtu_seg_max
725 * Max number of segments per one MTU.
727 * - For non-TSO packet, this is the maximum allowed number of segments
728 * in a single transmit packet.
730 * - For TSO packet each segment within the TSO may span up to this
735 uint16_t nb_mtu_seg_max;
739 * This enum indicates the flow control mode
741 enum rte_eth_fc_mode {
742 RTE_FC_NONE = 0, /**< Disable flow control. */
743 RTE_FC_RX_PAUSE, /**< RX pause frame, enable flowctrl on TX side. */
744 RTE_FC_TX_PAUSE, /**< TX pause frame, enable flowctrl on RX side. */
745 RTE_FC_FULL /**< Enable flow control on both side. */
749 * A structure used to configure Ethernet flow control parameter.
750 * These parameters will be configured into the register of the NIC.
751 * Please refer to the corresponding data sheet for proper value.
753 struct rte_eth_fc_conf {
754 uint32_t high_water; /**< High threshold value to trigger XOFF */
755 uint32_t low_water; /**< Low threshold value to trigger XON */
756 uint16_t pause_time; /**< Pause quota in the Pause frame */
757 uint16_t send_xon; /**< Is XON frame need be sent */
758 enum rte_eth_fc_mode mode; /**< Link flow control mode */
759 uint8_t mac_ctrl_frame_fwd; /**< Forward MAC control frames */
760 uint8_t autoneg; /**< Use Pause autoneg */
764 * A structure used to configure Ethernet priority flow control parameter.
765 * These parameters will be configured into the register of the NIC.
766 * Please refer to the corresponding data sheet for proper value.
768 struct rte_eth_pfc_conf {
769 struct rte_eth_fc_conf fc; /**< General flow control parameter. */
770 uint8_t priority; /**< VLAN User Priority. */
774 * Memory space that can be configured to store Flow Director filters
775 * in the board memory.
777 enum rte_fdir_pballoc_type {
778 RTE_FDIR_PBALLOC_64K = 0, /**< 64k. */
779 RTE_FDIR_PBALLOC_128K, /**< 128k. */
780 RTE_FDIR_PBALLOC_256K, /**< 256k. */
784 * Select report mode of FDIR hash information in RX descriptors.
786 enum rte_fdir_status_mode {
787 RTE_FDIR_NO_REPORT_STATUS = 0, /**< Never report FDIR hash. */
788 RTE_FDIR_REPORT_STATUS, /**< Only report FDIR hash for matching pkts. */
789 RTE_FDIR_REPORT_STATUS_ALWAYS, /**< Always report FDIR hash. */
793 * A structure used to configure the Flow Director (FDIR) feature
794 * of an Ethernet port.
796 * If mode is RTE_FDIR_DISABLE, the pballoc value is ignored.
798 struct rte_fdir_conf {
799 enum rte_fdir_mode mode; /**< Flow Director mode. */
800 enum rte_fdir_pballoc_type pballoc; /**< Space for FDIR filters. */
801 enum rte_fdir_status_mode status; /**< How to report FDIR hash. */
802 /** RX queue of packets matching a "drop" filter in perfect mode. */
804 struct rte_eth_fdir_masks mask;
805 struct rte_eth_fdir_flex_conf flex_conf;
806 /**< Flex payload configuration. */
810 * UDP tunneling configuration.
811 * Used to config the UDP port for a type of tunnel.
812 * NICs need the UDP port to identify the tunnel type.
813 * Normally a type of tunnel has a default UDP port, this structure can be used
814 * in case if the users want to change or support more UDP port.
816 struct rte_eth_udp_tunnel {
817 uint16_t udp_port; /**< UDP port used for the tunnel. */
818 uint8_t prot_type; /**< Tunnel type. Defined in rte_eth_tunnel_type. */
822 * A structure used to enable/disable specific device interrupts.
824 struct rte_intr_conf {
825 /** enable/disable lsc interrupt. 0 (default) - disable, 1 enable */
827 /** enable/disable rxq interrupt. 0 (default) - disable, 1 enable */
829 /** enable/disable rmv interrupt. 0 (default) - disable, 1 enable */
834 * A structure used to configure an Ethernet port.
835 * Depending upon the RX multi-queue mode, extra advanced
836 * configuration settings may be needed.
838 struct rte_eth_conf {
839 uint32_t link_speeds; /**< bitmap of ETH_LINK_SPEED_XXX of speeds to be
840 used. ETH_LINK_SPEED_FIXED disables link
841 autonegotiation, and a unique speed shall be
842 set. Otherwise, the bitmap defines the set of
843 speeds to be advertised. If the special value
844 ETH_LINK_SPEED_AUTONEG (0) is used, all speeds
845 supported are advertised. */
846 struct rte_eth_rxmode rxmode; /**< Port RX configuration. */
847 struct rte_eth_txmode txmode; /**< Port TX configuration. */
848 uint32_t lpbk_mode; /**< Loopback operation mode. By default the value
849 is 0, meaning the loopback mode is disabled.
850 Read the datasheet of given ethernet controller
851 for details. The possible values of this field
852 are defined in implementation of each driver. */
854 struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
855 struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
856 /**< Port vmdq+dcb configuration. */
857 struct rte_eth_dcb_rx_conf dcb_rx_conf;
858 /**< Port dcb RX configuration. */
859 struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
860 /**< Port vmdq RX configuration. */
861 } rx_adv_conf; /**< Port RX filtering configuration (union). */
863 struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
864 /**< Port vmdq+dcb TX configuration. */
865 struct rte_eth_dcb_tx_conf dcb_tx_conf;
866 /**< Port dcb TX configuration. */
867 struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
868 /**< Port vmdq TX configuration. */
869 } tx_adv_conf; /**< Port TX DCB configuration (union). */
870 /** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
871 is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
872 uint32_t dcb_capability_en;
873 struct rte_fdir_conf fdir_conf; /**< FDIR configuration. */
874 struct rte_intr_conf intr_conf; /**< Interrupt mode configuration. */
878 * A structure used to retrieve the contextual information of
879 * an Ethernet device, such as the controlling driver of the device,
880 * its PCI context, etc...
884 * RX offload capabilities of a device.
886 #define DEV_RX_OFFLOAD_VLAN_STRIP 0x00000001
887 #define DEV_RX_OFFLOAD_IPV4_CKSUM 0x00000002
888 #define DEV_RX_OFFLOAD_UDP_CKSUM 0x00000004
889 #define DEV_RX_OFFLOAD_TCP_CKSUM 0x00000008
890 #define DEV_RX_OFFLOAD_TCP_LRO 0x00000010
891 #define DEV_RX_OFFLOAD_QINQ_STRIP 0x00000020
892 #define DEV_RX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000040
893 #define DEV_RX_OFFLOAD_MACSEC_STRIP 0x00000080
896 * TX offload capabilities of a device.
898 #define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001
899 #define DEV_TX_OFFLOAD_IPV4_CKSUM 0x00000002
900 #define DEV_TX_OFFLOAD_UDP_CKSUM 0x00000004
901 #define DEV_TX_OFFLOAD_TCP_CKSUM 0x00000008
902 #define DEV_TX_OFFLOAD_SCTP_CKSUM 0x00000010
903 #define DEV_TX_OFFLOAD_TCP_TSO 0x00000020
904 #define DEV_TX_OFFLOAD_UDP_TSO 0x00000040
905 #define DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000080 /**< Used for tunneling packet. */
906 #define DEV_TX_OFFLOAD_QINQ_INSERT 0x00000100
907 #define DEV_TX_OFFLOAD_VXLAN_TNL_TSO 0x00000200 /**< Used for tunneling packet. */
908 #define DEV_TX_OFFLOAD_GRE_TNL_TSO 0x00000400 /**< Used for tunneling packet. */
909 #define DEV_TX_OFFLOAD_IPIP_TNL_TSO 0x00000800 /**< Used for tunneling packet. */
910 #define DEV_TX_OFFLOAD_GENEVE_TNL_TSO 0x00001000 /**< Used for tunneling packet. */
911 #define DEV_TX_OFFLOAD_MACSEC_INSERT 0x00002000
913 struct rte_pci_device;
916 * Ethernet device information
918 struct rte_eth_dev_info {
919 struct rte_pci_device *pci_dev; /**< Device PCI information. */
920 const char *driver_name; /**< Device Driver name. */
921 unsigned int if_index; /**< Index to bound host interface, or 0 if none.
922 Use if_indextoname() to translate into an interface name. */
923 uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
924 uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
925 uint16_t max_rx_queues; /**< Maximum number of RX queues. */
926 uint16_t max_tx_queues; /**< Maximum number of TX queues. */
927 uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
928 uint32_t max_hash_mac_addrs;
929 /** Maximum number of hash MAC addresses for MTA and UTA. */
930 uint16_t max_vfs; /**< Maximum number of VFs. */
931 uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
932 uint32_t rx_offload_capa; /**< Device RX offload capabilities. */
933 uint32_t tx_offload_capa; /**< Device TX offload capabilities. */
935 /**< Device redirection table size, the total number of entries. */
936 uint8_t hash_key_size; /**< Hash key size in bytes */
937 /** Bit mask of RSS offloads, the bit offset also means flow type */
938 uint64_t flow_type_rss_offloads;
939 struct rte_eth_rxconf default_rxconf; /**< Default RX configuration */
940 struct rte_eth_txconf default_txconf; /**< Default TX configuration */
941 uint16_t vmdq_queue_base; /**< First queue ID for VMDQ pools. */
942 uint16_t vmdq_queue_num; /**< Queue number for VMDQ pools. */
943 uint16_t vmdq_pool_base; /**< First ID of VMDQ pools. */
944 struct rte_eth_desc_lim rx_desc_lim; /**< RX descriptors limits */
945 struct rte_eth_desc_lim tx_desc_lim; /**< TX descriptors limits */
946 uint32_t speed_capa; /**< Supported speeds bitmap (ETH_LINK_SPEED_). */
947 /** Configured number of rx/tx queues */
948 uint16_t nb_rx_queues; /**< Number of RX queues. */
949 uint16_t nb_tx_queues; /**< Number of TX queues. */
953 * Ethernet device RX queue information structure.
954 * Used to retieve information about configured queue.
956 struct rte_eth_rxq_info {
957 struct rte_mempool *mp; /**< mempool used by that queue. */
958 struct rte_eth_rxconf conf; /**< queue config parameters. */
959 uint8_t scattered_rx; /**< scattered packets RX supported. */
960 uint16_t nb_desc; /**< configured number of RXDs. */
961 } __rte_cache_min_aligned;
964 * Ethernet device TX queue information structure.
965 * Used to retieve information about configured queue.
967 struct rte_eth_txq_info {
968 struct rte_eth_txconf conf; /**< queue config parameters. */
969 uint16_t nb_desc; /**< configured number of TXDs. */
970 } __rte_cache_min_aligned;
972 /** Maximum name length for extended statistics counters */
973 #define RTE_ETH_XSTATS_NAME_SIZE 64
976 * An Ethernet device extended statistic structure
978 * This structure is used by rte_eth_xstats_get() to provide
979 * statistics that are not provided in the generic *rte_eth_stats*
981 * It maps a name id, corresponding to an index in the array returned
982 * by rte_eth_xstats_get_names(), to a statistic value.
984 struct rte_eth_xstat {
985 uint64_t id; /**< The index in xstats name array. */
986 uint64_t value; /**< The statistic counter value. */
990 * A name element for extended statistics.
992 * An array of this structure is returned by rte_eth_xstats_get_names().
993 * It lists the names of extended statistics for a PMD. The *rte_eth_xstat*
994 * structure references these names by their array index.
996 struct rte_eth_xstat_name {
997 char name[RTE_ETH_XSTATS_NAME_SIZE]; /**< The statistic name. */
1000 #define ETH_DCB_NUM_TCS 8
1001 #define ETH_MAX_VMDQ_POOL 64
1004 * A structure used to get the information of queue and
1005 * TC mapping on both TX and RX paths.
1007 struct rte_eth_dcb_tc_queue_mapping {
1008 /** rx queues assigned to tc per Pool */
1012 } tc_rxq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
1013 /** rx queues assigned to tc per Pool */
1017 } tc_txq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
1021 * A structure used to get the information of DCB.
1022 * It includes TC UP mapping and queue TC mapping.
1024 struct rte_eth_dcb_info {
1025 uint8_t nb_tcs; /**< number of TCs */
1026 uint8_t prio_tc[ETH_DCB_NUM_USER_PRIORITIES]; /**< Priority to tc */
1027 uint8_t tc_bws[ETH_DCB_NUM_TCS]; /**< TX BW percentage for each TC */
1028 /** rx queues assigned to tc */
1029 struct rte_eth_dcb_tc_queue_mapping tc_queue;
1033 * RX/TX queue states
1035 #define RTE_ETH_QUEUE_STATE_STOPPED 0
1036 #define RTE_ETH_QUEUE_STATE_STARTED 1
1040 struct rte_eth_dev_callback;
1041 /** @internal Structure to keep track of registered callbacks */
1042 TAILQ_HEAD(rte_eth_dev_cb_list, rte_eth_dev_callback);
1044 /* Macros to check for valid port */
1045 #define RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, retval) do { \
1046 if (!rte_eth_dev_is_valid_port(port_id)) { \
1047 RTE_PMD_DEBUG_TRACE("Invalid port_id=%d\n", port_id); \
1052 #define RTE_ETH_VALID_PORTID_OR_RET(port_id) do { \
1053 if (!rte_eth_dev_is_valid_port(port_id)) { \
1054 RTE_PMD_DEBUG_TRACE("Invalid port_id=%d\n", port_id); \
1059 #define RTE_ETH_DEV_TO_PCI(eth_dev) RTE_DEV_TO_PCI((eth_dev)->device)
1062 * l2 tunnel configuration.
1065 /**< l2 tunnel enable mask */
1066 #define ETH_L2_TUNNEL_ENABLE_MASK 0x00000001
1067 /**< l2 tunnel insertion mask */
1068 #define ETH_L2_TUNNEL_INSERTION_MASK 0x00000002
1069 /**< l2 tunnel stripping mask */
1070 #define ETH_L2_TUNNEL_STRIPPING_MASK 0x00000004
1071 /**< l2 tunnel forwarding mask */
1072 #define ETH_L2_TUNNEL_FORWARDING_MASK 0x00000008
1075 * Definitions of all functions exported by an Ethernet driver through the
1076 * the generic structure of type *eth_dev_ops* supplied in the *rte_eth_dev*
1077 * structure associated with an Ethernet device.
1080 typedef int (*eth_dev_configure_t)(struct rte_eth_dev *dev);
1081 /**< @internal Ethernet device configuration. */
1083 typedef int (*eth_dev_start_t)(struct rte_eth_dev *dev);
1084 /**< @internal Function used to start a configured Ethernet device. */
1086 typedef void (*eth_dev_stop_t)(struct rte_eth_dev *dev);
1087 /**< @internal Function used to stop a configured Ethernet device. */
1089 typedef int (*eth_dev_set_link_up_t)(struct rte_eth_dev *dev);
1090 /**< @internal Function used to link up a configured Ethernet device. */
1092 typedef int (*eth_dev_set_link_down_t)(struct rte_eth_dev *dev);
1093 /**< @internal Function used to link down a configured Ethernet device. */
1095 typedef void (*eth_dev_close_t)(struct rte_eth_dev *dev);
1096 /**< @internal Function used to close a configured Ethernet device. */
1098 typedef void (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev);
1099 /**< @internal Function used to enable the RX promiscuous mode of an Ethernet device. */
1101 typedef void (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev);
1102 /**< @internal Function used to disable the RX promiscuous mode of an Ethernet device. */
1104 typedef void (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
1105 /**< @internal Enable the receipt of all multicast packets by an Ethernet device. */
1107 typedef void (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
1108 /**< @internal Disable the receipt of all multicast packets by an Ethernet device. */
1110 typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
1111 int wait_to_complete);
1112 /**< @internal Get link speed, duplex mode and state (up/down) of an Ethernet device. */
1114 typedef void (*eth_stats_get_t)(struct rte_eth_dev *dev,
1115 struct rte_eth_stats *igb_stats);
1116 /**< @internal Get global I/O statistics of an Ethernet device. */
1118 typedef void (*eth_stats_reset_t)(struct rte_eth_dev *dev);
1119 /**< @internal Reset global I/O statistics of an Ethernet device to 0. */
1121 typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev,
1122 struct rte_eth_xstat *stats, unsigned n);
1123 /**< @internal Get extended stats of an Ethernet device. */
1125 typedef int (*eth_xstats_get_by_id_t)(struct rte_eth_dev *dev,
1126 const uint64_t *ids,
1129 /**< @internal Get extended stats of an Ethernet device. */
1131 typedef void (*eth_xstats_reset_t)(struct rte_eth_dev *dev);
1132 /**< @internal Reset extended stats of an Ethernet device. */
1134 typedef int (*eth_xstats_get_names_t)(struct rte_eth_dev *dev,
1135 struct rte_eth_xstat_name *xstats_names, unsigned size);
1136 /**< @internal Get names of extended stats of an Ethernet device. */
1138 typedef int (*eth_xstats_get_names_by_id_t)(struct rte_eth_dev *dev,
1139 struct rte_eth_xstat_name *xstats_names, const uint64_t *ids,
1141 /**< @internal Get names of extended stats of an Ethernet device. */
1143 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
1147 /**< @internal Set a queue statistics mapping for a tx/rx queue of an Ethernet device. */
1149 typedef void (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
1150 struct rte_eth_dev_info *dev_info);
1151 /**< @internal Get specific informations of an Ethernet device. */
1153 typedef const uint32_t *(*eth_dev_supported_ptypes_get_t)(struct rte_eth_dev *dev);
1154 /**< @internal Get supported ptypes of an Ethernet device. */
1156 typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
1158 /**< @internal Start rx and tx of a queue of an Ethernet device. */
1160 typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
1162 /**< @internal Stop rx and tx of a queue of an Ethernet device. */
1164 typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
1165 uint16_t rx_queue_id,
1166 uint16_t nb_rx_desc,
1167 unsigned int socket_id,
1168 const struct rte_eth_rxconf *rx_conf,
1169 struct rte_mempool *mb_pool);
1170 /**< @internal Set up a receive queue of an Ethernet device. */
1172 typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
1173 uint16_t tx_queue_id,
1174 uint16_t nb_tx_desc,
1175 unsigned int socket_id,
1176 const struct rte_eth_txconf *tx_conf);
1177 /**< @internal Setup a transmit queue of an Ethernet device. */
1179 typedef int (*eth_rx_enable_intr_t)(struct rte_eth_dev *dev,
1180 uint16_t rx_queue_id);
1181 /**< @internal Enable interrupt of a receive queue of an Ethernet device. */
1183 typedef int (*eth_rx_disable_intr_t)(struct rte_eth_dev *dev,
1184 uint16_t rx_queue_id);
1185 /**< @internal Disable interrupt of a receive queue of an Ethernet device. */
1187 typedef void (*eth_queue_release_t)(void *queue);
1188 /**< @internal Release memory resources allocated by given RX/TX queue. */
1190 typedef uint32_t (*eth_rx_queue_count_t)(struct rte_eth_dev *dev,
1191 uint16_t rx_queue_id);
1192 /**< @internal Get number of used descriptors on a receive queue. */
1194 typedef int (*eth_rx_descriptor_done_t)(void *rxq, uint16_t offset);
1195 /**< @internal Check DD bit of specific RX descriptor */
1197 typedef int (*eth_rx_descriptor_status_t)(void *rxq, uint16_t offset);
1198 /**< @internal Check the status of a Rx descriptor */
1200 typedef int (*eth_tx_descriptor_status_t)(void *txq, uint16_t offset);
1201 /**< @internal Check the status of a Tx descriptor */
1203 typedef int (*eth_fw_version_get_t)(struct rte_eth_dev *dev,
1204 char *fw_version, size_t fw_size);
1205 /**< @internal Get firmware information of an Ethernet device. */
1207 typedef int (*eth_tx_done_cleanup_t)(void *txq, uint32_t free_cnt);
1208 /**< @internal Force mbufs to be from TX ring. */
1210 typedef void (*eth_rxq_info_get_t)(struct rte_eth_dev *dev,
1211 uint16_t rx_queue_id, struct rte_eth_rxq_info *qinfo);
1213 typedef void (*eth_txq_info_get_t)(struct rte_eth_dev *dev,
1214 uint16_t tx_queue_id, struct rte_eth_txq_info *qinfo);
1216 typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);
1217 /**< @internal Set MTU. */
1219 typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
1222 /**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */
1224 typedef int (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
1225 enum rte_vlan_type type, uint16_t tpid);
1226 /**< @internal set the outer/inner VLAN-TPID by an Ethernet device. */
1228 typedef void (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
1229 /**< @internal set VLAN offload function by an Ethernet device. */
1231 typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
1234 /**< @internal set port based TX VLAN insertion by an Ethernet device. */
1236 typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
1237 uint16_t rx_queue_id,
1239 /**< @internal VLAN stripping enable/disable by an queue of Ethernet device. */
1241 typedef uint16_t (*eth_rx_burst_t)(void *rxq,
1242 struct rte_mbuf **rx_pkts,
1244 /**< @internal Retrieve input packets from a receive queue of an Ethernet device. */
1246 typedef uint16_t (*eth_tx_burst_t)(void *txq,
1247 struct rte_mbuf **tx_pkts,
1249 /**< @internal Send output packets on a transmit queue of an Ethernet device. */
1251 typedef uint16_t (*eth_tx_prep_t)(void *txq,
1252 struct rte_mbuf **tx_pkts,
1254 /**< @internal Prepare output packets on a transmit queue of an Ethernet device. */
1256 typedef int (*flow_ctrl_get_t)(struct rte_eth_dev *dev,
1257 struct rte_eth_fc_conf *fc_conf);
1258 /**< @internal Get current flow control parameter on an Ethernet device */
1260 typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
1261 struct rte_eth_fc_conf *fc_conf);
1262 /**< @internal Setup flow control parameter on an Ethernet device */
1264 typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
1265 struct rte_eth_pfc_conf *pfc_conf);
1266 /**< @internal Setup priority flow control parameter on an Ethernet device */
1268 typedef int (*reta_update_t)(struct rte_eth_dev *dev,
1269 struct rte_eth_rss_reta_entry64 *reta_conf,
1270 uint16_t reta_size);
1271 /**< @internal Update RSS redirection table on an Ethernet device */
1273 typedef int (*reta_query_t)(struct rte_eth_dev *dev,
1274 struct rte_eth_rss_reta_entry64 *reta_conf,
1275 uint16_t reta_size);
1276 /**< @internal Query RSS redirection table on an Ethernet device */
1278 typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
1279 struct rte_eth_rss_conf *rss_conf);
1280 /**< @internal Update RSS hash configuration of an Ethernet device */
1282 typedef int (*rss_hash_conf_get_t)(struct rte_eth_dev *dev,
1283 struct rte_eth_rss_conf *rss_conf);
1284 /**< @internal Get current RSS hash configuration of an Ethernet device */
1286 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
1287 /**< @internal Turn on SW controllable LED on an Ethernet device */
1289 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
1290 /**< @internal Turn off SW controllable LED on an Ethernet device */
1292 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
1293 /**< @internal Remove MAC address from receive address register */
1295 typedef int (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
1296 struct ether_addr *mac_addr,
1299 /**< @internal Set a MAC address into Receive Address Address Register */
1301 typedef void (*eth_mac_addr_set_t)(struct rte_eth_dev *dev,
1302 struct ether_addr *mac_addr);
1303 /**< @internal Set a MAC address into Receive Address Address Register */
1305 typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
1306 struct ether_addr *mac_addr,
1308 /**< @internal Set a Unicast Hash bitmap */
1310 typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
1312 /**< @internal Set all Unicast Hash bitmap */
1314 typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
1317 /**< @internal Set queue TX rate */
1319 typedef int (*eth_mirror_rule_set_t)(struct rte_eth_dev *dev,
1320 struct rte_eth_mirror_conf *mirror_conf,
1323 /**< @internal Add a traffic mirroring rule on an Ethernet device */
1325 typedef int (*eth_mirror_rule_reset_t)(struct rte_eth_dev *dev,
1327 /**< @internal Remove a traffic mirroring rule on an Ethernet device */
1329 typedef int (*eth_udp_tunnel_port_add_t)(struct rte_eth_dev *dev,
1330 struct rte_eth_udp_tunnel *tunnel_udp);
1331 /**< @internal Add tunneling UDP port */
1333 typedef int (*eth_udp_tunnel_port_del_t)(struct rte_eth_dev *dev,
1334 struct rte_eth_udp_tunnel *tunnel_udp);
1335 /**< @internal Delete tunneling UDP port */
1337 typedef int (*eth_set_mc_addr_list_t)(struct rte_eth_dev *dev,
1338 struct ether_addr *mc_addr_set,
1339 uint32_t nb_mc_addr);
1340 /**< @internal set the list of multicast addresses on an Ethernet device */
1342 typedef int (*eth_timesync_enable_t)(struct rte_eth_dev *dev);
1343 /**< @internal Function used to enable IEEE1588/802.1AS timestamping. */
1345 typedef int (*eth_timesync_disable_t)(struct rte_eth_dev *dev);
1346 /**< @internal Function used to disable IEEE1588/802.1AS timestamping. */
1348 typedef int (*eth_timesync_read_rx_timestamp_t)(struct rte_eth_dev *dev,
1349 struct timespec *timestamp,
1351 /**< @internal Function used to read an RX IEEE1588/802.1AS timestamp. */
1353 typedef int (*eth_timesync_read_tx_timestamp_t)(struct rte_eth_dev *dev,
1354 struct timespec *timestamp);
1355 /**< @internal Function used to read a TX IEEE1588/802.1AS timestamp. */
1357 typedef int (*eth_timesync_adjust_time)(struct rte_eth_dev *dev, int64_t);
1358 /**< @internal Function used to adjust the device clock */
1360 typedef int (*eth_timesync_read_time)(struct rte_eth_dev *dev,
1361 struct timespec *timestamp);
1362 /**< @internal Function used to get time from the device clock. */
1364 typedef int (*eth_timesync_write_time)(struct rte_eth_dev *dev,
1365 const struct timespec *timestamp);
1366 /**< @internal Function used to get time from the device clock */
1368 typedef int (*eth_get_reg_t)(struct rte_eth_dev *dev,
1369 struct rte_dev_reg_info *info);
1370 /**< @internal Retrieve registers */
1372 typedef int (*eth_get_eeprom_length_t)(struct rte_eth_dev *dev);
1373 /**< @internal Retrieve eeprom size */
1375 typedef int (*eth_get_eeprom_t)(struct rte_eth_dev *dev,
1376 struct rte_dev_eeprom_info *info);
1377 /**< @internal Retrieve eeprom data */
1379 typedef int (*eth_set_eeprom_t)(struct rte_eth_dev *dev,
1380 struct rte_dev_eeprom_info *info);
1381 /**< @internal Program eeprom data */
1383 typedef int (*eth_l2_tunnel_eth_type_conf_t)
1384 (struct rte_eth_dev *dev, struct rte_eth_l2_tunnel_conf *l2_tunnel);
1385 /**< @internal config l2 tunnel ether type */
1387 typedef int (*eth_l2_tunnel_offload_set_t)
1388 (struct rte_eth_dev *dev,
1389 struct rte_eth_l2_tunnel_conf *l2_tunnel,
1392 /**< @internal enable/disable the l2 tunnel offload functions */
1395 typedef int (*eth_filter_ctrl_t)(struct rte_eth_dev *dev,
1396 enum rte_filter_type filter_type,
1397 enum rte_filter_op filter_op,
1399 /**< @internal Take operations to assigned filter type on an Ethernet device */
1401 typedef int (*eth_get_dcb_info)(struct rte_eth_dev *dev,
1402 struct rte_eth_dcb_info *dcb_info);
1403 /**< @internal Get dcb information on an Ethernet device */
1406 * @internal A structure containing the functions exported by an Ethernet driver.
1408 struct eth_dev_ops {
1409 eth_dev_configure_t dev_configure; /**< Configure device. */
1410 eth_dev_start_t dev_start; /**< Start device. */
1411 eth_dev_stop_t dev_stop; /**< Stop device. */
1412 eth_dev_set_link_up_t dev_set_link_up; /**< Device link up. */
1413 eth_dev_set_link_down_t dev_set_link_down; /**< Device link down. */
1414 eth_dev_close_t dev_close; /**< Close device. */
1415 eth_link_update_t link_update; /**< Get device link state. */
1417 eth_promiscuous_enable_t promiscuous_enable; /**< Promiscuous ON. */
1418 eth_promiscuous_disable_t promiscuous_disable;/**< Promiscuous OFF. */
1419 eth_allmulticast_enable_t allmulticast_enable;/**< RX multicast ON. */
1420 eth_allmulticast_disable_t allmulticast_disable;/**< RX multicast OFF. */
1421 eth_mac_addr_remove_t mac_addr_remove; /**< Remove MAC address. */
1422 eth_mac_addr_add_t mac_addr_add; /**< Add a MAC address. */
1423 eth_mac_addr_set_t mac_addr_set; /**< Set a MAC address. */
1424 eth_set_mc_addr_list_t set_mc_addr_list; /**< set list of mcast addrs. */
1425 mtu_set_t mtu_set; /**< Set MTU. */
1427 eth_stats_get_t stats_get; /**< Get generic device statistics. */
1428 eth_stats_reset_t stats_reset; /**< Reset generic device statistics. */
1429 eth_xstats_get_t xstats_get; /**< Get extended device statistics. */
1430 eth_xstats_reset_t xstats_reset; /**< Reset extended device statistics. */
1431 eth_xstats_get_names_t xstats_get_names;
1432 /**< Get names of extended statistics. */
1433 eth_queue_stats_mapping_set_t queue_stats_mapping_set;
1434 /**< Configure per queue stat counter mapping. */
1436 eth_dev_infos_get_t dev_infos_get; /**< Get device info. */
1437 eth_rxq_info_get_t rxq_info_get; /**< retrieve RX queue information. */
1438 eth_txq_info_get_t txq_info_get; /**< retrieve TX queue information. */
1439 eth_fw_version_get_t fw_version_get; /**< Get firmware version. */
1440 eth_dev_supported_ptypes_get_t dev_supported_ptypes_get;
1441 /**< Get packet types supported and identified by device. */
1443 vlan_filter_set_t vlan_filter_set; /**< Filter VLAN Setup. */
1444 vlan_tpid_set_t vlan_tpid_set; /**< Outer/Inner VLAN TPID Setup. */
1445 vlan_strip_queue_set_t vlan_strip_queue_set; /**< VLAN Stripping on queue. */
1446 vlan_offload_set_t vlan_offload_set; /**< Set VLAN Offload. */
1447 vlan_pvid_set_t vlan_pvid_set; /**< Set port based TX VLAN insertion. */
1449 eth_queue_start_t rx_queue_start;/**< Start RX for a queue. */
1450 eth_queue_stop_t rx_queue_stop; /**< Stop RX for a queue. */
1451 eth_queue_start_t tx_queue_start;/**< Start TX for a queue. */
1452 eth_queue_stop_t tx_queue_stop; /**< Stop TX for a queue. */
1453 eth_rx_queue_setup_t rx_queue_setup;/**< Set up device RX queue. */
1454 eth_queue_release_t rx_queue_release; /**< Release RX queue. */
1455 eth_rx_queue_count_t rx_queue_count;
1456 /**< Get the number of used RX descriptors. */
1457 eth_rx_descriptor_done_t rx_descriptor_done; /**< Check rxd DD bit. */
1458 eth_rx_descriptor_status_t rx_descriptor_status;
1459 /**< Check the status of a Rx descriptor. */
1460 eth_tx_descriptor_status_t tx_descriptor_status;
1461 /**< Check the status of a Tx descriptor. */
1462 eth_rx_enable_intr_t rx_queue_intr_enable; /**< Enable Rx queue interrupt. */
1463 eth_rx_disable_intr_t rx_queue_intr_disable; /**< Disable Rx queue interrupt. */
1464 eth_tx_queue_setup_t tx_queue_setup;/**< Set up device TX queue. */
1465 eth_queue_release_t tx_queue_release; /**< Release TX queue. */
1466 eth_tx_done_cleanup_t tx_done_cleanup;/**< Free tx ring mbufs */
1468 eth_dev_led_on_t dev_led_on; /**< Turn on LED. */
1469 eth_dev_led_off_t dev_led_off; /**< Turn off LED. */
1471 flow_ctrl_get_t flow_ctrl_get; /**< Get flow control. */
1472 flow_ctrl_set_t flow_ctrl_set; /**< Setup flow control. */
1473 priority_flow_ctrl_set_t priority_flow_ctrl_set; /**< Setup priority flow control. */
1475 eth_uc_hash_table_set_t uc_hash_table_set; /**< Set Unicast Table Array. */
1476 eth_uc_all_hash_table_set_t uc_all_hash_table_set; /**< Set Unicast hash bitmap. */
1478 eth_mirror_rule_set_t mirror_rule_set; /**< Add a traffic mirror rule. */
1479 eth_mirror_rule_reset_t mirror_rule_reset; /**< reset a traffic mirror rule. */
1481 eth_udp_tunnel_port_add_t udp_tunnel_port_add; /** Add UDP tunnel port. */
1482 eth_udp_tunnel_port_del_t udp_tunnel_port_del; /** Del UDP tunnel port. */
1483 eth_l2_tunnel_eth_type_conf_t l2_tunnel_eth_type_conf;
1484 /** Config ether type of l2 tunnel. */
1485 eth_l2_tunnel_offload_set_t l2_tunnel_offload_set;
1486 /** Enable/disable l2 tunnel offload functions. */
1488 eth_set_queue_rate_limit_t set_queue_rate_limit; /**< Set queue rate limit. */
1490 rss_hash_update_t rss_hash_update; /** Configure RSS hash protocols. */
1491 rss_hash_conf_get_t rss_hash_conf_get; /** Get current RSS hash configuration. */
1492 reta_update_t reta_update; /** Update redirection table. */
1493 reta_query_t reta_query; /** Query redirection table. */
1495 eth_get_reg_t get_reg; /**< Get registers. */
1496 eth_get_eeprom_length_t get_eeprom_length; /**< Get eeprom length. */
1497 eth_get_eeprom_t get_eeprom; /**< Get eeprom data. */
1498 eth_set_eeprom_t set_eeprom; /**< Set eeprom. */
1501 eth_filter_ctrl_t filter_ctrl; /**< common filter control. */
1503 eth_get_dcb_info get_dcb_info; /** Get DCB information. */
1505 eth_timesync_enable_t timesync_enable;
1506 /** Turn IEEE1588/802.1AS timestamping on. */
1507 eth_timesync_disable_t timesync_disable;
1508 /** Turn IEEE1588/802.1AS timestamping off. */
1509 eth_timesync_read_rx_timestamp_t timesync_read_rx_timestamp;
1510 /** Read the IEEE1588/802.1AS RX timestamp. */
1511 eth_timesync_read_tx_timestamp_t timesync_read_tx_timestamp;
1512 /** Read the IEEE1588/802.1AS TX timestamp. */
1513 eth_timesync_adjust_time timesync_adjust_time; /** Adjust the device clock. */
1514 eth_timesync_read_time timesync_read_time; /** Get the device clock time. */
1515 eth_timesync_write_time timesync_write_time; /** Set the device clock time. */
1517 eth_xstats_get_by_id_t xstats_get_by_id;
1518 /**< Get extended device statistic values by ID. */
1519 eth_xstats_get_names_by_id_t xstats_get_names_by_id;
1520 /**< Get name of extended device statistics by ID. */
1524 * Function type used for RX packet processing packet callbacks.
1526 * The callback function is called on RX with a burst of packets that have
1527 * been received on the given port and queue.
1530 * The Ethernet port on which RX is being performed.
1532 * The queue on the Ethernet port which is being used to receive the packets.
1534 * The burst of packets that have just been received.
1536 * The number of packets in the burst pointed to by "pkts".
1538 * The max number of packets that can be stored in the "pkts" array.
1540 * The arbitrary user parameter passed in by the application when the callback
1541 * was originally configured.
1543 * The number of packets returned to the user.
1545 typedef uint16_t (*rte_rx_callback_fn)(uint8_t port, uint16_t queue,
1546 struct rte_mbuf *pkts[], uint16_t nb_pkts, uint16_t max_pkts,
1550 * Function type used for TX packet processing packet callbacks.
1552 * The callback function is called on TX with a burst of packets immediately
1553 * before the packets are put onto the hardware queue for transmission.
1556 * The Ethernet port on which TX is being performed.
1558 * The queue on the Ethernet port which is being used to transmit the packets.
1560 * The burst of packets that are about to be transmitted.
1562 * The number of packets in the burst pointed to by "pkts".
1564 * The arbitrary user parameter passed in by the application when the callback
1565 * was originally configured.
1567 * The number of packets to be written to the NIC.
1569 typedef uint16_t (*rte_tx_callback_fn)(uint8_t port, uint16_t queue,
1570 struct rte_mbuf *pkts[], uint16_t nb_pkts, void *user_param);
1574 * Structure used to hold information about the callbacks to be called for a
1575 * queue on RX and TX.
1577 struct rte_eth_rxtx_callback {
1578 struct rte_eth_rxtx_callback *next;
1580 rte_rx_callback_fn rx;
1581 rte_tx_callback_fn tx;
1587 * A set of values to describe the possible states of an eth device.
1589 enum rte_eth_dev_state {
1590 RTE_ETH_DEV_UNUSED = 0,
1591 RTE_ETH_DEV_ATTACHED,
1596 * The generic data structure associated with each ethernet device.
1598 * Pointers to burst-oriented packet receive and transmit functions are
1599 * located at the beginning of the structure, along with the pointer to
1600 * where all the data elements for the particular device are stored in shared
1601 * memory. This split allows the function pointer and driver data to be per-
1602 * process, while the actual configuration data for the device is shared.
1604 struct rte_eth_dev {
1605 eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
1606 eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
1607 eth_tx_prep_t tx_pkt_prepare; /**< Pointer to PMD transmit prepare function. */
1608 struct rte_eth_dev_data *data; /**< Pointer to device data */
1609 const struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
1610 struct rte_device *device; /**< Backing device */
1611 struct rte_intr_handle *intr_handle; /**< Device interrupt handle */
1612 /** User application callbacks for NIC interrupts */
1613 struct rte_eth_dev_cb_list link_intr_cbs;
1615 * User-supplied functions called from rx_burst to post-process
1616 * received packets before passing them to the user
1618 struct rte_eth_rxtx_callback *post_rx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
1620 * User-supplied functions called from tx_burst to pre-process
1621 * received packets before passing them to the driver for transmission.
1623 struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
1624 enum rte_eth_dev_state state; /**< Flag indicating the port state */
1625 } __rte_cache_aligned;
1627 struct rte_eth_dev_sriov {
1628 uint8_t active; /**< SRIOV is active with 16, 32 or 64 pools */
1629 uint8_t nb_q_per_pool; /**< rx queue number per pool */
1630 uint16_t def_vmdq_idx; /**< Default pool num used for PF */
1631 uint16_t def_pool_q_idx; /**< Default pool queue start reg index */
1633 #define RTE_ETH_DEV_SRIOV(dev) ((dev)->data->sriov)
1635 #define RTE_ETH_NAME_MAX_LEN RTE_DEV_NAME_MAX_LEN
1639 * The data part, with no function pointers, associated with each ethernet device.
1641 * This structure is safe to place in shared memory to be common among different
1642 * processes in a multi-process configuration.
1644 struct rte_eth_dev_data {
1645 char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
1647 void **rx_queues; /**< Array of pointers to RX queues. */
1648 void **tx_queues; /**< Array of pointers to TX queues. */
1649 uint16_t nb_rx_queues; /**< Number of RX queues. */
1650 uint16_t nb_tx_queues; /**< Number of TX queues. */
1652 struct rte_eth_dev_sriov sriov; /**< SRIOV data */
1654 void *dev_private; /**< PMD-specific private data */
1656 struct rte_eth_link dev_link;
1657 /**< Link-level information & status */
1659 struct rte_eth_conf dev_conf; /**< Configuration applied to device. */
1660 uint16_t mtu; /**< Maximum Transmission Unit. */
1662 uint32_t min_rx_buf_size;
1663 /**< Common rx buffer size handled by all queues */
1665 uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
1666 struct ether_addr* mac_addrs;/**< Device Ethernet Link address. */
1667 uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
1668 /** bitmap array of associating Ethernet MAC addresses to pools */
1669 struct ether_addr* hash_mac_addrs;
1670 /** Device Ethernet MAC addresses of hash filtering. */
1671 uint8_t port_id; /**< Device [external] port identifier. */
1673 uint8_t promiscuous : 1, /**< RX promiscuous mode ON(1) / OFF(0). */
1674 scattered_rx : 1, /**< RX of scattered packets is ON(1) / OFF(0) */
1675 all_multicast : 1, /**< RX all multicast mode ON(1) / OFF(0). */
1676 dev_started : 1, /**< Device state: STARTED(1) / STOPPED(0). */
1677 lro : 1; /**< RX LRO is ON(1) / OFF(0) */
1678 uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT];
1679 /** Queues state: STARTED(1) / STOPPED(0) */
1680 uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
1681 /** Queues state: STARTED(1) / STOPPED(0) */
1682 uint32_t dev_flags; /**< Capabilities */
1683 enum rte_kernel_driver kdrv; /**< Kernel driver passthrough */
1684 int numa_node; /**< NUMA node connection */
1685 struct rte_vlan_filter_conf vlan_filter_conf;
1686 /**< VLAN filter configuration. */
1689 /** Device supports hotplug detach */
1690 #define RTE_ETH_DEV_DETACHABLE 0x0001
1691 /** Device supports link state interrupt */
1692 #define RTE_ETH_DEV_INTR_LSC 0x0002
1693 /** Device is a bonded slave */
1694 #define RTE_ETH_DEV_BONDED_SLAVE 0x0004
1695 /** Device supports device removal interrupt */
1696 #define RTE_ETH_DEV_INTR_RMV 0x0008
1700 * The pool of *rte_eth_dev* structures. The size of the pool
1701 * is configured at compile-time in the <rte_ethdev.c> file.
1703 extern struct rte_eth_dev rte_eth_devices[];
1706 * Iterates over valid ethdev ports.
1709 * The id of the next possible valid port.
1711 * Next valid port id, RTE_MAX_ETHPORTS if there is none.
1713 uint8_t rte_eth_find_next(uint8_t port_id);
1716 * Macro to iterate over all enabled ethdev ports.
1718 #define RTE_ETH_FOREACH_DEV(p) \
1719 for (p = rte_eth_find_next(0); \
1720 (unsigned int)p < (unsigned int)RTE_MAX_ETHPORTS; \
1721 p = rte_eth_find_next(p + 1))
1725 * Get the total number of Ethernet devices that have been successfully
1726 * initialized by the [matching] Ethernet driver during the PCI probing phase.
1727 * All devices whose port identifier is in the range
1728 * [0, rte_eth_dev_count() - 1] can be operated on by network applications
1729 * immediately after invoking rte_eal_init().
1730 * If the application unplugs a port using hotplug function, The enabled port
1731 * numbers may be noncontiguous. In the case, the applications need to manage
1732 * enabled port by using the ``RTE_ETH_FOREACH_DEV()`` macro.
1735 * - The total number of usable Ethernet devices.
1737 uint8_t rte_eth_dev_count(void);
1741 * Returns a ethdev slot specified by the unique identifier name.
1744 * The pointer to the Unique identifier name for each Ethernet device
1746 * - The pointer to the ethdev slot, on success. NULL on error
1748 struct rte_eth_dev *rte_eth_dev_allocated(const char *name);
1752 * Allocates a new ethdev slot for an ethernet device and returns the pointer
1753 * to that slot for the driver to use.
1755 * @param name Unique identifier name for each Ethernet device
1756 * @param type Device type of this Ethernet device
1758 * - Slot in the rte_dev_devices array for a new device;
1760 struct rte_eth_dev *rte_eth_dev_allocate(const char *name);
1764 * Attach to the ethdev already initialized by the primary
1767 * @param name Ethernet device's name.
1769 * - Success: Slot in the rte_dev_devices array for attached
1771 * - Error: Null pointer.
1773 struct rte_eth_dev *rte_eth_dev_attach_secondary(const char *name);
1777 * Release the specified ethdev port.
1780 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure.
1782 * - 0 on success, negative on error
1784 int rte_eth_dev_release_port(struct rte_eth_dev *eth_dev);
1787 * Attach a new Ethernet device specified by arguments.
1790 * A pointer to a strings array describing the new device
1791 * to be attached. The strings should be a pci address like
1792 * '0000:01:00.0' or virtual device name like 'net_pcap0'.
1794 * A pointer to a port identifier actually attached.
1796 * 0 on success and port_id is filled, negative on error
1798 int rte_eth_dev_attach(const char *devargs, uint8_t *port_id);
1801 * Detach a Ethernet device specified by port identifier.
1802 * This function must be called when the device is in the
1806 * The port identifier of the device to detach.
1808 * A pointer to a device name actually detached.
1810 * 0 on success and devname is filled, negative on error
1812 int rte_eth_dev_detach(uint8_t port_id, char *devname);
1815 * Convert a numerical speed in Mbps to a bitmap flag that can be used in
1816 * the bitmap link_speeds of the struct rte_eth_conf
1819 * Numerical speed value in Mbps
1821 * ETH_LINK_[HALF/FULL]_DUPLEX (only for 10/100M speeds)
1823 * 0 if the speed cannot be mapped
1825 uint32_t rte_eth_speed_bitflag(uint32_t speed, int duplex);
1828 * Configure an Ethernet device.
1829 * This function must be invoked first before any other function in the
1830 * Ethernet API. This function can also be re-invoked when a device is in the
1834 * The port identifier of the Ethernet device to configure.
1835 * @param nb_rx_queue
1836 * The number of receive queues to set up for the Ethernet device.
1837 * @param nb_tx_queue
1838 * The number of transmit queues to set up for the Ethernet device.
1840 * The pointer to the configuration data to be used for the Ethernet device.
1841 * The *rte_eth_conf* structure includes:
1842 * - the hardware offload features to activate, with dedicated fields for
1843 * each statically configurable offload hardware feature provided by
1844 * Ethernet devices, such as IP checksum or VLAN tag stripping for
1846 * - the Receive Side Scaling (RSS) configuration when using multiple RX
1849 * Embedding all configuration information in a single data structure
1850 * is the more flexible method that allows the addition of new features
1851 * without changing the syntax of the API.
1853 * - 0: Success, device configured.
1854 * - <0: Error code returned by the driver configuration function.
1856 int rte_eth_dev_configure(uint8_t port_id, uint16_t nb_rx_queue,
1857 uint16_t nb_tx_queue, const struct rte_eth_conf *eth_conf);
1861 * Release device queues and clear its configuration to force the user
1862 * application to reconfigure it. It is for internal use only.
1865 * Pointer to struct rte_eth_dev.
1870 void _rte_eth_dev_reset(struct rte_eth_dev *dev);
1873 * Allocate and set up a receive queue for an Ethernet device.
1875 * The function allocates a contiguous block of memory for *nb_rx_desc*
1876 * receive descriptors from a memory zone associated with *socket_id*
1877 * and initializes each receive descriptor with a network buffer allocated
1878 * from the memory pool *mb_pool*.
1881 * The port identifier of the Ethernet device.
1882 * @param rx_queue_id
1883 * The index of the receive queue to set up.
1884 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1885 * to rte_eth_dev_configure().
1887 * The number of receive descriptors to allocate for the receive ring.
1889 * The *socket_id* argument is the socket identifier in case of NUMA.
1890 * The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1891 * the DMA memory allocated for the receive descriptors of the ring.
1893 * The pointer to the configuration data to be used for the receive queue.
1894 * NULL value is allowed, in which case default RX configuration
1896 * The *rx_conf* structure contains an *rx_thresh* structure with the values
1897 * of the Prefetch, Host, and Write-Back threshold registers of the receive
1900 * The pointer to the memory pool from which to allocate *rte_mbuf* network
1901 * memory buffers to populate each descriptor of the receive ring.
1903 * - 0: Success, receive queue correctly set up.
1904 * - -EINVAL: The size of network buffers which can be allocated from the
1905 * memory pool does not fit the various buffer sizes allowed by the
1906 * device controller.
1907 * - -ENOMEM: Unable to allocate the receive ring descriptors or to
1908 * allocate network memory buffers from the memory pool when
1909 * initializing receive descriptors.
1911 int rte_eth_rx_queue_setup(uint8_t port_id, uint16_t rx_queue_id,
1912 uint16_t nb_rx_desc, unsigned int socket_id,
1913 const struct rte_eth_rxconf *rx_conf,
1914 struct rte_mempool *mb_pool);
1917 * Allocate and set up a transmit queue for an Ethernet device.
1920 * The port identifier of the Ethernet device.
1921 * @param tx_queue_id
1922 * The index of the transmit queue to set up.
1923 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1924 * to rte_eth_dev_configure().
1926 * The number of transmit descriptors to allocate for the transmit ring.
1928 * The *socket_id* argument is the socket identifier in case of NUMA.
1929 * Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1930 * the DMA memory allocated for the transmit descriptors of the ring.
1932 * The pointer to the configuration data to be used for the transmit queue.
1933 * NULL value is allowed, in which case default RX configuration
1935 * The *tx_conf* structure contains the following data:
1936 * - The *tx_thresh* structure with the values of the Prefetch, Host, and
1937 * Write-Back threshold registers of the transmit ring.
1938 * When setting Write-Back threshold to the value greater then zero,
1939 * *tx_rs_thresh* value should be explicitly set to one.
1940 * - The *tx_free_thresh* value indicates the [minimum] number of network
1941 * buffers that must be pending in the transmit ring to trigger their
1942 * [implicit] freeing by the driver transmit function.
1943 * - The *tx_rs_thresh* value indicates the [minimum] number of transmit
1944 * descriptors that must be pending in the transmit ring before setting the
1945 * RS bit on a descriptor by the driver transmit function.
1946 * The *tx_rs_thresh* value should be less or equal then
1947 * *tx_free_thresh* value, and both of them should be less then
1949 * - The *txq_flags* member contains flags to pass to the TX queue setup
1950 * function to configure the behavior of the TX queue. This should be set
1951 * to 0 if no special configuration is required.
1953 * Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces
1954 * the transmit function to use default values.
1956 * - 0: Success, the transmit queue is correctly set up.
1957 * - -ENOMEM: Unable to allocate the transmit ring descriptors.
1959 int rte_eth_tx_queue_setup(uint8_t port_id, uint16_t tx_queue_id,
1960 uint16_t nb_tx_desc, unsigned int socket_id,
1961 const struct rte_eth_txconf *tx_conf);
1964 * Return the NUMA socket to which an Ethernet device is connected
1967 * The port identifier of the Ethernet device
1969 * The NUMA socket id to which the Ethernet device is connected or
1970 * a default of zero if the socket could not be determined.
1971 * -1 is returned is the port_id value is out of range.
1973 int rte_eth_dev_socket_id(uint8_t port_id);
1976 * Check if port_id of device is attached
1979 * The port identifier of the Ethernet device
1981 * - 0 if port is out of range or not attached
1982 * - 1 if device is attached
1984 int rte_eth_dev_is_valid_port(uint8_t port_id);
1987 * Start specified RX queue of a port. It is used when rx_deferred_start
1988 * flag of the specified queue is true.
1991 * The port identifier of the Ethernet device
1992 * @param rx_queue_id
1993 * The index of the rx queue to update the ring.
1994 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1995 * to rte_eth_dev_configure().
1997 * - 0: Success, the receive queue is started.
1998 * - -EINVAL: The port_id or the queue_id out of range.
1999 * - -ENOTSUP: The function not supported in PMD driver.
2001 int rte_eth_dev_rx_queue_start(uint8_t port_id, uint16_t rx_queue_id);
2004 * Stop specified RX queue of a port
2007 * The port identifier of the Ethernet device
2008 * @param rx_queue_id
2009 * The index of the rx queue to update the ring.
2010 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2011 * to rte_eth_dev_configure().
2013 * - 0: Success, the receive queue is stopped.
2014 * - -EINVAL: The port_id or the queue_id out of range.
2015 * - -ENOTSUP: The function not supported in PMD driver.
2017 int rte_eth_dev_rx_queue_stop(uint8_t port_id, uint16_t rx_queue_id);
2020 * Start TX for specified queue of a port. It is used when tx_deferred_start
2021 * flag of the specified queue is true.
2024 * The port identifier of the Ethernet device
2025 * @param tx_queue_id
2026 * The index of the tx queue to update the ring.
2027 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2028 * to rte_eth_dev_configure().
2030 * - 0: Success, the transmit queue is started.
2031 * - -EINVAL: The port_id or the queue_id out of range.
2032 * - -ENOTSUP: The function not supported in PMD driver.
2034 int rte_eth_dev_tx_queue_start(uint8_t port_id, uint16_t tx_queue_id);
2037 * Stop specified TX queue of a port
2040 * The port identifier of the Ethernet device
2041 * @param tx_queue_id
2042 * The index of the tx queue to update the ring.
2043 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2044 * to rte_eth_dev_configure().
2046 * - 0: Success, the transmit queue is stopped.
2047 * - -EINVAL: The port_id or the queue_id out of range.
2048 * - -ENOTSUP: The function not supported in PMD driver.
2050 int rte_eth_dev_tx_queue_stop(uint8_t port_id, uint16_t tx_queue_id);
2055 * Start an Ethernet device.
2057 * The device start step is the last one and consists of setting the configured
2058 * offload features and in starting the transmit and the receive units of the
2060 * On success, all basic functions exported by the Ethernet API (link status,
2061 * receive/transmit, and so on) can be invoked.
2064 * The port identifier of the Ethernet device.
2066 * - 0: Success, Ethernet device started.
2067 * - <0: Error code of the driver device start function.
2069 int rte_eth_dev_start(uint8_t port_id);
2072 * Stop an Ethernet device. The device can be restarted with a call to
2073 * rte_eth_dev_start()
2076 * The port identifier of the Ethernet device.
2078 void rte_eth_dev_stop(uint8_t port_id);
2082 * Link up an Ethernet device.
2084 * Set device link up will re-enable the device rx/tx
2085 * functionality after it is previously set device linked down.
2088 * The port identifier of the Ethernet device.
2090 * - 0: Success, Ethernet device linked up.
2091 * - <0: Error code of the driver device link up function.
2093 int rte_eth_dev_set_link_up(uint8_t port_id);
2096 * Link down an Ethernet device.
2097 * The device rx/tx functionality will be disabled if success,
2098 * and it can be re-enabled with a call to
2099 * rte_eth_dev_set_link_up()
2102 * The port identifier of the Ethernet device.
2104 int rte_eth_dev_set_link_down(uint8_t port_id);
2107 * Close a stopped Ethernet device. The device cannot be restarted!
2108 * The function frees all resources except for needed by the
2109 * closed state. To free these resources, call rte_eth_dev_detach().
2112 * The port identifier of the Ethernet device.
2114 void rte_eth_dev_close(uint8_t port_id);
2117 * Enable receipt in promiscuous mode for an Ethernet device.
2120 * The port identifier of the Ethernet device.
2122 void rte_eth_promiscuous_enable(uint8_t port_id);
2125 * Disable receipt in promiscuous mode for an Ethernet device.
2128 * The port identifier of the Ethernet device.
2130 void rte_eth_promiscuous_disable(uint8_t port_id);
2133 * Return the value of promiscuous mode for an Ethernet device.
2136 * The port identifier of the Ethernet device.
2138 * - (1) if promiscuous is enabled
2139 * - (0) if promiscuous is disabled.
2142 int rte_eth_promiscuous_get(uint8_t port_id);
2145 * Enable the receipt of any multicast frame by an Ethernet device.
2148 * The port identifier of the Ethernet device.
2150 void rte_eth_allmulticast_enable(uint8_t port_id);
2153 * Disable the receipt of all multicast frames by an Ethernet device.
2156 * The port identifier of the Ethernet device.
2158 void rte_eth_allmulticast_disable(uint8_t port_id);
2161 * Return the value of allmulticast mode for an Ethernet device.
2164 * The port identifier of the Ethernet device.
2166 * - (1) if allmulticast is enabled
2167 * - (0) if allmulticast is disabled.
2170 int rte_eth_allmulticast_get(uint8_t port_id);
2173 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2174 * or FULL-DUPLEX) of the physical link of an Ethernet device. It might need
2175 * to wait up to 9 seconds in it.
2178 * The port identifier of the Ethernet device.
2180 * A pointer to an *rte_eth_link* structure to be filled with
2181 * the status, the speed and the mode of the Ethernet device link.
2183 void rte_eth_link_get(uint8_t port_id, struct rte_eth_link *link);
2186 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2187 * or FULL-DUPLEX) of the physical link of an Ethernet device. It is a no-wait
2188 * version of rte_eth_link_get().
2191 * The port identifier of the Ethernet device.
2193 * A pointer to an *rte_eth_link* structure to be filled with
2194 * the status, the speed and the mode of the Ethernet device link.
2196 void rte_eth_link_get_nowait(uint8_t port_id, struct rte_eth_link *link);
2199 * Retrieve the general I/O statistics of an Ethernet device.
2202 * The port identifier of the Ethernet device.
2204 * A pointer to a structure of type *rte_eth_stats* to be filled with
2205 * the values of device counters for the following set of statistics:
2206 * - *ipackets* with the total of successfully received packets.
2207 * - *opackets* with the total of successfully transmitted packets.
2208 * - *ibytes* with the total of successfully received bytes.
2209 * - *obytes* with the total of successfully transmitted bytes.
2210 * - *ierrors* with the total of erroneous received packets.
2211 * - *oerrors* with the total of failed transmitted packets.
2213 * Zero if successful. Non-zero otherwise.
2215 int rte_eth_stats_get(uint8_t port_id, struct rte_eth_stats *stats);
2218 * Reset the general I/O statistics of an Ethernet device.
2221 * The port identifier of the Ethernet device.
2223 void rte_eth_stats_reset(uint8_t port_id);
2226 * Retrieve names of extended statistics of an Ethernet device.
2229 * The port identifier of the Ethernet device.
2230 * @param xstats_names
2231 * An rte_eth_xstat_name array of at least *size* elements to
2232 * be filled. If set to NULL, the function returns the required number
2235 * The size of the xstats_names array (number of elements).
2237 * - A positive value lower or equal to size: success. The return value
2238 * is the number of entries filled in the stats table.
2239 * - A positive value higher than size: error, the given statistics table
2240 * is too small. The return value corresponds to the size that should
2241 * be given to succeed. The entries in the table are not valid and
2242 * shall not be used by the caller.
2243 * - A negative value on error (invalid port id).
2245 int rte_eth_xstats_get_names(uint8_t port_id,
2246 struct rte_eth_xstat_name *xstats_names,
2250 * Retrieve extended statistics of an Ethernet device.
2253 * The port identifier of the Ethernet device.
2255 * A pointer to a table of structure of type *rte_eth_xstat*
2256 * to be filled with device statistics ids and values: id is the
2257 * index of the name string in xstats_names (see rte_eth_xstats_get_names()),
2258 * and value is the statistic counter.
2259 * This parameter can be set to NULL if n is 0.
2261 * The size of the xstats array (number of elements).
2263 * - A positive value lower or equal to n: success. The return value
2264 * is the number of entries filled in the stats table.
2265 * - A positive value higher than n: error, the given statistics table
2266 * is too small. The return value corresponds to the size that should
2267 * be given to succeed. The entries in the table are not valid and
2268 * shall not be used by the caller.
2269 * - A negative value on error (invalid port id).
2271 int rte_eth_xstats_get(uint8_t port_id, struct rte_eth_xstat *xstats,
2275 * Retrieve names of extended statistics of an Ethernet device.
2278 * The port identifier of the Ethernet device.
2279 * @param xstats_names
2280 * An rte_eth_xstat_name array of at least *size* elements to
2281 * be filled. If set to NULL, the function returns the required number
2284 * IDs array given by app to retrieve specific statistics
2286 * The size of the xstats_names array (number of elements).
2288 * - A positive value lower or equal to size: success. The return value
2289 * is the number of entries filled in the stats table.
2290 * - A positive value higher than size: error, the given statistics table
2291 * is too small. The return value corresponds to the size that should
2292 * be given to succeed. The entries in the table are not valid and
2293 * shall not be used by the caller.
2294 * - A negative value on error (invalid port id).
2297 rte_eth_xstats_get_names_by_id(uint8_t port_id,
2298 struct rte_eth_xstat_name *xstats_names, unsigned int size,
2302 * Retrieve extended statistics of an Ethernet device.
2305 * The port identifier of the Ethernet device.
2307 * A pointer to an ids array passed by application. This tells which
2308 * statistics values function should retrieve. This parameter
2309 * can be set to NULL if n is 0. In this case function will retrieve
2310 * all avalible statistics.
2312 * A pointer to a table to be filled with device statistics values.
2314 * The size of the ids array (number of elements).
2316 * - A positive value lower or equal to n: success. The return value
2317 * is the number of entries filled in the stats table.
2318 * - A positive value higher than n: error, the given statistics table
2319 * is too small. The return value corresponds to the size that should
2320 * be given to succeed. The entries in the table are not valid and
2321 * shall not be used by the caller.
2322 * - A negative value on error (invalid port id).
2324 int rte_eth_xstats_get_by_id(uint8_t port_id, const uint64_t *ids,
2325 uint64_t *values, unsigned int n);
2328 * Gets the ID of a statistic from its name.
2330 * This function searches for the statistics using string compares, and
2331 * as such should not be used on the fast-path. For fast-path retrieval of
2332 * specific statistics, store the ID as provided in *id* from this function,
2333 * and pass the ID to rte_eth_xstats_get()
2335 * @param port_id The port to look up statistics from
2336 * @param xstat_name The name of the statistic to return
2337 * @param[out] id A pointer to an app-supplied uint64_t which should be
2338 * set to the ID of the stat if the stat exists.
2341 * -ENODEV for invalid port_id,
2342 * -EINVAL if the xstat_name doesn't exist in port_id
2344 int rte_eth_xstats_get_id_by_name(uint8_t port_id, const char *xstat_name,
2348 * Reset extended statistics of an Ethernet device.
2351 * The port identifier of the Ethernet device.
2353 void rte_eth_xstats_reset(uint8_t port_id);
2356 * Set a mapping for the specified transmit queue to the specified per-queue
2357 * statistics counter.
2360 * The port identifier of the Ethernet device.
2361 * @param tx_queue_id
2362 * The index of the transmit queue for which a queue stats mapping is required.
2363 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2364 * to rte_eth_dev_configure().
2366 * The per-queue packet statistics functionality number that the transmit
2367 * queue is to be assigned.
2368 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2370 * Zero if successful. Non-zero otherwise.
2372 int rte_eth_dev_set_tx_queue_stats_mapping(uint8_t port_id,
2373 uint16_t tx_queue_id, uint8_t stat_idx);
2376 * Set a mapping for the specified receive queue to the specified per-queue
2377 * statistics counter.
2380 * The port identifier of the Ethernet device.
2381 * @param rx_queue_id
2382 * The index of the receive queue for which a queue stats mapping is required.
2383 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2384 * to rte_eth_dev_configure().
2386 * The per-queue packet statistics functionality number that the receive
2387 * queue is to be assigned.
2388 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2390 * Zero if successful. Non-zero otherwise.
2392 int rte_eth_dev_set_rx_queue_stats_mapping(uint8_t port_id,
2393 uint16_t rx_queue_id,
2397 * Retrieve the Ethernet address of an Ethernet device.
2400 * The port identifier of the Ethernet device.
2402 * A pointer to a structure of type *ether_addr* to be filled with
2403 * the Ethernet address of the Ethernet device.
2405 void rte_eth_macaddr_get(uint8_t port_id, struct ether_addr *mac_addr);
2408 * Retrieve the contextual information of an Ethernet device.
2411 * The port identifier of the Ethernet device.
2413 * A pointer to a structure of type *rte_eth_dev_info* to be filled with
2414 * the contextual information of the Ethernet device.
2416 void rte_eth_dev_info_get(uint8_t port_id, struct rte_eth_dev_info *dev_info);
2419 * Retrieve the firmware version of a device.
2422 * The port identifier of the device.
2424 * A pointer to a string array storing the firmware version of a device,
2425 * the string includes terminating null. This pointer is allocated by caller.
2427 * The size of the string array pointed by fw_version, which should be
2428 * large enough to store firmware version of the device.
2430 * - (0) if successful.
2431 * - (-ENOTSUP) if operation is not supported.
2432 * - (-ENODEV) if *port_id* invalid.
2433 * - (>0) if *fw_size* is not enough to store firmware version, return
2434 * the size of the non truncated string.
2436 int rte_eth_dev_fw_version_get(uint8_t port_id,
2437 char *fw_version, size_t fw_size);
2440 * Retrieve the supported packet types of an Ethernet device.
2442 * When a packet type is announced as supported, it *must* be recognized by
2443 * the PMD. For instance, if RTE_PTYPE_L2_ETHER, RTE_PTYPE_L2_ETHER_VLAN
2444 * and RTE_PTYPE_L3_IPV4 are announced, the PMD must return the following
2445 * packet types for these packets:
2446 * - Ether/IPv4 -> RTE_PTYPE_L2_ETHER | RTE_PTYPE_L3_IPV4
2447 * - Ether/Vlan/IPv4 -> RTE_PTYPE_L2_ETHER_VLAN | RTE_PTYPE_L3_IPV4
2448 * - Ether/[anything else] -> RTE_PTYPE_L2_ETHER
2449 * - Ether/Vlan/[anything else] -> RTE_PTYPE_L2_ETHER_VLAN
2451 * When a packet is received by a PMD, the most precise type must be
2452 * returned among the ones supported. However a PMD is allowed to set
2453 * packet type that is not in the supported list, at the condition that it
2454 * is more precise. Therefore, a PMD announcing no supported packet types
2455 * can still set a matching packet type in a received packet.
2458 * Better to invoke this API after the device is already started or rx burst
2459 * function is decided, to obtain correct supported ptypes.
2461 * if a given PMD does not report what ptypes it supports, then the supported
2462 * ptype count is reported as 0.
2464 * The port identifier of the Ethernet device.
2466 * A hint of what kind of packet type which the caller is interested in.
2468 * An array pointer to store adequate packet types, allocated by caller.
2470 * Size of the array pointed by param ptypes.
2472 * - (>=0) Number of supported ptypes. If the number of types exceeds num,
2473 * only num entries will be filled into the ptypes array, but the full
2474 * count of supported ptypes will be returned.
2475 * - (-ENODEV) if *port_id* invalid.
2477 int rte_eth_dev_get_supported_ptypes(uint8_t port_id, uint32_t ptype_mask,
2478 uint32_t *ptypes, int num);
2481 * Retrieve the MTU of an Ethernet device.
2484 * The port identifier of the Ethernet device.
2486 * A pointer to a uint16_t where the retrieved MTU is to be stored.
2488 * - (0) if successful.
2489 * - (-ENODEV) if *port_id* invalid.
2491 int rte_eth_dev_get_mtu(uint8_t port_id, uint16_t *mtu);
2494 * Change the MTU of an Ethernet device.
2497 * The port identifier of the Ethernet device.
2499 * A uint16_t for the MTU to be applied.
2501 * - (0) if successful.
2502 * - (-ENOTSUP) if operation is not supported.
2503 * - (-ENODEV) if *port_id* invalid.
2504 * - (-EINVAL) if *mtu* invalid.
2505 * - (-EBUSY) if operation is not allowed when the port is running
2507 int rte_eth_dev_set_mtu(uint8_t port_id, uint16_t mtu);
2510 * Enable/Disable hardware filtering by an Ethernet device of received
2511 * VLAN packets tagged with a given VLAN Tag Identifier.
2514 * The port identifier of the Ethernet device.
2516 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
2518 * If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*.
2519 * Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*.
2521 * - (0) if successful.
2522 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2523 * - (-ENODEV) if *port_id* invalid.
2524 * - (-ENOSYS) if VLAN filtering on *port_id* disabled.
2525 * - (-EINVAL) if *vlan_id* > 4095.
2527 int rte_eth_dev_vlan_filter(uint8_t port_id, uint16_t vlan_id, int on);
2530 * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
2531 * 82599/X540/X550 can support VLAN stripping at the rx queue level
2534 * The port identifier of the Ethernet device.
2535 * @param rx_queue_id
2536 * The index of the receive queue for which a queue stats mapping is required.
2537 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2538 * to rte_eth_dev_configure().
2540 * If 1, Enable VLAN Stripping of the receive queue of the Ethernet port.
2541 * If 0, Disable VLAN Stripping of the receive queue of the Ethernet port.
2543 * - (0) if successful.
2544 * - (-ENOSUP) if hardware-assisted VLAN stripping not configured.
2545 * - (-ENODEV) if *port_id* invalid.
2546 * - (-EINVAL) if *rx_queue_id* invalid.
2548 int rte_eth_dev_set_vlan_strip_on_queue(uint8_t port_id, uint16_t rx_queue_id,
2552 * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
2553 * the VLAN Header. This is a register setup available on some Intel NIC, not
2554 * but all, please check the data sheet for availability.
2557 * The port identifier of the Ethernet device.
2561 * The Tag Protocol ID
2563 * - (0) if successful.
2564 * - (-ENOSUP) if hardware-assisted VLAN TPID setup is not supported.
2565 * - (-ENODEV) if *port_id* invalid.
2567 int rte_eth_dev_set_vlan_ether_type(uint8_t port_id,
2568 enum rte_vlan_type vlan_type,
2572 * Set VLAN offload configuration on an Ethernet device
2573 * Enable/Disable Extended VLAN by an Ethernet device, This is a register setup
2574 * available on some Intel NIC, not but all, please check the data sheet for
2576 * Enable/Disable VLAN Strip can be done on rx queue for certain NIC, but here
2577 * the configuration is applied on the port level.
2580 * The port identifier of the Ethernet device.
2581 * @param offload_mask
2582 * The VLAN Offload bit mask can be mixed use with "OR"
2583 * ETH_VLAN_STRIP_OFFLOAD
2584 * ETH_VLAN_FILTER_OFFLOAD
2585 * ETH_VLAN_EXTEND_OFFLOAD
2587 * - (0) if successful.
2588 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2589 * - (-ENODEV) if *port_id* invalid.
2591 int rte_eth_dev_set_vlan_offload(uint8_t port_id, int offload_mask);
2594 * Read VLAN Offload configuration from an Ethernet device
2597 * The port identifier of the Ethernet device.
2599 * - (>0) if successful. Bit mask to indicate
2600 * ETH_VLAN_STRIP_OFFLOAD
2601 * ETH_VLAN_FILTER_OFFLOAD
2602 * ETH_VLAN_EXTEND_OFFLOAD
2603 * - (-ENODEV) if *port_id* invalid.
2605 int rte_eth_dev_get_vlan_offload(uint8_t port_id);
2608 * Set port based TX VLAN insertion on or off.
2611 * The port identifier of the Ethernet device.
2613 * Port based TX VLAN identifier together with user priority.
2615 * Turn on or off the port based TX VLAN insertion.
2618 * - (0) if successful.
2619 * - negative if failed.
2621 int rte_eth_dev_set_vlan_pvid(uint8_t port_id, uint16_t pvid, int on);
2625 * Retrieve a burst of input packets from a receive queue of an Ethernet
2626 * device. The retrieved packets are stored in *rte_mbuf* structures whose
2627 * pointers are supplied in the *rx_pkts* array.
2629 * The rte_eth_rx_burst() function loops, parsing the RX ring of the
2630 * receive queue, up to *nb_pkts* packets, and for each completed RX
2631 * descriptor in the ring, it performs the following operations:
2633 * - Initialize the *rte_mbuf* data structure associated with the
2634 * RX descriptor according to the information provided by the NIC into
2635 * that RX descriptor.
2637 * - Store the *rte_mbuf* data structure into the next entry of the
2640 * - Replenish the RX descriptor with a new *rte_mbuf* buffer
2641 * allocated from the memory pool associated with the receive queue at
2642 * initialization time.
2644 * When retrieving an input packet that was scattered by the controller
2645 * into multiple receive descriptors, the rte_eth_rx_burst() function
2646 * appends the associated *rte_mbuf* buffers to the first buffer of the
2649 * The rte_eth_rx_burst() function returns the number of packets
2650 * actually retrieved, which is the number of *rte_mbuf* data structures
2651 * effectively supplied into the *rx_pkts* array.
2652 * A return value equal to *nb_pkts* indicates that the RX queue contained
2653 * at least *rx_pkts* packets, and this is likely to signify that other
2654 * received packets remain in the input queue. Applications implementing
2655 * a "retrieve as much received packets as possible" policy can check this
2656 * specific case and keep invoking the rte_eth_rx_burst() function until
2657 * a value less than *nb_pkts* is returned.
2659 * This receive method has the following advantages:
2661 * - It allows a run-to-completion network stack engine to retrieve and
2662 * to immediately process received packets in a fast burst-oriented
2663 * approach, avoiding the overhead of unnecessary intermediate packet
2664 * queue/dequeue operations.
2666 * - Conversely, it also allows an asynchronous-oriented processing
2667 * method to retrieve bursts of received packets and to immediately
2668 * queue them for further parallel processing by another logical core,
2669 * for instance. However, instead of having received packets being
2670 * individually queued by the driver, this approach allows the caller
2671 * of the rte_eth_rx_burst() function to queue a burst of retrieved
2672 * packets at a time and therefore dramatically reduce the cost of
2673 * enqueue/dequeue operations per packet.
2675 * - It allows the rte_eth_rx_burst() function of the driver to take
2676 * advantage of burst-oriented hardware features (CPU cache,
2677 * prefetch instructions, and so on) to minimize the number of CPU
2678 * cycles per packet.
2680 * To summarize, the proposed receive API enables many
2681 * burst-oriented optimizations in both synchronous and asynchronous
2682 * packet processing environments with no overhead in both cases.
2684 * The rte_eth_rx_burst() function does not provide any error
2685 * notification to avoid the corresponding overhead. As a hint, the
2686 * upper-level application might check the status of the device link once
2687 * being systematically returned a 0 value for a given number of tries.
2690 * The port identifier of the Ethernet device.
2692 * The index of the receive queue from which to retrieve input packets.
2693 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2694 * to rte_eth_dev_configure().
2696 * The address of an array of pointers to *rte_mbuf* structures that
2697 * must be large enough to store *nb_pkts* pointers in it.
2699 * The maximum number of packets to retrieve.
2701 * The number of packets actually retrieved, which is the number
2702 * of pointers to *rte_mbuf* structures effectively supplied to the
2705 static inline uint16_t
2706 rte_eth_rx_burst(uint8_t port_id, uint16_t queue_id,
2707 struct rte_mbuf **rx_pkts, const uint16_t nb_pkts)
2709 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2711 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2712 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
2713 RTE_FUNC_PTR_OR_ERR_RET(*dev->rx_pkt_burst, 0);
2715 if (queue_id >= dev->data->nb_rx_queues) {
2716 RTE_PMD_DEBUG_TRACE("Invalid RX queue_id=%d\n", queue_id);
2720 int16_t nb_rx = (*dev->rx_pkt_burst)(dev->data->rx_queues[queue_id],
2723 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
2724 struct rte_eth_rxtx_callback *cb = dev->post_rx_burst_cbs[queue_id];
2726 if (unlikely(cb != NULL)) {
2728 nb_rx = cb->fn.rx(port_id, queue_id, rx_pkts, nb_rx,
2729 nb_pkts, cb->param);
2731 } while (cb != NULL);
2739 * Get the number of used descriptors of a rx queue
2742 * The port identifier of the Ethernet device.
2744 * The queue id on the specific port.
2746 * The number of used descriptors in the specific queue, or:
2747 * (-EINVAL) if *port_id* or *queue_id* is invalid
2748 * (-ENOTSUP) if the device does not support this function
2751 rte_eth_rx_queue_count(uint8_t port_id, uint16_t queue_id)
2753 struct rte_eth_dev *dev;
2755 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -EINVAL);
2756 dev = &rte_eth_devices[port_id];
2757 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_queue_count, -ENOTSUP);
2758 if (queue_id >= dev->data->nb_rx_queues)
2761 return (*dev->dev_ops->rx_queue_count)(dev, queue_id);
2765 * Check if the DD bit of the specific RX descriptor in the queue has been set
2768 * The port identifier of the Ethernet device.
2770 * The queue id on the specific port.
2772 * The offset of the descriptor ID from tail.
2774 * - (1) if the specific DD bit is set.
2775 * - (0) if the specific DD bit is not set.
2776 * - (-ENODEV) if *port_id* invalid.
2777 * - (-ENOTSUP) if the device does not support this function
2780 rte_eth_rx_descriptor_done(uint8_t port_id, uint16_t queue_id, uint16_t offset)
2782 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2783 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
2784 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_descriptor_done, -ENOTSUP);
2785 return (*dev->dev_ops->rx_descriptor_done)( \
2786 dev->data->rx_queues[queue_id], offset);
2789 #define RTE_ETH_RX_DESC_AVAIL 0 /**< Desc available for hw. */
2790 #define RTE_ETH_RX_DESC_DONE 1 /**< Desc done, filled by hw. */
2791 #define RTE_ETH_RX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */
2794 * Check the status of a Rx descriptor in the queue
2796 * It should be called in a similar context than the Rx function:
2797 * - on a dataplane core
2798 * - not concurrently on the same queue
2800 * Since it's a dataplane function, no check is performed on port_id and
2801 * queue_id. The caller must therefore ensure that the port is enabled
2802 * and the queue is configured and running.
2804 * Note: accessing to a random descriptor in the ring may trigger cache
2805 * misses and have a performance impact.
2808 * A valid port identifier of the Ethernet device which.
2810 * A valid Rx queue identifier on this port.
2812 * The offset of the descriptor starting from tail (0 is the next
2813 * packet to be received by the driver).
2816 * - (RTE_ETH_RX_DESC_AVAIL): Descriptor is available for the hardware to
2818 * - (RTE_ETH_RX_DESC_DONE): Descriptor is done, it is filled by hw, but
2819 * not yet processed by the driver (i.e. in the receive queue).
2820 * - (RTE_ETH_RX_DESC_UNAVAIL): Descriptor is unavailable, either hold by
2821 * the driver and not yet returned to hw, or reserved by the hw.
2822 * - (-EINVAL) bad descriptor offset.
2823 * - (-ENOTSUP) if the device does not support this function.
2824 * - (-ENODEV) bad port or queue (only if compiled with debug).
2827 rte_eth_rx_descriptor_status(uint8_t port_id, uint16_t queue_id,
2830 struct rte_eth_dev *dev;
2833 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2834 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
2836 dev = &rte_eth_devices[port_id];
2837 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2838 if (queue_id >= dev->data->nb_rx_queues)
2841 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_descriptor_status, -ENOTSUP);
2842 rxq = dev->data->rx_queues[queue_id];
2844 return (*dev->dev_ops->rx_descriptor_status)(rxq, offset);
2847 #define RTE_ETH_TX_DESC_FULL 0 /**< Desc filled for hw, waiting xmit. */
2848 #define RTE_ETH_TX_DESC_DONE 1 /**< Desc done, packet is transmitted. */
2849 #define RTE_ETH_TX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */
2852 * Check the status of a Tx descriptor in the queue.
2854 * It should be called in a similar context than the Tx function:
2855 * - on a dataplane core
2856 * - not concurrently on the same queue
2858 * Since it's a dataplane function, no check is performed on port_id and
2859 * queue_id. The caller must therefore ensure that the port is enabled
2860 * and the queue is configured and running.
2862 * Note: accessing to a random descriptor in the ring may trigger cache
2863 * misses and have a performance impact.
2866 * A valid port identifier of the Ethernet device which.
2868 * A valid Tx queue identifier on this port.
2870 * The offset of the descriptor starting from tail (0 is the place where
2871 * the next packet will be send).
2874 * - (RTE_ETH_TX_DESC_FULL) Descriptor is being processed by the hw, i.e.
2875 * in the transmit queue.
2876 * - (RTE_ETH_TX_DESC_DONE) Hardware is done with this descriptor, it can
2877 * be reused by the driver.
2878 * - (RTE_ETH_TX_DESC_UNAVAIL): Descriptor is unavailable, reserved by the
2879 * driver or the hardware.
2880 * - (-EINVAL) bad descriptor offset.
2881 * - (-ENOTSUP) if the device does not support this function.
2882 * - (-ENODEV) bad port or queue (only if compiled with debug).
2884 static inline int rte_eth_tx_descriptor_status(uint8_t port_id,
2885 uint16_t queue_id, uint16_t offset)
2887 struct rte_eth_dev *dev;
2890 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2891 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
2893 dev = &rte_eth_devices[port_id];
2894 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2895 if (queue_id >= dev->data->nb_tx_queues)
2898 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->tx_descriptor_status, -ENOTSUP);
2899 txq = dev->data->tx_queues[queue_id];
2901 return (*dev->dev_ops->tx_descriptor_status)(txq, offset);
2905 * Send a burst of output packets on a transmit queue of an Ethernet device.
2907 * The rte_eth_tx_burst() function is invoked to transmit output packets
2908 * on the output queue *queue_id* of the Ethernet device designated by its
2910 * The *nb_pkts* parameter is the number of packets to send which are
2911 * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
2912 * allocated from a pool created with rte_pktmbuf_pool_create().
2913 * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
2914 * up to the number of transmit descriptors available in the TX ring of the
2916 * For each packet to send, the rte_eth_tx_burst() function performs
2917 * the following operations:
2919 * - Pick up the next available descriptor in the transmit ring.
2921 * - Free the network buffer previously sent with that descriptor, if any.
2923 * - Initialize the transmit descriptor with the information provided
2924 * in the *rte_mbuf data structure.
2926 * In the case of a segmented packet composed of a list of *rte_mbuf* buffers,
2927 * the rte_eth_tx_burst() function uses several transmit descriptors
2930 * The rte_eth_tx_burst() function returns the number of packets it
2931 * actually sent. A return value equal to *nb_pkts* means that all packets
2932 * have been sent, and this is likely to signify that other output packets
2933 * could be immediately transmitted again. Applications that implement a
2934 * "send as many packets to transmit as possible" policy can check this
2935 * specific case and keep invoking the rte_eth_tx_burst() function until
2936 * a value less than *nb_pkts* is returned.
2938 * It is the responsibility of the rte_eth_tx_burst() function to
2939 * transparently free the memory buffers of packets previously sent.
2940 * This feature is driven by the *tx_free_thresh* value supplied to the
2941 * rte_eth_dev_configure() function at device configuration time.
2942 * When the number of free TX descriptors drops below this threshold, the
2943 * rte_eth_tx_burst() function must [attempt to] free the *rte_mbuf* buffers
2944 * of those packets whose transmission was effectively completed.
2947 * The port identifier of the Ethernet device.
2949 * The index of the transmit queue through which output packets must be
2951 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2952 * to rte_eth_dev_configure().
2954 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
2955 * which contain the output packets.
2957 * The maximum number of packets to transmit.
2959 * The number of output packets actually stored in transmit descriptors of
2960 * the transmit ring. The return value can be less than the value of the
2961 * *tx_pkts* parameter when the transmit ring is full or has been filled up.
2963 static inline uint16_t
2964 rte_eth_tx_burst(uint8_t port_id, uint16_t queue_id,
2965 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
2967 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2969 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2970 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
2971 RTE_FUNC_PTR_OR_ERR_RET(*dev->tx_pkt_burst, 0);
2973 if (queue_id >= dev->data->nb_tx_queues) {
2974 RTE_PMD_DEBUG_TRACE("Invalid TX queue_id=%d\n", queue_id);
2979 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
2980 struct rte_eth_rxtx_callback *cb = dev->pre_tx_burst_cbs[queue_id];
2982 if (unlikely(cb != NULL)) {
2984 nb_pkts = cb->fn.tx(port_id, queue_id, tx_pkts, nb_pkts,
2987 } while (cb != NULL);
2991 return (*dev->tx_pkt_burst)(dev->data->tx_queues[queue_id], tx_pkts, nb_pkts);
2996 * @b EXPERIMENTAL: this API may change without prior notice
2998 * Process a burst of output packets on a transmit queue of an Ethernet device.
3000 * The rte_eth_tx_prepare() function is invoked to prepare output packets to be
3001 * transmitted on the output queue *queue_id* of the Ethernet device designated
3003 * The *nb_pkts* parameter is the number of packets to be prepared which are
3004 * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
3005 * allocated from a pool created with rte_pktmbuf_pool_create().
3006 * For each packet to send, the rte_eth_tx_prepare() function performs
3007 * the following operations:
3009 * - Check if packet meets devices requirements for tx offloads.
3011 * - Check limitations about number of segments.
3013 * - Check additional requirements when debug is enabled.
3015 * - Update and/or reset required checksums when tx offload is set for packet.
3017 * Since this function can modify packet data, provided mbufs must be safely
3018 * writable (e.g. modified data cannot be in shared segment).
3020 * The rte_eth_tx_prepare() function returns the number of packets ready to be
3021 * sent. A return value equal to *nb_pkts* means that all packets are valid and
3022 * ready to be sent, otherwise stops processing on the first invalid packet and
3023 * leaves the rest packets untouched.
3025 * When this functionality is not implemented in the driver, all packets are
3026 * are returned untouched.
3029 * The port identifier of the Ethernet device.
3030 * The value must be a valid port id.
3032 * The index of the transmit queue through which output packets must be
3034 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3035 * to rte_eth_dev_configure().
3037 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
3038 * which contain the output packets.
3040 * The maximum number of packets to process.
3042 * The number of packets correct and ready to be sent. The return value can be
3043 * less than the value of the *tx_pkts* parameter when some packet doesn't
3044 * meet devices requirements with rte_errno set appropriately:
3045 * - -EINVAL: offload flags are not correctly set
3046 * - -ENOTSUP: the offload feature is not supported by the hardware
3050 #ifndef RTE_ETHDEV_TX_PREPARE_NOOP
3052 static inline uint16_t
3053 rte_eth_tx_prepare(uint8_t port_id, uint16_t queue_id,
3054 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
3056 struct rte_eth_dev *dev;
3058 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3059 if (!rte_eth_dev_is_valid_port(port_id)) {
3060 RTE_PMD_DEBUG_TRACE("Invalid TX port_id=%d\n", port_id);
3061 rte_errno = -EINVAL;
3066 dev = &rte_eth_devices[port_id];
3068 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3069 if (queue_id >= dev->data->nb_tx_queues) {
3070 RTE_PMD_DEBUG_TRACE("Invalid TX queue_id=%d\n", queue_id);
3071 rte_errno = -EINVAL;
3076 if (!dev->tx_pkt_prepare)
3079 return (*dev->tx_pkt_prepare)(dev->data->tx_queues[queue_id],
3086 * Native NOOP operation for compilation targets which doesn't require any
3087 * preparations steps, and functional NOOP may introduce unnecessary performance
3090 * Generally this is not a good idea to turn it on globally and didn't should
3091 * be used if behavior of tx_preparation can change.
3094 static inline uint16_t
3095 rte_eth_tx_prepare(__rte_unused uint8_t port_id, __rte_unused uint16_t queue_id,
3096 __rte_unused struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
3103 typedef void (*buffer_tx_error_fn)(struct rte_mbuf **unsent, uint16_t count,
3107 * Structure used to buffer packets for future TX
3108 * Used by APIs rte_eth_tx_buffer and rte_eth_tx_buffer_flush
3110 struct rte_eth_dev_tx_buffer {
3111 buffer_tx_error_fn error_callback;
3112 void *error_userdata;
3113 uint16_t size; /**< Size of buffer for buffered tx */
3114 uint16_t length; /**< Number of packets in the array */
3115 struct rte_mbuf *pkts[];
3116 /**< Pending packets to be sent on explicit flush or when full */
3120 * Calculate the size of the tx buffer.
3123 * Number of stored packets.
3125 #define RTE_ETH_TX_BUFFER_SIZE(sz) \
3126 (sizeof(struct rte_eth_dev_tx_buffer) + (sz) * sizeof(struct rte_mbuf *))
3129 * Initialize default values for buffered transmitting
3132 * Tx buffer to be initialized.
3139 rte_eth_tx_buffer_init(struct rte_eth_dev_tx_buffer *buffer, uint16_t size);
3142 * Send any packets queued up for transmission on a port and HW queue
3144 * This causes an explicit flush of packets previously buffered via the
3145 * rte_eth_tx_buffer() function. It returns the number of packets successfully
3146 * sent to the NIC, and calls the error callback for any unsent packets. Unless
3147 * explicitly set up otherwise, the default callback simply frees the unsent
3148 * packets back to the owning mempool.
3151 * The port identifier of the Ethernet device.
3153 * The index of the transmit queue through which output packets must be
3155 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3156 * to rte_eth_dev_configure().
3158 * Buffer of packets to be transmit.
3160 * The number of packets successfully sent to the Ethernet device. The error
3161 * callback is called for any packets which could not be sent.
3163 static inline uint16_t
3164 rte_eth_tx_buffer_flush(uint8_t port_id, uint16_t queue_id,
3165 struct rte_eth_dev_tx_buffer *buffer)
3168 uint16_t to_send = buffer->length;
3173 sent = rte_eth_tx_burst(port_id, queue_id, buffer->pkts, to_send);
3177 /* All packets sent, or to be dealt with by callback below */
3178 if (unlikely(sent != to_send))
3179 buffer->error_callback(&buffer->pkts[sent], to_send - sent,
3180 buffer->error_userdata);
3186 * Buffer a single packet for future transmission on a port and queue
3188 * This function takes a single mbuf/packet and buffers it for later
3189 * transmission on the particular port and queue specified. Once the buffer is
3190 * full of packets, an attempt will be made to transmit all the buffered
3191 * packets. In case of error, where not all packets can be transmitted, a
3192 * callback is called with the unsent packets as a parameter. If no callback
3193 * is explicitly set up, the unsent packets are just freed back to the owning
3194 * mempool. The function returns the number of packets actually sent i.e.
3195 * 0 if no buffer flush occurred, otherwise the number of packets successfully
3199 * The port identifier of the Ethernet device.
3201 * The index of the transmit queue through which output packets must be
3203 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3204 * to rte_eth_dev_configure().
3206 * Buffer used to collect packets to be sent.
3208 * Pointer to the packet mbuf to be sent.
3210 * 0 = packet has been buffered for later transmission
3211 * N > 0 = packet has been buffered, and the buffer was subsequently flushed,
3212 * causing N packets to be sent, and the error callback to be called for
3215 static __rte_always_inline uint16_t
3216 rte_eth_tx_buffer(uint8_t port_id, uint16_t queue_id,
3217 struct rte_eth_dev_tx_buffer *buffer, struct rte_mbuf *tx_pkt)
3219 buffer->pkts[buffer->length++] = tx_pkt;
3220 if (buffer->length < buffer->size)
3223 return rte_eth_tx_buffer_flush(port_id, queue_id, buffer);
3227 * Configure a callback for buffered packets which cannot be sent
3229 * Register a specific callback to be called when an attempt is made to send
3230 * all packets buffered on an ethernet port, but not all packets can
3231 * successfully be sent. The callback registered here will be called only
3232 * from calls to rte_eth_tx_buffer() and rte_eth_tx_buffer_flush() APIs.
3233 * The default callback configured for each queue by default just frees the
3234 * packets back to the calling mempool. If additional behaviour is required,
3235 * for example, to count dropped packets, or to retry transmission of packets
3236 * which cannot be sent, this function should be used to register a suitable
3237 * callback function to implement the desired behaviour.
3238 * The example callback "rte_eth_count_unsent_packet_callback()" is also
3239 * provided as reference.
3242 * The port identifier of the Ethernet device.
3244 * The function to be used as the callback.
3246 * Arbitrary parameter to be passed to the callback function
3248 * 0 on success, or -1 on error with rte_errno set appropriately
3251 rte_eth_tx_buffer_set_err_callback(struct rte_eth_dev_tx_buffer *buffer,
3252 buffer_tx_error_fn callback, void *userdata);
3255 * Callback function for silently dropping unsent buffered packets.
3257 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
3258 * adjust the default behavior when buffered packets cannot be sent. This
3259 * function drops any unsent packets silently and is used by tx buffered
3260 * operations as default behavior.
3262 * NOTE: this function should not be called directly, instead it should be used
3263 * as a callback for packet buffering.
3265 * NOTE: when configuring this function as a callback with
3266 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
3267 * should point to an uint64_t value.
3270 * The previously buffered packets which could not be sent
3272 * The number of unsent packets in the pkts array
3277 rte_eth_tx_buffer_drop_callback(struct rte_mbuf **pkts, uint16_t unsent,
3281 * Callback function for tracking unsent buffered packets.
3283 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
3284 * adjust the default behavior when buffered packets cannot be sent. This
3285 * function drops any unsent packets, but also updates a user-supplied counter
3286 * to track the overall number of packets dropped. The counter should be an
3287 * uint64_t variable.
3289 * NOTE: this function should not be called directly, instead it should be used
3290 * as a callback for packet buffering.
3292 * NOTE: when configuring this function as a callback with
3293 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
3294 * should point to an uint64_t value.
3297 * The previously buffered packets which could not be sent
3299 * The number of unsent packets in the pkts array
3301 * Pointer to an uint64_t value, which will be incremented by unsent
3304 rte_eth_tx_buffer_count_callback(struct rte_mbuf **pkts, uint16_t unsent,
3308 * Request the driver to free mbufs currently cached by the driver. The
3309 * driver will only free the mbuf if it is no longer in use. It is the
3310 * application's responsibity to ensure rte_eth_tx_buffer_flush(..) is
3314 * The port identifier of the Ethernet device.
3316 * The index of the transmit queue through which output packets must be
3318 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
3319 * to rte_eth_dev_configure().
3321 * Maximum number of packets to free. Use 0 to indicate all possible packets
3322 * should be freed. Note that a packet may be using multiple mbufs.
3325 * -ENODEV: Invalid interface
3326 * -ENOTSUP: Driver does not support function
3328 * 0-n: Number of packets freed. More packets may still remain in ring that
3332 rte_eth_tx_done_cleanup(uint8_t port_id, uint16_t queue_id, uint32_t free_cnt);
3335 * The eth device event type for interrupt, and maybe others in the future.
3337 enum rte_eth_event_type {
3338 RTE_ETH_EVENT_UNKNOWN, /**< unknown event type */
3339 RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
3340 RTE_ETH_EVENT_QUEUE_STATE,
3341 /**< queue state event (enabled/disabled) */
3342 RTE_ETH_EVENT_INTR_RESET,
3343 /**< reset interrupt event, sent to VF on PF reset */
3344 RTE_ETH_EVENT_VF_MBOX, /**< message from the VF received by PF */
3345 RTE_ETH_EVENT_MACSEC, /**< MACsec offload related event */
3346 RTE_ETH_EVENT_INTR_RMV, /**< device removal event */
3347 RTE_ETH_EVENT_MAX /**< max value of this enum */
3350 typedef int (*rte_eth_dev_cb_fn)(uint8_t port_id,
3351 enum rte_eth_event_type event, void *cb_arg, void *ret_param);
3352 /**< user application callback to be registered for interrupts */
3357 * Register a callback function for specific port id.
3364 * User supplied callback function to be called.
3366 * Pointer to the parameters for the registered callback.
3369 * - On success, zero.
3370 * - On failure, a negative value.
3372 int rte_eth_dev_callback_register(uint8_t port_id,
3373 enum rte_eth_event_type event,
3374 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
3377 * Unregister a callback function for specific port id.
3384 * User supplied callback function to be called.
3386 * Pointer to the parameters for the registered callback. -1 means to
3387 * remove all for the same callback address and same event.
3390 * - On success, zero.
3391 * - On failure, a negative value.
3393 int rte_eth_dev_callback_unregister(uint8_t port_id,
3394 enum rte_eth_event_type event,
3395 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
3398 * @internal Executes all the user application registered callbacks for
3399 * the specific device. It is for DPDK internal user only. User
3400 * application should not call it directly.
3403 * Pointer to struct rte_eth_dev.
3405 * Eth device interrupt event type.
3407 * callback parameter.
3409 * To pass data back to user application.
3410 * This allows the user application to decide if a particular function
3411 * is permitted or not.
3416 int _rte_eth_dev_callback_process(struct rte_eth_dev *dev,
3417 enum rte_eth_event_type event, void *cb_arg, void *ret_param);
3420 * When there is no rx packet coming in Rx Queue for a long time, we can
3421 * sleep lcore related to RX Queue for power saving, and enable rx interrupt
3422 * to be triggered when Rx packet arrives.
3424 * The rte_eth_dev_rx_intr_enable() function enables rx queue
3425 * interrupt on specific rx queue of a port.
3428 * The port identifier of the Ethernet device.
3430 * The index of the receive queue from which to retrieve input packets.
3431 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3432 * to rte_eth_dev_configure().
3434 * - (0) if successful.
3435 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3437 * - (-ENODEV) if *port_id* invalid.
3439 int rte_eth_dev_rx_intr_enable(uint8_t port_id, uint16_t queue_id);
3442 * When lcore wakes up from rx interrupt indicating packet coming, disable rx
3443 * interrupt and returns to polling mode.
3445 * The rte_eth_dev_rx_intr_disable() function disables rx queue
3446 * interrupt on specific rx queue of a port.
3449 * The port identifier of the Ethernet device.
3451 * The index of the receive queue from which to retrieve input packets.
3452 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3453 * to rte_eth_dev_configure().
3455 * - (0) if successful.
3456 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3458 * - (-ENODEV) if *port_id* invalid.
3460 int rte_eth_dev_rx_intr_disable(uint8_t port_id, uint16_t queue_id);
3463 * RX Interrupt control per port.
3466 * The port identifier of the Ethernet device.
3468 * Epoll instance fd which the intr vector associated to.
3469 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
3471 * The operation be performed for the vector.
3472 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
3476 * - On success, zero.
3477 * - On failure, a negative value.
3479 int rte_eth_dev_rx_intr_ctl(uint8_t port_id, int epfd, int op, void *data);
3482 * RX Interrupt control per queue.
3485 * The port identifier of the Ethernet device.
3487 * The index of the receive queue from which to retrieve input packets.
3488 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3489 * to rte_eth_dev_configure().
3491 * Epoll instance fd which the intr vector associated to.
3492 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
3494 * The operation be performed for the vector.
3495 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
3499 * - On success, zero.
3500 * - On failure, a negative value.
3502 int rte_eth_dev_rx_intr_ctl_q(uint8_t port_id, uint16_t queue_id,
3503 int epfd, int op, void *data);
3506 * Turn on the LED on the Ethernet device.
3507 * This function turns on the LED on the Ethernet device.
3510 * The port identifier of the Ethernet device.
3512 * - (0) if successful.
3513 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3515 * - (-ENODEV) if *port_id* invalid.
3517 int rte_eth_led_on(uint8_t port_id);
3520 * Turn off the LED on the Ethernet device.
3521 * This function turns off the LED on the Ethernet device.
3524 * The port identifier of the Ethernet device.
3526 * - (0) if successful.
3527 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3529 * - (-ENODEV) if *port_id* invalid.
3531 int rte_eth_led_off(uint8_t port_id);
3534 * Get current status of the Ethernet link flow control for Ethernet device
3537 * The port identifier of the Ethernet device.
3539 * The pointer to the structure where to store the flow control parameters.
3541 * - (0) if successful.
3542 * - (-ENOTSUP) if hardware doesn't support flow control.
3543 * - (-ENODEV) if *port_id* invalid.
3545 int rte_eth_dev_flow_ctrl_get(uint8_t port_id,
3546 struct rte_eth_fc_conf *fc_conf);
3549 * Configure the Ethernet link flow control for Ethernet device
3552 * The port identifier of the Ethernet device.
3554 * The pointer to the structure of the flow control parameters.
3556 * - (0) if successful.
3557 * - (-ENOTSUP) if hardware doesn't support flow control mode.
3558 * - (-ENODEV) if *port_id* invalid.
3559 * - (-EINVAL) if bad parameter
3560 * - (-EIO) if flow control setup failure
3562 int rte_eth_dev_flow_ctrl_set(uint8_t port_id,
3563 struct rte_eth_fc_conf *fc_conf);
3566 * Configure the Ethernet priority flow control under DCB environment
3567 * for Ethernet device.
3570 * The port identifier of the Ethernet device.
3572 * The pointer to the structure of the priority flow control parameters.
3574 * - (0) if successful.
3575 * - (-ENOTSUP) if hardware doesn't support priority flow control mode.
3576 * - (-ENODEV) if *port_id* invalid.
3577 * - (-EINVAL) if bad parameter
3578 * - (-EIO) if flow control setup failure
3580 int rte_eth_dev_priority_flow_ctrl_set(uint8_t port_id,
3581 struct rte_eth_pfc_conf *pfc_conf);
3584 * Add a MAC address to an internal array of addresses used to enable whitelist
3585 * filtering to accept packets only if the destination MAC address matches.
3588 * The port identifier of the Ethernet device.
3590 * The MAC address to add.
3592 * VMDq pool index to associate address with (if VMDq is enabled). If VMDq is
3593 * not enabled, this should be set to 0.
3595 * - (0) if successfully added or *mac_addr" was already added.
3596 * - (-ENOTSUP) if hardware doesn't support this feature.
3597 * - (-ENODEV) if *port* is invalid.
3598 * - (-ENOSPC) if no more MAC addresses can be added.
3599 * - (-EINVAL) if MAC address is invalid.
3601 int rte_eth_dev_mac_addr_add(uint8_t port, struct ether_addr *mac_addr,
3605 * Remove a MAC address from the internal array of addresses.
3608 * The port identifier of the Ethernet device.
3610 * MAC address to remove.
3612 * - (0) if successful, or *mac_addr* didn't exist.
3613 * - (-ENOTSUP) if hardware doesn't support.
3614 * - (-ENODEV) if *port* invalid.
3615 * - (-EADDRINUSE) if attempting to remove the default MAC address
3617 int rte_eth_dev_mac_addr_remove(uint8_t port, struct ether_addr *mac_addr);
3620 * Set the default MAC address.
3623 * The port identifier of the Ethernet device.
3625 * New default MAC address.
3627 * - (0) if successful, or *mac_addr* didn't exist.
3628 * - (-ENOTSUP) if hardware doesn't support.
3629 * - (-ENODEV) if *port* invalid.
3630 * - (-EINVAL) if MAC address is invalid.
3632 int rte_eth_dev_default_mac_addr_set(uint8_t port, struct ether_addr *mac_addr);
3636 * Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3639 * The port identifier of the Ethernet device.
3643 * Redirection table size. The table size can be queried by
3644 * rte_eth_dev_info_get().
3646 * - (0) if successful.
3647 * - (-ENOTSUP) if hardware doesn't support.
3648 * - (-EINVAL) if bad parameter.
3650 int rte_eth_dev_rss_reta_update(uint8_t port,
3651 struct rte_eth_rss_reta_entry64 *reta_conf,
3652 uint16_t reta_size);
3655 * Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3658 * The port identifier of the Ethernet device.
3662 * Redirection table size. The table size can be queried by
3663 * rte_eth_dev_info_get().
3665 * - (0) if successful.
3666 * - (-ENOTSUP) if hardware doesn't support.
3667 * - (-EINVAL) if bad parameter.
3669 int rte_eth_dev_rss_reta_query(uint8_t port,
3670 struct rte_eth_rss_reta_entry64 *reta_conf,
3671 uint16_t reta_size);
3674 * Updates unicast hash table for receiving packet with the given destination
3675 * MAC address, and the packet is routed to all VFs for which the RX mode is
3676 * accept packets that match the unicast hash table.
3679 * The port identifier of the Ethernet device.
3681 * Unicast MAC address.
3683 * 1 - Set an unicast hash bit for receiving packets with the MAC address.
3684 * 0 - Clear an unicast hash bit.
3686 * - (0) if successful.
3687 * - (-ENOTSUP) if hardware doesn't support.
3688 * - (-ENODEV) if *port_id* invalid.
3689 * - (-EINVAL) if bad parameter.
3691 int rte_eth_dev_uc_hash_table_set(uint8_t port,struct ether_addr *addr,
3695 * Updates all unicast hash bitmaps for receiving packet with any Unicast
3696 * Ethernet MAC addresses,the packet is routed to all VFs for which the RX
3697 * mode is accept packets that match the unicast hash table.
3700 * The port identifier of the Ethernet device.
3702 * 1 - Set all unicast hash bitmaps for receiving all the Ethernet
3704 * 0 - Clear all unicast hash bitmaps
3706 * - (0) if successful.
3707 * - (-ENOTSUP) if hardware doesn't support.
3708 * - (-ENODEV) if *port_id* invalid.
3709 * - (-EINVAL) if bad parameter.
3711 int rte_eth_dev_uc_all_hash_table_set(uint8_t port,uint8_t on);
3714 * Set a traffic mirroring rule on an Ethernet device
3717 * The port identifier of the Ethernet device.
3718 * @param mirror_conf
3719 * The pointer to the traffic mirroring structure describing the mirroring rule.
3720 * The *rte_eth_vm_mirror_conf* structure includes the type of mirroring rule,
3721 * destination pool and the value of rule if enable vlan or pool mirroring.
3724 * The index of traffic mirroring rule, we support four separated rules.
3726 * 1 - Enable a mirroring rule.
3727 * 0 - Disable a mirroring rule.
3729 * - (0) if successful.
3730 * - (-ENOTSUP) if hardware doesn't support this feature.
3731 * - (-ENODEV) if *port_id* invalid.
3732 * - (-EINVAL) if the mr_conf information is not correct.
3734 int rte_eth_mirror_rule_set(uint8_t port_id,
3735 struct rte_eth_mirror_conf *mirror_conf,
3740 * Reset a traffic mirroring rule on an Ethernet device.
3743 * The port identifier of the Ethernet device.
3745 * The index of traffic mirroring rule, we support four separated rules.
3747 * - (0) if successful.
3748 * - (-ENOTSUP) if hardware doesn't support this feature.
3749 * - (-ENODEV) if *port_id* invalid.
3750 * - (-EINVAL) if bad parameter.
3752 int rte_eth_mirror_rule_reset(uint8_t port_id,
3756 * Set the rate limitation for a queue on an Ethernet device.
3759 * The port identifier of the Ethernet device.
3763 * The tx rate in Mbps. Allocated from the total port link speed.
3765 * - (0) if successful.
3766 * - (-ENOTSUP) if hardware doesn't support this feature.
3767 * - (-ENODEV) if *port_id* invalid.
3768 * - (-EINVAL) if bad parameter.
3770 int rte_eth_set_queue_rate_limit(uint8_t port_id, uint16_t queue_idx,
3774 * Configuration of Receive Side Scaling hash computation of Ethernet device.
3777 * The port identifier of the Ethernet device.
3779 * The new configuration to use for RSS hash computation on the port.
3781 * - (0) if successful.
3782 * - (-ENODEV) if port identifier is invalid.
3783 * - (-ENOTSUP) if hardware doesn't support.
3784 * - (-EINVAL) if bad parameter.
3786 int rte_eth_dev_rss_hash_update(uint8_t port_id,
3787 struct rte_eth_rss_conf *rss_conf);
3790 * Retrieve current configuration of Receive Side Scaling hash computation
3791 * of Ethernet device.
3794 * The port identifier of the Ethernet device.
3796 * Where to store the current RSS hash configuration of the Ethernet device.
3798 * - (0) if successful.
3799 * - (-ENODEV) if port identifier is invalid.
3800 * - (-ENOTSUP) if hardware doesn't support RSS.
3803 rte_eth_dev_rss_hash_conf_get(uint8_t port_id,
3804 struct rte_eth_rss_conf *rss_conf);
3807 * Add UDP tunneling port for a specific type of tunnel.
3808 * The packets with this UDP port will be identified as this type of tunnel.
3809 * Before enabling any offloading function for a tunnel, users can call this API
3810 * to change or add more UDP port for the tunnel. So the offloading function
3811 * can take effect on the packets with the specific UDP port.
3814 * The port identifier of the Ethernet device.
3816 * UDP tunneling configuration.
3819 * - (0) if successful.
3820 * - (-ENODEV) if port identifier is invalid.
3821 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3824 rte_eth_dev_udp_tunnel_port_add(uint8_t port_id,
3825 struct rte_eth_udp_tunnel *tunnel_udp);
3828 * Delete UDP tunneling port a specific type of tunnel.
3829 * The packets with this UDP port will not be identified as this type of tunnel
3831 * Before enabling any offloading function for a tunnel, users can call this API
3832 * to delete a UDP port for the tunnel. So the offloading function will not take
3833 * effect on the packets with the specific UDP port.
3836 * The port identifier of the Ethernet device.
3838 * UDP tunneling configuration.
3841 * - (0) if successful.
3842 * - (-ENODEV) if port identifier is invalid.
3843 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3846 rte_eth_dev_udp_tunnel_port_delete(uint8_t port_id,
3847 struct rte_eth_udp_tunnel *tunnel_udp);
3850 * Check whether the filter type is supported on an Ethernet device.
3851 * All the supported filter types are defined in 'rte_eth_ctrl.h'.
3854 * The port identifier of the Ethernet device.
3855 * @param filter_type
3858 * - (0) if successful.
3859 * - (-ENOTSUP) if hardware doesn't support this filter type.
3860 * - (-ENODEV) if *port_id* invalid.
3862 int rte_eth_dev_filter_supported(uint8_t port_id, enum rte_filter_type filter_type);
3865 * Take operations to assigned filter type on an Ethernet device.
3866 * All the supported operations and filter types are defined in 'rte_eth_ctrl.h'.
3869 * The port identifier of the Ethernet device.
3870 * @param filter_type
3873 * Type of operation.
3875 * A pointer to arguments defined specifically for the operation.
3877 * - (0) if successful.
3878 * - (-ENOTSUP) if hardware doesn't support.
3879 * - (-ENODEV) if *port_id* invalid.
3880 * - others depends on the specific operations implementation.
3882 int rte_eth_dev_filter_ctrl(uint8_t port_id, enum rte_filter_type filter_type,
3883 enum rte_filter_op filter_op, void *arg);
3886 * Get DCB information on an Ethernet device.
3889 * The port identifier of the Ethernet device.
3893 * - (0) if successful.
3894 * - (-ENODEV) if port identifier is invalid.
3895 * - (-ENOTSUP) if hardware doesn't support.
3897 int rte_eth_dev_get_dcb_info(uint8_t port_id,
3898 struct rte_eth_dcb_info *dcb_info);
3901 * Add a callback to be called on packet RX on a given port and queue.
3903 * This API configures a function to be called for each burst of
3904 * packets received on a given NIC port queue. The return value is a pointer
3905 * that can be used to later remove the callback using
3906 * rte_eth_remove_rx_callback().
3908 * Multiple functions are called in the order that they are added.
3911 * The port identifier of the Ethernet device.
3913 * The queue on the Ethernet device on which the callback is to be added.
3915 * The callback function
3917 * A generic pointer parameter which will be passed to each invocation of the
3918 * callback function on this port and queue.
3922 * On success, a pointer value which can later be used to remove the callback.
3924 void *rte_eth_add_rx_callback(uint8_t port_id, uint16_t queue_id,
3925 rte_rx_callback_fn fn, void *user_param);
3928 * Add a callback that must be called first on packet RX on a given port
3931 * This API configures a first function to be called for each burst of
3932 * packets received on a given NIC port queue. The return value is a pointer
3933 * that can be used to later remove the callback using
3934 * rte_eth_remove_rx_callback().
3936 * Multiple functions are called in the order that they are added.
3939 * The port identifier of the Ethernet device.
3941 * The queue on the Ethernet device on which the callback is to be added.
3943 * The callback function
3945 * A generic pointer parameter which will be passed to each invocation of the
3946 * callback function on this port and queue.
3950 * On success, a pointer value which can later be used to remove the callback.
3952 void *rte_eth_add_first_rx_callback(uint8_t port_id, uint16_t queue_id,
3953 rte_rx_callback_fn fn, void *user_param);
3956 * Add a callback to be called on packet TX on a given port and queue.
3958 * This API configures a function to be called for each burst of
3959 * packets sent on a given NIC port queue. The return value is a pointer
3960 * that can be used to later remove the callback using
3961 * rte_eth_remove_tx_callback().
3963 * Multiple functions are called in the order that they are added.
3966 * The port identifier of the Ethernet device.
3968 * The queue on the Ethernet device on which the callback is to be added.
3970 * The callback function
3972 * A generic pointer parameter which will be passed to each invocation of the
3973 * callback function on this port and queue.
3977 * On success, a pointer value which can later be used to remove the callback.
3979 void *rte_eth_add_tx_callback(uint8_t port_id, uint16_t queue_id,
3980 rte_tx_callback_fn fn, void *user_param);
3983 * Remove an RX packet callback from a given port and queue.
3985 * This function is used to removed callbacks that were added to a NIC port
3986 * queue using rte_eth_add_rx_callback().
3988 * Note: the callback is removed from the callback list but it isn't freed
3989 * since the it may still be in use. The memory for the callback can be
3990 * subsequently freed back by the application by calling rte_free():
3992 * - Immediately - if the port is stopped, or the user knows that no
3993 * callbacks are in flight e.g. if called from the thread doing RX/TX
3996 * - After a short delay - where the delay is sufficient to allow any
3997 * in-flight callbacks to complete.
4000 * The port identifier of the Ethernet device.
4002 * The queue on the Ethernet device from which the callback is to be removed.
4004 * User supplied callback created via rte_eth_add_rx_callback().
4007 * - 0: Success. Callback was removed.
4008 * - -ENOTSUP: Callback support is not available.
4009 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
4010 * is NULL or not found for the port/queue.
4012 int rte_eth_remove_rx_callback(uint8_t port_id, uint16_t queue_id,
4013 struct rte_eth_rxtx_callback *user_cb);
4016 * Remove a TX packet callback from a given port and queue.
4018 * This function is used to removed callbacks that were added to a NIC port
4019 * queue using rte_eth_add_tx_callback().
4021 * Note: the callback is removed from the callback list but it isn't freed
4022 * since the it may still be in use. The memory for the callback can be
4023 * subsequently freed back by the application by calling rte_free():
4025 * - Immediately - if the port is stopped, or the user knows that no
4026 * callbacks are in flight e.g. if called from the thread doing RX/TX
4029 * - After a short delay - where the delay is sufficient to allow any
4030 * in-flight callbacks to complete.
4033 * The port identifier of the Ethernet device.
4035 * The queue on the Ethernet device from which the callback is to be removed.
4037 * User supplied callback created via rte_eth_add_tx_callback().
4040 * - 0: Success. Callback was removed.
4041 * - -ENOTSUP: Callback support is not available.
4042 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
4043 * is NULL or not found for the port/queue.
4045 int rte_eth_remove_tx_callback(uint8_t port_id, uint16_t queue_id,
4046 struct rte_eth_rxtx_callback *user_cb);
4049 * Retrieve information about given port's RX queue.
4052 * The port identifier of the Ethernet device.
4054 * The RX queue on the Ethernet device for which information
4055 * will be retrieved.
4057 * A pointer to a structure of type *rte_eth_rxq_info_info* to be filled with
4058 * the information of the Ethernet device.
4062 * - -ENOTSUP: routine is not supported by the device PMD.
4063 * - -EINVAL: The port_id or the queue_id is out of range.
4065 int rte_eth_rx_queue_info_get(uint8_t port_id, uint16_t queue_id,
4066 struct rte_eth_rxq_info *qinfo);
4069 * Retrieve information about given port's TX queue.
4072 * The port identifier of the Ethernet device.
4074 * The TX queue on the Ethernet device for which information
4075 * will be retrieved.
4077 * A pointer to a structure of type *rte_eth_txq_info_info* to be filled with
4078 * the information of the Ethernet device.
4082 * - -ENOTSUP: routine is not supported by the device PMD.
4083 * - -EINVAL: The port_id or the queue_id is out of range.
4085 int rte_eth_tx_queue_info_get(uint8_t port_id, uint16_t queue_id,
4086 struct rte_eth_txq_info *qinfo);
4089 * Retrieve device registers and register attributes (number of registers and
4093 * The port identifier of the Ethernet device.
4095 * Pointer to rte_dev_reg_info structure to fill in. If info->data is
4096 * NULL the function fills in the width and length fields. If non-NULL
4097 * the registers are put into the buffer pointed at by the data field.
4099 * - (0) if successful.
4100 * - (-ENOTSUP) if hardware doesn't support.
4101 * - (-ENODEV) if *port_id* invalid.
4102 * - others depends on the specific operations implementation.
4104 int rte_eth_dev_get_reg_info(uint8_t port_id, struct rte_dev_reg_info *info);
4107 * Retrieve size of device EEPROM
4110 * The port identifier of the Ethernet device.
4112 * - (>=0) EEPROM size if successful.
4113 * - (-ENOTSUP) if hardware doesn't support.
4114 * - (-ENODEV) if *port_id* invalid.
4115 * - others depends on the specific operations implementation.
4117 int rte_eth_dev_get_eeprom_length(uint8_t port_id);
4120 * Retrieve EEPROM and EEPROM attribute
4123 * The port identifier of the Ethernet device.
4125 * The template includes buffer for return EEPROM data and
4126 * EEPROM attributes to be filled.
4128 * - (0) if successful.
4129 * - (-ENOTSUP) if hardware doesn't support.
4130 * - (-ENODEV) if *port_id* invalid.
4131 * - others depends on the specific operations implementation.
4133 int rte_eth_dev_get_eeprom(uint8_t port_id, struct rte_dev_eeprom_info *info);
4136 * Program EEPROM with provided data
4139 * The port identifier of the Ethernet device.
4141 * The template includes EEPROM data for programming and
4142 * EEPROM attributes to be filled
4144 * - (0) if successful.
4145 * - (-ENOTSUP) if hardware doesn't support.
4146 * - (-ENODEV) if *port_id* invalid.
4147 * - others depends on the specific operations implementation.
4149 int rte_eth_dev_set_eeprom(uint8_t port_id, struct rte_dev_eeprom_info *info);
4152 * Set the list of multicast addresses to filter on an Ethernet device.
4155 * The port identifier of the Ethernet device.
4156 * @param mc_addr_set
4157 * The array of multicast addresses to set. Equal to NULL when the function
4158 * is invoked to flush the set of filtered addresses.
4160 * The number of multicast addresses in the *mc_addr_set* array. Equal to 0
4161 * when the function is invoked to flush the set of filtered addresses.
4163 * - (0) if successful.
4164 * - (-ENODEV) if *port_id* invalid.
4165 * - (-ENOTSUP) if PMD of *port_id* doesn't support multicast filtering.
4166 * - (-ENOSPC) if *port_id* has not enough multicast filtering resources.
4168 int rte_eth_dev_set_mc_addr_list(uint8_t port_id,
4169 struct ether_addr *mc_addr_set,
4170 uint32_t nb_mc_addr);
4173 * Enable IEEE1588/802.1AS timestamping for an Ethernet device.
4176 * The port identifier of the Ethernet device.
4180 * - -ENODEV: The port ID is invalid.
4181 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4183 int rte_eth_timesync_enable(uint8_t port_id);
4186 * Disable IEEE1588/802.1AS timestamping for an Ethernet device.
4189 * The port identifier of the Ethernet device.
4193 * - -ENODEV: The port ID is invalid.
4194 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4196 int rte_eth_timesync_disable(uint8_t port_id);
4199 * Read an IEEE1588/802.1AS RX timestamp from an Ethernet device.
4202 * The port identifier of the Ethernet device.
4204 * Pointer to the timestamp struct.
4206 * Device specific flags. Used to pass the RX timesync register index to
4207 * i40e. Unused in igb/ixgbe, pass 0 instead.
4211 * - -EINVAL: No timestamp is available.
4212 * - -ENODEV: The port ID is invalid.
4213 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4215 int rte_eth_timesync_read_rx_timestamp(uint8_t port_id,
4216 struct timespec *timestamp, uint32_t flags);
4219 * Read an IEEE1588/802.1AS TX timestamp from an Ethernet device.
4222 * The port identifier of the Ethernet device.
4224 * Pointer to the timestamp struct.
4228 * - -EINVAL: No timestamp is available.
4229 * - -ENODEV: The port ID is invalid.
4230 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4232 int rte_eth_timesync_read_tx_timestamp(uint8_t port_id,
4233 struct timespec *timestamp);
4236 * Adjust the timesync clock on an Ethernet device.
4238 * This is usually used in conjunction with other Ethdev timesync functions to
4239 * synchronize the device time using the IEEE1588/802.1AS protocol.
4242 * The port identifier of the Ethernet device.
4244 * The adjustment in nanoseconds.
4248 * - -ENODEV: The port ID is invalid.
4249 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4251 int rte_eth_timesync_adjust_time(uint8_t port_id, int64_t delta);
4254 * Read the time from the timesync clock on an Ethernet device.
4256 * This is usually used in conjunction with other Ethdev timesync functions to
4257 * synchronize the device time using the IEEE1588/802.1AS protocol.
4260 * The port identifier of the Ethernet device.
4262 * Pointer to the timespec struct that holds the time.
4267 int rte_eth_timesync_read_time(uint8_t port_id, struct timespec *time);
4270 * Set the time of the timesync clock on an Ethernet device.
4272 * This is usually used in conjunction with other Ethdev timesync functions to
4273 * synchronize the device time using the IEEE1588/802.1AS protocol.
4276 * The port identifier of the Ethernet device.
4278 * Pointer to the timespec struct that holds the time.
4282 * - -EINVAL: No timestamp is available.
4283 * - -ENODEV: The port ID is invalid.
4284 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4286 int rte_eth_timesync_write_time(uint8_t port_id, const struct timespec *time);
4289 * Create memzone for HW rings.
4290 * malloc can't be used as the physical address is needed.
4291 * If the memzone is already created, then this function returns a ptr
4295 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
4297 * The name of the memory zone
4299 * The index of the queue to add to name
4301 * The sizeof of the memory area
4303 * Alignment for resulting memzone. Must be a power of 2.
4305 * The *socket_id* argument is the socket identifier in case of NUMA.
4307 const struct rte_memzone *
4308 rte_eth_dma_zone_reserve(const struct rte_eth_dev *eth_dev, const char *name,
4309 uint16_t queue_id, size_t size,
4310 unsigned align, int socket_id);
4313 * Config l2 tunnel ether type of an Ethernet device for filtering specific
4314 * tunnel packets by ether type.
4317 * The port identifier of the Ethernet device.
4319 * l2 tunnel configuration.
4322 * - (0) if successful.
4323 * - (-ENODEV) if port identifier is invalid.
4324 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4327 rte_eth_dev_l2_tunnel_eth_type_conf(uint8_t port_id,
4328 struct rte_eth_l2_tunnel_conf *l2_tunnel);
4331 * Enable/disable l2 tunnel offload functions. Include,
4332 * 1, The ability of parsing a type of l2 tunnel of an Ethernet device.
4333 * Filtering, forwarding and offloading this type of tunnel packets depend on
4335 * 2, Stripping the l2 tunnel tag.
4336 * 3, Insertion of the l2 tunnel tag.
4337 * 4, Forwarding the packets based on the l2 tunnel tag.
4340 * The port identifier of the Ethernet device.
4342 * l2 tunnel parameters.
4344 * Indicate the offload function.
4346 * Enable or disable this function.
4349 * - (0) if successful.
4350 * - (-ENODEV) if port identifier is invalid.
4351 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4354 rte_eth_dev_l2_tunnel_offload_set(uint8_t port_id,
4355 struct rte_eth_l2_tunnel_conf *l2_tunnel,
4360 * Get the port id from pci address or device name
4361 * Ex: 0000:2:00.0 or vdev name net_pcap0
4364 * pci address or name of the device
4366 * pointer to port identifier of the device
4368 * - (0) if successful and port_id is filled.
4369 * - (-ENODEV or -EINVAL) on failure.
4372 rte_eth_dev_get_port_by_name(const char *name, uint8_t *port_id);
4375 * Get the device name from port id
4378 * pointer to port identifier of the device
4380 * pci address or name of the device
4382 * - (0) if successful.
4383 * - (-EINVAL) on failure.
4386 rte_eth_dev_get_name_by_port(uint8_t port_id, char *name);
4389 * Check that numbers of Rx and Tx descriptors satisfy descriptors limits from
4390 * the ethernet device information, otherwise adjust them to boundaries.
4393 * The port identifier of the Ethernet device.
4395 * A pointer to a uint16_t where the number of receive
4396 * descriptors stored.
4398 * A pointer to a uint16_t where the number of transmit
4399 * descriptors stored.
4401 * - (0) if successful.
4402 * - (-ENOTSUP, -ENODEV or -EINVAL) on failure.
4404 int rte_eth_dev_adjust_nb_rx_tx_desc(uint8_t port_id,
4405 uint16_t *nb_rx_desc,
4406 uint16_t *nb_tx_desc);
4412 #endif /* _RTE_ETHDEV_H_ */