4 * Copyright(c) 2010-2016 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 #ifndef _RTE_ETHDEV_H_
35 #define _RTE_ETHDEV_H_
40 * RTE Ethernet Device API
42 * The Ethernet Device API is composed of two parts:
44 * - The application-oriented Ethernet API that includes functions to setup
45 * an Ethernet device (configure it, setup its RX and TX queues and start it),
46 * to get its MAC address, the speed and the status of its physical link,
47 * to receive and to transmit packets, and so on.
49 * - The driver-oriented Ethernet API that exports a function allowing
50 * an Ethernet Poll Mode Driver (PMD) to simultaneously register itself as
51 * an Ethernet device driver and as a PCI driver for a set of matching PCI
52 * [Ethernet] devices classes.
54 * By default, all the functions of the Ethernet Device API exported by a PMD
55 * are lock-free functions which assume to not be invoked in parallel on
56 * different logical cores to work on the same target object. For instance,
57 * the receive function of a PMD cannot be invoked in parallel on two logical
58 * cores to poll the same RX queue [of the same port]. Of course, this function
59 * can be invoked in parallel by different logical cores on different RX queues.
60 * It is the responsibility of the upper level application to enforce this rule.
62 * If needed, parallel accesses by multiple logical cores to shared queues
63 * shall be explicitly protected by dedicated inline lock-aware functions
64 * built on top of their corresponding lock-free functions of the PMD API.
66 * In all functions of the Ethernet API, the Ethernet device is
67 * designated by an integer >= 0 named the device port identifier.
69 * At the Ethernet driver level, Ethernet devices are represented by a generic
70 * data structure of type *rte_eth_dev*.
72 * Ethernet devices are dynamically registered during the PCI probing phase
73 * performed at EAL initialization time.
74 * When an Ethernet device is being probed, an *rte_eth_dev* structure and
75 * a new port identifier are allocated for that device. Then, the eth_dev_init()
76 * function supplied by the Ethernet driver matching the probed PCI
77 * device is invoked to properly initialize the device.
79 * The role of the device init function consists of resetting the hardware,
80 * checking access to Non-volatile Memory (NVM), reading the MAC address
83 * If the device init operation is successful, the correspondence between
84 * the port identifier assigned to the new device and its associated
85 * *rte_eth_dev* structure is effectively registered.
86 * Otherwise, both the *rte_eth_dev* structure and the port identifier are
89 * The functions exported by the application Ethernet API to setup a device
90 * designated by its port identifier must be invoked in the following order:
91 * - rte_eth_dev_configure()
92 * - rte_eth_tx_queue_setup()
93 * - rte_eth_rx_queue_setup()
94 * - rte_eth_dev_start()
96 * Then, the network application can invoke, in any order, the functions
97 * exported by the Ethernet API to get the MAC address of a given device, to
98 * get the speed and the status of a device physical link, to receive/transmit
99 * [burst of] packets, and so on.
101 * If the application wants to change the configuration (i.e. call
102 * rte_eth_dev_configure(), rte_eth_tx_queue_setup(), or
103 * rte_eth_rx_queue_setup()), it must call rte_eth_dev_stop() first to stop the
104 * device and then do the reconfiguration before calling rte_eth_dev_start()
105 * again. The tramsit and receive functions should not be invoked when the
108 * Please note that some configuration is not stored between calls to
109 * rte_eth_dev_stop()/rte_eth_dev_start(). The following configuration will
112 * - flow control settings
113 * - receive mode configuration (promiscuous mode, hardware checksum mode,
114 * RSS/VMDQ settings etc.)
115 * - VLAN filtering configuration
116 * - MAC addresses supplied to MAC address array
117 * - flow director filtering mode (but not filtering rules)
118 * - NIC queue statistics mappings
120 * Any other configuration will not be stored and will need to be re-entered
121 * after a call to rte_eth_dev_start().
123 * Finally, a network application can close an Ethernet device by invoking the
124 * rte_eth_dev_close() function.
126 * Each function of the application Ethernet API invokes a specific function
127 * of the PMD that controls the target device designated by its port
129 * For this purpose, all device-specific functions of an Ethernet driver are
130 * supplied through a set of pointers contained in a generic structure of type
132 * The address of the *eth_dev_ops* structure is stored in the *rte_eth_dev*
133 * structure by the device init function of the Ethernet driver, which is
134 * invoked during the PCI probing phase, as explained earlier.
136 * In other words, each function of the Ethernet API simply retrieves the
137 * *rte_eth_dev* structure associated with the device port identifier and
138 * performs an indirect invocation of the corresponding driver function
139 * supplied in the *eth_dev_ops* structure of the *rte_eth_dev* structure.
141 * For performance reasons, the address of the burst-oriented RX and TX
142 * functions of the Ethernet driver are not contained in the *eth_dev_ops*
143 * structure. Instead, they are directly stored at the beginning of the
144 * *rte_eth_dev* structure to avoid an extra indirect memory access during
147 * RTE ethernet device drivers do not use interrupts for transmitting or
148 * receiving. Instead, Ethernet drivers export Poll-Mode receive and transmit
149 * functions to applications.
150 * Both receive and transmit functions are packet-burst oriented to minimize
151 * their cost per packet through the following optimizations:
153 * - Sharing among multiple packets the incompressible cost of the
154 * invocation of receive/transmit functions.
156 * - Enabling receive/transmit functions to take advantage of burst-oriented
157 * hardware features (L1 cache, prefetch instructions, NIC head/tail
158 * registers) to minimize the number of CPU cycles per packet, for instance,
159 * by avoiding useless read memory accesses to ring descriptors, or by
160 * systematically using arrays of pointers that exactly fit L1 cache line
161 * boundaries and sizes.
163 * The burst-oriented receive function does not provide any error notification,
164 * to avoid the corresponding overhead. As a hint, the upper-level application
165 * might check the status of the device link once being systematically returned
166 * a 0 value by the receive function of the driver for a given number of tries.
177 /* Use this macro to check if LRO API is supported */
178 #define RTE_ETHDEV_HAS_LRO_SUPPORT
181 #include <rte_interrupts.h>
184 #include <rte_devargs.h>
185 #include "rte_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.
194 struct rte_eth_stats {
195 uint64_t ipackets; /**< Total number of successfully received packets. */
196 uint64_t opackets; /**< Total number of successfully transmitted packets.*/
197 uint64_t ibytes; /**< Total number of successfully received bytes. */
198 uint64_t obytes; /**< Total number of successfully transmitted bytes. */
200 /**< Total of RX packets dropped by the HW,
201 * because there are no available mbufs (i.e. RX queues are full).
203 uint64_t ibadcrc __rte_deprecated;
204 /**< Deprecated; Total of RX packets with CRC error. */
205 uint64_t ibadlen __rte_deprecated;
206 /**< Deprecated; Total of RX packets with bad length. */
207 uint64_t ierrors; /**< Total number of erroneous received packets. */
208 uint64_t oerrors; /**< Total number of failed transmitted packets. */
210 /**< Deprecated; Total number of multicast received packets. */
211 uint64_t rx_nombuf; /**< Total number of RX mbuf allocation failures. */
212 uint64_t fdirmatch __rte_deprecated;
213 /**< Deprecated; Total number of RX packets matching a filter. */
214 uint64_t fdirmiss __rte_deprecated;
215 /**< Deprecated; Total number of RX packets not matching any filter. */
216 uint64_t tx_pause_xon __rte_deprecated;
217 /**< Deprecated; Total nb. of XON pause frame sent. */
218 uint64_t rx_pause_xon __rte_deprecated;
219 /**< Deprecated; Total nb. of XON pause frame received. */
220 uint64_t tx_pause_xoff __rte_deprecated;
221 /**< Deprecated; Total nb. of XOFF pause frame sent. */
222 uint64_t rx_pause_xoff __rte_deprecated;
223 /**< Deprecated; Total nb. of XOFF pause frame received. */
224 uint64_t q_ipackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
225 /**< Total number of queue RX packets. */
226 uint64_t q_opackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
227 /**< Total number of queue TX packets. */
228 uint64_t q_ibytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
229 /**< Total number of successfully received queue bytes. */
230 uint64_t q_obytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
231 /**< Total number of successfully transmitted queue bytes. */
232 uint64_t q_errors[RTE_ETHDEV_QUEUE_STAT_CNTRS];
233 /**< Total number of queue packets received that are dropped. */
235 /**< Total number of good packets received from loopback,VF Only */
237 /**< Total number of good packets transmitted to loopback,VF Only */
239 /**< Total number of good bytes received from loopback,VF Only */
241 /**< Total number of good bytes transmitted to loopback,VF Only */
245 * Device supported speeds bitmap flags
247 #define ETH_LINK_SPEED_10M_HD (1 << 1) /**< 10 Mbps half-duplex */
248 #define ETH_LINK_SPEED_10M (1 << 2) /**< 10 Mbps full-duplex */
249 #define ETH_LINK_SPEED_100M_HD (1 << 3) /**< 100 Mbps half-duplex */
250 #define ETH_LINK_SPEED_100M (1 << 4) /**< 100 Mbps full-duplex */
251 #define ETH_LINK_SPEED_1G (1 << 5) /**< 1 Gbps */
252 #define ETH_LINK_SPEED_2_5G (1 << 6) /**< 2.5 Gbps */
253 #define ETH_LINK_SPEED_5G (1 << 7) /**< 5 Gbps */
254 #define ETH_LINK_SPEED_10G (1 << 8) /**< 10 Gbps */
255 #define ETH_LINK_SPEED_20G (1 << 9) /**< 20 Gbps */
256 #define ETH_LINK_SPEED_25G (1 << 10) /**< 25 Gbps */
257 #define ETH_LINK_SPEED_40G (1 << 11) /**< 40 Gbps */
258 #define ETH_LINK_SPEED_50G (1 << 12) /**< 50 Gbps */
259 #define ETH_LINK_SPEED_56G (1 << 13) /**< 56 Gbps */
262 * Ethernet numeric link speeds in Mbps
264 #define ETH_LINK_SPEED_AUTONEG 0 /**< Auto-negotiate link speed. */
265 #define ETH_SPEED_NUM_10M 10 /**< 10 Mbps */
266 #define ETH_SPEED_NUM_100M 100 /**< 100 Mbps */
267 #define ETH_SPEED_NUM_1G 1000 /**< 1 Gbps */
268 #define ETH_SPEED_NUM_2_5G 2500 /**< 2.5 Gbps */
269 #define ETH_SPEED_NUM_5G 5000 /**< 5 Gbps */
270 #define ETH_SPEED_NUM_10G 10000 /**< 10 Gbps */
271 #define ETH_SPEED_NUM_20G 20000 /**< 20 Gbps */
272 #define ETH_SPEED_NUM_25G 25000 /**< 25 Gbps */
273 #define ETH_SPEED_NUM_40G 40000 /**< 40 Gbps */
274 #define ETH_SPEED_NUM_50G 50000 /**< 50 Gbps */
275 #define ETH_SPEED_NUM_56G 56000 /**< 56 Gbps */
278 * A structure used to retrieve link-level information of an Ethernet port.
280 struct rte_eth_link {
281 uint16_t link_speed; /**< ETH_SPEED_NUM_ */
282 uint16_t link_duplex; /**< ETH_LINK_[HALF/FULL]_DUPLEX */
283 uint8_t link_status : 1; /**< ETH_LINK_[DOWN/UP] */
284 }__attribute__((aligned(8))); /**< aligned for atomic64 read/write */
286 /* Utility constants */
287 #define ETH_LINK_AUTONEG_DUPLEX 0 /**< Auto-negotiate duplex. */
288 #define ETH_LINK_HALF_DUPLEX 1 /**< Half-duplex connection. */
289 #define ETH_LINK_FULL_DUPLEX 2 /**< Full-duplex connection. */
290 #define ETH_LINK_DOWN 0 /**< Link is down. */
291 #define ETH_LINK_UP 1 /**< Link is up. */
294 * A structure used to configure the ring threshold registers of an RX/TX
295 * queue for an Ethernet port.
297 struct rte_eth_thresh {
298 uint8_t pthresh; /**< Ring prefetch threshold. */
299 uint8_t hthresh; /**< Ring host threshold. */
300 uint8_t wthresh; /**< Ring writeback threshold. */
304 * Simple flags are used for rte_eth_conf.rxmode.mq_mode.
306 #define ETH_MQ_RX_RSS_FLAG 0x1
307 #define ETH_MQ_RX_DCB_FLAG 0x2
308 #define ETH_MQ_RX_VMDQ_FLAG 0x4
311 * A set of values to identify what method is to be used to route
312 * packets to multiple queues.
314 enum rte_eth_rx_mq_mode {
315 /** None of DCB,RSS or VMDQ mode */
318 /** For RX side, only RSS is on */
319 ETH_MQ_RX_RSS = ETH_MQ_RX_RSS_FLAG,
320 /** For RX side,only DCB is on. */
321 ETH_MQ_RX_DCB = ETH_MQ_RX_DCB_FLAG,
322 /** Both DCB and RSS enable */
323 ETH_MQ_RX_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG,
325 /** Only VMDQ, no RSS nor DCB */
326 ETH_MQ_RX_VMDQ_ONLY = ETH_MQ_RX_VMDQ_FLAG,
327 /** RSS mode with VMDQ */
328 ETH_MQ_RX_VMDQ_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_VMDQ_FLAG,
329 /** Use VMDQ+DCB to route traffic to queues */
330 ETH_MQ_RX_VMDQ_DCB = ETH_MQ_RX_VMDQ_FLAG | ETH_MQ_RX_DCB_FLAG,
331 /** Enable both VMDQ and DCB in VMDq */
332 ETH_MQ_RX_VMDQ_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG |
337 * for rx mq mode backward compatible
339 #define ETH_RSS ETH_MQ_RX_RSS
340 #define VMDQ_DCB ETH_MQ_RX_VMDQ_DCB
341 #define ETH_DCB_RX ETH_MQ_RX_DCB
344 * A set of values to identify what method is to be used to transmit
345 * packets using multi-TCs.
347 enum rte_eth_tx_mq_mode {
348 ETH_MQ_TX_NONE = 0, /**< It is in neither DCB nor VT mode. */
349 ETH_MQ_TX_DCB, /**< For TX side,only DCB is on. */
350 ETH_MQ_TX_VMDQ_DCB, /**< For TX side,both DCB and VT is on. */
351 ETH_MQ_TX_VMDQ_ONLY, /**< Only VT on, no DCB */
355 * for tx mq mode backward compatible
357 #define ETH_DCB_NONE ETH_MQ_TX_NONE
358 #define ETH_VMDQ_DCB_TX ETH_MQ_TX_VMDQ_DCB
359 #define ETH_DCB_TX ETH_MQ_TX_DCB
362 * A structure used to configure the RX features of an Ethernet port.
364 struct rte_eth_rxmode {
365 /** The multi-queue packet distribution mode to be used, e.g. RSS. */
366 enum rte_eth_rx_mq_mode mq_mode;
367 uint32_t max_rx_pkt_len; /**< Only used if jumbo_frame enabled. */
368 uint16_t split_hdr_size; /**< hdr buf size (header_split enabled).*/
369 uint16_t header_split : 1, /**< Header Split enable. */
370 hw_ip_checksum : 1, /**< IP/UDP/TCP checksum offload enable. */
371 hw_vlan_filter : 1, /**< VLAN filter enable. */
372 hw_vlan_strip : 1, /**< VLAN strip enable. */
373 hw_vlan_extend : 1, /**< Extended VLAN enable. */
374 jumbo_frame : 1, /**< Jumbo Frame Receipt enable. */
375 hw_strip_crc : 1, /**< Enable CRC stripping by hardware. */
376 enable_scatter : 1, /**< Enable scatter packets rx handler */
377 enable_lro : 1; /**< Enable LRO */
381 * VLAN types to indicate if it is for single VLAN, inner VLAN or outer VLAN.
382 * Note that single VLAN is treated the same as inner VLAN.
385 ETH_VLAN_TYPE_UNKNOWN = 0,
386 ETH_VLAN_TYPE_INNER, /**< Single VLAN, or inner VLAN. */
387 ETH_VLAN_TYPE_OUTER, /**< Outer VLAN. */
392 * A structure used to configure the Receive Side Scaling (RSS) feature
393 * of an Ethernet port.
394 * If not NULL, the *rss_key* pointer of the *rss_conf* structure points
395 * to an array holding the RSS key to use for hashing specific header
396 * fields of received packets. The length of this array should be indicated
397 * by *rss_key_len* below. Otherwise, a default random hash key is used by
400 * The *rss_key_len* field of the *rss_conf* structure indicates the length
401 * in bytes of the array pointed by *rss_key*. To be compatible, this length
402 * will be checked in i40e only. Others assume 40 bytes to be used as before.
404 * The *rss_hf* field of the *rss_conf* structure indicates the different
405 * types of IPv4/IPv6 packets to which the RSS hashing must be applied.
406 * Supplying an *rss_hf* equal to zero disables the RSS feature.
408 struct rte_eth_rss_conf {
409 uint8_t *rss_key; /**< If not NULL, 40-byte hash key. */
410 uint8_t rss_key_len; /**< hash key length in bytes. */
411 uint64_t rss_hf; /**< Hash functions to apply - see below. */
415 * The RSS offload types are defined based on flow types which are defined
416 * in rte_eth_ctrl.h. Different NIC hardwares may support different RSS offload
417 * types. The supported flow types or RSS offload types can be queried by
418 * rte_eth_dev_info_get().
420 #define ETH_RSS_IPV4 (1ULL << RTE_ETH_FLOW_IPV4)
421 #define ETH_RSS_FRAG_IPV4 (1ULL << RTE_ETH_FLOW_FRAG_IPV4)
422 #define ETH_RSS_NONFRAG_IPV4_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_TCP)
423 #define ETH_RSS_NONFRAG_IPV4_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_UDP)
424 #define ETH_RSS_NONFRAG_IPV4_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_SCTP)
425 #define ETH_RSS_NONFRAG_IPV4_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_OTHER)
426 #define ETH_RSS_IPV6 (1ULL << RTE_ETH_FLOW_IPV6)
427 #define ETH_RSS_FRAG_IPV6 (1ULL << RTE_ETH_FLOW_FRAG_IPV6)
428 #define ETH_RSS_NONFRAG_IPV6_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_TCP)
429 #define ETH_RSS_NONFRAG_IPV6_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_UDP)
430 #define ETH_RSS_NONFRAG_IPV6_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_SCTP)
431 #define ETH_RSS_NONFRAG_IPV6_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_OTHER)
432 #define ETH_RSS_L2_PAYLOAD (1ULL << RTE_ETH_FLOW_L2_PAYLOAD)
433 #define ETH_RSS_IPV6_EX (1ULL << RTE_ETH_FLOW_IPV6_EX)
434 #define ETH_RSS_IPV6_TCP_EX (1ULL << RTE_ETH_FLOW_IPV6_TCP_EX)
435 #define ETH_RSS_IPV6_UDP_EX (1ULL << RTE_ETH_FLOW_IPV6_UDP_EX)
437 #define ETH_RSS_IP ( \
439 ETH_RSS_FRAG_IPV4 | \
440 ETH_RSS_NONFRAG_IPV4_OTHER | \
442 ETH_RSS_FRAG_IPV6 | \
443 ETH_RSS_NONFRAG_IPV6_OTHER | \
446 #define ETH_RSS_UDP ( \
447 ETH_RSS_NONFRAG_IPV4_UDP | \
448 ETH_RSS_NONFRAG_IPV6_UDP | \
451 #define ETH_RSS_TCP ( \
452 ETH_RSS_NONFRAG_IPV4_TCP | \
453 ETH_RSS_NONFRAG_IPV6_TCP | \
456 #define ETH_RSS_SCTP ( \
457 ETH_RSS_NONFRAG_IPV4_SCTP | \
458 ETH_RSS_NONFRAG_IPV6_SCTP)
460 /**< Mask of valid RSS hash protocols */
461 #define ETH_RSS_PROTO_MASK ( \
463 ETH_RSS_FRAG_IPV4 | \
464 ETH_RSS_NONFRAG_IPV4_TCP | \
465 ETH_RSS_NONFRAG_IPV4_UDP | \
466 ETH_RSS_NONFRAG_IPV4_SCTP | \
467 ETH_RSS_NONFRAG_IPV4_OTHER | \
469 ETH_RSS_FRAG_IPV6 | \
470 ETH_RSS_NONFRAG_IPV6_TCP | \
471 ETH_RSS_NONFRAG_IPV6_UDP | \
472 ETH_RSS_NONFRAG_IPV6_SCTP | \
473 ETH_RSS_NONFRAG_IPV6_OTHER | \
474 ETH_RSS_L2_PAYLOAD | \
476 ETH_RSS_IPV6_TCP_EX | \
480 * Definitions used for redirection table entry size.
481 * Some RSS RETA sizes may not be supported by some drivers, check the
482 * documentation or the description of relevant functions for more details.
484 #define ETH_RSS_RETA_SIZE_64 64
485 #define ETH_RSS_RETA_SIZE_128 128
486 #define ETH_RSS_RETA_SIZE_512 512
487 #define RTE_RETA_GROUP_SIZE 64
489 /* Definitions used for VMDQ and DCB functionality */
490 #define ETH_VMDQ_MAX_VLAN_FILTERS 64 /**< Maximum nb. of VMDQ vlan filters. */
491 #define ETH_DCB_NUM_USER_PRIORITIES 8 /**< Maximum nb. of DCB priorities. */
492 #define ETH_VMDQ_DCB_NUM_QUEUES 128 /**< Maximum nb. of VMDQ DCB queues. */
493 #define ETH_DCB_NUM_QUEUES 128 /**< Maximum nb. of DCB queues. */
495 /* DCB capability defines */
496 #define ETH_DCB_PG_SUPPORT 0x00000001 /**< Priority Group(ETS) support. */
497 #define ETH_DCB_PFC_SUPPORT 0x00000002 /**< Priority Flow Control support. */
499 /* Definitions used for VLAN Offload functionality */
500 #define ETH_VLAN_STRIP_OFFLOAD 0x0001 /**< VLAN Strip On/Off */
501 #define ETH_VLAN_FILTER_OFFLOAD 0x0002 /**< VLAN Filter On/Off */
502 #define ETH_VLAN_EXTEND_OFFLOAD 0x0004 /**< VLAN Extend On/Off */
504 /* Definitions used for mask VLAN setting */
505 #define ETH_VLAN_STRIP_MASK 0x0001 /**< VLAN Strip setting mask */
506 #define ETH_VLAN_FILTER_MASK 0x0002 /**< VLAN Filter setting mask*/
507 #define ETH_VLAN_EXTEND_MASK 0x0004 /**< VLAN Extend setting mask*/
508 #define ETH_VLAN_ID_MAX 0x0FFF /**< VLAN ID is in lower 12 bits*/
510 /* Definitions used for receive MAC address */
511 #define ETH_NUM_RECEIVE_MAC_ADDR 128 /**< Maximum nb. of receive mac addr. */
513 /* Definitions used for unicast hash */
514 #define ETH_VMDQ_NUM_UC_HASH_ARRAY 128 /**< Maximum nb. of UC hash array. */
516 /* Definitions used for VMDQ pool rx mode setting */
517 #define ETH_VMDQ_ACCEPT_UNTAG 0x0001 /**< accept untagged packets. */
518 #define ETH_VMDQ_ACCEPT_HASH_MC 0x0002 /**< accept packets in multicast table . */
519 #define ETH_VMDQ_ACCEPT_HASH_UC 0x0004 /**< accept packets in unicast table. */
520 #define ETH_VMDQ_ACCEPT_BROADCAST 0x0008 /**< accept broadcast packets. */
521 #define ETH_VMDQ_ACCEPT_MULTICAST 0x0010 /**< multicast promiscuous. */
523 /** Maximum nb. of vlan per mirror rule */
524 #define ETH_MIRROR_MAX_VLANS 64
526 #define ETH_MIRROR_VIRTUAL_POOL_UP 0x01 /**< Virtual Pool uplink Mirroring. */
527 #define ETH_MIRROR_UPLINK_PORT 0x02 /**< Uplink Port Mirroring. */
528 #define ETH_MIRROR_DOWNLINK_PORT 0x04 /**< Downlink Port Mirroring. */
529 #define ETH_MIRROR_VLAN 0x08 /**< VLAN Mirroring. */
530 #define ETH_MIRROR_VIRTUAL_POOL_DOWN 0x10 /**< Virtual Pool downlink Mirroring. */
533 * A structure used to configure VLAN traffic mirror of an Ethernet port.
535 struct rte_eth_vlan_mirror {
536 uint64_t vlan_mask; /**< mask for valid VLAN ID. */
537 /** VLAN ID list for vlan mirroring. */
538 uint16_t vlan_id[ETH_MIRROR_MAX_VLANS];
542 * A structure used to configure traffic mirror of an Ethernet port.
544 struct rte_eth_mirror_conf {
545 uint8_t rule_type; /**< Mirroring rule type */
546 uint8_t dst_pool; /**< Destination pool for this mirror rule. */
547 uint64_t pool_mask; /**< Bitmap of pool for pool mirroring */
548 /** VLAN ID setting for VLAN mirroring. */
549 struct rte_eth_vlan_mirror vlan;
553 * A structure used to configure 64 entries of Redirection Table of the
554 * Receive Side Scaling (RSS) feature of an Ethernet port. To configure
555 * more than 64 entries supported by hardware, an array of this structure
558 struct rte_eth_rss_reta_entry64 {
560 /**< Mask bits indicate which entries need to be updated/queried. */
561 uint16_t reta[RTE_RETA_GROUP_SIZE];
562 /**< Group of 64 redirection table entries. */
566 * This enum indicates the possible number of traffic classes
567 * in DCB configratioins
569 enum rte_eth_nb_tcs {
570 ETH_4_TCS = 4, /**< 4 TCs with DCB. */
571 ETH_8_TCS = 8 /**< 8 TCs with DCB. */
575 * This enum indicates the possible number of queue pools
576 * in VMDQ configurations.
578 enum rte_eth_nb_pools {
579 ETH_8_POOLS = 8, /**< 8 VMDq pools. */
580 ETH_16_POOLS = 16, /**< 16 VMDq pools. */
581 ETH_32_POOLS = 32, /**< 32 VMDq pools. */
582 ETH_64_POOLS = 64 /**< 64 VMDq pools. */
585 /* This structure may be extended in future. */
586 struct rte_eth_dcb_rx_conf {
587 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs */
588 /** Traffic class each UP mapped to. */
589 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
592 struct rte_eth_vmdq_dcb_tx_conf {
593 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools. */
594 /** Traffic class each UP mapped to. */
595 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
598 struct rte_eth_dcb_tx_conf {
599 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs. */
600 /** Traffic class each UP mapped to. */
601 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
604 struct rte_eth_vmdq_tx_conf {
605 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq mode, 64 pools. */
609 * A structure used to configure the VMDQ+DCB feature
610 * of an Ethernet port.
612 * Using this feature, packets are routed to a pool of queues, based
613 * on the vlan id in the vlan tag, and then to a specific queue within
614 * that pool, using the user priority vlan tag field.
616 * A default pool may be used, if desired, to route all traffic which
617 * does not match the vlan filter rules.
619 struct rte_eth_vmdq_dcb_conf {
620 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools */
621 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
622 uint8_t default_pool; /**< The default pool, if applicable */
623 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
625 uint16_t vlan_id; /**< The vlan id of the received frame */
626 uint64_t pools; /**< Bitmask of pools for packet rx */
627 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
628 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
629 /**< Selects a queue in a pool */
632 struct rte_eth_vmdq_rx_conf {
633 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq only mode, 8 or 64 pools */
634 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
635 uint8_t default_pool; /**< The default pool, if applicable */
636 uint8_t enable_loop_back; /**< Enable VT loop back */
637 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
638 uint32_t rx_mode; /**< Flags from ETH_VMDQ_ACCEPT_* */
640 uint16_t vlan_id; /**< The vlan id of the received frame */
641 uint64_t pools; /**< Bitmask of pools for packet rx */
642 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
646 * A structure used to configure the TX features of an Ethernet port.
648 struct rte_eth_txmode {
649 enum rte_eth_tx_mq_mode mq_mode; /**< TX multi-queues mode. */
651 /* For i40e specifically */
653 uint8_t hw_vlan_reject_tagged : 1,
654 /**< If set, reject sending out tagged pkts */
655 hw_vlan_reject_untagged : 1,
656 /**< If set, reject sending out untagged pkts */
657 hw_vlan_insert_pvid : 1;
658 /**< If set, enable port based VLAN insertion */
662 * A structure used to configure an RX ring of an Ethernet port.
664 struct rte_eth_rxconf {
665 struct rte_eth_thresh rx_thresh; /**< RX ring threshold registers. */
666 uint16_t rx_free_thresh; /**< Drives the freeing of RX descriptors. */
667 uint8_t rx_drop_en; /**< Drop packets if no descriptors are available. */
668 uint8_t rx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
671 #define ETH_TXQ_FLAGS_NOMULTSEGS 0x0001 /**< nb_segs=1 for all mbufs */
672 #define ETH_TXQ_FLAGS_NOREFCOUNT 0x0002 /**< refcnt can be ignored */
673 #define ETH_TXQ_FLAGS_NOMULTMEMP 0x0004 /**< all bufs come from same mempool */
674 #define ETH_TXQ_FLAGS_NOVLANOFFL 0x0100 /**< disable VLAN offload */
675 #define ETH_TXQ_FLAGS_NOXSUMSCTP 0x0200 /**< disable SCTP checksum offload */
676 #define ETH_TXQ_FLAGS_NOXSUMUDP 0x0400 /**< disable UDP checksum offload */
677 #define ETH_TXQ_FLAGS_NOXSUMTCP 0x0800 /**< disable TCP checksum offload */
678 #define ETH_TXQ_FLAGS_NOOFFLOADS \
679 (ETH_TXQ_FLAGS_NOVLANOFFL | ETH_TXQ_FLAGS_NOXSUMSCTP | \
680 ETH_TXQ_FLAGS_NOXSUMUDP | ETH_TXQ_FLAGS_NOXSUMTCP)
681 #define ETH_TXQ_FLAGS_NOXSUMS \
682 (ETH_TXQ_FLAGS_NOXSUMSCTP | ETH_TXQ_FLAGS_NOXSUMUDP | \
683 ETH_TXQ_FLAGS_NOXSUMTCP)
685 * A structure used to configure a TX ring of an Ethernet port.
687 struct rte_eth_txconf {
688 struct rte_eth_thresh tx_thresh; /**< TX ring threshold registers. */
689 uint16_t tx_rs_thresh; /**< Drives the setting of RS bit on TXDs. */
690 uint16_t tx_free_thresh; /**< Start freeing TX buffers if there are
691 less free descriptors than this value. */
693 uint32_t txq_flags; /**< Set flags for the Tx queue */
694 uint8_t tx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
698 * A structure contains information about HW descriptor ring limitations.
700 struct rte_eth_desc_lim {
701 uint16_t nb_max; /**< Max allowed number of descriptors. */
702 uint16_t nb_min; /**< Min allowed number of descriptors. */
703 uint16_t nb_align; /**< Number of descriptors should be aligned to. */
707 * This enum indicates the flow control mode
709 enum rte_eth_fc_mode {
710 RTE_FC_NONE = 0, /**< Disable flow control. */
711 RTE_FC_RX_PAUSE, /**< RX pause frame, enable flowctrl on TX side. */
712 RTE_FC_TX_PAUSE, /**< TX pause frame, enable flowctrl on RX side. */
713 RTE_FC_FULL /**< Enable flow control on both side. */
717 * A structure used to configure Ethernet flow control parameter.
718 * These parameters will be configured into the register of the NIC.
719 * Please refer to the corresponding data sheet for proper value.
721 struct rte_eth_fc_conf {
722 uint32_t high_water; /**< High threshold value to trigger XOFF */
723 uint32_t low_water; /**< Low threshold value to trigger XON */
724 uint16_t pause_time; /**< Pause quota in the Pause frame */
725 uint16_t send_xon; /**< Is XON frame need be sent */
726 enum rte_eth_fc_mode mode; /**< Link flow control mode */
727 uint8_t mac_ctrl_frame_fwd; /**< Forward MAC control frames */
728 uint8_t autoneg; /**< Use Pause autoneg */
732 * A structure used to configure Ethernet priority flow control parameter.
733 * These parameters will be configured into the register of the NIC.
734 * Please refer to the corresponding data sheet for proper value.
736 struct rte_eth_pfc_conf {
737 struct rte_eth_fc_conf fc; /**< General flow control parameter. */
738 uint8_t priority; /**< VLAN User Priority. */
742 * Memory space that can be configured to store Flow Director filters
743 * in the board memory.
745 enum rte_fdir_pballoc_type {
746 RTE_FDIR_PBALLOC_64K = 0, /**< 64k. */
747 RTE_FDIR_PBALLOC_128K, /**< 128k. */
748 RTE_FDIR_PBALLOC_256K, /**< 256k. */
752 * Select report mode of FDIR hash information in RX descriptors.
754 enum rte_fdir_status_mode {
755 RTE_FDIR_NO_REPORT_STATUS = 0, /**< Never report FDIR hash. */
756 RTE_FDIR_REPORT_STATUS, /**< Only report FDIR hash for matching pkts. */
757 RTE_FDIR_REPORT_STATUS_ALWAYS, /**< Always report FDIR hash. */
761 * A structure used to configure the Flow Director (FDIR) feature
762 * of an Ethernet port.
764 * If mode is RTE_FDIR_DISABLE, the pballoc value is ignored.
766 struct rte_fdir_conf {
767 enum rte_fdir_mode mode; /**< Flow Director mode. */
768 enum rte_fdir_pballoc_type pballoc; /**< Space for FDIR filters. */
769 enum rte_fdir_status_mode status; /**< How to report FDIR hash. */
770 /** RX queue of packets matching a "drop" filter in perfect mode. */
772 struct rte_eth_fdir_masks mask;
773 struct rte_eth_fdir_flex_conf flex_conf;
774 /**< Flex payload configuration. */
778 * UDP tunneling configuration.
779 * Used to config the UDP port for a type of tunnel.
780 * NICs need the UDP port to identify the tunnel type.
781 * Normally a type of tunnel has a default UDP port, this structure can be used
782 * in case if the users want to change or support more UDP port.
784 struct rte_eth_udp_tunnel {
785 uint16_t udp_port; /**< UDP port used for the tunnel. */
786 uint8_t prot_type; /**< Tunnel type. Defined in rte_eth_tunnel_type. */
790 * A structure used to enable/disable specific device interrupts.
792 struct rte_intr_conf {
793 /** enable/disable lsc interrupt. 0 (default) - disable, 1 enable */
795 /** enable/disable rxq interrupt. 0 (default) - disable, 1 enable */
800 * A structure used to configure an Ethernet port.
801 * Depending upon the RX multi-queue mode, extra advanced
802 * configuration settings may be needed.
804 struct rte_eth_conf {
806 /**< ETH_SPEED_NUM_ or 0 for autonegotiation */
807 uint16_t link_duplex;
808 /**< ETH_LINK_[HALF_DUPLEX|FULL_DUPLEX], or 0 for autonegotation */
809 struct rte_eth_rxmode rxmode; /**< Port RX configuration. */
810 struct rte_eth_txmode txmode; /**< Port TX configuration. */
811 uint32_t lpbk_mode; /**< Loopback operation mode. By default the value
812 is 0, meaning the loopback mode is disabled.
813 Read the datasheet of given ethernet controller
814 for details. The possible values of this field
815 are defined in implementation of each driver. */
817 struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
818 struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
819 /**< Port vmdq+dcb configuration. */
820 struct rte_eth_dcb_rx_conf dcb_rx_conf;
821 /**< Port dcb RX configuration. */
822 struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
823 /**< Port vmdq RX configuration. */
824 } rx_adv_conf; /**< Port RX filtering configuration (union). */
826 struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
827 /**< Port vmdq+dcb TX configuration. */
828 struct rte_eth_dcb_tx_conf dcb_tx_conf;
829 /**< Port dcb TX configuration. */
830 struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
831 /**< Port vmdq TX configuration. */
832 } tx_adv_conf; /**< Port TX DCB configuration (union). */
833 /** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
834 is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
835 uint32_t dcb_capability_en;
836 struct rte_fdir_conf fdir_conf; /**< FDIR configuration. */
837 struct rte_intr_conf intr_conf; /**< Interrupt mode configuration. */
841 * A structure used to retrieve the contextual information of
842 * an Ethernet device, such as the controlling driver of the device,
843 * its PCI context, etc...
847 * RX offload capabilities of a device.
849 #define DEV_RX_OFFLOAD_VLAN_STRIP 0x00000001
850 #define DEV_RX_OFFLOAD_IPV4_CKSUM 0x00000002
851 #define DEV_RX_OFFLOAD_UDP_CKSUM 0x00000004
852 #define DEV_RX_OFFLOAD_TCP_CKSUM 0x00000008
853 #define DEV_RX_OFFLOAD_TCP_LRO 0x00000010
854 #define DEV_RX_OFFLOAD_QINQ_STRIP 0x00000020
855 #define DEV_RX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000040
858 * TX offload capabilities of a device.
860 #define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001
861 #define DEV_TX_OFFLOAD_IPV4_CKSUM 0x00000002
862 #define DEV_TX_OFFLOAD_UDP_CKSUM 0x00000004
863 #define DEV_TX_OFFLOAD_TCP_CKSUM 0x00000008
864 #define DEV_TX_OFFLOAD_SCTP_CKSUM 0x00000010
865 #define DEV_TX_OFFLOAD_TCP_TSO 0x00000020
866 #define DEV_TX_OFFLOAD_UDP_TSO 0x00000040
867 #define DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000080 /**< Used for tunneling packet. */
868 #define DEV_TX_OFFLOAD_QINQ_INSERT 0x00000100
871 * Ethernet device information
873 struct rte_eth_dev_info {
874 struct rte_pci_device *pci_dev; /**< Device PCI information. */
875 const char *driver_name; /**< Device Driver name. */
876 unsigned int if_index; /**< Index to bound host interface, or 0 if none.
877 Use if_indextoname() to translate into an interface name. */
878 uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
879 uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
880 uint16_t max_rx_queues; /**< Maximum number of RX queues. */
881 uint16_t max_tx_queues; /**< Maximum number of TX queues. */
882 uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
883 uint32_t max_hash_mac_addrs;
884 /** Maximum number of hash MAC addresses for MTA and UTA. */
885 uint16_t max_vfs; /**< Maximum number of VFs. */
886 uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
887 uint32_t rx_offload_capa; /**< Device RX offload capabilities. */
888 uint32_t tx_offload_capa; /**< Device TX offload capabilities. */
890 /**< Device redirection table size, the total number of entries. */
891 uint8_t hash_key_size; /**< Hash key size in bytes */
892 /** Bit mask of RSS offloads, the bit offset also means flow type */
893 uint64_t flow_type_rss_offloads;
894 struct rte_eth_rxconf default_rxconf; /**< Default RX configuration */
895 struct rte_eth_txconf default_txconf; /**< Default TX configuration */
896 uint16_t vmdq_queue_base; /**< First queue ID for VMDQ pools. */
897 uint16_t vmdq_queue_num; /**< Queue number for VMDQ pools. */
898 uint16_t vmdq_pool_base; /**< First ID of VMDQ pools. */
899 struct rte_eth_desc_lim rx_desc_lim; /**< RX descriptors limits */
900 struct rte_eth_desc_lim tx_desc_lim; /**< TX descriptors limits */
901 uint32_t speed_capa; /**< Supported speeds bitmap (ETH_LINK_SPEED_). */
905 * Ethernet device RX queue information structure.
906 * Used to retieve information about configured queue.
908 struct rte_eth_rxq_info {
909 struct rte_mempool *mp; /**< mempool used by that queue. */
910 struct rte_eth_rxconf conf; /**< queue config parameters. */
911 uint8_t scattered_rx; /**< scattered packets RX supported. */
912 uint16_t nb_desc; /**< configured number of RXDs. */
913 } __rte_cache_min_aligned;
916 * Ethernet device TX queue information structure.
917 * Used to retieve information about configured queue.
919 struct rte_eth_txq_info {
920 struct rte_eth_txconf conf; /**< queue config parameters. */
921 uint16_t nb_desc; /**< configured number of TXDs. */
922 } __rte_cache_min_aligned;
924 /** Maximum name length for extended statistics counters */
925 #define RTE_ETH_XSTATS_NAME_SIZE 64
928 * An Ethernet device extended statistic structure
930 * This structure is used by ethdev->eth_xstats_get() to provide
931 * statistics that are not provided in the generic rte_eth_stats
934 struct rte_eth_xstats {
935 char name[RTE_ETH_XSTATS_NAME_SIZE];
939 #define ETH_DCB_NUM_TCS 8
940 #define ETH_MAX_VMDQ_POOL 64
943 * A structure used to get the information of queue and
944 * TC mapping on both TX and RX paths.
946 struct rte_eth_dcb_tc_queue_mapping {
947 /** rx queues assigned to tc per Pool */
951 } tc_rxq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
952 /** rx queues assigned to tc per Pool */
956 } tc_txq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
960 * A structure used to get the information of DCB.
961 * It includes TC UP mapping and queue TC mapping.
963 struct rte_eth_dcb_info {
964 uint8_t nb_tcs; /**< number of TCs */
965 uint8_t prio_tc[ETH_DCB_NUM_USER_PRIORITIES]; /**< Priority to tc */
966 uint8_t tc_bws[ETH_DCB_NUM_TCS]; /**< TX BW percentage for each TC */
967 /** rx queues assigned to tc */
968 struct rte_eth_dcb_tc_queue_mapping tc_queue;
974 #define RTE_ETH_QUEUE_STATE_STOPPED 0
975 #define RTE_ETH_QUEUE_STATE_STARTED 1
979 struct rte_eth_dev_callback;
980 /** @internal Structure to keep track of registered callbacks */
981 TAILQ_HEAD(rte_eth_dev_cb_list, rte_eth_dev_callback);
984 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
985 #define RTE_PMD_DEBUG_TRACE(...) \
986 rte_pmd_debug_trace(__func__, __VA_ARGS__)
988 #define RTE_PMD_DEBUG_TRACE(...)
992 /* Macros to check for valid port */
993 #define RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, retval) do { \
994 if (!rte_eth_dev_is_valid_port(port_id)) { \
995 RTE_PMD_DEBUG_TRACE("Invalid port_id=%d\n", port_id); \
1000 #define RTE_ETH_VALID_PORTID_OR_RET(port_id) do { \
1001 if (!rte_eth_dev_is_valid_port(port_id)) { \
1002 RTE_PMD_DEBUG_TRACE("Invalid port_id=%d\n", port_id); \
1008 * l2 tunnel configuration.
1011 /**< l2 tunnel enable mask */
1012 #define ETH_L2_TUNNEL_ENABLE_MASK 0x00000001
1013 /**< l2 tunnel insertion mask */
1014 #define ETH_L2_TUNNEL_INSERTION_MASK 0x00000002
1015 /**< l2 tunnel stripping mask */
1016 #define ETH_L2_TUNNEL_STRIPPING_MASK 0x00000004
1017 /**< l2 tunnel forwarding mask */
1018 #define ETH_L2_TUNNEL_FORWARDING_MASK 0x00000008
1021 * Definitions of all functions exported by an Ethernet driver through the
1022 * the generic structure of type *eth_dev_ops* supplied in the *rte_eth_dev*
1023 * structure associated with an Ethernet device.
1026 typedef int (*eth_dev_configure_t)(struct rte_eth_dev *dev);
1027 /**< @internal Ethernet device configuration. */
1029 typedef int (*eth_dev_start_t)(struct rte_eth_dev *dev);
1030 /**< @internal Function used to start a configured Ethernet device. */
1032 typedef void (*eth_dev_stop_t)(struct rte_eth_dev *dev);
1033 /**< @internal Function used to stop a configured Ethernet device. */
1035 typedef int (*eth_dev_set_link_up_t)(struct rte_eth_dev *dev);
1036 /**< @internal Function used to link up a configured Ethernet device. */
1038 typedef int (*eth_dev_set_link_down_t)(struct rte_eth_dev *dev);
1039 /**< @internal Function used to link down a configured Ethernet device. */
1041 typedef void (*eth_dev_close_t)(struct rte_eth_dev *dev);
1042 /**< @internal Function used to close a configured Ethernet device. */
1044 typedef void (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev);
1045 /**< @internal Function used to enable the RX promiscuous mode of an Ethernet device. */
1047 typedef void (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev);
1048 /**< @internal Function used to disable the RX promiscuous mode of an Ethernet device. */
1050 typedef void (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
1051 /**< @internal Enable the receipt of all multicast packets by an Ethernet device. */
1053 typedef void (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
1054 /**< @internal Disable the receipt of all multicast packets by an Ethernet device. */
1056 typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
1057 int wait_to_complete);
1058 /**< @internal Get link speed, duplex mode and state (up/down) of an Ethernet device. */
1060 typedef void (*eth_stats_get_t)(struct rte_eth_dev *dev,
1061 struct rte_eth_stats *igb_stats);
1062 /**< @internal Get global I/O statistics of an Ethernet device. */
1064 typedef void (*eth_stats_reset_t)(struct rte_eth_dev *dev);
1065 /**< @internal Reset global I/O statistics of an Ethernet device to 0. */
1067 typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev,
1068 struct rte_eth_xstats *stats, unsigned n);
1069 /**< @internal Get extended stats of an Ethernet device. */
1071 typedef void (*eth_xstats_reset_t)(struct rte_eth_dev *dev);
1072 /**< @internal Reset extended stats of an Ethernet device. */
1074 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
1078 /**< @internal Set a queue statistics mapping for a tx/rx queue of an Ethernet device. */
1080 typedef void (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
1081 struct rte_eth_dev_info *dev_info);
1082 /**< @internal Get specific informations of an Ethernet device. */
1084 typedef const uint32_t *(*eth_dev_supported_ptypes_get_t)(struct rte_eth_dev *dev);
1085 /**< @internal Get supported ptypes of an Ethernet device. */
1087 typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
1089 /**< @internal Start rx and tx of a queue of an Ethernet device. */
1091 typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
1093 /**< @internal Stop rx and tx of a queue of an Ethernet device. */
1095 typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
1096 uint16_t rx_queue_id,
1097 uint16_t nb_rx_desc,
1098 unsigned int socket_id,
1099 const struct rte_eth_rxconf *rx_conf,
1100 struct rte_mempool *mb_pool);
1101 /**< @internal Set up a receive queue of an Ethernet device. */
1103 typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
1104 uint16_t tx_queue_id,
1105 uint16_t nb_tx_desc,
1106 unsigned int socket_id,
1107 const struct rte_eth_txconf *tx_conf);
1108 /**< @internal Setup a transmit queue of an Ethernet device. */
1110 typedef int (*eth_rx_enable_intr_t)(struct rte_eth_dev *dev,
1111 uint16_t rx_queue_id);
1112 /**< @internal Enable interrupt of a receive queue of an Ethernet device. */
1114 typedef int (*eth_rx_disable_intr_t)(struct rte_eth_dev *dev,
1115 uint16_t rx_queue_id);
1116 /**< @internal Disable interrupt of a receive queue of an Ethernet device. */
1118 typedef void (*eth_queue_release_t)(void *queue);
1119 /**< @internal Release memory resources allocated by given RX/TX queue. */
1121 typedef uint32_t (*eth_rx_queue_count_t)(struct rte_eth_dev *dev,
1122 uint16_t rx_queue_id);
1123 /**< @internal Get number of available descriptors on a receive queue of an Ethernet device. */
1125 typedef int (*eth_rx_descriptor_done_t)(void *rxq, uint16_t offset);
1126 /**< @internal Check DD bit of specific RX descriptor */
1128 typedef void (*eth_rxq_info_get_t)(struct rte_eth_dev *dev,
1129 uint16_t rx_queue_id, struct rte_eth_rxq_info *qinfo);
1131 typedef void (*eth_txq_info_get_t)(struct rte_eth_dev *dev,
1132 uint16_t tx_queue_id, struct rte_eth_txq_info *qinfo);
1134 typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);
1135 /**< @internal Set MTU. */
1137 typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
1140 /**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */
1142 typedef int (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
1143 enum rte_vlan_type type, uint16_t tpid);
1144 /**< @internal set the outer VLAN-TPID by an Ethernet device. */
1146 typedef void (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
1147 /**< @internal set VLAN offload function by an Ethernet device. */
1149 typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
1152 /**< @internal set port based TX VLAN insertion by an Ethernet device. */
1154 typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
1155 uint16_t rx_queue_id,
1157 /**< @internal VLAN stripping enable/disable by an queue of Ethernet device. */
1159 typedef uint16_t (*eth_rx_burst_t)(void *rxq,
1160 struct rte_mbuf **rx_pkts,
1162 /**< @internal Retrieve input packets from a receive queue of an Ethernet device. */
1164 typedef uint16_t (*eth_tx_burst_t)(void *txq,
1165 struct rte_mbuf **tx_pkts,
1167 /**< @internal Send output packets on a transmit queue of an Ethernet device. */
1169 typedef int (*flow_ctrl_get_t)(struct rte_eth_dev *dev,
1170 struct rte_eth_fc_conf *fc_conf);
1171 /**< @internal Get current flow control parameter on an Ethernet device */
1173 typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
1174 struct rte_eth_fc_conf *fc_conf);
1175 /**< @internal Setup flow control parameter on an Ethernet device */
1177 typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
1178 struct rte_eth_pfc_conf *pfc_conf);
1179 /**< @internal Setup priority flow control parameter on an Ethernet device */
1181 typedef int (*reta_update_t)(struct rte_eth_dev *dev,
1182 struct rte_eth_rss_reta_entry64 *reta_conf,
1183 uint16_t reta_size);
1184 /**< @internal Update RSS redirection table on an Ethernet device */
1186 typedef int (*reta_query_t)(struct rte_eth_dev *dev,
1187 struct rte_eth_rss_reta_entry64 *reta_conf,
1188 uint16_t reta_size);
1189 /**< @internal Query RSS redirection table on an Ethernet device */
1191 typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
1192 struct rte_eth_rss_conf *rss_conf);
1193 /**< @internal Update RSS hash configuration of an Ethernet device */
1195 typedef int (*rss_hash_conf_get_t)(struct rte_eth_dev *dev,
1196 struct rte_eth_rss_conf *rss_conf);
1197 /**< @internal Get current RSS hash configuration of an Ethernet device */
1199 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
1200 /**< @internal Turn on SW controllable LED on an Ethernet device */
1202 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
1203 /**< @internal Turn off SW controllable LED on an Ethernet device */
1205 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
1206 /**< @internal Remove MAC address from receive address register */
1208 typedef void (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
1209 struct ether_addr *mac_addr,
1212 /**< @internal Set a MAC address into Receive Address Address Register */
1214 typedef void (*eth_mac_addr_set_t)(struct rte_eth_dev *dev,
1215 struct ether_addr *mac_addr);
1216 /**< @internal Set a MAC address into Receive Address Address Register */
1218 typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
1219 struct ether_addr *mac_addr,
1221 /**< @internal Set a Unicast Hash bitmap */
1223 typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
1225 /**< @internal Set all Unicast Hash bitmap */
1227 typedef int (*eth_set_vf_rx_mode_t)(struct rte_eth_dev *dev,
1231 /**< @internal Set a VF receive mode */
1233 typedef int (*eth_set_vf_rx_t)(struct rte_eth_dev *dev,
1236 /**< @internal Set a VF receive mode */
1238 typedef int (*eth_set_vf_tx_t)(struct rte_eth_dev *dev,
1241 /**< @internal Enable or disable a VF transmit */
1243 typedef int (*eth_set_vf_vlan_filter_t)(struct rte_eth_dev *dev,
1247 /**< @internal Set VF VLAN pool filter */
1249 typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
1252 /**< @internal Set queue TX rate */
1254 typedef int (*eth_set_vf_rate_limit_t)(struct rte_eth_dev *dev,
1258 /**< @internal Set VF TX rate */
1260 typedef int (*eth_mirror_rule_set_t)(struct rte_eth_dev *dev,
1261 struct rte_eth_mirror_conf *mirror_conf,
1264 /**< @internal Add a traffic mirroring rule on an Ethernet device */
1266 typedef int (*eth_mirror_rule_reset_t)(struct rte_eth_dev *dev,
1268 /**< @internal Remove a traffic mirroring rule on an Ethernet device */
1270 typedef int (*eth_udp_tunnel_port_add_t)(struct rte_eth_dev *dev,
1271 struct rte_eth_udp_tunnel *tunnel_udp);
1272 /**< @internal Add tunneling UDP port */
1274 typedef int (*eth_udp_tunnel_port_del_t)(struct rte_eth_dev *dev,
1275 struct rte_eth_udp_tunnel *tunnel_udp);
1276 /**< @internal Delete tunneling UDP port */
1278 typedef int (*eth_set_mc_addr_list_t)(struct rte_eth_dev *dev,
1279 struct ether_addr *mc_addr_set,
1280 uint32_t nb_mc_addr);
1281 /**< @internal set the list of multicast addresses on an Ethernet device */
1283 typedef int (*eth_timesync_enable_t)(struct rte_eth_dev *dev);
1284 /**< @internal Function used to enable IEEE1588/802.1AS timestamping. */
1286 typedef int (*eth_timesync_disable_t)(struct rte_eth_dev *dev);
1287 /**< @internal Function used to disable IEEE1588/802.1AS timestamping. */
1289 typedef int (*eth_timesync_read_rx_timestamp_t)(struct rte_eth_dev *dev,
1290 struct timespec *timestamp,
1292 /**< @internal Function used to read an RX IEEE1588/802.1AS timestamp. */
1294 typedef int (*eth_timesync_read_tx_timestamp_t)(struct rte_eth_dev *dev,
1295 struct timespec *timestamp);
1296 /**< @internal Function used to read a TX IEEE1588/802.1AS timestamp. */
1298 typedef int (*eth_timesync_adjust_time)(struct rte_eth_dev *dev, int64_t);
1299 /**< @internal Function used to adjust the device clock */
1301 typedef int (*eth_timesync_read_time)(struct rte_eth_dev *dev,
1302 struct timespec *timestamp);
1303 /**< @internal Function used to get time from the device clock. */
1305 typedef int (*eth_timesync_write_time)(struct rte_eth_dev *dev,
1306 const struct timespec *timestamp);
1307 /**< @internal Function used to get time from the device clock */
1309 typedef int (*eth_get_reg_length_t)(struct rte_eth_dev *dev);
1310 /**< @internal Retrieve device register count */
1312 typedef int (*eth_get_reg_t)(struct rte_eth_dev *dev,
1313 struct rte_dev_reg_info *info);
1314 /**< @internal Retrieve registers */
1316 typedef int (*eth_get_eeprom_length_t)(struct rte_eth_dev *dev);
1317 /**< @internal Retrieve eeprom size */
1319 typedef int (*eth_get_eeprom_t)(struct rte_eth_dev *dev,
1320 struct rte_dev_eeprom_info *info);
1321 /**< @internal Retrieve eeprom data */
1323 typedef int (*eth_set_eeprom_t)(struct rte_eth_dev *dev,
1324 struct rte_dev_eeprom_info *info);
1325 /**< @internal Program eeprom data */
1327 typedef int (*eth_l2_tunnel_eth_type_conf_t)
1328 (struct rte_eth_dev *dev, struct rte_eth_l2_tunnel_conf *l2_tunnel);
1329 /**< @internal config l2 tunnel ether type */
1331 typedef int (*eth_l2_tunnel_offload_set_t)
1332 (struct rte_eth_dev *dev,
1333 struct rte_eth_l2_tunnel_conf *l2_tunnel,
1336 /**< @internal enable/disable the l2 tunnel offload functions */
1338 #ifdef RTE_NIC_BYPASS
1341 RTE_BYPASS_MODE_NONE,
1342 RTE_BYPASS_MODE_NORMAL,
1343 RTE_BYPASS_MODE_BYPASS,
1344 RTE_BYPASS_MODE_ISOLATE,
1345 RTE_BYPASS_MODE_NUM,
1348 #define RTE_BYPASS_MODE_VALID(x) \
1349 ((x) > RTE_BYPASS_MODE_NONE && (x) < RTE_BYPASS_MODE_NUM)
1352 RTE_BYPASS_EVENT_NONE,
1353 RTE_BYPASS_EVENT_START,
1354 RTE_BYPASS_EVENT_OS_ON = RTE_BYPASS_EVENT_START,
1355 RTE_BYPASS_EVENT_POWER_ON,
1356 RTE_BYPASS_EVENT_OS_OFF,
1357 RTE_BYPASS_EVENT_POWER_OFF,
1358 RTE_BYPASS_EVENT_TIMEOUT,
1359 RTE_BYPASS_EVENT_NUM
1362 #define RTE_BYPASS_EVENT_VALID(x) \
1363 ((x) > RTE_BYPASS_EVENT_NONE && (x) < RTE_BYPASS_MODE_NUM)
1366 RTE_BYPASS_TMT_OFF, /* timeout disabled. */
1367 RTE_BYPASS_TMT_1_5_SEC, /* timeout for 1.5 seconds */
1368 RTE_BYPASS_TMT_2_SEC, /* timeout for 2 seconds */
1369 RTE_BYPASS_TMT_3_SEC, /* timeout for 3 seconds */
1370 RTE_BYPASS_TMT_4_SEC, /* timeout for 4 seconds */
1371 RTE_BYPASS_TMT_8_SEC, /* timeout for 8 seconds */
1372 RTE_BYPASS_TMT_16_SEC, /* timeout for 16 seconds */
1373 RTE_BYPASS_TMT_32_SEC, /* timeout for 32 seconds */
1377 #define RTE_BYPASS_TMT_VALID(x) \
1378 ((x) == RTE_BYPASS_TMT_OFF || \
1379 ((x) > RTE_BYPASS_TMT_OFF && (x) < RTE_BYPASS_TMT_NUM))
1381 typedef void (*bypass_init_t)(struct rte_eth_dev *dev);
1382 typedef int32_t (*bypass_state_set_t)(struct rte_eth_dev *dev, uint32_t *new_state);
1383 typedef int32_t (*bypass_state_show_t)(struct rte_eth_dev *dev, uint32_t *state);
1384 typedef int32_t (*bypass_event_set_t)(struct rte_eth_dev *dev, uint32_t state, uint32_t event);
1385 typedef int32_t (*bypass_event_show_t)(struct rte_eth_dev *dev, uint32_t event_shift, uint32_t *event);
1386 typedef int32_t (*bypass_wd_timeout_set_t)(struct rte_eth_dev *dev, uint32_t timeout);
1387 typedef int32_t (*bypass_wd_timeout_show_t)(struct rte_eth_dev *dev, uint32_t *wd_timeout);
1388 typedef int32_t (*bypass_ver_show_t)(struct rte_eth_dev *dev, uint32_t *ver);
1389 typedef int32_t (*bypass_wd_reset_t)(struct rte_eth_dev *dev);
1392 typedef int (*eth_filter_ctrl_t)(struct rte_eth_dev *dev,
1393 enum rte_filter_type filter_type,
1394 enum rte_filter_op filter_op,
1396 /**< @internal Take operations to assigned filter type on an Ethernet device */
1398 typedef int (*eth_get_dcb_info)(struct rte_eth_dev *dev,
1399 struct rte_eth_dcb_info *dcb_info);
1400 /**< @internal Get dcb information on an Ethernet device */
1403 * @internal A structure containing the functions exported by an Ethernet driver.
1405 struct eth_dev_ops {
1406 eth_dev_configure_t dev_configure; /**< Configure device. */
1407 eth_dev_start_t dev_start; /**< Start device. */
1408 eth_dev_stop_t dev_stop; /**< Stop device. */
1409 eth_dev_set_link_up_t dev_set_link_up; /**< Device link up. */
1410 eth_dev_set_link_down_t dev_set_link_down; /**< Device link down. */
1411 eth_dev_close_t dev_close; /**< Close device. */
1412 eth_promiscuous_enable_t promiscuous_enable; /**< Promiscuous ON. */
1413 eth_promiscuous_disable_t promiscuous_disable;/**< Promiscuous OFF. */
1414 eth_allmulticast_enable_t allmulticast_enable;/**< RX multicast ON. */
1415 eth_allmulticast_disable_t allmulticast_disable;/**< RX multicast OF. */
1416 eth_link_update_t link_update; /**< Get device link state. */
1417 eth_stats_get_t stats_get; /**< Get generic device statistics. */
1418 eth_stats_reset_t stats_reset; /**< Reset generic device statistics. */
1419 eth_xstats_get_t xstats_get; /**< Get extended device statistics. */
1420 eth_xstats_reset_t xstats_reset; /**< Reset extended device statistics. */
1421 eth_queue_stats_mapping_set_t queue_stats_mapping_set;
1422 /**< Configure per queue stat counter mapping. */
1423 eth_dev_infos_get_t dev_infos_get; /**< Get device info. */
1424 eth_dev_supported_ptypes_get_t dev_supported_ptypes_get;
1425 /**< Get packet types supported and identified by device*/
1426 mtu_set_t mtu_set; /**< Set MTU. */
1427 vlan_filter_set_t vlan_filter_set; /**< Filter VLAN Setup. */
1428 vlan_tpid_set_t vlan_tpid_set; /**< Outer VLAN TPID Setup. */
1429 vlan_strip_queue_set_t vlan_strip_queue_set; /**< VLAN Stripping on queue. */
1430 vlan_offload_set_t vlan_offload_set; /**< Set VLAN Offload. */
1431 vlan_pvid_set_t vlan_pvid_set; /**< Set port based TX VLAN insertion */
1432 eth_queue_start_t rx_queue_start;/**< Start RX for a queue.*/
1433 eth_queue_stop_t rx_queue_stop;/**< Stop RX for a queue.*/
1434 eth_queue_start_t tx_queue_start;/**< Start TX for a queue.*/
1435 eth_queue_stop_t tx_queue_stop;/**< Stop TX for a queue.*/
1436 eth_rx_queue_setup_t rx_queue_setup;/**< Set up device RX queue.*/
1437 eth_queue_release_t rx_queue_release;/**< Release RX queue.*/
1438 eth_rx_queue_count_t rx_queue_count; /**< Get Rx queue count. */
1439 eth_rx_descriptor_done_t rx_descriptor_done; /**< Check rxd DD bit */
1440 /**< Enable Rx queue interrupt. */
1441 eth_rx_enable_intr_t rx_queue_intr_enable;
1442 /**< Disable Rx queue interrupt.*/
1443 eth_rx_disable_intr_t rx_queue_intr_disable;
1444 eth_tx_queue_setup_t tx_queue_setup;/**< Set up device TX queue.*/
1445 eth_queue_release_t tx_queue_release;/**< Release TX queue.*/
1446 eth_dev_led_on_t dev_led_on; /**< Turn on LED. */
1447 eth_dev_led_off_t dev_led_off; /**< Turn off LED. */
1448 flow_ctrl_get_t flow_ctrl_get; /**< Get flow control. */
1449 flow_ctrl_set_t flow_ctrl_set; /**< Setup flow control. */
1450 priority_flow_ctrl_set_t priority_flow_ctrl_set; /**< Setup priority flow control.*/
1451 eth_mac_addr_remove_t mac_addr_remove; /**< Remove MAC address */
1452 eth_mac_addr_add_t mac_addr_add; /**< Add a MAC address */
1453 eth_mac_addr_set_t mac_addr_set; /**< Set a MAC address */
1454 eth_uc_hash_table_set_t uc_hash_table_set; /**< Set Unicast Table Array */
1455 eth_uc_all_hash_table_set_t uc_all_hash_table_set; /**< Set Unicast hash bitmap */
1456 eth_mirror_rule_set_t mirror_rule_set; /**< Add a traffic mirror rule.*/
1457 eth_mirror_rule_reset_t mirror_rule_reset; /**< reset a traffic mirror rule.*/
1458 eth_set_vf_rx_mode_t set_vf_rx_mode; /**< Set VF RX mode */
1459 eth_set_vf_rx_t set_vf_rx; /**< enable/disable a VF receive */
1460 eth_set_vf_tx_t set_vf_tx; /**< enable/disable a VF transmit */
1461 eth_set_vf_vlan_filter_t set_vf_vlan_filter; /**< Set VF VLAN filter */
1462 /** Add UDP tunnel port. */
1463 eth_udp_tunnel_port_add_t udp_tunnel_port_add;
1464 /** Del UDP tunnel port. */
1465 eth_udp_tunnel_port_del_t udp_tunnel_port_del;
1466 eth_set_queue_rate_limit_t set_queue_rate_limit; /**< Set queue rate limit */
1467 eth_set_vf_rate_limit_t set_vf_rate_limit; /**< Set VF rate limit */
1468 /** Update redirection table. */
1469 reta_update_t reta_update;
1470 /** Query redirection table. */
1471 reta_query_t reta_query;
1473 eth_get_reg_length_t get_reg_length;
1474 /**< Get # of registers */
1475 eth_get_reg_t get_reg;
1476 /**< Get registers */
1477 eth_get_eeprom_length_t get_eeprom_length;
1478 /**< Get eeprom length */
1479 eth_get_eeprom_t get_eeprom;
1480 /**< Get eeprom data */
1481 eth_set_eeprom_t set_eeprom;
1483 /* bypass control */
1484 #ifdef RTE_NIC_BYPASS
1485 bypass_init_t bypass_init;
1486 bypass_state_set_t bypass_state_set;
1487 bypass_state_show_t bypass_state_show;
1488 bypass_event_set_t bypass_event_set;
1489 bypass_event_show_t bypass_event_show;
1490 bypass_wd_timeout_set_t bypass_wd_timeout_set;
1491 bypass_wd_timeout_show_t bypass_wd_timeout_show;
1492 bypass_ver_show_t bypass_ver_show;
1493 bypass_wd_reset_t bypass_wd_reset;
1496 /** Configure RSS hash protocols. */
1497 rss_hash_update_t rss_hash_update;
1498 /** Get current RSS hash configuration. */
1499 rss_hash_conf_get_t rss_hash_conf_get;
1500 eth_filter_ctrl_t filter_ctrl;
1501 /**< common filter control. */
1502 eth_set_mc_addr_list_t set_mc_addr_list; /**< set list of mcast addrs */
1503 eth_rxq_info_get_t rxq_info_get;
1504 /**< retrieve RX queue information. */
1505 eth_txq_info_get_t txq_info_get;
1506 /**< retrieve TX queue information. */
1507 /** Turn IEEE1588/802.1AS timestamping on. */
1508 eth_timesync_enable_t timesync_enable;
1509 /** Turn IEEE1588/802.1AS timestamping off. */
1510 eth_timesync_disable_t timesync_disable;
1511 /** Read the IEEE1588/802.1AS RX timestamp. */
1512 eth_timesync_read_rx_timestamp_t timesync_read_rx_timestamp;
1513 /** Read the IEEE1588/802.1AS TX timestamp. */
1514 eth_timesync_read_tx_timestamp_t timesync_read_tx_timestamp;
1516 /** Get DCB information */
1517 eth_get_dcb_info get_dcb_info;
1518 /** Adjust the device clock.*/
1519 eth_timesync_adjust_time timesync_adjust_time;
1520 /** Get the device clock time. */
1521 eth_timesync_read_time timesync_read_time;
1522 /** Set the device clock time. */
1523 eth_timesync_write_time timesync_write_time;
1524 /** Config ether type of l2 tunnel */
1525 eth_l2_tunnel_eth_type_conf_t l2_tunnel_eth_type_conf;
1526 /** Enable/disable l2 tunnel offload functions */
1527 eth_l2_tunnel_offload_set_t l2_tunnel_offload_set;
1531 * Function type used for RX packet processing packet callbacks.
1533 * The callback function is called on RX with a burst of packets that have
1534 * been received on the given port and queue.
1537 * The Ethernet port on which RX is being performed.
1539 * The queue on the Ethernet port which is being used to receive the packets.
1541 * The burst of packets that have just been received.
1543 * The number of packets in the burst pointed to by "pkts".
1545 * The max number of packets that can be stored in the "pkts" array.
1547 * The arbitrary user parameter passed in by the application when the callback
1548 * was originally configured.
1550 * The number of packets returned to the user.
1552 typedef uint16_t (*rte_rx_callback_fn)(uint8_t port, uint16_t queue,
1553 struct rte_mbuf *pkts[], uint16_t nb_pkts, uint16_t max_pkts,
1557 * Function type used for TX packet processing packet callbacks.
1559 * The callback function is called on TX with a burst of packets immediately
1560 * before the packets are put onto the hardware queue for transmission.
1563 * The Ethernet port on which TX is being performed.
1565 * The queue on the Ethernet port which is being used to transmit the packets.
1567 * The burst of packets that are about to be transmitted.
1569 * The number of packets in the burst pointed to by "pkts".
1571 * The arbitrary user parameter passed in by the application when the callback
1572 * was originally configured.
1574 * The number of packets to be written to the NIC.
1576 typedef uint16_t (*rte_tx_callback_fn)(uint8_t port, uint16_t queue,
1577 struct rte_mbuf *pkts[], uint16_t nb_pkts, void *user_param);
1581 * Structure used to hold information about the callbacks to be called for a
1582 * queue on RX and TX.
1584 struct rte_eth_rxtx_callback {
1585 struct rte_eth_rxtx_callback *next;
1587 rte_rx_callback_fn rx;
1588 rte_tx_callback_fn tx;
1594 * The eth device type.
1596 enum rte_eth_dev_type {
1597 RTE_ETH_DEV_UNKNOWN, /**< unknown device type */
1599 /**< Physical function and Virtual function of PCI devices */
1600 RTE_ETH_DEV_VIRTUAL, /**< non hardware device */
1601 RTE_ETH_DEV_MAX /**< max value of this enum */
1606 * The generic data structure associated with each ethernet device.
1608 * Pointers to burst-oriented packet receive and transmit functions are
1609 * located at the beginning of the structure, along with the pointer to
1610 * where all the data elements for the particular device are stored in shared
1611 * memory. This split allows the function pointer and driver data to be per-
1612 * process, while the actual configuration data for the device is shared.
1614 struct rte_eth_dev {
1615 eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
1616 eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
1617 struct rte_eth_dev_data *data; /**< Pointer to device data */
1618 const struct eth_driver *driver;/**< Driver for this device */
1619 const struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
1620 struct rte_pci_device *pci_dev; /**< PCI info. supplied by probing */
1621 /** User application callbacks for NIC interrupts */
1622 struct rte_eth_dev_cb_list link_intr_cbs;
1624 * User-supplied functions called from rx_burst to post-process
1625 * received packets before passing them to the user
1627 struct rte_eth_rxtx_callback *post_rx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
1629 * User-supplied functions called from tx_burst to pre-process
1630 * received packets before passing them to the driver for transmission.
1632 struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
1633 uint8_t attached; /**< Flag indicating the port is attached */
1634 enum rte_eth_dev_type dev_type; /**< Flag indicating the device type */
1637 struct rte_eth_dev_sriov {
1638 uint8_t active; /**< SRIOV is active with 16, 32 or 64 pools */
1639 uint8_t nb_q_per_pool; /**< rx queue number per pool */
1640 uint16_t def_vmdq_idx; /**< Default pool num used for PF */
1641 uint16_t def_pool_q_idx; /**< Default pool queue start reg index */
1643 #define RTE_ETH_DEV_SRIOV(dev) ((dev)->data->sriov)
1645 #define RTE_ETH_NAME_MAX_LEN (32)
1649 * The data part, with no function pointers, associated with each ethernet device.
1651 * This structure is safe to place in shared memory to be common among different
1652 * processes in a multi-process configuration.
1654 struct rte_eth_dev_data {
1655 char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
1657 void **rx_queues; /**< Array of pointers to RX queues. */
1658 void **tx_queues; /**< Array of pointers to TX queues. */
1659 uint16_t nb_rx_queues; /**< Number of RX queues. */
1660 uint16_t nb_tx_queues; /**< Number of TX queues. */
1662 struct rte_eth_dev_sriov sriov; /**< SRIOV data */
1664 void *dev_private; /**< PMD-specific private data */
1666 struct rte_eth_link dev_link;
1667 /**< Link-level information & status */
1669 struct rte_eth_conf dev_conf; /**< Configuration applied to device. */
1670 uint16_t mtu; /**< Maximum Transmission Unit. */
1672 uint32_t min_rx_buf_size;
1673 /**< Common rx buffer size handled by all queues */
1675 uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
1676 struct ether_addr* mac_addrs;/**< Device Ethernet Link address. */
1677 uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
1678 /** bitmap array of associating Ethernet MAC addresses to pools */
1679 struct ether_addr* hash_mac_addrs;
1680 /** Device Ethernet MAC addresses of hash filtering. */
1681 uint8_t port_id; /**< Device [external] port identifier. */
1682 uint8_t promiscuous : 1, /**< RX promiscuous mode ON(1) / OFF(0). */
1683 scattered_rx : 1, /**< RX of scattered packets is ON(1) / OFF(0) */
1684 all_multicast : 1, /**< RX all multicast mode ON(1) / OFF(0). */
1685 dev_started : 1, /**< Device state: STARTED(1) / STOPPED(0). */
1686 lro : 1; /**< RX LRO is ON(1) / OFF(0) */
1687 uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT];
1688 /** Queues state: STARTED(1) / STOPPED(0) */
1689 uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
1690 /** Queues state: STARTED(1) / STOPPED(0) */
1691 uint32_t dev_flags; /**< Capabilities */
1692 enum rte_kernel_driver kdrv; /**< Kernel driver passthrough */
1693 int numa_node; /**< NUMA node connection */
1694 const char *drv_name; /**< Driver name */
1697 /** Device supports hotplug detach */
1698 #define RTE_ETH_DEV_DETACHABLE 0x0001
1699 /** Device supports link state interrupt */
1700 #define RTE_ETH_DEV_INTR_LSC 0x0002
1701 /** Device is a bonded slave */
1702 #define RTE_ETH_DEV_BONDED_SLAVE 0x0004
1706 * The pool of *rte_eth_dev* structures. The size of the pool
1707 * is configured at compile-time in the <rte_ethdev.c> file.
1709 extern struct rte_eth_dev rte_eth_devices[];
1712 * Get the total number of Ethernet devices that have been successfully
1713 * initialized by the [matching] Ethernet driver during the PCI probing phase.
1714 * All devices whose port identifier is in the range
1715 * [0, rte_eth_dev_count() - 1] can be operated on by network applications
1716 * immediately after invoking rte_eal_init().
1717 * If the application unplugs a port using hotplug function, The enabled port
1718 * numbers may be noncontiguous. In the case, the applications need to manage
1719 * enabled port by themselves.
1722 * - The total number of usable Ethernet devices.
1724 uint8_t rte_eth_dev_count(void);
1728 * Returns a ethdev slot specified by the unique identifier name.
1731 * The pointer to the Unique identifier name for each Ethernet device
1733 * - The pointer to the ethdev slot, on success. NULL on error
1735 struct rte_eth_dev *rte_eth_dev_allocated(const char *name);
1739 * Allocates a new ethdev slot for an ethernet device and returns the pointer
1740 * to that slot for the driver to use.
1742 * @param name Unique identifier name for each Ethernet device
1743 * @param type Device type of this Ethernet device
1745 * - Slot in the rte_dev_devices array for a new device;
1747 struct rte_eth_dev *rte_eth_dev_allocate(const char *name,
1748 enum rte_eth_dev_type type);
1752 * Release the specified ethdev port.
1755 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure.
1757 * - 0 on success, negative on error
1759 int rte_eth_dev_release_port(struct rte_eth_dev *eth_dev);
1762 * Attach a new Ethernet device specified by aruguments.
1765 * A pointer to a strings array describing the new device
1766 * to be attached. The strings should be a pci address like
1767 * '0000:01:00.0' or virtual device name like 'eth_pcap0'.
1769 * A pointer to a port identifier actually attached.
1771 * 0 on success and port_id is filled, negative on error
1773 int rte_eth_dev_attach(const char *devargs, uint8_t *port_id);
1776 * Detach a Ethernet device specified by port identifier.
1777 * This function must be called when the device is in the
1781 * The port identifier of the device to detach.
1783 * A pointer to a device name actually detached.
1785 * 0 on success and devname is filled, negative on error
1787 int rte_eth_dev_detach(uint8_t port_id, char *devname);
1792 * Initialization function of an Ethernet driver invoked for each matching
1793 * Ethernet PCI device detected during the PCI probing phase.
1796 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1797 * associated with the matching device and which have been [automatically]
1798 * allocated in the *rte_eth_devices* array.
1799 * The *eth_dev* structure is supplied to the driver initialization function
1800 * with the following fields already initialized:
1802 * - *pci_dev*: Holds the pointers to the *rte_pci_device* structure which
1803 * contains the generic PCI information of the matching device.
1805 * - *driver*: Holds the pointer to the *eth_driver* structure.
1807 * - *dev_private*: Holds a pointer to the device private data structure.
1809 * - *mtu*: Contains the default Ethernet maximum frame length (1500).
1811 * - *port_id*: Contains the port index of the device (actually the index
1812 * of the *eth_dev* structure in the *rte_eth_devices* array).
1815 * - 0: Success, the device is properly initialized by the driver.
1816 * In particular, the driver MUST have set up the *dev_ops* pointer
1817 * of the *eth_dev* structure.
1818 * - <0: Error code of the device initialization failure.
1820 typedef int (*eth_dev_init_t)(struct rte_eth_dev *eth_dev);
1824 * Finalization function of an Ethernet driver invoked for each matching
1825 * Ethernet PCI device detected during the PCI closing phase.
1828 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1829 * associated with the matching device and which have been [automatically]
1830 * allocated in the *rte_eth_devices* array.
1832 * - 0: Success, the device is properly finalized by the driver.
1833 * In particular, the driver MUST free the *dev_ops* pointer
1834 * of the *eth_dev* structure.
1835 * - <0: Error code of the device initialization failure.
1837 typedef int (*eth_dev_uninit_t)(struct rte_eth_dev *eth_dev);
1841 * The structure associated with a PMD Ethernet driver.
1843 * Each Ethernet driver acts as a PCI driver and is represented by a generic
1844 * *eth_driver* structure that holds:
1846 * - An *rte_pci_driver* structure (which must be the first field).
1848 * - The *eth_dev_init* function invoked for each matching PCI device.
1850 * - The *eth_dev_uninit* function invoked for each matching PCI device.
1852 * - The size of the private data to allocate for each matching device.
1855 struct rte_pci_driver pci_drv; /**< The PMD is also a PCI driver. */
1856 eth_dev_init_t eth_dev_init; /**< Device init function. */
1857 eth_dev_uninit_t eth_dev_uninit; /**< Device uninit function. */
1858 unsigned int dev_private_size; /**< Size of device private data. */
1863 * A function invoked by the initialization function of an Ethernet driver
1864 * to simultaneously register itself as a PCI driver and as an Ethernet
1865 * Poll Mode Driver (PMD).
1868 * The pointer to the *eth_driver* structure associated with
1869 * the Ethernet driver.
1871 void rte_eth_driver_register(struct eth_driver *eth_drv);
1874 * Configure an Ethernet device.
1875 * This function must be invoked first before any other function in the
1876 * Ethernet API. This function can also be re-invoked when a device is in the
1880 * The port identifier of the Ethernet device to configure.
1881 * @param nb_rx_queue
1882 * The number of receive queues to set up for the Ethernet device.
1883 * @param nb_tx_queue
1884 * The number of transmit queues to set up for the Ethernet device.
1886 * The pointer to the configuration data to be used for the Ethernet device.
1887 * The *rte_eth_conf* structure includes:
1888 * - the hardware offload features to activate, with dedicated fields for
1889 * each statically configurable offload hardware feature provided by
1890 * Ethernet devices, such as IP checksum or VLAN tag stripping for
1892 * - the Receive Side Scaling (RSS) configuration when using multiple RX
1895 * Embedding all configuration information in a single data structure
1896 * is the more flexible method that allows the addition of new features
1897 * without changing the syntax of the API.
1899 * - 0: Success, device configured.
1900 * - <0: Error code returned by the driver configuration function.
1902 int rte_eth_dev_configure(uint8_t port_id, uint16_t nb_rx_queue,
1903 uint16_t nb_tx_queue, const struct rte_eth_conf *eth_conf);
1906 * Allocate and set up a receive queue for an Ethernet device.
1908 * The function allocates a contiguous block of memory for *nb_rx_desc*
1909 * receive descriptors from a memory zone associated with *socket_id*
1910 * and initializes each receive descriptor with a network buffer allocated
1911 * from the memory pool *mb_pool*.
1914 * The port identifier of the Ethernet device.
1915 * @param rx_queue_id
1916 * The index of the receive queue to set up.
1917 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1918 * to rte_eth_dev_configure().
1920 * The number of receive descriptors to allocate for the receive ring.
1922 * The *socket_id* argument is the socket identifier in case of NUMA.
1923 * The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1924 * the DMA memory allocated for the receive descriptors of the ring.
1926 * The pointer to the configuration data to be used for the receive queue.
1927 * NULL value is allowed, in which case default RX configuration
1929 * The *rx_conf* structure contains an *rx_thresh* structure with the values
1930 * of the Prefetch, Host, and Write-Back threshold registers of the receive
1933 * The pointer to the memory pool from which to allocate *rte_mbuf* network
1934 * memory buffers to populate each descriptor of the receive ring.
1936 * - 0: Success, receive queue correctly set up.
1937 * - -EINVAL: The size of network buffers which can be allocated from the
1938 * memory pool does not fit the various buffer sizes allowed by the
1939 * device controller.
1940 * - -ENOMEM: Unable to allocate the receive ring descriptors or to
1941 * allocate network memory buffers from the memory pool when
1942 * initializing receive descriptors.
1944 int rte_eth_rx_queue_setup(uint8_t port_id, uint16_t rx_queue_id,
1945 uint16_t nb_rx_desc, unsigned int socket_id,
1946 const struct rte_eth_rxconf *rx_conf,
1947 struct rte_mempool *mb_pool);
1950 * Allocate and set up a transmit queue for an Ethernet device.
1953 * The port identifier of the Ethernet device.
1954 * @param tx_queue_id
1955 * The index of the transmit queue to set up.
1956 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1957 * to rte_eth_dev_configure().
1959 * The number of transmit descriptors to allocate for the transmit ring.
1961 * The *socket_id* argument is the socket identifier in case of NUMA.
1962 * Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1963 * the DMA memory allocated for the transmit descriptors of the ring.
1965 * The pointer to the configuration data to be used for the transmit queue.
1966 * NULL value is allowed, in which case default RX configuration
1968 * The *tx_conf* structure contains the following data:
1969 * - The *tx_thresh* structure with the values of the Prefetch, Host, and
1970 * Write-Back threshold registers of the transmit ring.
1971 * When setting Write-Back threshold to the value greater then zero,
1972 * *tx_rs_thresh* value should be explicitly set to one.
1973 * - The *tx_free_thresh* value indicates the [minimum] number of network
1974 * buffers that must be pending in the transmit ring to trigger their
1975 * [implicit] freeing by the driver transmit function.
1976 * - The *tx_rs_thresh* value indicates the [minimum] number of transmit
1977 * descriptors that must be pending in the transmit ring before setting the
1978 * RS bit on a descriptor by the driver transmit function.
1979 * The *tx_rs_thresh* value should be less or equal then
1980 * *tx_free_thresh* value, and both of them should be less then
1982 * - The *txq_flags* member contains flags to pass to the TX queue setup
1983 * function to configure the behavior of the TX queue. This should be set
1984 * to 0 if no special configuration is required.
1986 * Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces
1987 * the transmit function to use default values.
1989 * - 0: Success, the transmit queue is correctly set up.
1990 * - -ENOMEM: Unable to allocate the transmit ring descriptors.
1992 int rte_eth_tx_queue_setup(uint8_t port_id, uint16_t tx_queue_id,
1993 uint16_t nb_tx_desc, unsigned int socket_id,
1994 const struct rte_eth_txconf *tx_conf);
1997 * Return the NUMA socket to which an Ethernet device is connected
2000 * The port identifier of the Ethernet device
2002 * The NUMA socket id to which the Ethernet device is connected or
2003 * a default of zero if the socket could not be determined.
2004 * -1 is returned is the port_id value is out of range.
2006 int rte_eth_dev_socket_id(uint8_t port_id);
2009 * Check if port_id of device is attached
2012 * The port identifier of the Ethernet device
2014 * - 0 if port is out of range or not attached
2015 * - 1 if device is attached
2017 int rte_eth_dev_is_valid_port(uint8_t port_id);
2020 * Allocate mbuf from mempool, setup the DMA physical address
2021 * and then start RX for specified queue of a port. It is used
2022 * when rx_deferred_start flag of the specified queue is true.
2025 * The port identifier of the Ethernet device
2026 * @param rx_queue_id
2027 * The index of the rx queue to update the ring.
2028 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2029 * to rte_eth_dev_configure().
2031 * - 0: Success, the transmit queue is correctly set up.
2032 * - -EINVAL: The port_id or the queue_id out of range.
2033 * - -ENOTSUP: The function not supported in PMD driver.
2035 int rte_eth_dev_rx_queue_start(uint8_t port_id, uint16_t rx_queue_id);
2038 * Stop specified RX queue of a port
2041 * The port identifier of the Ethernet device
2042 * @param rx_queue_id
2043 * The index of the rx queue to update the ring.
2044 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2045 * to rte_eth_dev_configure().
2047 * - 0: Success, the transmit queue is correctly set up.
2048 * - -EINVAL: The port_id or the queue_id out of range.
2049 * - -ENOTSUP: The function not supported in PMD driver.
2051 int rte_eth_dev_rx_queue_stop(uint8_t port_id, uint16_t rx_queue_id);
2054 * Start TX for specified queue of a port. It is used when tx_deferred_start
2055 * flag of the specified queue is true.
2058 * The port identifier of the Ethernet device
2059 * @param tx_queue_id
2060 * The index of the tx queue to update the ring.
2061 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2062 * to rte_eth_dev_configure().
2064 * - 0: Success, the transmit queue is correctly set up.
2065 * - -EINVAL: The port_id or the queue_id out of range.
2066 * - -ENOTSUP: The function not supported in PMD driver.
2068 int rte_eth_dev_tx_queue_start(uint8_t port_id, uint16_t tx_queue_id);
2071 * Stop specified TX queue of a port
2074 * The port identifier of the Ethernet device
2075 * @param tx_queue_id
2076 * The index of the tx queue to update the ring.
2077 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2078 * to rte_eth_dev_configure().
2080 * - 0: Success, the transmit queue is correctly set up.
2081 * - -EINVAL: The port_id or the queue_id out of range.
2082 * - -ENOTSUP: The function not supported in PMD driver.
2084 int rte_eth_dev_tx_queue_stop(uint8_t port_id, uint16_t tx_queue_id);
2089 * Start an Ethernet device.
2091 * The device start step is the last one and consists of setting the configured
2092 * offload features and in starting the transmit and the receive units of the
2094 * On success, all basic functions exported by the Ethernet API (link status,
2095 * receive/transmit, and so on) can be invoked.
2098 * The port identifier of the Ethernet device.
2100 * - 0: Success, Ethernet device started.
2101 * - <0: Error code of the driver device start function.
2103 int rte_eth_dev_start(uint8_t port_id);
2106 * Stop an Ethernet device. The device can be restarted with a call to
2107 * rte_eth_dev_start()
2110 * The port identifier of the Ethernet device.
2112 void rte_eth_dev_stop(uint8_t port_id);
2116 * Link up an Ethernet device.
2118 * Set device link up will re-enable the device rx/tx
2119 * functionality after it is previously set device linked down.
2122 * The port identifier of the Ethernet device.
2124 * - 0: Success, Ethernet device linked up.
2125 * - <0: Error code of the driver device link up function.
2127 int rte_eth_dev_set_link_up(uint8_t port_id);
2130 * Link down an Ethernet device.
2131 * The device rx/tx functionality will be disabled if success,
2132 * and it can be re-enabled with a call to
2133 * rte_eth_dev_set_link_up()
2136 * The port identifier of the Ethernet device.
2138 int rte_eth_dev_set_link_down(uint8_t port_id);
2141 * Close a stopped Ethernet device. The device cannot be restarted!
2142 * The function frees all resources except for needed by the
2143 * closed state. To free these resources, call rte_eth_dev_detach().
2146 * The port identifier of the Ethernet device.
2148 void rte_eth_dev_close(uint8_t port_id);
2151 * Enable receipt in promiscuous mode for an Ethernet device.
2154 * The port identifier of the Ethernet device.
2156 void rte_eth_promiscuous_enable(uint8_t port_id);
2159 * Disable receipt in promiscuous mode for an Ethernet device.
2162 * The port identifier of the Ethernet device.
2164 void rte_eth_promiscuous_disable(uint8_t port_id);
2167 * Return the value of promiscuous mode for an Ethernet device.
2170 * The port identifier of the Ethernet device.
2172 * - (1) if promiscuous is enabled
2173 * - (0) if promiscuous is disabled.
2176 int rte_eth_promiscuous_get(uint8_t port_id);
2179 * Enable the receipt of any multicast frame by an Ethernet device.
2182 * The port identifier of the Ethernet device.
2184 void rte_eth_allmulticast_enable(uint8_t port_id);
2187 * Disable the receipt of all multicast frames by an Ethernet device.
2190 * The port identifier of the Ethernet device.
2192 void rte_eth_allmulticast_disable(uint8_t port_id);
2195 * Return the value of allmulticast mode for an Ethernet device.
2198 * The port identifier of the Ethernet device.
2200 * - (1) if allmulticast is enabled
2201 * - (0) if allmulticast is disabled.
2204 int rte_eth_allmulticast_get(uint8_t port_id);
2207 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2208 * or FULL-DUPLEX) of the physical link of an Ethernet device. It might need
2209 * to wait up to 9 seconds in it.
2212 * The port identifier of the Ethernet device.
2214 * A pointer to an *rte_eth_link* structure to be filled with
2215 * the status, the speed and the mode of the Ethernet device link.
2217 void rte_eth_link_get(uint8_t port_id, struct rte_eth_link *link);
2220 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2221 * or FULL-DUPLEX) of the physical link of an Ethernet device. It is a no-wait
2222 * version of rte_eth_link_get().
2225 * The port identifier of the Ethernet device.
2227 * A pointer to an *rte_eth_link* structure to be filled with
2228 * the status, the speed and the mode of the Ethernet device link.
2230 void rte_eth_link_get_nowait(uint8_t port_id, struct rte_eth_link *link);
2233 * Retrieve the general I/O statistics of an Ethernet device.
2236 * The port identifier of the Ethernet device.
2238 * A pointer to a structure of type *rte_eth_stats* to be filled with
2239 * the values of device counters for the following set of statistics:
2240 * - *ipackets* with the total of successfully received packets.
2241 * - *opackets* with the total of successfully transmitted packets.
2242 * - *ibytes* with the total of successfully received bytes.
2243 * - *obytes* with the total of successfully transmitted bytes.
2244 * - *ierrors* with the total of erroneous received packets.
2245 * - *oerrors* with the total of failed transmitted packets.
2247 * Zero if successful. Non-zero otherwise.
2249 int rte_eth_stats_get(uint8_t port_id, struct rte_eth_stats *stats);
2252 * Reset the general I/O statistics of an Ethernet device.
2255 * The port identifier of the Ethernet device.
2257 void rte_eth_stats_reset(uint8_t port_id);
2260 * Retrieve extended statistics of an Ethernet device.
2263 * The port identifier of the Ethernet device.
2265 * A pointer to a table of structure of type *rte_eth_xstats*
2266 * to be filled with device statistics names and values.
2267 * This parameter can be set to NULL if n is 0.
2269 * The size of the stats table, which should be large enough to store
2270 * all the statistics of the device.
2272 * - positive value lower or equal to n: success. The return value
2273 * is the number of entries filled in the stats table.
2274 * - positive value higher than n: error, the given statistics table
2275 * is too small. The return value corresponds to the size that should
2276 * be given to succeed. The entries in the table are not valid and
2277 * shall not be used by the caller.
2278 * - negative value on error (invalid port id)
2280 int rte_eth_xstats_get(uint8_t port_id, struct rte_eth_xstats *xstats,
2284 * Reset extended statistics of an Ethernet device.
2287 * The port identifier of the Ethernet device.
2289 void rte_eth_xstats_reset(uint8_t port_id);
2292 * Set a mapping for the specified transmit queue to the specified per-queue
2293 * statistics counter.
2296 * The port identifier of the Ethernet device.
2297 * @param tx_queue_id
2298 * The index of the transmit queue for which a queue stats mapping is required.
2299 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2300 * to rte_eth_dev_configure().
2302 * The per-queue packet statistics functionality number that the transmit
2303 * queue is to be assigned.
2304 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2306 * Zero if successful. Non-zero otherwise.
2308 int rte_eth_dev_set_tx_queue_stats_mapping(uint8_t port_id,
2309 uint16_t tx_queue_id, uint8_t stat_idx);
2312 * Set a mapping for the specified receive queue to the specified per-queue
2313 * statistics counter.
2316 * The port identifier of the Ethernet device.
2317 * @param rx_queue_id
2318 * The index of the receive queue for which a queue stats mapping is required.
2319 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2320 * to rte_eth_dev_configure().
2322 * The per-queue packet statistics functionality number that the receive
2323 * queue is to be assigned.
2324 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2326 * Zero if successful. Non-zero otherwise.
2328 int rte_eth_dev_set_rx_queue_stats_mapping(uint8_t port_id,
2329 uint16_t rx_queue_id,
2333 * Retrieve the Ethernet address of an Ethernet device.
2336 * The port identifier of the Ethernet device.
2338 * A pointer to a structure of type *ether_addr* to be filled with
2339 * the Ethernet address of the Ethernet device.
2341 void rte_eth_macaddr_get(uint8_t port_id, struct ether_addr *mac_addr);
2344 * Retrieve the contextual information of an Ethernet device.
2347 * The port identifier of the Ethernet device.
2349 * A pointer to a structure of type *rte_eth_dev_info* to be filled with
2350 * the contextual information of the Ethernet device.
2352 void rte_eth_dev_info_get(uint8_t port_id, struct rte_eth_dev_info *dev_info);
2355 * Retrieve the supported packet types of an Ethernet device.
2358 * Better to invoke this API after the device is already started or rx burst
2359 * function is decided, to obtain correct supported ptypes.
2361 * The port identifier of the Ethernet device.
2363 * A hint of what kind of packet type which the caller is interested in.
2365 * An array pointer to store adequent packet types, allocated by caller.
2367 * Size of the array pointed by param ptypes.
2369 * - (>0) Number of supported ptypes. If it exceeds param num, exceeding
2370 * packet types will not be filled in the given array.
2371 * - (0 or -ENOTSUP) if PMD does not fill the specified ptype.
2372 * - (-ENODEV) if *port_id* invalid.
2374 int rte_eth_dev_get_supported_ptypes(uint8_t port_id, uint32_t ptype_mask,
2375 uint32_t *ptypes, int num);
2378 * Retrieve the MTU of an Ethernet device.
2381 * The port identifier of the Ethernet device.
2383 * A pointer to a uint16_t where the retrieved MTU is to be stored.
2385 * - (0) if successful.
2386 * - (-ENODEV) if *port_id* invalid.
2388 int rte_eth_dev_get_mtu(uint8_t port_id, uint16_t *mtu);
2391 * Change the MTU of an Ethernet device.
2394 * The port identifier of the Ethernet device.
2396 * A uint16_t for the MTU to be applied.
2398 * - (0) if successful.
2399 * - (-ENOTSUP) if operation is not supported.
2400 * - (-ENODEV) if *port_id* invalid.
2401 * - (-EINVAL) if *mtu* invalid.
2403 int rte_eth_dev_set_mtu(uint8_t port_id, uint16_t mtu);
2406 * Enable/Disable hardware filtering by an Ethernet device of received
2407 * VLAN packets tagged with a given VLAN Tag Identifier.
2410 * The port identifier of the Ethernet device.
2412 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
2414 * If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*.
2415 * Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*.
2417 * - (0) if successful.
2418 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2419 * - (-ENODEV) if *port_id* invalid.
2420 * - (-ENOSYS) if VLAN filtering on *port_id* disabled.
2421 * - (-EINVAL) if *vlan_id* > 4095.
2423 int rte_eth_dev_vlan_filter(uint8_t port_id, uint16_t vlan_id, int on);
2426 * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
2427 * 82599/X540/X550 can support VLAN stripping at the rx queue level
2430 * The port identifier of the Ethernet device.
2431 * @param rx_queue_id
2432 * The index of the receive queue for which a queue stats mapping is required.
2433 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2434 * to rte_eth_dev_configure().
2436 * If 1, Enable VLAN Stripping of the receive queue of the Ethernet port.
2437 * If 0, Disable VLAN Stripping of the receive queue of the Ethernet port.
2439 * - (0) if successful.
2440 * - (-ENOSUP) if hardware-assisted VLAN stripping not configured.
2441 * - (-ENODEV) if *port_id* invalid.
2442 * - (-EINVAL) if *rx_queue_id* invalid.
2444 int rte_eth_dev_set_vlan_strip_on_queue(uint8_t port_id, uint16_t rx_queue_id,
2448 * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
2449 * the VLAN Header. This is a register setup available on some Intel NIC, not
2450 * but all, please check the data sheet for availability.
2453 * The port identifier of the Ethernet device.
2457 * The Tag Protocol ID
2459 * - (0) if successful.
2460 * - (-ENOSUP) if hardware-assisted VLAN TPID setup is not supported.
2461 * - (-ENODEV) if *port_id* invalid.
2463 int rte_eth_dev_set_vlan_ether_type(uint8_t port_id,
2464 enum rte_vlan_type vlan_type,
2468 * Set VLAN offload configuration on an Ethernet device
2469 * Enable/Disable Extended VLAN by an Ethernet device, This is a register setup
2470 * available on some Intel NIC, not but all, please check the data sheet for
2472 * Enable/Disable VLAN Strip can be done on rx queue for certain NIC, but here
2473 * the configuration is applied on the port level.
2476 * The port identifier of the Ethernet device.
2477 * @param offload_mask
2478 * The VLAN Offload bit mask can be mixed use with "OR"
2479 * ETH_VLAN_STRIP_OFFLOAD
2480 * ETH_VLAN_FILTER_OFFLOAD
2481 * ETH_VLAN_EXTEND_OFFLOAD
2483 * - (0) if successful.
2484 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2485 * - (-ENODEV) if *port_id* invalid.
2487 int rte_eth_dev_set_vlan_offload(uint8_t port_id, int offload_mask);
2490 * Read VLAN Offload configuration from an Ethernet device
2493 * The port identifier of the Ethernet device.
2495 * - (>0) if successful. Bit mask to indicate
2496 * ETH_VLAN_STRIP_OFFLOAD
2497 * ETH_VLAN_FILTER_OFFLOAD
2498 * ETH_VLAN_EXTEND_OFFLOAD
2499 * - (-ENODEV) if *port_id* invalid.
2501 int rte_eth_dev_get_vlan_offload(uint8_t port_id);
2504 * Set port based TX VLAN insersion on or off.
2507 * The port identifier of the Ethernet device.
2509 * Port based TX VLAN identifier togeth with user priority.
2511 * Turn on or off the port based TX VLAN insertion.
2514 * - (0) if successful.
2515 * - negative if failed.
2517 int rte_eth_dev_set_vlan_pvid(uint8_t port_id, uint16_t pvid, int on);
2521 * Retrieve a burst of input packets from a receive queue of an Ethernet
2522 * device. The retrieved packets are stored in *rte_mbuf* structures whose
2523 * pointers are supplied in the *rx_pkts* array.
2525 * The rte_eth_rx_burst() function loops, parsing the RX ring of the
2526 * receive queue, up to *nb_pkts* packets, and for each completed RX
2527 * descriptor in the ring, it performs the following operations:
2529 * - Initialize the *rte_mbuf* data structure associated with the
2530 * RX descriptor according to the information provided by the NIC into
2531 * that RX descriptor.
2533 * - Store the *rte_mbuf* data structure into the next entry of the
2536 * - Replenish the RX descriptor with a new *rte_mbuf* buffer
2537 * allocated from the memory pool associated with the receive queue at
2538 * initialization time.
2540 * When retrieving an input packet that was scattered by the controller
2541 * into multiple receive descriptors, the rte_eth_rx_burst() function
2542 * appends the associated *rte_mbuf* buffers to the first buffer of the
2545 * The rte_eth_rx_burst() function returns the number of packets
2546 * actually retrieved, which is the number of *rte_mbuf* data structures
2547 * effectively supplied into the *rx_pkts* array.
2548 * A return value equal to *nb_pkts* indicates that the RX queue contained
2549 * at least *rx_pkts* packets, and this is likely to signify that other
2550 * received packets remain in the input queue. Applications implementing
2551 * a "retrieve as much received packets as possible" policy can check this
2552 * specific case and keep invoking the rte_eth_rx_burst() function until
2553 * a value less than *nb_pkts* is returned.
2555 * This receive method has the following advantages:
2557 * - It allows a run-to-completion network stack engine to retrieve and
2558 * to immediately process received packets in a fast burst-oriented
2559 * approach, avoiding the overhead of unnecessary intermediate packet
2560 * queue/dequeue operations.
2562 * - Conversely, it also allows an asynchronous-oriented processing
2563 * method to retrieve bursts of received packets and to immediately
2564 * queue them for further parallel processing by another logical core,
2565 * for instance. However, instead of having received packets being
2566 * individually queued by the driver, this approach allows the invoker
2567 * of the rte_eth_rx_burst() function to queue a burst of retrieved
2568 * packets at a time and therefore dramatically reduce the cost of
2569 * enqueue/dequeue operations per packet.
2571 * - It allows the rte_eth_rx_burst() function of the driver to take
2572 * advantage of burst-oriented hardware features (CPU cache,
2573 * prefetch instructions, and so on) to minimize the number of CPU
2574 * cycles per packet.
2576 * To summarize, the proposed receive API enables many
2577 * burst-oriented optimizations in both synchronous and asynchronous
2578 * packet processing environments with no overhead in both cases.
2580 * The rte_eth_rx_burst() function does not provide any error
2581 * notification to avoid the corresponding overhead. As a hint, the
2582 * upper-level application might check the status of the device link once
2583 * being systematically returned a 0 value for a given number of tries.
2586 * The port identifier of the Ethernet device.
2588 * The index of the receive queue from which to retrieve input packets.
2589 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2590 * to rte_eth_dev_configure().
2592 * The address of an array of pointers to *rte_mbuf* structures that
2593 * must be large enough to store *nb_pkts* pointers in it.
2595 * The maximum number of packets to retrieve.
2597 * The number of packets actually retrieved, which is the number
2598 * of pointers to *rte_mbuf* structures effectively supplied to the
2601 static inline uint16_t
2602 rte_eth_rx_burst(uint8_t port_id, uint16_t queue_id,
2603 struct rte_mbuf **rx_pkts, const uint16_t nb_pkts)
2605 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2607 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2608 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
2609 RTE_FUNC_PTR_OR_ERR_RET(*dev->rx_pkt_burst, 0);
2611 if (queue_id >= dev->data->nb_rx_queues) {
2612 RTE_PMD_DEBUG_TRACE("Invalid RX queue_id=%d\n", queue_id);
2616 int16_t nb_rx = (*dev->rx_pkt_burst)(dev->data->rx_queues[queue_id],
2619 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
2620 struct rte_eth_rxtx_callback *cb = dev->post_rx_burst_cbs[queue_id];
2622 if (unlikely(cb != NULL)) {
2624 nb_rx = cb->fn.rx(port_id, queue_id, rx_pkts, nb_rx,
2625 nb_pkts, cb->param);
2627 } while (cb != NULL);
2635 * Get the number of used descriptors in a specific queue
2638 * The port identifier of the Ethernet device.
2640 * The queue id on the specific port.
2642 * The number of used descriptors in the specific queue, or:
2643 * (-EINVAL) if *port_id* is invalid
2644 * (-ENOTSUP) if the device does not support this function
2647 rte_eth_rx_queue_count(uint8_t port_id, uint16_t queue_id)
2649 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2650 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -EINVAL);
2651 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_queue_count, -ENOTSUP);
2652 return (*dev->dev_ops->rx_queue_count)(dev, queue_id);
2656 * Check if the DD bit of the specific RX descriptor in the queue has been set
2659 * The port identifier of the Ethernet device.
2661 * The queue id on the specific port.
2663 * The offset of the descriptor ID from tail.
2665 * - (1) if the specific DD bit is set.
2666 * - (0) if the specific DD bit is not set.
2667 * - (-ENODEV) if *port_id* invalid.
2668 * - (-ENOTSUP) if the device does not support this function
2671 rte_eth_rx_descriptor_done(uint8_t port_id, uint16_t queue_id, uint16_t offset)
2673 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2674 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
2675 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_descriptor_done, -ENOTSUP);
2676 return (*dev->dev_ops->rx_descriptor_done)( \
2677 dev->data->rx_queues[queue_id], offset);
2681 * Send a burst of output packets on a transmit queue of an Ethernet device.
2683 * The rte_eth_tx_burst() function is invoked to transmit output packets
2684 * on the output queue *queue_id* of the Ethernet device designated by its
2686 * The *nb_pkts* parameter is the number of packets to send which are
2687 * supplied in the *tx_pkts* array of *rte_mbuf* structures.
2688 * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
2689 * up to the number of transmit descriptors available in the TX ring of the
2691 * For each packet to send, the rte_eth_tx_burst() function performs
2692 * the following operations:
2694 * - Pick up the next available descriptor in the transmit ring.
2696 * - Free the network buffer previously sent with that descriptor, if any.
2698 * - Initialize the transmit descriptor with the information provided
2699 * in the *rte_mbuf data structure.
2701 * In the case of a segmented packet composed of a list of *rte_mbuf* buffers,
2702 * the rte_eth_tx_burst() function uses several transmit descriptors
2705 * The rte_eth_tx_burst() function returns the number of packets it
2706 * actually sent. A return value equal to *nb_pkts* means that all packets
2707 * have been sent, and this is likely to signify that other output packets
2708 * could be immediately transmitted again. Applications that implement a
2709 * "send as many packets to transmit as possible" policy can check this
2710 * specific case and keep invoking the rte_eth_tx_burst() function until
2711 * a value less than *nb_pkts* is returned.
2713 * It is the responsibility of the rte_eth_tx_burst() function to
2714 * transparently free the memory buffers of packets previously sent.
2715 * This feature is driven by the *tx_free_thresh* value supplied to the
2716 * rte_eth_dev_configure() function at device configuration time.
2717 * When the number of free TX descriptors drops below this threshold, the
2718 * rte_eth_tx_burst() function must [attempt to] free the *rte_mbuf* buffers
2719 * of those packets whose transmission was effectively completed.
2722 * The port identifier of the Ethernet device.
2724 * The index of the transmit queue through which output packets must be
2726 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2727 * to rte_eth_dev_configure().
2729 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
2730 * which contain the output packets.
2732 * The maximum number of packets to transmit.
2734 * The number of output packets actually stored in transmit descriptors of
2735 * the transmit ring. The return value can be less than the value of the
2736 * *tx_pkts* parameter when the transmit ring is full or has been filled up.
2738 static inline uint16_t
2739 rte_eth_tx_burst(uint8_t port_id, uint16_t queue_id,
2740 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
2742 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2744 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2745 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
2746 RTE_FUNC_PTR_OR_ERR_RET(*dev->tx_pkt_burst, 0);
2748 if (queue_id >= dev->data->nb_tx_queues) {
2749 RTE_PMD_DEBUG_TRACE("Invalid TX queue_id=%d\n", queue_id);
2754 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
2755 struct rte_eth_rxtx_callback *cb = dev->pre_tx_burst_cbs[queue_id];
2757 if (unlikely(cb != NULL)) {
2759 nb_pkts = cb->fn.tx(port_id, queue_id, tx_pkts, nb_pkts,
2762 } while (cb != NULL);
2766 return (*dev->tx_pkt_burst)(dev->data->tx_queues[queue_id], tx_pkts, nb_pkts);
2769 typedef void (*buffer_tx_error_fn)(struct rte_mbuf **unsent, uint16_t count,
2773 * Structure used to buffer packets for future TX
2774 * Used by APIs rte_eth_tx_buffer and rte_eth_tx_buffer_flush
2776 struct rte_eth_dev_tx_buffer {
2777 buffer_tx_error_fn error_callback;
2778 void *error_userdata;
2779 uint16_t size; /**< Size of buffer for buffered tx */
2780 uint16_t length; /**< Number of packets in the array */
2781 struct rte_mbuf *pkts[];
2782 /**< Pending packets to be sent on explicit flush or when full */
2786 * Calculate the size of the tx buffer.
2789 * Number of stored packets.
2791 #define RTE_ETH_TX_BUFFER_SIZE(sz) \
2792 (sizeof(struct rte_eth_dev_tx_buffer) + (sz) * sizeof(struct rte_mbuf *))
2795 * Initialize default values for buffered transmitting
2798 * Tx buffer to be initialized.
2805 rte_eth_tx_buffer_init(struct rte_eth_dev_tx_buffer *buffer, uint16_t size);
2808 * Send any packets queued up for transmission on a port and HW queue
2810 * This causes an explicit flush of packets previously buffered via the
2811 * rte_eth_tx_buffer() function. It returns the number of packets successfully
2812 * sent to the NIC, and calls the error callback for any unsent packets. Unless
2813 * explicitly set up otherwise, the default callback simply frees the unsent
2814 * packets back to the owning mempool.
2817 * The port identifier of the Ethernet device.
2819 * The index of the transmit queue through which output packets must be
2821 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2822 * to rte_eth_dev_configure().
2824 * Buffer of packets to be transmit.
2826 * The number of packets successfully sent to the Ethernet device. The error
2827 * callback is called for any packets which could not be sent.
2829 static inline uint16_t
2830 rte_eth_tx_buffer_flush(uint8_t port_id, uint16_t queue_id,
2831 struct rte_eth_dev_tx_buffer *buffer)
2834 uint16_t to_send = buffer->length;
2839 sent = rte_eth_tx_burst(port_id, queue_id, buffer->pkts, to_send);
2843 /* All packets sent, or to be dealt with by callback below */
2844 if (unlikely(sent != to_send))
2845 buffer->error_callback(&buffer->pkts[sent], to_send - sent,
2846 buffer->error_userdata);
2852 * Buffer a single packet for future transmission on a port and queue
2854 * This function takes a single mbuf/packet and buffers it for later
2855 * transmission on the particular port and queue specified. Once the buffer is
2856 * full of packets, an attempt will be made to transmit all the buffered
2857 * packets. In case of error, where not all packets can be transmitted, a
2858 * callback is called with the unsent packets as a parameter. If no callback
2859 * is explicitly set up, the unsent packets are just freed back to the owning
2860 * mempool. The function returns the number of packets actually sent i.e.
2861 * 0 if no buffer flush occurred, otherwise the number of packets successfully
2865 * The port identifier of the Ethernet device.
2867 * The index of the transmit queue through which output packets must be
2869 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2870 * to rte_eth_dev_configure().
2872 * Buffer used to collect packets to be sent.
2874 * Pointer to the packet mbuf to be sent.
2876 * 0 = packet has been buffered for later transmission
2877 * N > 0 = packet has been buffered, and the buffer was subsequently flushed,
2878 * causing N packets to be sent, and the error callback to be called for
2881 static inline uint16_t __attribute__((always_inline))
2882 rte_eth_tx_buffer(uint8_t port_id, uint16_t queue_id,
2883 struct rte_eth_dev_tx_buffer *buffer, struct rte_mbuf *tx_pkt)
2885 buffer->pkts[buffer->length++] = tx_pkt;
2886 if (buffer->length < buffer->size)
2889 return rte_eth_tx_buffer_flush(port_id, queue_id, buffer);
2893 * Configure a callback for buffered packets which cannot be sent
2895 * Register a specific callback to be called when an attempt is made to send
2896 * all packets buffered on an ethernet port, but not all packets can
2897 * successfully be sent. The callback registered here will be called only
2898 * from calls to rte_eth_tx_buffer() and rte_eth_tx_buffer_flush() APIs.
2899 * The default callback configured for each queue by default just frees the
2900 * packets back to the calling mempool. If additional behaviour is required,
2901 * for example, to count dropped packets, or to retry transmission of packets
2902 * which cannot be sent, this function should be used to register a suitable
2903 * callback function to implement the desired behaviour.
2904 * The example callback "rte_eth_count_unsent_packet_callback()" is also
2905 * provided as reference.
2908 * The port identifier of the Ethernet device.
2910 * The function to be used as the callback.
2912 * Arbitrary parameter to be passed to the callback function
2914 * 0 on success, or -1 on error with rte_errno set appropriately
2917 rte_eth_tx_buffer_set_err_callback(struct rte_eth_dev_tx_buffer *buffer,
2918 buffer_tx_error_fn callback, void *userdata);
2921 * Callback function for silently dropping unsent buffered packets.
2923 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
2924 * adjust the default behavior when buffered packets cannot be sent. This
2925 * function drops any unsent packets silently and is used by tx buffered
2926 * operations as default behavior.
2928 * NOTE: this function should not be called directly, instead it should be used
2929 * as a callback for packet buffering.
2931 * NOTE: when configuring this function as a callback with
2932 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
2933 * should point to an uint64_t value.
2936 * The previously buffered packets which could not be sent
2938 * The number of unsent packets in the pkts array
2943 rte_eth_tx_buffer_drop_callback(struct rte_mbuf **pkts, uint16_t unsent,
2947 * Callback function for tracking unsent buffered packets.
2949 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
2950 * adjust the default behavior when buffered packets cannot be sent. This
2951 * function drops any unsent packets, but also updates a user-supplied counter
2952 * to track the overall number of packets dropped. The counter should be an
2953 * uint64_t variable.
2955 * NOTE: this function should not be called directly, instead it should be used
2956 * as a callback for packet buffering.
2958 * NOTE: when configuring this function as a callback with
2959 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
2960 * should point to an uint64_t value.
2963 * The previously buffered packets which could not be sent
2965 * The number of unsent packets in the pkts array
2967 * Pointer to an uint64_t value, which will be incremented by unsent
2970 rte_eth_tx_buffer_count_callback(struct rte_mbuf **pkts, uint16_t unsent,
2974 * The eth device event type for interrupt, and maybe others in the future.
2976 enum rte_eth_event_type {
2977 RTE_ETH_EVENT_UNKNOWN, /**< unknown event type */
2978 RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
2979 RTE_ETH_EVENT_QUEUE_STATE,
2980 /**< queue state event (enabled/disabled) */
2981 RTE_ETH_EVENT_INTR_RESET,
2982 /**< reset interrupt event, sent to VF on PF reset */
2983 RTE_ETH_EVENT_MAX /**< max value of this enum */
2986 typedef void (*rte_eth_dev_cb_fn)(uint8_t port_id, \
2987 enum rte_eth_event_type event, void *cb_arg);
2988 /**< user application callback to be registered for interrupts */
2993 * Register a callback function for specific port id.
3000 * User supplied callback function to be called.
3002 * Pointer to the parameters for the registered callback.
3005 * - On success, zero.
3006 * - On failure, a negative value.
3008 int rte_eth_dev_callback_register(uint8_t port_id,
3009 enum rte_eth_event_type event,
3010 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
3013 * Unregister a callback function for specific port id.
3020 * User supplied callback function to be called.
3022 * Pointer to the parameters for the registered callback. -1 means to
3023 * remove all for the same callback address and same event.
3026 * - On success, zero.
3027 * - On failure, a negative value.
3029 int rte_eth_dev_callback_unregister(uint8_t port_id,
3030 enum rte_eth_event_type event,
3031 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
3034 * @internal Executes all the user application registered callbacks for
3035 * the specific device. It is for DPDK internal user only. User
3036 * application should not call it directly.
3039 * Pointer to struct rte_eth_dev.
3041 * Eth device interrupt event type.
3046 void _rte_eth_dev_callback_process(struct rte_eth_dev *dev,
3047 enum rte_eth_event_type event);
3050 * When there is no rx packet coming in Rx Queue for a long time, we can
3051 * sleep lcore related to RX Queue for power saving, and enable rx interrupt
3052 * to be triggered when rx packect arrives.
3054 * The rte_eth_dev_rx_intr_enable() function enables rx queue
3055 * interrupt on specific rx queue of a port.
3058 * The port identifier of the Ethernet device.
3060 * The index of the receive queue from which to retrieve input packets.
3061 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3062 * to rte_eth_dev_configure().
3064 * - (0) if successful.
3065 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3067 * - (-ENODEV) if *port_id* invalid.
3069 int rte_eth_dev_rx_intr_enable(uint8_t port_id, uint16_t queue_id);
3072 * When lcore wakes up from rx interrupt indicating packet coming, disable rx
3073 * interrupt and returns to polling mode.
3075 * The rte_eth_dev_rx_intr_disable() function disables rx queue
3076 * interrupt on specific rx queue of a port.
3079 * The port identifier of the Ethernet device.
3081 * The index of the receive queue from which to retrieve input packets.
3082 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3083 * to rte_eth_dev_configure().
3085 * - (0) if successful.
3086 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3088 * - (-ENODEV) if *port_id* invalid.
3090 int rte_eth_dev_rx_intr_disable(uint8_t port_id, uint16_t queue_id);
3093 * RX Interrupt control per port.
3096 * The port identifier of the Ethernet device.
3098 * Epoll instance fd which the intr vector associated to.
3099 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
3101 * The operation be performed for the vector.
3102 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
3106 * - On success, zero.
3107 * - On failure, a negative value.
3109 int rte_eth_dev_rx_intr_ctl(uint8_t port_id, int epfd, int op, void *data);
3112 * RX Interrupt control per queue.
3115 * The port identifier of the Ethernet device.
3117 * The index of the receive queue from which to retrieve input packets.
3118 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3119 * to rte_eth_dev_configure().
3121 * Epoll instance fd which the intr vector associated to.
3122 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
3124 * The operation be performed for the vector.
3125 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
3129 * - On success, zero.
3130 * - On failure, a negative value.
3132 int rte_eth_dev_rx_intr_ctl_q(uint8_t port_id, uint16_t queue_id,
3133 int epfd, int op, void *data);
3136 * Turn on the LED on the Ethernet device.
3137 * This function turns on the LED on the Ethernet device.
3140 * The port identifier of the Ethernet device.
3142 * - (0) if successful.
3143 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3145 * - (-ENODEV) if *port_id* invalid.
3147 int rte_eth_led_on(uint8_t port_id);
3150 * Turn off the LED on the Ethernet device.
3151 * This function turns off the LED on the Ethernet device.
3154 * The port identifier of the Ethernet device.
3156 * - (0) if successful.
3157 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3159 * - (-ENODEV) if *port_id* invalid.
3161 int rte_eth_led_off(uint8_t port_id);
3164 * Get current status of the Ethernet link flow control for Ethernet device
3167 * The port identifier of the Ethernet device.
3169 * The pointer to the structure where to store the flow control parameters.
3171 * - (0) if successful.
3172 * - (-ENOTSUP) if hardware doesn't support flow control.
3173 * - (-ENODEV) if *port_id* invalid.
3175 int rte_eth_dev_flow_ctrl_get(uint8_t port_id,
3176 struct rte_eth_fc_conf *fc_conf);
3179 * Configure the Ethernet link flow control for Ethernet device
3182 * The port identifier of the Ethernet device.
3184 * The pointer to the structure of the flow control parameters.
3186 * - (0) if successful.
3187 * - (-ENOTSUP) if hardware doesn't support flow control mode.
3188 * - (-ENODEV) if *port_id* invalid.
3189 * - (-EINVAL) if bad parameter
3190 * - (-EIO) if flow control setup failure
3192 int rte_eth_dev_flow_ctrl_set(uint8_t port_id,
3193 struct rte_eth_fc_conf *fc_conf);
3196 * Configure the Ethernet priority flow control under DCB environment
3197 * for Ethernet device.
3200 * The port identifier of the Ethernet device.
3202 * The pointer to the structure of the priority flow control parameters.
3204 * - (0) if successful.
3205 * - (-ENOTSUP) if hardware doesn't support priority flow control mode.
3206 * - (-ENODEV) if *port_id* invalid.
3207 * - (-EINVAL) if bad parameter
3208 * - (-EIO) if flow control setup failure
3210 int rte_eth_dev_priority_flow_ctrl_set(uint8_t port_id,
3211 struct rte_eth_pfc_conf *pfc_conf);
3214 * Add a MAC address to an internal array of addresses used to enable whitelist
3215 * filtering to accept packets only if the destination MAC address matches.
3218 * The port identifier of the Ethernet device.
3220 * The MAC address to add.
3222 * VMDq pool index to associate address with (if VMDq is enabled). If VMDq is
3223 * not enabled, this should be set to 0.
3225 * - (0) if successfully added or *mac_addr" was already added.
3226 * - (-ENOTSUP) if hardware doesn't support this feature.
3227 * - (-ENODEV) if *port* is invalid.
3228 * - (-ENOSPC) if no more MAC addresses can be added.
3229 * - (-EINVAL) if MAC address is invalid.
3231 int rte_eth_dev_mac_addr_add(uint8_t port, struct ether_addr *mac_addr,
3235 * Remove a MAC address from the internal array of addresses.
3238 * The port identifier of the Ethernet device.
3240 * MAC address to remove.
3242 * - (0) if successful, or *mac_addr* didn't exist.
3243 * - (-ENOTSUP) if hardware doesn't support.
3244 * - (-ENODEV) if *port* invalid.
3245 * - (-EADDRINUSE) if attempting to remove the default MAC address
3247 int rte_eth_dev_mac_addr_remove(uint8_t port, struct ether_addr *mac_addr);
3250 * Set the default MAC address.
3253 * The port identifier of the Ethernet device.
3255 * New default MAC address.
3257 * - (0) if successful, or *mac_addr* didn't exist.
3258 * - (-ENOTSUP) if hardware doesn't support.
3259 * - (-ENODEV) if *port* invalid.
3260 * - (-EINVAL) if MAC address is invalid.
3262 int rte_eth_dev_default_mac_addr_set(uint8_t port, struct ether_addr *mac_addr);
3266 * Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3269 * The port identifier of the Ethernet device.
3273 * Redirection table size. The table size can be queried by
3274 * rte_eth_dev_info_get().
3276 * - (0) if successful.
3277 * - (-ENOTSUP) if hardware doesn't support.
3278 * - (-EINVAL) if bad parameter.
3280 int rte_eth_dev_rss_reta_update(uint8_t port,
3281 struct rte_eth_rss_reta_entry64 *reta_conf,
3282 uint16_t reta_size);
3285 * Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3288 * The port identifier of the Ethernet device.
3292 * Redirection table size. The table size can be queried by
3293 * rte_eth_dev_info_get().
3295 * - (0) if successful.
3296 * - (-ENOTSUP) if hardware doesn't support.
3297 * - (-EINVAL) if bad parameter.
3299 int rte_eth_dev_rss_reta_query(uint8_t port,
3300 struct rte_eth_rss_reta_entry64 *reta_conf,
3301 uint16_t reta_size);
3304 * Updates unicast hash table for receiving packet with the given destination
3305 * MAC address, and the packet is routed to all VFs for which the RX mode is
3306 * accept packets that match the unicast hash table.
3309 * The port identifier of the Ethernet device.
3311 * Unicast MAC address.
3313 * 1 - Set an unicast hash bit for receiving packets with the MAC address.
3314 * 0 - Clear an unicast hash bit.
3316 * - (0) if successful.
3317 * - (-ENOTSUP) if hardware doesn't support.
3318 * - (-ENODEV) if *port_id* invalid.
3319 * - (-EINVAL) if bad parameter.
3321 int rte_eth_dev_uc_hash_table_set(uint8_t port,struct ether_addr *addr,
3325 * Updates all unicast hash bitmaps for receiving packet with any Unicast
3326 * Ethernet MAC addresses,the packet is routed to all VFs for which the RX
3327 * mode is accept packets that match the unicast hash table.
3330 * The port identifier of the Ethernet device.
3332 * 1 - Set all unicast hash bitmaps for receiving all the Ethernet
3334 * 0 - Clear all unicast hash bitmaps
3336 * - (0) if successful.
3337 * - (-ENOTSUP) if hardware doesn't support.
3338 * - (-ENODEV) if *port_id* invalid.
3339 * - (-EINVAL) if bad parameter.
3341 int rte_eth_dev_uc_all_hash_table_set(uint8_t port,uint8_t on);
3344 * Set RX L2 Filtering mode of a VF of an Ethernet device.
3347 * The port identifier of the Ethernet device.
3351 * The RX mode mask, which is one or more of accepting Untagged Packets,
3352 * packets that match the PFUTA table, Broadcast and Multicast Promiscuous.
3353 * ETH_VMDQ_ACCEPT_UNTAG,ETH_VMDQ_ACCEPT_HASH_UC,
3354 * ETH_VMDQ_ACCEPT_BROADCAST and ETH_VMDQ_ACCEPT_MULTICAST will be used
3357 * 1 - Enable a VF RX mode.
3358 * 0 - Disable a VF RX mode.
3360 * - (0) if successful.
3361 * - (-ENOTSUP) if hardware doesn't support.
3362 * - (-ENOTSUP) if hardware doesn't support.
3363 * - (-EINVAL) if bad parameter.
3365 int rte_eth_dev_set_vf_rxmode(uint8_t port, uint16_t vf, uint16_t rx_mode,
3369 * Enable or disable a VF traffic transmit of the Ethernet device.
3372 * The port identifier of the Ethernet device.
3376 * 1 - Enable a VF traffic transmit.
3377 * 0 - Disable a VF traffic transmit.
3379 * - (0) if successful.
3380 * - (-ENODEV) if *port_id* invalid.
3381 * - (-ENOTSUP) if hardware doesn't support.
3382 * - (-EINVAL) if bad parameter.
3385 rte_eth_dev_set_vf_tx(uint8_t port,uint16_t vf, uint8_t on);
3388 * Enable or disable a VF traffic receive of an Ethernet device.
3391 * The port identifier of the Ethernet device.
3395 * 1 - Enable a VF traffic receive.
3396 * 0 - Disable a VF traffic receive.
3398 * - (0) if successful.
3399 * - (-ENOTSUP) if hardware doesn't support.
3400 * - (-ENODEV) if *port_id* invalid.
3401 * - (-EINVAL) if bad parameter.
3404 rte_eth_dev_set_vf_rx(uint8_t port,uint16_t vf, uint8_t on);
3407 * Enable/Disable hardware VF VLAN filtering by an Ethernet device of
3408 * received VLAN packets tagged with a given VLAN Tag Identifier.
3411 * The port identifier of the Ethernet device.
3413 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
3415 * Bitmap listing which VFs participate in the VLAN filtering.
3417 * 1 - Enable VFs VLAN filtering.
3418 * 0 - Disable VFs VLAN filtering.
3420 * - (0) if successful.
3421 * - (-ENOTSUP) if hardware doesn't support.
3422 * - (-ENODEV) if *port_id* invalid.
3423 * - (-EINVAL) if bad parameter.
3426 rte_eth_dev_set_vf_vlan_filter(uint8_t port, uint16_t vlan_id,
3431 * Set a traffic mirroring rule on an Ethernet device
3434 * The port identifier of the Ethernet device.
3435 * @param mirror_conf
3436 * The pointer to the traffic mirroring structure describing the mirroring rule.
3437 * The *rte_eth_vm_mirror_conf* structure includes the type of mirroring rule,
3438 * destination pool and the value of rule if enable vlan or pool mirroring.
3441 * The index of traffic mirroring rule, we support four separated rules.
3443 * 1 - Enable a mirroring rule.
3444 * 0 - Disable a mirroring rule.
3446 * - (0) if successful.
3447 * - (-ENOTSUP) if hardware doesn't support this feature.
3448 * - (-ENODEV) if *port_id* invalid.
3449 * - (-EINVAL) if the mr_conf information is not correct.
3451 int rte_eth_mirror_rule_set(uint8_t port_id,
3452 struct rte_eth_mirror_conf *mirror_conf,
3457 * Reset a traffic mirroring rule on an Ethernet device.
3460 * The port identifier of the Ethernet device.
3462 * The index of traffic mirroring rule, we support four separated rules.
3464 * - (0) if successful.
3465 * - (-ENOTSUP) if hardware doesn't support this feature.
3466 * - (-ENODEV) if *port_id* invalid.
3467 * - (-EINVAL) if bad parameter.
3469 int rte_eth_mirror_rule_reset(uint8_t port_id,
3473 * Set the rate limitation for a queue on an Ethernet device.
3476 * The port identifier of the Ethernet device.
3480 * The tx rate in Mbps. Allocated from the total port link speed.
3482 * - (0) if successful.
3483 * - (-ENOTSUP) if hardware doesn't support this feature.
3484 * - (-ENODEV) if *port_id* invalid.
3485 * - (-EINVAL) if bad parameter.
3487 int rte_eth_set_queue_rate_limit(uint8_t port_id, uint16_t queue_idx,
3491 * Set the rate limitation for a vf on an Ethernet device.
3494 * The port identifier of the Ethernet device.
3498 * The tx rate allocated from the total link speed for this VF id.
3500 * The queue mask which need to set the rate.
3502 * - (0) if successful.
3503 * - (-ENOTSUP) if hardware doesn't support this feature.
3504 * - (-ENODEV) if *port_id* invalid.
3505 * - (-EINVAL) if bad parameter.
3507 int rte_eth_set_vf_rate_limit(uint8_t port_id, uint16_t vf,
3508 uint16_t tx_rate, uint64_t q_msk);
3511 * Initialize bypass logic. This function needs to be called before
3512 * executing any other bypass API.
3515 * The port identifier of the Ethernet device.
3517 * - (0) if successful.
3518 * - (-ENOTSUP) if hardware doesn't support.
3519 * - (-EINVAL) if bad parameter.
3521 int rte_eth_dev_bypass_init(uint8_t port);
3524 * Return bypass state.
3527 * The port identifier of the Ethernet device.
3529 * The return bypass state.
3532 * - (3) Isolate mode
3534 * - (0) if successful.
3535 * - (-ENOTSUP) if hardware doesn't support.
3536 * - (-EINVAL) if bad parameter.
3538 int rte_eth_dev_bypass_state_show(uint8_t port, uint32_t *state);
3544 * The port identifier of the Ethernet device.
3546 * The current bypass state.
3549 * - (3) Isolate mode
3551 * - (0) if successful.
3552 * - (-ENOTSUP) if hardware doesn't support.
3553 * - (-EINVAL) if bad parameter.
3555 int rte_eth_dev_bypass_state_set(uint8_t port, uint32_t *new_state);
3558 * Return bypass state when given event occurs.
3561 * The port identifier of the Ethernet device.
3564 * - (1) Main power on (power button is pushed)
3565 * - (2) Auxiliary power on (power supply is being plugged)
3566 * - (3) Main power off (system shutdown and power supply is left plugged in)
3567 * - (4) Auxiliary power off (power supply is being unplugged)
3568 * - (5) Display or set the watchdog timer
3570 * The bypass state when given event occurred.
3573 * - (3) Isolate mode
3575 * - (0) if successful.
3576 * - (-ENOTSUP) if hardware doesn't support.
3577 * - (-EINVAL) if bad parameter.
3579 int rte_eth_dev_bypass_event_show(uint8_t port, uint32_t event, uint32_t *state);
3582 * Set bypass state when given event occurs.
3585 * The port identifier of the Ethernet device.
3588 * - (1) Main power on (power button is pushed)
3589 * - (2) Auxiliary power on (power supply is being plugged)
3590 * - (3) Main power off (system shutdown and power supply is left plugged in)
3591 * - (4) Auxiliary power off (power supply is being unplugged)
3592 * - (5) Display or set the watchdog timer
3594 * The assigned state when given event occurs.
3597 * - (3) Isolate mode
3599 * - (0) if successful.
3600 * - (-ENOTSUP) if hardware doesn't support.
3601 * - (-EINVAL) if bad parameter.
3603 int rte_eth_dev_bypass_event_store(uint8_t port, uint32_t event, uint32_t state);
3606 * Set bypass watchdog timeout count.
3609 * The port identifier of the Ethernet device.
3611 * The timeout to be set.
3612 * - (0) 0 seconds (timer is off)
3621 * - (0) if successful.
3622 * - (-ENOTSUP) if hardware doesn't support.
3623 * - (-EINVAL) if bad parameter.
3625 int rte_eth_dev_wd_timeout_store(uint8_t port, uint32_t timeout);
3628 * Get bypass firmware version.
3631 * The port identifier of the Ethernet device.
3633 * The firmware version
3635 * - (0) if successful.
3636 * - (-ENOTSUP) if hardware doesn't support.
3637 * - (-EINVAL) if bad parameter.
3639 int rte_eth_dev_bypass_ver_show(uint8_t port, uint32_t *ver);
3642 * Return bypass watchdog timeout in seconds
3645 * The port identifier of the Ethernet device.
3647 * The return watchdog timeout. "0" represents timer expired
3648 * - (0) 0 seconds (timer is off)
3657 * - (0) if successful.
3658 * - (-ENOTSUP) if hardware doesn't support.
3659 * - (-EINVAL) if bad parameter.
3661 int rte_eth_dev_bypass_wd_timeout_show(uint8_t port, uint32_t *wd_timeout);
3664 * Reset bypass watchdog timer
3667 * The port identifier of the Ethernet device.
3669 * - (0) if successful.
3670 * - (-ENOTSUP) if hardware doesn't support.
3671 * - (-EINVAL) if bad parameter.
3673 int rte_eth_dev_bypass_wd_reset(uint8_t port);
3676 * Configuration of Receive Side Scaling hash computation of Ethernet device.
3679 * The port identifier of the Ethernet device.
3681 * The new configuration to use for RSS hash computation on the port.
3683 * - (0) if successful.
3684 * - (-ENODEV) if port identifier is invalid.
3685 * - (-ENOTSUP) if hardware doesn't support.
3686 * - (-EINVAL) if bad parameter.
3688 int rte_eth_dev_rss_hash_update(uint8_t port_id,
3689 struct rte_eth_rss_conf *rss_conf);
3692 * Retrieve current configuration of Receive Side Scaling hash computation
3693 * of Ethernet device.
3696 * The port identifier of the Ethernet device.
3698 * Where to store the current RSS hash configuration of the Ethernet device.
3700 * - (0) if successful.
3701 * - (-ENODEV) if port identifier is invalid.
3702 * - (-ENOTSUP) if hardware doesn't support RSS.
3705 rte_eth_dev_rss_hash_conf_get(uint8_t port_id,
3706 struct rte_eth_rss_conf *rss_conf);
3709 * Add UDP tunneling port for a specific type of tunnel.
3710 * The packets with this UDP port will be identified as this type of tunnel.
3711 * Before enabling any offloading function for a tunnel, users can call this API
3712 * to change or add more UDP port for the tunnel. So the offloading function
3713 * can take effect on the packets with the sepcific UDP port.
3716 * The port identifier of the Ethernet device.
3718 * UDP tunneling configuration.
3721 * - (0) if successful.
3722 * - (-ENODEV) if port identifier is invalid.
3723 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3726 rte_eth_dev_udp_tunnel_port_add(uint8_t port_id,
3727 struct rte_eth_udp_tunnel *tunnel_udp);
3730 * Delete UDP tunneling port a specific type of tunnel.
3731 * The packets with this UDP port will not be identified as this type of tunnel
3733 * Before enabling any offloading function for a tunnel, users can call this API
3734 * to delete a UDP port for the tunnel. So the offloading function will not take
3735 * effect on the packets with the sepcific UDP port.
3738 * The port identifier of the Ethernet device.
3740 * UDP tunneling configuration.
3743 * - (0) if successful.
3744 * - (-ENODEV) if port identifier is invalid.
3745 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3748 rte_eth_dev_udp_tunnel_port_delete(uint8_t port_id,
3749 struct rte_eth_udp_tunnel *tunnel_udp);
3752 * Check whether the filter type is supported on an Ethernet device.
3753 * All the supported filter types are defined in 'rte_eth_ctrl.h'.
3756 * The port identifier of the Ethernet device.
3757 * @param filter_type
3760 * - (0) if successful.
3761 * - (-ENOTSUP) if hardware doesn't support this filter type.
3762 * - (-ENODEV) if *port_id* invalid.
3764 int rte_eth_dev_filter_supported(uint8_t port_id, enum rte_filter_type filter_type);
3767 * Take operations to assigned filter type on an Ethernet device.
3768 * All the supported operations and filter types are defined in 'rte_eth_ctrl.h'.
3771 * The port identifier of the Ethernet device.
3772 * @param filter_type
3775 * Type of operation.
3777 * A pointer to arguments defined specifically for the operation.
3779 * - (0) if successful.
3780 * - (-ENOTSUP) if hardware doesn't support.
3781 * - (-ENODEV) if *port_id* invalid.
3782 * - others depends on the specific operations implementation.
3784 int rte_eth_dev_filter_ctrl(uint8_t port_id, enum rte_filter_type filter_type,
3785 enum rte_filter_op filter_op, void *arg);
3788 * Get DCB information on an Ethernet device.
3791 * The port identifier of the Ethernet device.
3795 * - (0) if successful.
3796 * - (-ENODEV) if port identifier is invalid.
3797 * - (-ENOTSUP) if hardware doesn't support.
3799 int rte_eth_dev_get_dcb_info(uint8_t port_id,
3800 struct rte_eth_dcb_info *dcb_info);
3803 * Add a callback to be called on packet RX on a given port and queue.
3805 * This API configures a function to be called for each burst of
3806 * packets received on a given NIC port queue. The return value is a pointer
3807 * that can be used to later remove the callback using
3808 * rte_eth_remove_rx_callback().
3810 * Multiple functions are called in the order that they are added.
3813 * The port identifier of the Ethernet device.
3815 * The queue on the Ethernet device on which the callback is to be added.
3817 * The callback function
3819 * A generic pointer parameter which will be passed to each invocation of the
3820 * callback function on this port and queue.
3824 * On success, a pointer value which can later be used to remove the callback.
3826 void *rte_eth_add_rx_callback(uint8_t port_id, uint16_t queue_id,
3827 rte_rx_callback_fn fn, void *user_param);
3830 * Add a callback to be called on packet TX on a given port and queue.
3832 * This API configures a function to be called for each burst of
3833 * packets sent on a given NIC port queue. The return value is a pointer
3834 * that can be used to later remove the callback using
3835 * rte_eth_remove_tx_callback().
3837 * Multiple functions are called in the order that they are added.
3840 * The port identifier of the Ethernet device.
3842 * The queue on the Ethernet device on which the callback is to be added.
3844 * The callback function
3846 * A generic pointer parameter which will be passed to each invocation of the
3847 * callback function on this port and queue.
3851 * On success, a pointer value which can later be used to remove the callback.
3853 void *rte_eth_add_tx_callback(uint8_t port_id, uint16_t queue_id,
3854 rte_tx_callback_fn fn, void *user_param);
3857 * Remove an RX packet callback from a given port and queue.
3859 * This function is used to removed callbacks that were added to a NIC port
3860 * queue using rte_eth_add_rx_callback().
3862 * Note: the callback is removed from the callback list but it isn't freed
3863 * since the it may still be in use. The memory for the callback can be
3864 * subsequently freed back by the application by calling rte_free():
3866 * - Immediately - if the port is stopped, or the user knows that no
3867 * callbacks are in flight e.g. if called from the thread doing RX/TX
3870 * - After a short delay - where the delay is sufficient to allow any
3871 * in-flight callbacks to complete.
3874 * The port identifier of the Ethernet device.
3876 * The queue on the Ethernet device from which the callback is to be removed.
3878 * User supplied callback created via rte_eth_add_rx_callback().
3881 * - 0: Success. Callback was removed.
3882 * - -ENOTSUP: Callback support is not available.
3883 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
3884 * is NULL or not found for the port/queue.
3886 int rte_eth_remove_rx_callback(uint8_t port_id, uint16_t queue_id,
3887 struct rte_eth_rxtx_callback *user_cb);
3890 * Remove a TX packet callback from a given port and queue.
3892 * This function is used to removed callbacks that were added to a NIC port
3893 * queue using rte_eth_add_tx_callback().
3895 * Note: the callback is removed from the callback list but it isn't freed
3896 * since the it may still be in use. The memory for the callback can be
3897 * subsequently freed back by the application by calling rte_free():
3899 * - Immediately - if the port is stopped, or the user knows that no
3900 * callbacks are in flight e.g. if called from the thread doing RX/TX
3903 * - After a short delay - where the delay is sufficient to allow any
3904 * in-flight callbacks to complete.
3907 * The port identifier of the Ethernet device.
3909 * The queue on the Ethernet device from which the callback is to be removed.
3911 * User supplied callback created via rte_eth_add_tx_callback().
3914 * - 0: Success. Callback was removed.
3915 * - -ENOTSUP: Callback support is not available.
3916 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
3917 * is NULL or not found for the port/queue.
3919 int rte_eth_remove_tx_callback(uint8_t port_id, uint16_t queue_id,
3920 struct rte_eth_rxtx_callback *user_cb);
3923 * Retrieve information about given port's RX queue.
3926 * The port identifier of the Ethernet device.
3928 * The RX queue on the Ethernet device for which information
3929 * will be retrieved.
3931 * A pointer to a structure of type *rte_eth_rxq_info_info* to be filled with
3932 * the information of the Ethernet device.
3936 * - -ENOTSUP: routine is not supported by the device PMD.
3937 * - -EINVAL: The port_id or the queue_id is out of range.
3939 int rte_eth_rx_queue_info_get(uint8_t port_id, uint16_t queue_id,
3940 struct rte_eth_rxq_info *qinfo);
3943 * Retrieve information about given port's TX queue.
3946 * The port identifier of the Ethernet device.
3948 * The TX queue on the Ethernet device for which information
3949 * will be retrieved.
3951 * A pointer to a structure of type *rte_eth_txq_info_info* to be filled with
3952 * the information of the Ethernet device.
3956 * - -ENOTSUP: routine is not supported by the device PMD.
3957 * - -EINVAL: The port_id or the queue_id is out of range.
3959 int rte_eth_tx_queue_info_get(uint8_t port_id, uint16_t queue_id,
3960 struct rte_eth_txq_info *qinfo);
3963 * Retrieve number of available registers for access
3966 * The port identifier of the Ethernet device.
3968 * - (>=0) number of registers if successful.
3969 * - (-ENOTSUP) if hardware doesn't support.
3970 * - (-ENODEV) if *port_id* invalid.
3971 * - others depends on the specific operations implementation.
3973 int rte_eth_dev_get_reg_length(uint8_t port_id);
3976 * Retrieve device registers and register attributes
3979 * The port identifier of the Ethernet device.
3981 * The template includes buffer for register data and attribute to be filled.
3983 * - (0) if successful.
3984 * - (-ENOTSUP) if hardware doesn't support.
3985 * - (-ENODEV) if *port_id* invalid.
3986 * - others depends on the specific operations implementation.
3988 int rte_eth_dev_get_reg_info(uint8_t port_id, struct rte_dev_reg_info *info);
3991 * Retrieve size of device EEPROM
3994 * The port identifier of the Ethernet device.
3996 * - (>=0) EEPROM size if successful.
3997 * - (-ENOTSUP) if hardware doesn't support.
3998 * - (-ENODEV) if *port_id* invalid.
3999 * - others depends on the specific operations implementation.
4001 int rte_eth_dev_get_eeprom_length(uint8_t port_id);
4004 * Retrieve EEPROM and EEPROM attribute
4007 * The port identifier of the Ethernet device.
4009 * The template includes buffer for return EEPROM data and
4010 * EEPROM attributes to be filled.
4012 * - (0) if successful.
4013 * - (-ENOTSUP) if hardware doesn't support.
4014 * - (-ENODEV) if *port_id* invalid.
4015 * - others depends on the specific operations implementation.
4017 int rte_eth_dev_get_eeprom(uint8_t port_id, struct rte_dev_eeprom_info *info);
4020 * Program EEPROM with provided data
4023 * The port identifier of the Ethernet device.
4025 * The template includes EEPROM data for programming and
4026 * EEPROM attributes to be filled
4028 * - (0) if successful.
4029 * - (-ENOTSUP) if hardware doesn't support.
4030 * - (-ENODEV) if *port_id* invalid.
4031 * - others depends on the specific operations implementation.
4033 int rte_eth_dev_set_eeprom(uint8_t port_id, struct rte_dev_eeprom_info *info);
4036 * Set the list of multicast addresses to filter on an Ethernet device.
4039 * The port identifier of the Ethernet device.
4040 * @param mc_addr_set
4041 * The array of multicast addresses to set. Equal to NULL when the function
4042 * is invoked to flush the set of filtered addresses.
4044 * The number of multicast addresses in the *mc_addr_set* array. Equal to 0
4045 * when the function is invoked to flush the set of filtered addresses.
4047 * - (0) if successful.
4048 * - (-ENODEV) if *port_id* invalid.
4049 * - (-ENOTSUP) if PMD of *port_id* doesn't support multicast filtering.
4050 * - (-ENOSPC) if *port_id* has not enough multicast filtering resources.
4052 int rte_eth_dev_set_mc_addr_list(uint8_t port_id,
4053 struct ether_addr *mc_addr_set,
4054 uint32_t nb_mc_addr);
4057 * Enable IEEE1588/802.1AS timestamping for an Ethernet device.
4060 * The port identifier of the Ethernet device.
4064 * - -ENODEV: The port ID is invalid.
4065 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4067 int rte_eth_timesync_enable(uint8_t port_id);
4070 * Disable IEEE1588/802.1AS timestamping for an Ethernet device.
4073 * The port identifier of the Ethernet device.
4077 * - -ENODEV: The port ID is invalid.
4078 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4080 int rte_eth_timesync_disable(uint8_t port_id);
4083 * Read an IEEE1588/802.1AS RX timestamp from an Ethernet device.
4086 * The port identifier of the Ethernet device.
4088 * Pointer to the timestamp struct.
4090 * Device specific flags. Used to pass the RX timesync register index to
4091 * i40e. Unused in igb/ixgbe, pass 0 instead.
4095 * - -EINVAL: No timestamp is available.
4096 * - -ENODEV: The port ID is invalid.
4097 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4099 int rte_eth_timesync_read_rx_timestamp(uint8_t port_id,
4100 struct timespec *timestamp, uint32_t flags);
4103 * Read an IEEE1588/802.1AS TX timestamp from an Ethernet device.
4106 * The port identifier of the Ethernet device.
4108 * Pointer to the timestamp struct.
4112 * - -EINVAL: No timestamp is available.
4113 * - -ENODEV: The port ID is invalid.
4114 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4116 int rte_eth_timesync_read_tx_timestamp(uint8_t port_id,
4117 struct timespec *timestamp);
4120 * Adjust the timesync clock on an Ethernet device.
4122 * This is usually used in conjunction with other Ethdev timesync functions to
4123 * synchronize the device time using the IEEE1588/802.1AS protocol.
4126 * The port identifier of the Ethernet device.
4128 * The adjustment in nanoseconds.
4132 * - -ENODEV: The port ID is invalid.
4133 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4135 int rte_eth_timesync_adjust_time(uint8_t port_id, int64_t delta);
4138 * Read the time from the timesync clock on an Ethernet device.
4140 * This is usually used in conjunction with other Ethdev timesync functions to
4141 * synchronize the device time using the IEEE1588/802.1AS protocol.
4144 * The port identifier of the Ethernet device.
4146 * Pointer to the timespec struct that holds the time.
4151 int rte_eth_timesync_read_time(uint8_t port_id, struct timespec *time);
4154 * Set the time of the timesync clock on an Ethernet device.
4156 * This is usually used in conjunction with other Ethdev timesync functions to
4157 * synchronize the device time using the IEEE1588/802.1AS protocol.
4160 * The port identifier of the Ethernet device.
4162 * Pointer to the timespec struct that holds the time.
4166 * - -EINVAL: No timestamp is available.
4167 * - -ENODEV: The port ID is invalid.
4168 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4170 int rte_eth_timesync_write_time(uint8_t port_id, const struct timespec *time);
4173 * Copy pci device info to the Ethernet device data.
4176 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure.
4178 * The *pci_dev* pointer is the address of the *rte_pci_device* structure.
4181 * - 0 on success, negative on error
4183 void rte_eth_copy_pci_info(struct rte_eth_dev *eth_dev,
4184 struct rte_pci_device *pci_dev);
4187 * Create memzone for HW rings.
4188 * malloc can't be used as the physical address is needed.
4189 * If the memzone is already created, then this function returns a ptr
4193 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
4195 * The name of the memory zone
4197 * The index of the queue to add to name
4199 * The sizeof of the memory area
4201 * Alignment for resulting memzone. Must be a power of 2.
4203 * The *socket_id* argument is the socket identifier in case of NUMA.
4205 const struct rte_memzone *
4206 rte_eth_dma_zone_reserve(const struct rte_eth_dev *eth_dev, const char *name,
4207 uint16_t queue_id, size_t size,
4208 unsigned align, int socket_id);
4211 * Config l2 tunnel ether type of an Ethernet device for filtering specific
4212 * tunnel packets by ether type.
4215 * The port identifier of the Ethernet device.
4217 * l2 tunnel configuration.
4220 * - (0) if successful.
4221 * - (-ENODEV) if port identifier is invalid.
4222 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4225 rte_eth_dev_l2_tunnel_eth_type_conf(uint8_t port_id,
4226 struct rte_eth_l2_tunnel_conf *l2_tunnel);
4229 * Enable/disable l2 tunnel offload functions. Include,
4230 * 1, The ability of parsing a type of l2 tunnel of an Ethernet device.
4231 * Filtering, forwarding and offloading this type of tunnel packets depend on
4233 * 2, Stripping the l2 tunnel tag.
4234 * 3, Insertion of the l2 tunnel tag.
4235 * 4, Forwarding the packets based on the l2 tunnel tag.
4238 * The port identifier of the Ethernet device.
4240 * l2 tunnel parameters.
4242 * Indicate the offload function.
4244 * Enable or disable this function.
4247 * - (0) if successful.
4248 * - (-ENODEV) if port identifier is invalid.
4249 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4252 rte_eth_dev_l2_tunnel_offload_set(uint8_t port_id,
4253 struct rte_eth_l2_tunnel_conf *l2_tunnel,
4261 #endif /* _RTE_ETHDEV_H_ */