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_AUTONEG (0 << 0) /**< Autonegotiate (all speeds) */
248 #define ETH_LINK_SPEED_FIXED (1 << 0) /**< Disable autoneg (fixed speed) */
249 #define ETH_LINK_SPEED_10M_HD (1 << 1) /**< 10 Mbps half-duplex */
250 #define ETH_LINK_SPEED_10M (1 << 2) /**< 10 Mbps full-duplex */
251 #define ETH_LINK_SPEED_100M_HD (1 << 3) /**< 100 Mbps half-duplex */
252 #define ETH_LINK_SPEED_100M (1 << 4) /**< 100 Mbps full-duplex */
253 #define ETH_LINK_SPEED_1G (1 << 5) /**< 1 Gbps */
254 #define ETH_LINK_SPEED_2_5G (1 << 6) /**< 2.5 Gbps */
255 #define ETH_LINK_SPEED_5G (1 << 7) /**< 5 Gbps */
256 #define ETH_LINK_SPEED_10G (1 << 8) /**< 10 Gbps */
257 #define ETH_LINK_SPEED_20G (1 << 9) /**< 20 Gbps */
258 #define ETH_LINK_SPEED_25G (1 << 10) /**< 25 Gbps */
259 #define ETH_LINK_SPEED_40G (1 << 11) /**< 40 Gbps */
260 #define ETH_LINK_SPEED_50G (1 << 12) /**< 50 Gbps */
261 #define ETH_LINK_SPEED_56G (1 << 13) /**< 56 Gbps */
264 * Ethernet numeric link speeds in Mbps
266 #define ETH_SPEED_NUM_NONE 0 /**< Not defined */
267 #define ETH_SPEED_NUM_10M 10 /**< 10 Mbps */
268 #define ETH_SPEED_NUM_100M 100 /**< 100 Mbps */
269 #define ETH_SPEED_NUM_1G 1000 /**< 1 Gbps */
270 #define ETH_SPEED_NUM_2_5G 2500 /**< 2.5 Gbps */
271 #define ETH_SPEED_NUM_5G 5000 /**< 5 Gbps */
272 #define ETH_SPEED_NUM_10G 10000 /**< 10 Gbps */
273 #define ETH_SPEED_NUM_20G 20000 /**< 20 Gbps */
274 #define ETH_SPEED_NUM_25G 25000 /**< 25 Gbps */
275 #define ETH_SPEED_NUM_40G 40000 /**< 40 Gbps */
276 #define ETH_SPEED_NUM_50G 50000 /**< 50 Gbps */
277 #define ETH_SPEED_NUM_56G 56000 /**< 56 Gbps */
280 * A structure used to retrieve link-level information of an Ethernet port.
282 struct rte_eth_link {
283 uint16_t link_speed; /**< ETH_SPEED_NUM_ */
284 uint16_t link_duplex : 1; /**< ETH_LINK_[HALF/FULL]_DUPLEX */
285 uint16_t link_autoneg : 1; /**< ETH_LINK_SPEED_[AUTONEG/FIXED] */
286 uint16_t link_status : 1; /**< ETH_LINK_[DOWN/UP] */
287 } __attribute__((aligned(8))); /**< aligned for atomic64 read/write */
289 /* Utility constants */
290 #define ETH_LINK_HALF_DUPLEX 0 /**< Half-duplex connection. */
291 #define ETH_LINK_FULL_DUPLEX 1 /**< Full-duplex connection. */
292 #define ETH_LINK_DOWN 0 /**< Link is down. */
293 #define ETH_LINK_UP 1 /**< Link is up. */
294 #define ETH_LINK_FIXED 0 /**< No autonegotiation. */
295 #define ETH_LINK_AUTONEG 1 /**< Autonegotiated. */
298 * A structure used to configure the ring threshold registers of an RX/TX
299 * queue for an Ethernet port.
301 struct rte_eth_thresh {
302 uint8_t pthresh; /**< Ring prefetch threshold. */
303 uint8_t hthresh; /**< Ring host threshold. */
304 uint8_t wthresh; /**< Ring writeback threshold. */
308 * Simple flags are used for rte_eth_conf.rxmode.mq_mode.
310 #define ETH_MQ_RX_RSS_FLAG 0x1
311 #define ETH_MQ_RX_DCB_FLAG 0x2
312 #define ETH_MQ_RX_VMDQ_FLAG 0x4
315 * A set of values to identify what method is to be used to route
316 * packets to multiple queues.
318 enum rte_eth_rx_mq_mode {
319 /** None of DCB,RSS or VMDQ mode */
322 /** For RX side, only RSS is on */
323 ETH_MQ_RX_RSS = ETH_MQ_RX_RSS_FLAG,
324 /** For RX side,only DCB is on. */
325 ETH_MQ_RX_DCB = ETH_MQ_RX_DCB_FLAG,
326 /** Both DCB and RSS enable */
327 ETH_MQ_RX_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG,
329 /** Only VMDQ, no RSS nor DCB */
330 ETH_MQ_RX_VMDQ_ONLY = ETH_MQ_RX_VMDQ_FLAG,
331 /** RSS mode with VMDQ */
332 ETH_MQ_RX_VMDQ_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_VMDQ_FLAG,
333 /** Use VMDQ+DCB to route traffic to queues */
334 ETH_MQ_RX_VMDQ_DCB = ETH_MQ_RX_VMDQ_FLAG | ETH_MQ_RX_DCB_FLAG,
335 /** Enable both VMDQ and DCB in VMDq */
336 ETH_MQ_RX_VMDQ_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG |
341 * for rx mq mode backward compatible
343 #define ETH_RSS ETH_MQ_RX_RSS
344 #define VMDQ_DCB ETH_MQ_RX_VMDQ_DCB
345 #define ETH_DCB_RX ETH_MQ_RX_DCB
348 * A set of values to identify what method is to be used to transmit
349 * packets using multi-TCs.
351 enum rte_eth_tx_mq_mode {
352 ETH_MQ_TX_NONE = 0, /**< It is in neither DCB nor VT mode. */
353 ETH_MQ_TX_DCB, /**< For TX side,only DCB is on. */
354 ETH_MQ_TX_VMDQ_DCB, /**< For TX side,both DCB and VT is on. */
355 ETH_MQ_TX_VMDQ_ONLY, /**< Only VT on, no DCB */
359 * for tx mq mode backward compatible
361 #define ETH_DCB_NONE ETH_MQ_TX_NONE
362 #define ETH_VMDQ_DCB_TX ETH_MQ_TX_VMDQ_DCB
363 #define ETH_DCB_TX ETH_MQ_TX_DCB
366 * A structure used to configure the RX features of an Ethernet port.
368 struct rte_eth_rxmode {
369 /** The multi-queue packet distribution mode to be used, e.g. RSS. */
370 enum rte_eth_rx_mq_mode mq_mode;
371 uint32_t max_rx_pkt_len; /**< Only used if jumbo_frame enabled. */
372 uint16_t split_hdr_size; /**< hdr buf size (header_split enabled).*/
373 uint16_t header_split : 1, /**< Header Split enable. */
374 hw_ip_checksum : 1, /**< IP/UDP/TCP checksum offload enable. */
375 hw_vlan_filter : 1, /**< VLAN filter enable. */
376 hw_vlan_strip : 1, /**< VLAN strip enable. */
377 hw_vlan_extend : 1, /**< Extended VLAN enable. */
378 jumbo_frame : 1, /**< Jumbo Frame Receipt enable. */
379 hw_strip_crc : 1, /**< Enable CRC stripping by hardware. */
380 enable_scatter : 1, /**< Enable scatter packets rx handler */
381 enable_lro : 1; /**< Enable LRO */
385 * VLAN types to indicate if it is for single VLAN, inner VLAN or outer VLAN.
386 * Note that single VLAN is treated the same as inner VLAN.
389 ETH_VLAN_TYPE_UNKNOWN = 0,
390 ETH_VLAN_TYPE_INNER, /**< Single VLAN, or inner VLAN. */
391 ETH_VLAN_TYPE_OUTER, /**< Outer VLAN. */
396 * A structure used to configure the Receive Side Scaling (RSS) feature
397 * of an Ethernet port.
398 * If not NULL, the *rss_key* pointer of the *rss_conf* structure points
399 * to an array holding the RSS key to use for hashing specific header
400 * fields of received packets. The length of this array should be indicated
401 * by *rss_key_len* below. Otherwise, a default random hash key is used by
404 * The *rss_key_len* field of the *rss_conf* structure indicates the length
405 * in bytes of the array pointed by *rss_key*. To be compatible, this length
406 * will be checked in i40e only. Others assume 40 bytes to be used as before.
408 * The *rss_hf* field of the *rss_conf* structure indicates the different
409 * types of IPv4/IPv6 packets to which the RSS hashing must be applied.
410 * Supplying an *rss_hf* equal to zero disables the RSS feature.
412 struct rte_eth_rss_conf {
413 uint8_t *rss_key; /**< If not NULL, 40-byte hash key. */
414 uint8_t rss_key_len; /**< hash key length in bytes. */
415 uint64_t rss_hf; /**< Hash functions to apply - see below. */
419 * The RSS offload types are defined based on flow types which are defined
420 * in rte_eth_ctrl.h. Different NIC hardwares may support different RSS offload
421 * types. The supported flow types or RSS offload types can be queried by
422 * rte_eth_dev_info_get().
424 #define ETH_RSS_IPV4 (1ULL << RTE_ETH_FLOW_IPV4)
425 #define ETH_RSS_FRAG_IPV4 (1ULL << RTE_ETH_FLOW_FRAG_IPV4)
426 #define ETH_RSS_NONFRAG_IPV4_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_TCP)
427 #define ETH_RSS_NONFRAG_IPV4_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_UDP)
428 #define ETH_RSS_NONFRAG_IPV4_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_SCTP)
429 #define ETH_RSS_NONFRAG_IPV4_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_OTHER)
430 #define ETH_RSS_IPV6 (1ULL << RTE_ETH_FLOW_IPV6)
431 #define ETH_RSS_FRAG_IPV6 (1ULL << RTE_ETH_FLOW_FRAG_IPV6)
432 #define ETH_RSS_NONFRAG_IPV6_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_TCP)
433 #define ETH_RSS_NONFRAG_IPV6_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_UDP)
434 #define ETH_RSS_NONFRAG_IPV6_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_SCTP)
435 #define ETH_RSS_NONFRAG_IPV6_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_OTHER)
436 #define ETH_RSS_L2_PAYLOAD (1ULL << RTE_ETH_FLOW_L2_PAYLOAD)
437 #define ETH_RSS_IPV6_EX (1ULL << RTE_ETH_FLOW_IPV6_EX)
438 #define ETH_RSS_IPV6_TCP_EX (1ULL << RTE_ETH_FLOW_IPV6_TCP_EX)
439 #define ETH_RSS_IPV6_UDP_EX (1ULL << RTE_ETH_FLOW_IPV6_UDP_EX)
441 #define ETH_RSS_IP ( \
443 ETH_RSS_FRAG_IPV4 | \
444 ETH_RSS_NONFRAG_IPV4_OTHER | \
446 ETH_RSS_FRAG_IPV6 | \
447 ETH_RSS_NONFRAG_IPV6_OTHER | \
450 #define ETH_RSS_UDP ( \
451 ETH_RSS_NONFRAG_IPV4_UDP | \
452 ETH_RSS_NONFRAG_IPV6_UDP | \
455 #define ETH_RSS_TCP ( \
456 ETH_RSS_NONFRAG_IPV4_TCP | \
457 ETH_RSS_NONFRAG_IPV6_TCP | \
460 #define ETH_RSS_SCTP ( \
461 ETH_RSS_NONFRAG_IPV4_SCTP | \
462 ETH_RSS_NONFRAG_IPV6_SCTP)
464 /**< Mask of valid RSS hash protocols */
465 #define ETH_RSS_PROTO_MASK ( \
467 ETH_RSS_FRAG_IPV4 | \
468 ETH_RSS_NONFRAG_IPV4_TCP | \
469 ETH_RSS_NONFRAG_IPV4_UDP | \
470 ETH_RSS_NONFRAG_IPV4_SCTP | \
471 ETH_RSS_NONFRAG_IPV4_OTHER | \
473 ETH_RSS_FRAG_IPV6 | \
474 ETH_RSS_NONFRAG_IPV6_TCP | \
475 ETH_RSS_NONFRAG_IPV6_UDP | \
476 ETH_RSS_NONFRAG_IPV6_SCTP | \
477 ETH_RSS_NONFRAG_IPV6_OTHER | \
478 ETH_RSS_L2_PAYLOAD | \
480 ETH_RSS_IPV6_TCP_EX | \
484 * Definitions used for redirection table entry size.
485 * Some RSS RETA sizes may not be supported by some drivers, check the
486 * documentation or the description of relevant functions for more details.
488 #define ETH_RSS_RETA_SIZE_64 64
489 #define ETH_RSS_RETA_SIZE_128 128
490 #define ETH_RSS_RETA_SIZE_512 512
491 #define RTE_RETA_GROUP_SIZE 64
493 /* Definitions used for VMDQ and DCB functionality */
494 #define ETH_VMDQ_MAX_VLAN_FILTERS 64 /**< Maximum nb. of VMDQ vlan filters. */
495 #define ETH_DCB_NUM_USER_PRIORITIES 8 /**< Maximum nb. of DCB priorities. */
496 #define ETH_VMDQ_DCB_NUM_QUEUES 128 /**< Maximum nb. of VMDQ DCB queues. */
497 #define ETH_DCB_NUM_QUEUES 128 /**< Maximum nb. of DCB queues. */
499 /* DCB capability defines */
500 #define ETH_DCB_PG_SUPPORT 0x00000001 /**< Priority Group(ETS) support. */
501 #define ETH_DCB_PFC_SUPPORT 0x00000002 /**< Priority Flow Control support. */
503 /* Definitions used for VLAN Offload functionality */
504 #define ETH_VLAN_STRIP_OFFLOAD 0x0001 /**< VLAN Strip On/Off */
505 #define ETH_VLAN_FILTER_OFFLOAD 0x0002 /**< VLAN Filter On/Off */
506 #define ETH_VLAN_EXTEND_OFFLOAD 0x0004 /**< VLAN Extend On/Off */
508 /* Definitions used for mask VLAN setting */
509 #define ETH_VLAN_STRIP_MASK 0x0001 /**< VLAN Strip setting mask */
510 #define ETH_VLAN_FILTER_MASK 0x0002 /**< VLAN Filter setting mask*/
511 #define ETH_VLAN_EXTEND_MASK 0x0004 /**< VLAN Extend setting mask*/
512 #define ETH_VLAN_ID_MAX 0x0FFF /**< VLAN ID is in lower 12 bits*/
514 /* Definitions used for receive MAC address */
515 #define ETH_NUM_RECEIVE_MAC_ADDR 128 /**< Maximum nb. of receive mac addr. */
517 /* Definitions used for unicast hash */
518 #define ETH_VMDQ_NUM_UC_HASH_ARRAY 128 /**< Maximum nb. of UC hash array. */
520 /* Definitions used for VMDQ pool rx mode setting */
521 #define ETH_VMDQ_ACCEPT_UNTAG 0x0001 /**< accept untagged packets. */
522 #define ETH_VMDQ_ACCEPT_HASH_MC 0x0002 /**< accept packets in multicast table . */
523 #define ETH_VMDQ_ACCEPT_HASH_UC 0x0004 /**< accept packets in unicast table. */
524 #define ETH_VMDQ_ACCEPT_BROADCAST 0x0008 /**< accept broadcast packets. */
525 #define ETH_VMDQ_ACCEPT_MULTICAST 0x0010 /**< multicast promiscuous. */
527 /** Maximum nb. of vlan per mirror rule */
528 #define ETH_MIRROR_MAX_VLANS 64
530 #define ETH_MIRROR_VIRTUAL_POOL_UP 0x01 /**< Virtual Pool uplink Mirroring. */
531 #define ETH_MIRROR_UPLINK_PORT 0x02 /**< Uplink Port Mirroring. */
532 #define ETH_MIRROR_DOWNLINK_PORT 0x04 /**< Downlink Port Mirroring. */
533 #define ETH_MIRROR_VLAN 0x08 /**< VLAN Mirroring. */
534 #define ETH_MIRROR_VIRTUAL_POOL_DOWN 0x10 /**< Virtual Pool downlink Mirroring. */
537 * A structure used to configure VLAN traffic mirror of an Ethernet port.
539 struct rte_eth_vlan_mirror {
540 uint64_t vlan_mask; /**< mask for valid VLAN ID. */
541 /** VLAN ID list for vlan mirroring. */
542 uint16_t vlan_id[ETH_MIRROR_MAX_VLANS];
546 * A structure used to configure traffic mirror of an Ethernet port.
548 struct rte_eth_mirror_conf {
549 uint8_t rule_type; /**< Mirroring rule type */
550 uint8_t dst_pool; /**< Destination pool for this mirror rule. */
551 uint64_t pool_mask; /**< Bitmap of pool for pool mirroring */
552 /** VLAN ID setting for VLAN mirroring. */
553 struct rte_eth_vlan_mirror vlan;
557 * A structure used to configure 64 entries of Redirection Table of the
558 * Receive Side Scaling (RSS) feature of an Ethernet port. To configure
559 * more than 64 entries supported by hardware, an array of this structure
562 struct rte_eth_rss_reta_entry64 {
564 /**< Mask bits indicate which entries need to be updated/queried. */
565 uint16_t reta[RTE_RETA_GROUP_SIZE];
566 /**< Group of 64 redirection table entries. */
570 * This enum indicates the possible number of traffic classes
571 * in DCB configratioins
573 enum rte_eth_nb_tcs {
574 ETH_4_TCS = 4, /**< 4 TCs with DCB. */
575 ETH_8_TCS = 8 /**< 8 TCs with DCB. */
579 * This enum indicates the possible number of queue pools
580 * in VMDQ configurations.
582 enum rte_eth_nb_pools {
583 ETH_8_POOLS = 8, /**< 8 VMDq pools. */
584 ETH_16_POOLS = 16, /**< 16 VMDq pools. */
585 ETH_32_POOLS = 32, /**< 32 VMDq pools. */
586 ETH_64_POOLS = 64 /**< 64 VMDq pools. */
589 /* This structure may be extended in future. */
590 struct rte_eth_dcb_rx_conf {
591 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs */
592 /** Traffic class each UP mapped to. */
593 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
596 struct rte_eth_vmdq_dcb_tx_conf {
597 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools. */
598 /** Traffic class each UP mapped to. */
599 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
602 struct rte_eth_dcb_tx_conf {
603 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs. */
604 /** Traffic class each UP mapped to. */
605 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
608 struct rte_eth_vmdq_tx_conf {
609 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq mode, 64 pools. */
613 * A structure used to configure the VMDQ+DCB feature
614 * of an Ethernet port.
616 * Using this feature, packets are routed to a pool of queues, based
617 * on the vlan id in the vlan tag, and then to a specific queue within
618 * that pool, using the user priority vlan tag field.
620 * A default pool may be used, if desired, to route all traffic which
621 * does not match the vlan filter rules.
623 struct rte_eth_vmdq_dcb_conf {
624 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools */
625 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
626 uint8_t default_pool; /**< The default pool, if applicable */
627 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
629 uint16_t vlan_id; /**< The vlan id of the received frame */
630 uint64_t pools; /**< Bitmask of pools for packet rx */
631 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
632 uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
633 /**< Selects a queue in a pool */
636 struct rte_eth_vmdq_rx_conf {
637 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq only mode, 8 or 64 pools */
638 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
639 uint8_t default_pool; /**< The default pool, if applicable */
640 uint8_t enable_loop_back; /**< Enable VT loop back */
641 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
642 uint32_t rx_mode; /**< Flags from ETH_VMDQ_ACCEPT_* */
644 uint16_t vlan_id; /**< The vlan id of the received frame */
645 uint64_t pools; /**< Bitmask of pools for packet rx */
646 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
650 * A structure used to configure the TX features of an Ethernet port.
652 struct rte_eth_txmode {
653 enum rte_eth_tx_mq_mode mq_mode; /**< TX multi-queues mode. */
655 /* For i40e specifically */
657 uint8_t hw_vlan_reject_tagged : 1,
658 /**< If set, reject sending out tagged pkts */
659 hw_vlan_reject_untagged : 1,
660 /**< If set, reject sending out untagged pkts */
661 hw_vlan_insert_pvid : 1;
662 /**< If set, enable port based VLAN insertion */
666 * A structure used to configure an RX ring of an Ethernet port.
668 struct rte_eth_rxconf {
669 struct rte_eth_thresh rx_thresh; /**< RX ring threshold registers. */
670 uint16_t rx_free_thresh; /**< Drives the freeing of RX descriptors. */
671 uint8_t rx_drop_en; /**< Drop packets if no descriptors are available. */
672 uint8_t rx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
675 #define ETH_TXQ_FLAGS_NOMULTSEGS 0x0001 /**< nb_segs=1 for all mbufs */
676 #define ETH_TXQ_FLAGS_NOREFCOUNT 0x0002 /**< refcnt can be ignored */
677 #define ETH_TXQ_FLAGS_NOMULTMEMP 0x0004 /**< all bufs come from same mempool */
678 #define ETH_TXQ_FLAGS_NOVLANOFFL 0x0100 /**< disable VLAN offload */
679 #define ETH_TXQ_FLAGS_NOXSUMSCTP 0x0200 /**< disable SCTP checksum offload */
680 #define ETH_TXQ_FLAGS_NOXSUMUDP 0x0400 /**< disable UDP checksum offload */
681 #define ETH_TXQ_FLAGS_NOXSUMTCP 0x0800 /**< disable TCP checksum offload */
682 #define ETH_TXQ_FLAGS_NOOFFLOADS \
683 (ETH_TXQ_FLAGS_NOVLANOFFL | ETH_TXQ_FLAGS_NOXSUMSCTP | \
684 ETH_TXQ_FLAGS_NOXSUMUDP | ETH_TXQ_FLAGS_NOXSUMTCP)
685 #define ETH_TXQ_FLAGS_NOXSUMS \
686 (ETH_TXQ_FLAGS_NOXSUMSCTP | ETH_TXQ_FLAGS_NOXSUMUDP | \
687 ETH_TXQ_FLAGS_NOXSUMTCP)
689 * A structure used to configure a TX ring of an Ethernet port.
691 struct rte_eth_txconf {
692 struct rte_eth_thresh tx_thresh; /**< TX ring threshold registers. */
693 uint16_t tx_rs_thresh; /**< Drives the setting of RS bit on TXDs. */
694 uint16_t tx_free_thresh; /**< Start freeing TX buffers if there are
695 less free descriptors than this value. */
697 uint32_t txq_flags; /**< Set flags for the Tx queue */
698 uint8_t tx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
702 * A structure contains information about HW descriptor ring limitations.
704 struct rte_eth_desc_lim {
705 uint16_t nb_max; /**< Max allowed number of descriptors. */
706 uint16_t nb_min; /**< Min allowed number of descriptors. */
707 uint16_t nb_align; /**< Number of descriptors should be aligned to. */
711 * This enum indicates the flow control mode
713 enum rte_eth_fc_mode {
714 RTE_FC_NONE = 0, /**< Disable flow control. */
715 RTE_FC_RX_PAUSE, /**< RX pause frame, enable flowctrl on TX side. */
716 RTE_FC_TX_PAUSE, /**< TX pause frame, enable flowctrl on RX side. */
717 RTE_FC_FULL /**< Enable flow control on both side. */
721 * A structure used to configure Ethernet flow control parameter.
722 * These parameters will be configured into the register of the NIC.
723 * Please refer to the corresponding data sheet for proper value.
725 struct rte_eth_fc_conf {
726 uint32_t high_water; /**< High threshold value to trigger XOFF */
727 uint32_t low_water; /**< Low threshold value to trigger XON */
728 uint16_t pause_time; /**< Pause quota in the Pause frame */
729 uint16_t send_xon; /**< Is XON frame need be sent */
730 enum rte_eth_fc_mode mode; /**< Link flow control mode */
731 uint8_t mac_ctrl_frame_fwd; /**< Forward MAC control frames */
732 uint8_t autoneg; /**< Use Pause autoneg */
736 * A structure used to configure Ethernet priority flow control parameter.
737 * These parameters will be configured into the register of the NIC.
738 * Please refer to the corresponding data sheet for proper value.
740 struct rte_eth_pfc_conf {
741 struct rte_eth_fc_conf fc; /**< General flow control parameter. */
742 uint8_t priority; /**< VLAN User Priority. */
746 * Memory space that can be configured to store Flow Director filters
747 * in the board memory.
749 enum rte_fdir_pballoc_type {
750 RTE_FDIR_PBALLOC_64K = 0, /**< 64k. */
751 RTE_FDIR_PBALLOC_128K, /**< 128k. */
752 RTE_FDIR_PBALLOC_256K, /**< 256k. */
756 * Select report mode of FDIR hash information in RX descriptors.
758 enum rte_fdir_status_mode {
759 RTE_FDIR_NO_REPORT_STATUS = 0, /**< Never report FDIR hash. */
760 RTE_FDIR_REPORT_STATUS, /**< Only report FDIR hash for matching pkts. */
761 RTE_FDIR_REPORT_STATUS_ALWAYS, /**< Always report FDIR hash. */
765 * A structure used to configure the Flow Director (FDIR) feature
766 * of an Ethernet port.
768 * If mode is RTE_FDIR_DISABLE, the pballoc value is ignored.
770 struct rte_fdir_conf {
771 enum rte_fdir_mode mode; /**< Flow Director mode. */
772 enum rte_fdir_pballoc_type pballoc; /**< Space for FDIR filters. */
773 enum rte_fdir_status_mode status; /**< How to report FDIR hash. */
774 /** RX queue of packets matching a "drop" filter in perfect mode. */
776 struct rte_eth_fdir_masks mask;
777 struct rte_eth_fdir_flex_conf flex_conf;
778 /**< Flex payload configuration. */
782 * UDP tunneling configuration.
783 * Used to config the UDP port for a type of tunnel.
784 * NICs need the UDP port to identify the tunnel type.
785 * Normally a type of tunnel has a default UDP port, this structure can be used
786 * in case if the users want to change or support more UDP port.
788 struct rte_eth_udp_tunnel {
789 uint16_t udp_port; /**< UDP port used for the tunnel. */
790 uint8_t prot_type; /**< Tunnel type. Defined in rte_eth_tunnel_type. */
794 * A structure used to enable/disable specific device interrupts.
796 struct rte_intr_conf {
797 /** enable/disable lsc interrupt. 0 (default) - disable, 1 enable */
799 /** enable/disable rxq interrupt. 0 (default) - disable, 1 enable */
804 * A structure used to configure an Ethernet port.
805 * Depending upon the RX multi-queue mode, extra advanced
806 * configuration settings may be needed.
808 struct rte_eth_conf {
809 uint32_t link_speeds; /**< bitmap of ETH_LINK_SPEED_XXX of speeds to be
810 used. ETH_LINK_SPEED_FIXED disables link
811 autonegotiation, and a unique speed shall be
812 set. Otherwise, the bitmap defines the set of
813 speeds to be advertised. If the special value
814 ETH_LINK_SPEED_AUTONEG (0) is used, all speeds
815 supported are advertised. */
816 struct rte_eth_rxmode rxmode; /**< Port RX configuration. */
817 struct rte_eth_txmode txmode; /**< Port TX configuration. */
818 uint32_t lpbk_mode; /**< Loopback operation mode. By default the value
819 is 0, meaning the loopback mode is disabled.
820 Read the datasheet of given ethernet controller
821 for details. The possible values of this field
822 are defined in implementation of each driver. */
824 struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
825 struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
826 /**< Port vmdq+dcb configuration. */
827 struct rte_eth_dcb_rx_conf dcb_rx_conf;
828 /**< Port dcb RX configuration. */
829 struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
830 /**< Port vmdq RX configuration. */
831 } rx_adv_conf; /**< Port RX filtering configuration (union). */
833 struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
834 /**< Port vmdq+dcb TX configuration. */
835 struct rte_eth_dcb_tx_conf dcb_tx_conf;
836 /**< Port dcb TX configuration. */
837 struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
838 /**< Port vmdq TX configuration. */
839 } tx_adv_conf; /**< Port TX DCB configuration (union). */
840 /** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
841 is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
842 uint32_t dcb_capability_en;
843 struct rte_fdir_conf fdir_conf; /**< FDIR configuration. */
844 struct rte_intr_conf intr_conf; /**< Interrupt mode configuration. */
848 * A structure used to retrieve the contextual information of
849 * an Ethernet device, such as the controlling driver of the device,
850 * its PCI context, etc...
854 * RX offload capabilities of a device.
856 #define DEV_RX_OFFLOAD_VLAN_STRIP 0x00000001
857 #define DEV_RX_OFFLOAD_IPV4_CKSUM 0x00000002
858 #define DEV_RX_OFFLOAD_UDP_CKSUM 0x00000004
859 #define DEV_RX_OFFLOAD_TCP_CKSUM 0x00000008
860 #define DEV_RX_OFFLOAD_TCP_LRO 0x00000010
861 #define DEV_RX_OFFLOAD_QINQ_STRIP 0x00000020
862 #define DEV_RX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000040
865 * TX offload capabilities of a device.
867 #define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001
868 #define DEV_TX_OFFLOAD_IPV4_CKSUM 0x00000002
869 #define DEV_TX_OFFLOAD_UDP_CKSUM 0x00000004
870 #define DEV_TX_OFFLOAD_TCP_CKSUM 0x00000008
871 #define DEV_TX_OFFLOAD_SCTP_CKSUM 0x00000010
872 #define DEV_TX_OFFLOAD_TCP_TSO 0x00000020
873 #define DEV_TX_OFFLOAD_UDP_TSO 0x00000040
874 #define DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000080 /**< Used for tunneling packet. */
875 #define DEV_TX_OFFLOAD_QINQ_INSERT 0x00000100
878 * Ethernet device information
880 struct rte_eth_dev_info {
881 struct rte_pci_device *pci_dev; /**< Device PCI information. */
882 const char *driver_name; /**< Device Driver name. */
883 unsigned int if_index; /**< Index to bound host interface, or 0 if none.
884 Use if_indextoname() to translate into an interface name. */
885 uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
886 uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
887 uint16_t max_rx_queues; /**< Maximum number of RX queues. */
888 uint16_t max_tx_queues; /**< Maximum number of TX queues. */
889 uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
890 uint32_t max_hash_mac_addrs;
891 /** Maximum number of hash MAC addresses for MTA and UTA. */
892 uint16_t max_vfs; /**< Maximum number of VFs. */
893 uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
894 uint32_t rx_offload_capa; /**< Device RX offload capabilities. */
895 uint32_t tx_offload_capa; /**< Device TX offload capabilities. */
897 /**< Device redirection table size, the total number of entries. */
898 uint8_t hash_key_size; /**< Hash key size in bytes */
899 /** Bit mask of RSS offloads, the bit offset also means flow type */
900 uint64_t flow_type_rss_offloads;
901 struct rte_eth_rxconf default_rxconf; /**< Default RX configuration */
902 struct rte_eth_txconf default_txconf; /**< Default TX configuration */
903 uint16_t vmdq_queue_base; /**< First queue ID for VMDQ pools. */
904 uint16_t vmdq_queue_num; /**< Queue number for VMDQ pools. */
905 uint16_t vmdq_pool_base; /**< First ID of VMDQ pools. */
906 struct rte_eth_desc_lim rx_desc_lim; /**< RX descriptors limits */
907 struct rte_eth_desc_lim tx_desc_lim; /**< TX descriptors limits */
908 uint32_t speed_capa; /**< Supported speeds bitmap (ETH_LINK_SPEED_). */
912 * Ethernet device RX queue information structure.
913 * Used to retieve information about configured queue.
915 struct rte_eth_rxq_info {
916 struct rte_mempool *mp; /**< mempool used by that queue. */
917 struct rte_eth_rxconf conf; /**< queue config parameters. */
918 uint8_t scattered_rx; /**< scattered packets RX supported. */
919 uint16_t nb_desc; /**< configured number of RXDs. */
920 } __rte_cache_min_aligned;
923 * Ethernet device TX queue information structure.
924 * Used to retieve information about configured queue.
926 struct rte_eth_txq_info {
927 struct rte_eth_txconf conf; /**< queue config parameters. */
928 uint16_t nb_desc; /**< configured number of TXDs. */
929 } __rte_cache_min_aligned;
931 /** Maximum name length for extended statistics counters */
932 #define RTE_ETH_XSTATS_NAME_SIZE 64
935 * An Ethernet device extended statistic structure
937 * This structure is used by ethdev->eth_xstats_get() to provide
938 * statistics that are not provided in the generic rte_eth_stats
941 struct rte_eth_xstats {
942 char name[RTE_ETH_XSTATS_NAME_SIZE];
946 #define ETH_DCB_NUM_TCS 8
947 #define ETH_MAX_VMDQ_POOL 64
950 * A structure used to get the information of queue and
951 * TC mapping on both TX and RX paths.
953 struct rte_eth_dcb_tc_queue_mapping {
954 /** rx queues assigned to tc per Pool */
958 } tc_rxq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
959 /** rx queues assigned to tc per Pool */
963 } tc_txq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
967 * A structure used to get the information of DCB.
968 * It includes TC UP mapping and queue TC mapping.
970 struct rte_eth_dcb_info {
971 uint8_t nb_tcs; /**< number of TCs */
972 uint8_t prio_tc[ETH_DCB_NUM_USER_PRIORITIES]; /**< Priority to tc */
973 uint8_t tc_bws[ETH_DCB_NUM_TCS]; /**< TX BW percentage for each TC */
974 /** rx queues assigned to tc */
975 struct rte_eth_dcb_tc_queue_mapping tc_queue;
981 #define RTE_ETH_QUEUE_STATE_STOPPED 0
982 #define RTE_ETH_QUEUE_STATE_STARTED 1
986 struct rte_eth_dev_callback;
987 /** @internal Structure to keep track of registered callbacks */
988 TAILQ_HEAD(rte_eth_dev_cb_list, rte_eth_dev_callback);
991 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
992 #define RTE_PMD_DEBUG_TRACE(...) \
993 rte_pmd_debug_trace(__func__, __VA_ARGS__)
995 #define RTE_PMD_DEBUG_TRACE(...)
999 /* Macros to check for valid port */
1000 #define RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, retval) do { \
1001 if (!rte_eth_dev_is_valid_port(port_id)) { \
1002 RTE_PMD_DEBUG_TRACE("Invalid port_id=%d\n", port_id); \
1007 #define RTE_ETH_VALID_PORTID_OR_RET(port_id) do { \
1008 if (!rte_eth_dev_is_valid_port(port_id)) { \
1009 RTE_PMD_DEBUG_TRACE("Invalid port_id=%d\n", port_id); \
1015 * l2 tunnel configuration.
1018 /**< l2 tunnel enable mask */
1019 #define ETH_L2_TUNNEL_ENABLE_MASK 0x00000001
1020 /**< l2 tunnel insertion mask */
1021 #define ETH_L2_TUNNEL_INSERTION_MASK 0x00000002
1022 /**< l2 tunnel stripping mask */
1023 #define ETH_L2_TUNNEL_STRIPPING_MASK 0x00000004
1024 /**< l2 tunnel forwarding mask */
1025 #define ETH_L2_TUNNEL_FORWARDING_MASK 0x00000008
1028 * Definitions of all functions exported by an Ethernet driver through the
1029 * the generic structure of type *eth_dev_ops* supplied in the *rte_eth_dev*
1030 * structure associated with an Ethernet device.
1033 typedef int (*eth_dev_configure_t)(struct rte_eth_dev *dev);
1034 /**< @internal Ethernet device configuration. */
1036 typedef int (*eth_dev_start_t)(struct rte_eth_dev *dev);
1037 /**< @internal Function used to start a configured Ethernet device. */
1039 typedef void (*eth_dev_stop_t)(struct rte_eth_dev *dev);
1040 /**< @internal Function used to stop a configured Ethernet device. */
1042 typedef int (*eth_dev_set_link_up_t)(struct rte_eth_dev *dev);
1043 /**< @internal Function used to link up a configured Ethernet device. */
1045 typedef int (*eth_dev_set_link_down_t)(struct rte_eth_dev *dev);
1046 /**< @internal Function used to link down a configured Ethernet device. */
1048 typedef void (*eth_dev_close_t)(struct rte_eth_dev *dev);
1049 /**< @internal Function used to close a configured Ethernet device. */
1051 typedef void (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev);
1052 /**< @internal Function used to enable the RX promiscuous mode of an Ethernet device. */
1054 typedef void (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev);
1055 /**< @internal Function used to disable the RX promiscuous mode of an Ethernet device. */
1057 typedef void (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
1058 /**< @internal Enable the receipt of all multicast packets by an Ethernet device. */
1060 typedef void (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
1061 /**< @internal Disable the receipt of all multicast packets by an Ethernet device. */
1063 typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
1064 int wait_to_complete);
1065 /**< @internal Get link speed, duplex mode and state (up/down) of an Ethernet device. */
1067 typedef void (*eth_stats_get_t)(struct rte_eth_dev *dev,
1068 struct rte_eth_stats *igb_stats);
1069 /**< @internal Get global I/O statistics of an Ethernet device. */
1071 typedef void (*eth_stats_reset_t)(struct rte_eth_dev *dev);
1072 /**< @internal Reset global I/O statistics of an Ethernet device to 0. */
1074 typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev,
1075 struct rte_eth_xstats *stats, unsigned n);
1076 /**< @internal Get extended stats of an Ethernet device. */
1078 typedef void (*eth_xstats_reset_t)(struct rte_eth_dev *dev);
1079 /**< @internal Reset extended stats of an Ethernet device. */
1081 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
1085 /**< @internal Set a queue statistics mapping for a tx/rx queue of an Ethernet device. */
1087 typedef void (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
1088 struct rte_eth_dev_info *dev_info);
1089 /**< @internal Get specific informations of an Ethernet device. */
1091 typedef const uint32_t *(*eth_dev_supported_ptypes_get_t)(struct rte_eth_dev *dev);
1092 /**< @internal Get supported ptypes of an Ethernet device. */
1094 typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
1096 /**< @internal Start rx and tx of a queue of an Ethernet device. */
1098 typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
1100 /**< @internal Stop rx and tx of a queue of an Ethernet device. */
1102 typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
1103 uint16_t rx_queue_id,
1104 uint16_t nb_rx_desc,
1105 unsigned int socket_id,
1106 const struct rte_eth_rxconf *rx_conf,
1107 struct rte_mempool *mb_pool);
1108 /**< @internal Set up a receive queue of an Ethernet device. */
1110 typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
1111 uint16_t tx_queue_id,
1112 uint16_t nb_tx_desc,
1113 unsigned int socket_id,
1114 const struct rte_eth_txconf *tx_conf);
1115 /**< @internal Setup a transmit queue of an Ethernet device. */
1117 typedef int (*eth_rx_enable_intr_t)(struct rte_eth_dev *dev,
1118 uint16_t rx_queue_id);
1119 /**< @internal Enable interrupt of a receive queue of an Ethernet device. */
1121 typedef int (*eth_rx_disable_intr_t)(struct rte_eth_dev *dev,
1122 uint16_t rx_queue_id);
1123 /**< @internal Disable interrupt of a receive queue of an Ethernet device. */
1125 typedef void (*eth_queue_release_t)(void *queue);
1126 /**< @internal Release memory resources allocated by given RX/TX queue. */
1128 typedef uint32_t (*eth_rx_queue_count_t)(struct rte_eth_dev *dev,
1129 uint16_t rx_queue_id);
1130 /**< @internal Get number of available descriptors on a receive queue of an Ethernet device. */
1132 typedef int (*eth_rx_descriptor_done_t)(void *rxq, uint16_t offset);
1133 /**< @internal Check DD bit of specific RX descriptor */
1135 typedef void (*eth_rxq_info_get_t)(struct rte_eth_dev *dev,
1136 uint16_t rx_queue_id, struct rte_eth_rxq_info *qinfo);
1138 typedef void (*eth_txq_info_get_t)(struct rte_eth_dev *dev,
1139 uint16_t tx_queue_id, struct rte_eth_txq_info *qinfo);
1141 typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);
1142 /**< @internal Set MTU. */
1144 typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
1147 /**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */
1149 typedef int (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
1150 enum rte_vlan_type type, uint16_t tpid);
1151 /**< @internal set the outer VLAN-TPID by an Ethernet device. */
1153 typedef void (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
1154 /**< @internal set VLAN offload function by an Ethernet device. */
1156 typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
1159 /**< @internal set port based TX VLAN insertion by an Ethernet device. */
1161 typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
1162 uint16_t rx_queue_id,
1164 /**< @internal VLAN stripping enable/disable by an queue of Ethernet device. */
1166 typedef uint16_t (*eth_rx_burst_t)(void *rxq,
1167 struct rte_mbuf **rx_pkts,
1169 /**< @internal Retrieve input packets from a receive queue of an Ethernet device. */
1171 typedef uint16_t (*eth_tx_burst_t)(void *txq,
1172 struct rte_mbuf **tx_pkts,
1174 /**< @internal Send output packets on a transmit queue of an Ethernet device. */
1176 typedef int (*flow_ctrl_get_t)(struct rte_eth_dev *dev,
1177 struct rte_eth_fc_conf *fc_conf);
1178 /**< @internal Get current flow control parameter on an Ethernet device */
1180 typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
1181 struct rte_eth_fc_conf *fc_conf);
1182 /**< @internal Setup flow control parameter on an Ethernet device */
1184 typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
1185 struct rte_eth_pfc_conf *pfc_conf);
1186 /**< @internal Setup priority flow control parameter on an Ethernet device */
1188 typedef int (*reta_update_t)(struct rte_eth_dev *dev,
1189 struct rte_eth_rss_reta_entry64 *reta_conf,
1190 uint16_t reta_size);
1191 /**< @internal Update RSS redirection table on an Ethernet device */
1193 typedef int (*reta_query_t)(struct rte_eth_dev *dev,
1194 struct rte_eth_rss_reta_entry64 *reta_conf,
1195 uint16_t reta_size);
1196 /**< @internal Query RSS redirection table on an Ethernet device */
1198 typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
1199 struct rte_eth_rss_conf *rss_conf);
1200 /**< @internal Update RSS hash configuration of an Ethernet device */
1202 typedef int (*rss_hash_conf_get_t)(struct rte_eth_dev *dev,
1203 struct rte_eth_rss_conf *rss_conf);
1204 /**< @internal Get current RSS hash configuration of an Ethernet device */
1206 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
1207 /**< @internal Turn on SW controllable LED on an Ethernet device */
1209 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
1210 /**< @internal Turn off SW controllable LED on an Ethernet device */
1212 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
1213 /**< @internal Remove MAC address from receive address register */
1215 typedef void (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
1216 struct ether_addr *mac_addr,
1219 /**< @internal Set a MAC address into Receive Address Address Register */
1221 typedef void (*eth_mac_addr_set_t)(struct rte_eth_dev *dev,
1222 struct ether_addr *mac_addr);
1223 /**< @internal Set a MAC address into Receive Address Address Register */
1225 typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
1226 struct ether_addr *mac_addr,
1228 /**< @internal Set a Unicast Hash bitmap */
1230 typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
1232 /**< @internal Set all Unicast Hash bitmap */
1234 typedef int (*eth_set_vf_rx_mode_t)(struct rte_eth_dev *dev,
1238 /**< @internal Set a VF receive mode */
1240 typedef int (*eth_set_vf_rx_t)(struct rte_eth_dev *dev,
1243 /**< @internal Set a VF receive mode */
1245 typedef int (*eth_set_vf_tx_t)(struct rte_eth_dev *dev,
1248 /**< @internal Enable or disable a VF transmit */
1250 typedef int (*eth_set_vf_vlan_filter_t)(struct rte_eth_dev *dev,
1254 /**< @internal Set VF VLAN pool filter */
1256 typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
1259 /**< @internal Set queue TX rate */
1261 typedef int (*eth_set_vf_rate_limit_t)(struct rte_eth_dev *dev,
1265 /**< @internal Set VF TX rate */
1267 typedef int (*eth_mirror_rule_set_t)(struct rte_eth_dev *dev,
1268 struct rte_eth_mirror_conf *mirror_conf,
1271 /**< @internal Add a traffic mirroring rule on an Ethernet device */
1273 typedef int (*eth_mirror_rule_reset_t)(struct rte_eth_dev *dev,
1275 /**< @internal Remove a traffic mirroring rule on an Ethernet device */
1277 typedef int (*eth_udp_tunnel_port_add_t)(struct rte_eth_dev *dev,
1278 struct rte_eth_udp_tunnel *tunnel_udp);
1279 /**< @internal Add tunneling UDP port */
1281 typedef int (*eth_udp_tunnel_port_del_t)(struct rte_eth_dev *dev,
1282 struct rte_eth_udp_tunnel *tunnel_udp);
1283 /**< @internal Delete tunneling UDP port */
1285 typedef int (*eth_set_mc_addr_list_t)(struct rte_eth_dev *dev,
1286 struct ether_addr *mc_addr_set,
1287 uint32_t nb_mc_addr);
1288 /**< @internal set the list of multicast addresses on an Ethernet device */
1290 typedef int (*eth_timesync_enable_t)(struct rte_eth_dev *dev);
1291 /**< @internal Function used to enable IEEE1588/802.1AS timestamping. */
1293 typedef int (*eth_timesync_disable_t)(struct rte_eth_dev *dev);
1294 /**< @internal Function used to disable IEEE1588/802.1AS timestamping. */
1296 typedef int (*eth_timesync_read_rx_timestamp_t)(struct rte_eth_dev *dev,
1297 struct timespec *timestamp,
1299 /**< @internal Function used to read an RX IEEE1588/802.1AS timestamp. */
1301 typedef int (*eth_timesync_read_tx_timestamp_t)(struct rte_eth_dev *dev,
1302 struct timespec *timestamp);
1303 /**< @internal Function used to read a TX IEEE1588/802.1AS timestamp. */
1305 typedef int (*eth_timesync_adjust_time)(struct rte_eth_dev *dev, int64_t);
1306 /**< @internal Function used to adjust the device clock */
1308 typedef int (*eth_timesync_read_time)(struct rte_eth_dev *dev,
1309 struct timespec *timestamp);
1310 /**< @internal Function used to get time from the device clock. */
1312 typedef int (*eth_timesync_write_time)(struct rte_eth_dev *dev,
1313 const struct timespec *timestamp);
1314 /**< @internal Function used to get time from the device clock */
1316 typedef int (*eth_get_reg_length_t)(struct rte_eth_dev *dev);
1317 /**< @internal Retrieve device register count */
1319 typedef int (*eth_get_reg_t)(struct rte_eth_dev *dev,
1320 struct rte_dev_reg_info *info);
1321 /**< @internal Retrieve registers */
1323 typedef int (*eth_get_eeprom_length_t)(struct rte_eth_dev *dev);
1324 /**< @internal Retrieve eeprom size */
1326 typedef int (*eth_get_eeprom_t)(struct rte_eth_dev *dev,
1327 struct rte_dev_eeprom_info *info);
1328 /**< @internal Retrieve eeprom data */
1330 typedef int (*eth_set_eeprom_t)(struct rte_eth_dev *dev,
1331 struct rte_dev_eeprom_info *info);
1332 /**< @internal Program eeprom data */
1334 typedef int (*eth_l2_tunnel_eth_type_conf_t)
1335 (struct rte_eth_dev *dev, struct rte_eth_l2_tunnel_conf *l2_tunnel);
1336 /**< @internal config l2 tunnel ether type */
1338 typedef int (*eth_l2_tunnel_offload_set_t)
1339 (struct rte_eth_dev *dev,
1340 struct rte_eth_l2_tunnel_conf *l2_tunnel,
1343 /**< @internal enable/disable the l2 tunnel offload functions */
1345 #ifdef RTE_NIC_BYPASS
1348 RTE_BYPASS_MODE_NONE,
1349 RTE_BYPASS_MODE_NORMAL,
1350 RTE_BYPASS_MODE_BYPASS,
1351 RTE_BYPASS_MODE_ISOLATE,
1352 RTE_BYPASS_MODE_NUM,
1355 #define RTE_BYPASS_MODE_VALID(x) \
1356 ((x) > RTE_BYPASS_MODE_NONE && (x) < RTE_BYPASS_MODE_NUM)
1359 RTE_BYPASS_EVENT_NONE,
1360 RTE_BYPASS_EVENT_START,
1361 RTE_BYPASS_EVENT_OS_ON = RTE_BYPASS_EVENT_START,
1362 RTE_BYPASS_EVENT_POWER_ON,
1363 RTE_BYPASS_EVENT_OS_OFF,
1364 RTE_BYPASS_EVENT_POWER_OFF,
1365 RTE_BYPASS_EVENT_TIMEOUT,
1366 RTE_BYPASS_EVENT_NUM
1369 #define RTE_BYPASS_EVENT_VALID(x) \
1370 ((x) > RTE_BYPASS_EVENT_NONE && (x) < RTE_BYPASS_MODE_NUM)
1373 RTE_BYPASS_TMT_OFF, /* timeout disabled. */
1374 RTE_BYPASS_TMT_1_5_SEC, /* timeout for 1.5 seconds */
1375 RTE_BYPASS_TMT_2_SEC, /* timeout for 2 seconds */
1376 RTE_BYPASS_TMT_3_SEC, /* timeout for 3 seconds */
1377 RTE_BYPASS_TMT_4_SEC, /* timeout for 4 seconds */
1378 RTE_BYPASS_TMT_8_SEC, /* timeout for 8 seconds */
1379 RTE_BYPASS_TMT_16_SEC, /* timeout for 16 seconds */
1380 RTE_BYPASS_TMT_32_SEC, /* timeout for 32 seconds */
1384 #define RTE_BYPASS_TMT_VALID(x) \
1385 ((x) == RTE_BYPASS_TMT_OFF || \
1386 ((x) > RTE_BYPASS_TMT_OFF && (x) < RTE_BYPASS_TMT_NUM))
1388 typedef void (*bypass_init_t)(struct rte_eth_dev *dev);
1389 typedef int32_t (*bypass_state_set_t)(struct rte_eth_dev *dev, uint32_t *new_state);
1390 typedef int32_t (*bypass_state_show_t)(struct rte_eth_dev *dev, uint32_t *state);
1391 typedef int32_t (*bypass_event_set_t)(struct rte_eth_dev *dev, uint32_t state, uint32_t event);
1392 typedef int32_t (*bypass_event_show_t)(struct rte_eth_dev *dev, uint32_t event_shift, uint32_t *event);
1393 typedef int32_t (*bypass_wd_timeout_set_t)(struct rte_eth_dev *dev, uint32_t timeout);
1394 typedef int32_t (*bypass_wd_timeout_show_t)(struct rte_eth_dev *dev, uint32_t *wd_timeout);
1395 typedef int32_t (*bypass_ver_show_t)(struct rte_eth_dev *dev, uint32_t *ver);
1396 typedef int32_t (*bypass_wd_reset_t)(struct rte_eth_dev *dev);
1399 typedef int (*eth_filter_ctrl_t)(struct rte_eth_dev *dev,
1400 enum rte_filter_type filter_type,
1401 enum rte_filter_op filter_op,
1403 /**< @internal Take operations to assigned filter type on an Ethernet device */
1405 typedef int (*eth_get_dcb_info)(struct rte_eth_dev *dev,
1406 struct rte_eth_dcb_info *dcb_info);
1407 /**< @internal Get dcb information on an Ethernet device */
1410 * @internal A structure containing the functions exported by an Ethernet driver.
1412 struct eth_dev_ops {
1413 eth_dev_configure_t dev_configure; /**< Configure device. */
1414 eth_dev_start_t dev_start; /**< Start device. */
1415 eth_dev_stop_t dev_stop; /**< Stop device. */
1416 eth_dev_set_link_up_t dev_set_link_up; /**< Device link up. */
1417 eth_dev_set_link_down_t dev_set_link_down; /**< Device link down. */
1418 eth_dev_close_t dev_close; /**< Close device. */
1419 eth_promiscuous_enable_t promiscuous_enable; /**< Promiscuous ON. */
1420 eth_promiscuous_disable_t promiscuous_disable;/**< Promiscuous OFF. */
1421 eth_allmulticast_enable_t allmulticast_enable;/**< RX multicast ON. */
1422 eth_allmulticast_disable_t allmulticast_disable;/**< RX multicast OF. */
1423 eth_link_update_t link_update; /**< Get device link state. */
1424 eth_stats_get_t stats_get; /**< Get generic device statistics. */
1425 eth_stats_reset_t stats_reset; /**< Reset generic device statistics. */
1426 eth_xstats_get_t xstats_get; /**< Get extended device statistics. */
1427 eth_xstats_reset_t xstats_reset; /**< Reset extended device statistics. */
1428 eth_queue_stats_mapping_set_t queue_stats_mapping_set;
1429 /**< Configure per queue stat counter mapping. */
1430 eth_dev_infos_get_t dev_infos_get; /**< Get device info. */
1431 eth_dev_supported_ptypes_get_t dev_supported_ptypes_get;
1432 /**< Get packet types supported and identified by device*/
1433 mtu_set_t mtu_set; /**< Set MTU. */
1434 vlan_filter_set_t vlan_filter_set; /**< Filter VLAN Setup. */
1435 vlan_tpid_set_t vlan_tpid_set; /**< Outer VLAN TPID Setup. */
1436 vlan_strip_queue_set_t vlan_strip_queue_set; /**< VLAN Stripping on queue. */
1437 vlan_offload_set_t vlan_offload_set; /**< Set VLAN Offload. */
1438 vlan_pvid_set_t vlan_pvid_set; /**< Set port based TX VLAN insertion */
1439 eth_queue_start_t rx_queue_start;/**< Start RX for a queue.*/
1440 eth_queue_stop_t rx_queue_stop;/**< Stop RX for a queue.*/
1441 eth_queue_start_t tx_queue_start;/**< Start TX for a queue.*/
1442 eth_queue_stop_t tx_queue_stop;/**< Stop TX for a queue.*/
1443 eth_rx_queue_setup_t rx_queue_setup;/**< Set up device RX queue.*/
1444 eth_queue_release_t rx_queue_release;/**< Release RX queue.*/
1445 eth_rx_queue_count_t rx_queue_count; /**< Get Rx queue count. */
1446 eth_rx_descriptor_done_t rx_descriptor_done; /**< Check rxd DD bit */
1447 /**< Enable Rx queue interrupt. */
1448 eth_rx_enable_intr_t rx_queue_intr_enable;
1449 /**< Disable Rx queue interrupt.*/
1450 eth_rx_disable_intr_t rx_queue_intr_disable;
1451 eth_tx_queue_setup_t tx_queue_setup;/**< Set up device TX queue.*/
1452 eth_queue_release_t tx_queue_release;/**< Release TX queue.*/
1453 eth_dev_led_on_t dev_led_on; /**< Turn on LED. */
1454 eth_dev_led_off_t dev_led_off; /**< Turn off LED. */
1455 flow_ctrl_get_t flow_ctrl_get; /**< Get flow control. */
1456 flow_ctrl_set_t flow_ctrl_set; /**< Setup flow control. */
1457 priority_flow_ctrl_set_t priority_flow_ctrl_set; /**< Setup priority flow control.*/
1458 eth_mac_addr_remove_t mac_addr_remove; /**< Remove MAC address */
1459 eth_mac_addr_add_t mac_addr_add; /**< Add a MAC address */
1460 eth_mac_addr_set_t mac_addr_set; /**< Set a MAC address */
1461 eth_uc_hash_table_set_t uc_hash_table_set; /**< Set Unicast Table Array */
1462 eth_uc_all_hash_table_set_t uc_all_hash_table_set; /**< Set Unicast hash bitmap */
1463 eth_mirror_rule_set_t mirror_rule_set; /**< Add a traffic mirror rule.*/
1464 eth_mirror_rule_reset_t mirror_rule_reset; /**< reset a traffic mirror rule.*/
1465 eth_set_vf_rx_mode_t set_vf_rx_mode; /**< Set VF RX mode */
1466 eth_set_vf_rx_t set_vf_rx; /**< enable/disable a VF receive */
1467 eth_set_vf_tx_t set_vf_tx; /**< enable/disable a VF transmit */
1468 eth_set_vf_vlan_filter_t set_vf_vlan_filter; /**< Set VF VLAN filter */
1469 /** Add UDP tunnel port. */
1470 eth_udp_tunnel_port_add_t udp_tunnel_port_add;
1471 /** Del UDP tunnel port. */
1472 eth_udp_tunnel_port_del_t udp_tunnel_port_del;
1473 eth_set_queue_rate_limit_t set_queue_rate_limit; /**< Set queue rate limit */
1474 eth_set_vf_rate_limit_t set_vf_rate_limit; /**< Set VF rate limit */
1475 /** Update redirection table. */
1476 reta_update_t reta_update;
1477 /** Query redirection table. */
1478 reta_query_t reta_query;
1480 eth_get_reg_length_t get_reg_length;
1481 /**< Get # of registers */
1482 eth_get_reg_t get_reg;
1483 /**< Get registers */
1484 eth_get_eeprom_length_t get_eeprom_length;
1485 /**< Get eeprom length */
1486 eth_get_eeprom_t get_eeprom;
1487 /**< Get eeprom data */
1488 eth_set_eeprom_t set_eeprom;
1490 /* bypass control */
1491 #ifdef RTE_NIC_BYPASS
1492 bypass_init_t bypass_init;
1493 bypass_state_set_t bypass_state_set;
1494 bypass_state_show_t bypass_state_show;
1495 bypass_event_set_t bypass_event_set;
1496 bypass_event_show_t bypass_event_show;
1497 bypass_wd_timeout_set_t bypass_wd_timeout_set;
1498 bypass_wd_timeout_show_t bypass_wd_timeout_show;
1499 bypass_ver_show_t bypass_ver_show;
1500 bypass_wd_reset_t bypass_wd_reset;
1503 /** Configure RSS hash protocols. */
1504 rss_hash_update_t rss_hash_update;
1505 /** Get current RSS hash configuration. */
1506 rss_hash_conf_get_t rss_hash_conf_get;
1507 eth_filter_ctrl_t filter_ctrl;
1508 /**< common filter control. */
1509 eth_set_mc_addr_list_t set_mc_addr_list; /**< set list of mcast addrs */
1510 eth_rxq_info_get_t rxq_info_get;
1511 /**< retrieve RX queue information. */
1512 eth_txq_info_get_t txq_info_get;
1513 /**< retrieve TX queue information. */
1514 /** Turn IEEE1588/802.1AS timestamping on. */
1515 eth_timesync_enable_t timesync_enable;
1516 /** Turn IEEE1588/802.1AS timestamping off. */
1517 eth_timesync_disable_t timesync_disable;
1518 /** Read the IEEE1588/802.1AS RX timestamp. */
1519 eth_timesync_read_rx_timestamp_t timesync_read_rx_timestamp;
1520 /** Read the IEEE1588/802.1AS TX timestamp. */
1521 eth_timesync_read_tx_timestamp_t timesync_read_tx_timestamp;
1523 /** Get DCB information */
1524 eth_get_dcb_info get_dcb_info;
1525 /** Adjust the device clock.*/
1526 eth_timesync_adjust_time timesync_adjust_time;
1527 /** Get the device clock time. */
1528 eth_timesync_read_time timesync_read_time;
1529 /** Set the device clock time. */
1530 eth_timesync_write_time timesync_write_time;
1531 /** Config ether type of l2 tunnel */
1532 eth_l2_tunnel_eth_type_conf_t l2_tunnel_eth_type_conf;
1533 /** Enable/disable l2 tunnel offload functions */
1534 eth_l2_tunnel_offload_set_t l2_tunnel_offload_set;
1538 * Function type used for RX packet processing packet callbacks.
1540 * The callback function is called on RX with a burst of packets that have
1541 * been received on the given port and queue.
1544 * The Ethernet port on which RX is being performed.
1546 * The queue on the Ethernet port which is being used to receive the packets.
1548 * The burst of packets that have just been received.
1550 * The number of packets in the burst pointed to by "pkts".
1552 * The max number of packets that can be stored in the "pkts" array.
1554 * The arbitrary user parameter passed in by the application when the callback
1555 * was originally configured.
1557 * The number of packets returned to the user.
1559 typedef uint16_t (*rte_rx_callback_fn)(uint8_t port, uint16_t queue,
1560 struct rte_mbuf *pkts[], uint16_t nb_pkts, uint16_t max_pkts,
1564 * Function type used for TX packet processing packet callbacks.
1566 * The callback function is called on TX with a burst of packets immediately
1567 * before the packets are put onto the hardware queue for transmission.
1570 * The Ethernet port on which TX is being performed.
1572 * The queue on the Ethernet port which is being used to transmit the packets.
1574 * The burst of packets that are about to be transmitted.
1576 * The number of packets in the burst pointed to by "pkts".
1578 * The arbitrary user parameter passed in by the application when the callback
1579 * was originally configured.
1581 * The number of packets to be written to the NIC.
1583 typedef uint16_t (*rte_tx_callback_fn)(uint8_t port, uint16_t queue,
1584 struct rte_mbuf *pkts[], uint16_t nb_pkts, void *user_param);
1588 * Structure used to hold information about the callbacks to be called for a
1589 * queue on RX and TX.
1591 struct rte_eth_rxtx_callback {
1592 struct rte_eth_rxtx_callback *next;
1594 rte_rx_callback_fn rx;
1595 rte_tx_callback_fn tx;
1601 * The eth device type.
1603 enum rte_eth_dev_type {
1604 RTE_ETH_DEV_UNKNOWN, /**< unknown device type */
1606 /**< Physical function and Virtual function of PCI devices */
1607 RTE_ETH_DEV_VIRTUAL, /**< non hardware device */
1608 RTE_ETH_DEV_MAX /**< max value of this enum */
1613 * The generic data structure associated with each ethernet device.
1615 * Pointers to burst-oriented packet receive and transmit functions are
1616 * located at the beginning of the structure, along with the pointer to
1617 * where all the data elements for the particular device are stored in shared
1618 * memory. This split allows the function pointer and driver data to be per-
1619 * process, while the actual configuration data for the device is shared.
1621 struct rte_eth_dev {
1622 eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
1623 eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
1624 struct rte_eth_dev_data *data; /**< Pointer to device data */
1625 const struct eth_driver *driver;/**< Driver for this device */
1626 const struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
1627 struct rte_pci_device *pci_dev; /**< PCI info. supplied by probing */
1628 /** User application callbacks for NIC interrupts */
1629 struct rte_eth_dev_cb_list link_intr_cbs;
1631 * User-supplied functions called from rx_burst to post-process
1632 * received packets before passing them to the user
1634 struct rte_eth_rxtx_callback *post_rx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
1636 * User-supplied functions called from tx_burst to pre-process
1637 * received packets before passing them to the driver for transmission.
1639 struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
1640 uint8_t attached; /**< Flag indicating the port is attached */
1641 enum rte_eth_dev_type dev_type; /**< Flag indicating the device type */
1644 struct rte_eth_dev_sriov {
1645 uint8_t active; /**< SRIOV is active with 16, 32 or 64 pools */
1646 uint8_t nb_q_per_pool; /**< rx queue number per pool */
1647 uint16_t def_vmdq_idx; /**< Default pool num used for PF */
1648 uint16_t def_pool_q_idx; /**< Default pool queue start reg index */
1650 #define RTE_ETH_DEV_SRIOV(dev) ((dev)->data->sriov)
1652 #define RTE_ETH_NAME_MAX_LEN (32)
1656 * The data part, with no function pointers, associated with each ethernet device.
1658 * This structure is safe to place in shared memory to be common among different
1659 * processes in a multi-process configuration.
1661 struct rte_eth_dev_data {
1662 char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
1664 void **rx_queues; /**< Array of pointers to RX queues. */
1665 void **tx_queues; /**< Array of pointers to TX queues. */
1666 uint16_t nb_rx_queues; /**< Number of RX queues. */
1667 uint16_t nb_tx_queues; /**< Number of TX queues. */
1669 struct rte_eth_dev_sriov sriov; /**< SRIOV data */
1671 void *dev_private; /**< PMD-specific private data */
1673 struct rte_eth_link dev_link;
1674 /**< Link-level information & status */
1676 struct rte_eth_conf dev_conf; /**< Configuration applied to device. */
1677 uint16_t mtu; /**< Maximum Transmission Unit. */
1679 uint32_t min_rx_buf_size;
1680 /**< Common rx buffer size handled by all queues */
1682 uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
1683 struct ether_addr* mac_addrs;/**< Device Ethernet Link address. */
1684 uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
1685 /** bitmap array of associating Ethernet MAC addresses to pools */
1686 struct ether_addr* hash_mac_addrs;
1687 /** Device Ethernet MAC addresses of hash filtering. */
1688 uint8_t port_id; /**< Device [external] port identifier. */
1689 uint8_t promiscuous : 1, /**< RX promiscuous mode ON(1) / OFF(0). */
1690 scattered_rx : 1, /**< RX of scattered packets is ON(1) / OFF(0) */
1691 all_multicast : 1, /**< RX all multicast mode ON(1) / OFF(0). */
1692 dev_started : 1, /**< Device state: STARTED(1) / STOPPED(0). */
1693 lro : 1; /**< RX LRO is ON(1) / OFF(0) */
1694 uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT];
1695 /** Queues state: STARTED(1) / STOPPED(0) */
1696 uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
1697 /** Queues state: STARTED(1) / STOPPED(0) */
1698 uint32_t dev_flags; /**< Capabilities */
1699 enum rte_kernel_driver kdrv; /**< Kernel driver passthrough */
1700 int numa_node; /**< NUMA node connection */
1701 const char *drv_name; /**< Driver name */
1704 /** Device supports hotplug detach */
1705 #define RTE_ETH_DEV_DETACHABLE 0x0001
1706 /** Device supports link state interrupt */
1707 #define RTE_ETH_DEV_INTR_LSC 0x0002
1708 /** Device is a bonded slave */
1709 #define RTE_ETH_DEV_BONDED_SLAVE 0x0004
1713 * The pool of *rte_eth_dev* structures. The size of the pool
1714 * is configured at compile-time in the <rte_ethdev.c> file.
1716 extern struct rte_eth_dev rte_eth_devices[];
1719 * Get the total number of Ethernet devices that have been successfully
1720 * initialized by the [matching] Ethernet driver during the PCI probing phase.
1721 * All devices whose port identifier is in the range
1722 * [0, rte_eth_dev_count() - 1] can be operated on by network applications
1723 * immediately after invoking rte_eal_init().
1724 * If the application unplugs a port using hotplug function, The enabled port
1725 * numbers may be noncontiguous. In the case, the applications need to manage
1726 * enabled port by themselves.
1729 * - The total number of usable Ethernet devices.
1731 uint8_t rte_eth_dev_count(void);
1735 * Returns a ethdev slot specified by the unique identifier name.
1738 * The pointer to the Unique identifier name for each Ethernet device
1740 * - The pointer to the ethdev slot, on success. NULL on error
1742 struct rte_eth_dev *rte_eth_dev_allocated(const char *name);
1746 * Allocates a new ethdev slot for an ethernet device and returns the pointer
1747 * to that slot for the driver to use.
1749 * @param name Unique identifier name for each Ethernet device
1750 * @param type Device type of this Ethernet device
1752 * - Slot in the rte_dev_devices array for a new device;
1754 struct rte_eth_dev *rte_eth_dev_allocate(const char *name,
1755 enum rte_eth_dev_type type);
1759 * Release the specified ethdev port.
1762 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure.
1764 * - 0 on success, negative on error
1766 int rte_eth_dev_release_port(struct rte_eth_dev *eth_dev);
1769 * Attach a new Ethernet device specified by aruguments.
1772 * A pointer to a strings array describing the new device
1773 * to be attached. The strings should be a pci address like
1774 * '0000:01:00.0' or virtual device name like 'eth_pcap0'.
1776 * A pointer to a port identifier actually attached.
1778 * 0 on success and port_id is filled, negative on error
1780 int rte_eth_dev_attach(const char *devargs, uint8_t *port_id);
1783 * Detach a Ethernet device specified by port identifier.
1784 * This function must be called when the device is in the
1788 * The port identifier of the device to detach.
1790 * A pointer to a device name actually detached.
1792 * 0 on success and devname is filled, negative on error
1794 int rte_eth_dev_detach(uint8_t port_id, char *devname);
1799 * Initialization function of an Ethernet driver invoked for each matching
1800 * Ethernet PCI device detected during the PCI probing phase.
1803 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1804 * associated with the matching device and which have been [automatically]
1805 * allocated in the *rte_eth_devices* array.
1806 * The *eth_dev* structure is supplied to the driver initialization function
1807 * with the following fields already initialized:
1809 * - *pci_dev*: Holds the pointers to the *rte_pci_device* structure which
1810 * contains the generic PCI information of the matching device.
1812 * - *driver*: Holds the pointer to the *eth_driver* structure.
1814 * - *dev_private*: Holds a pointer to the device private data structure.
1816 * - *mtu*: Contains the default Ethernet maximum frame length (1500).
1818 * - *port_id*: Contains the port index of the device (actually the index
1819 * of the *eth_dev* structure in the *rte_eth_devices* array).
1822 * - 0: Success, the device is properly initialized by the driver.
1823 * In particular, the driver MUST have set up the *dev_ops* pointer
1824 * of the *eth_dev* structure.
1825 * - <0: Error code of the device initialization failure.
1827 typedef int (*eth_dev_init_t)(struct rte_eth_dev *eth_dev);
1831 * Finalization function of an Ethernet driver invoked for each matching
1832 * Ethernet PCI device detected during the PCI closing phase.
1835 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1836 * associated with the matching device and which have been [automatically]
1837 * allocated in the *rte_eth_devices* array.
1839 * - 0: Success, the device is properly finalized by the driver.
1840 * In particular, the driver MUST free the *dev_ops* pointer
1841 * of the *eth_dev* structure.
1842 * - <0: Error code of the device initialization failure.
1844 typedef int (*eth_dev_uninit_t)(struct rte_eth_dev *eth_dev);
1848 * The structure associated with a PMD Ethernet driver.
1850 * Each Ethernet driver acts as a PCI driver and is represented by a generic
1851 * *eth_driver* structure that holds:
1853 * - An *rte_pci_driver* structure (which must be the first field).
1855 * - The *eth_dev_init* function invoked for each matching PCI device.
1857 * - The *eth_dev_uninit* function invoked for each matching PCI device.
1859 * - The size of the private data to allocate for each matching device.
1862 struct rte_pci_driver pci_drv; /**< The PMD is also a PCI driver. */
1863 eth_dev_init_t eth_dev_init; /**< Device init function. */
1864 eth_dev_uninit_t eth_dev_uninit; /**< Device uninit function. */
1865 unsigned int dev_private_size; /**< Size of device private data. */
1870 * A function invoked by the initialization function of an Ethernet driver
1871 * to simultaneously register itself as a PCI driver and as an Ethernet
1872 * Poll Mode Driver (PMD).
1875 * The pointer to the *eth_driver* structure associated with
1876 * the Ethernet driver.
1878 void rte_eth_driver_register(struct eth_driver *eth_drv);
1881 * Configure an Ethernet device.
1882 * This function must be invoked first before any other function in the
1883 * Ethernet API. This function can also be re-invoked when a device is in the
1887 * The port identifier of the Ethernet device to configure.
1888 * @param nb_rx_queue
1889 * The number of receive queues to set up for the Ethernet device.
1890 * @param nb_tx_queue
1891 * The number of transmit queues to set up for the Ethernet device.
1893 * The pointer to the configuration data to be used for the Ethernet device.
1894 * The *rte_eth_conf* structure includes:
1895 * - the hardware offload features to activate, with dedicated fields for
1896 * each statically configurable offload hardware feature provided by
1897 * Ethernet devices, such as IP checksum or VLAN tag stripping for
1899 * - the Receive Side Scaling (RSS) configuration when using multiple RX
1902 * Embedding all configuration information in a single data structure
1903 * is the more flexible method that allows the addition of new features
1904 * without changing the syntax of the API.
1906 * - 0: Success, device configured.
1907 * - <0: Error code returned by the driver configuration function.
1909 int rte_eth_dev_configure(uint8_t port_id, uint16_t nb_rx_queue,
1910 uint16_t nb_tx_queue, const struct rte_eth_conf *eth_conf);
1913 * Allocate and set up a receive queue for an Ethernet device.
1915 * The function allocates a contiguous block of memory for *nb_rx_desc*
1916 * receive descriptors from a memory zone associated with *socket_id*
1917 * and initializes each receive descriptor with a network buffer allocated
1918 * from the memory pool *mb_pool*.
1921 * The port identifier of the Ethernet device.
1922 * @param rx_queue_id
1923 * The index of the receive queue to set up.
1924 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1925 * to rte_eth_dev_configure().
1927 * The number of receive descriptors to allocate for the receive ring.
1929 * The *socket_id* argument is the socket identifier in case of NUMA.
1930 * The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1931 * the DMA memory allocated for the receive descriptors of the ring.
1933 * The pointer to the configuration data to be used for the receive queue.
1934 * NULL value is allowed, in which case default RX configuration
1936 * The *rx_conf* structure contains an *rx_thresh* structure with the values
1937 * of the Prefetch, Host, and Write-Back threshold registers of the receive
1940 * The pointer to the memory pool from which to allocate *rte_mbuf* network
1941 * memory buffers to populate each descriptor of the receive ring.
1943 * - 0: Success, receive queue correctly set up.
1944 * - -EINVAL: The size of network buffers which can be allocated from the
1945 * memory pool does not fit the various buffer sizes allowed by the
1946 * device controller.
1947 * - -ENOMEM: Unable to allocate the receive ring descriptors or to
1948 * allocate network memory buffers from the memory pool when
1949 * initializing receive descriptors.
1951 int rte_eth_rx_queue_setup(uint8_t port_id, uint16_t rx_queue_id,
1952 uint16_t nb_rx_desc, unsigned int socket_id,
1953 const struct rte_eth_rxconf *rx_conf,
1954 struct rte_mempool *mb_pool);
1957 * Allocate and set up a transmit queue for an Ethernet device.
1960 * The port identifier of the Ethernet device.
1961 * @param tx_queue_id
1962 * The index of the transmit queue to set up.
1963 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1964 * to rte_eth_dev_configure().
1966 * The number of transmit descriptors to allocate for the transmit ring.
1968 * The *socket_id* argument is the socket identifier in case of NUMA.
1969 * Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1970 * the DMA memory allocated for the transmit descriptors of the ring.
1972 * The pointer to the configuration data to be used for the transmit queue.
1973 * NULL value is allowed, in which case default RX configuration
1975 * The *tx_conf* structure contains the following data:
1976 * - The *tx_thresh* structure with the values of the Prefetch, Host, and
1977 * Write-Back threshold registers of the transmit ring.
1978 * When setting Write-Back threshold to the value greater then zero,
1979 * *tx_rs_thresh* value should be explicitly set to one.
1980 * - The *tx_free_thresh* value indicates the [minimum] number of network
1981 * buffers that must be pending in the transmit ring to trigger their
1982 * [implicit] freeing by the driver transmit function.
1983 * - The *tx_rs_thresh* value indicates the [minimum] number of transmit
1984 * descriptors that must be pending in the transmit ring before setting the
1985 * RS bit on a descriptor by the driver transmit function.
1986 * The *tx_rs_thresh* value should be less or equal then
1987 * *tx_free_thresh* value, and both of them should be less then
1989 * - The *txq_flags* member contains flags to pass to the TX queue setup
1990 * function to configure the behavior of the TX queue. This should be set
1991 * to 0 if no special configuration is required.
1993 * Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces
1994 * the transmit function to use default values.
1996 * - 0: Success, the transmit queue is correctly set up.
1997 * - -ENOMEM: Unable to allocate the transmit ring descriptors.
1999 int rte_eth_tx_queue_setup(uint8_t port_id, uint16_t tx_queue_id,
2000 uint16_t nb_tx_desc, unsigned int socket_id,
2001 const struct rte_eth_txconf *tx_conf);
2004 * Return the NUMA socket to which an Ethernet device is connected
2007 * The port identifier of the Ethernet device
2009 * The NUMA socket id to which the Ethernet device is connected or
2010 * a default of zero if the socket could not be determined.
2011 * -1 is returned is the port_id value is out of range.
2013 int rte_eth_dev_socket_id(uint8_t port_id);
2016 * Check if port_id of device is attached
2019 * The port identifier of the Ethernet device
2021 * - 0 if port is out of range or not attached
2022 * - 1 if device is attached
2024 int rte_eth_dev_is_valid_port(uint8_t port_id);
2027 * Allocate mbuf from mempool, setup the DMA physical address
2028 * and then start RX for specified queue of a port. It is used
2029 * when rx_deferred_start flag of the specified queue is true.
2032 * The port identifier of the Ethernet device
2033 * @param rx_queue_id
2034 * The index of the rx queue to update the ring.
2035 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2036 * to rte_eth_dev_configure().
2038 * - 0: Success, the transmit queue is correctly set up.
2039 * - -EINVAL: The port_id or the queue_id out of range.
2040 * - -ENOTSUP: The function not supported in PMD driver.
2042 int rte_eth_dev_rx_queue_start(uint8_t port_id, uint16_t rx_queue_id);
2045 * Stop specified RX queue of a port
2048 * The port identifier of the Ethernet device
2049 * @param rx_queue_id
2050 * The index of the rx queue to update the ring.
2051 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2052 * to rte_eth_dev_configure().
2054 * - 0: Success, the transmit queue is correctly set up.
2055 * - -EINVAL: The port_id or the queue_id out of range.
2056 * - -ENOTSUP: The function not supported in PMD driver.
2058 int rte_eth_dev_rx_queue_stop(uint8_t port_id, uint16_t rx_queue_id);
2061 * Start TX for specified queue of a port. It is used when tx_deferred_start
2062 * flag of the specified queue is true.
2065 * The port identifier of the Ethernet device
2066 * @param tx_queue_id
2067 * The index of the tx queue to update the ring.
2068 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2069 * to rte_eth_dev_configure().
2071 * - 0: Success, the transmit queue is correctly set up.
2072 * - -EINVAL: The port_id or the queue_id out of range.
2073 * - -ENOTSUP: The function not supported in PMD driver.
2075 int rte_eth_dev_tx_queue_start(uint8_t port_id, uint16_t tx_queue_id);
2078 * Stop specified TX queue of a port
2081 * The port identifier of the Ethernet device
2082 * @param tx_queue_id
2083 * The index of the tx queue to update the ring.
2084 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2085 * to rte_eth_dev_configure().
2087 * - 0: Success, the transmit queue is correctly set up.
2088 * - -EINVAL: The port_id or the queue_id out of range.
2089 * - -ENOTSUP: The function not supported in PMD driver.
2091 int rte_eth_dev_tx_queue_stop(uint8_t port_id, uint16_t tx_queue_id);
2096 * Start an Ethernet device.
2098 * The device start step is the last one and consists of setting the configured
2099 * offload features and in starting the transmit and the receive units of the
2101 * On success, all basic functions exported by the Ethernet API (link status,
2102 * receive/transmit, and so on) can be invoked.
2105 * The port identifier of the Ethernet device.
2107 * - 0: Success, Ethernet device started.
2108 * - <0: Error code of the driver device start function.
2110 int rte_eth_dev_start(uint8_t port_id);
2113 * Stop an Ethernet device. The device can be restarted with a call to
2114 * rte_eth_dev_start()
2117 * The port identifier of the Ethernet device.
2119 void rte_eth_dev_stop(uint8_t port_id);
2123 * Link up an Ethernet device.
2125 * Set device link up will re-enable the device rx/tx
2126 * functionality after it is previously set device linked down.
2129 * The port identifier of the Ethernet device.
2131 * - 0: Success, Ethernet device linked up.
2132 * - <0: Error code of the driver device link up function.
2134 int rte_eth_dev_set_link_up(uint8_t port_id);
2137 * Link down an Ethernet device.
2138 * The device rx/tx functionality will be disabled if success,
2139 * and it can be re-enabled with a call to
2140 * rte_eth_dev_set_link_up()
2143 * The port identifier of the Ethernet device.
2145 int rte_eth_dev_set_link_down(uint8_t port_id);
2148 * Close a stopped Ethernet device. The device cannot be restarted!
2149 * The function frees all resources except for needed by the
2150 * closed state. To free these resources, call rte_eth_dev_detach().
2153 * The port identifier of the Ethernet device.
2155 void rte_eth_dev_close(uint8_t port_id);
2158 * Enable receipt in promiscuous mode for an Ethernet device.
2161 * The port identifier of the Ethernet device.
2163 void rte_eth_promiscuous_enable(uint8_t port_id);
2166 * Disable receipt in promiscuous mode for an Ethernet device.
2169 * The port identifier of the Ethernet device.
2171 void rte_eth_promiscuous_disable(uint8_t port_id);
2174 * Return the value of promiscuous mode for an Ethernet device.
2177 * The port identifier of the Ethernet device.
2179 * - (1) if promiscuous is enabled
2180 * - (0) if promiscuous is disabled.
2183 int rte_eth_promiscuous_get(uint8_t port_id);
2186 * Enable the receipt of any multicast frame by an Ethernet device.
2189 * The port identifier of the Ethernet device.
2191 void rte_eth_allmulticast_enable(uint8_t port_id);
2194 * Disable the receipt of all multicast frames by an Ethernet device.
2197 * The port identifier of the Ethernet device.
2199 void rte_eth_allmulticast_disable(uint8_t port_id);
2202 * Return the value of allmulticast mode for an Ethernet device.
2205 * The port identifier of the Ethernet device.
2207 * - (1) if allmulticast is enabled
2208 * - (0) if allmulticast is disabled.
2211 int rte_eth_allmulticast_get(uint8_t port_id);
2214 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2215 * or FULL-DUPLEX) of the physical link of an Ethernet device. It might need
2216 * to wait up to 9 seconds in it.
2219 * The port identifier of the Ethernet device.
2221 * A pointer to an *rte_eth_link* structure to be filled with
2222 * the status, the speed and the mode of the Ethernet device link.
2224 void rte_eth_link_get(uint8_t port_id, struct rte_eth_link *link);
2227 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2228 * or FULL-DUPLEX) of the physical link of an Ethernet device. It is a no-wait
2229 * version of rte_eth_link_get().
2232 * The port identifier of the Ethernet device.
2234 * A pointer to an *rte_eth_link* structure to be filled with
2235 * the status, the speed and the mode of the Ethernet device link.
2237 void rte_eth_link_get_nowait(uint8_t port_id, struct rte_eth_link *link);
2240 * Retrieve the general I/O statistics of an Ethernet device.
2243 * The port identifier of the Ethernet device.
2245 * A pointer to a structure of type *rte_eth_stats* to be filled with
2246 * the values of device counters for the following set of statistics:
2247 * - *ipackets* with the total of successfully received packets.
2248 * - *opackets* with the total of successfully transmitted packets.
2249 * - *ibytes* with the total of successfully received bytes.
2250 * - *obytes* with the total of successfully transmitted bytes.
2251 * - *ierrors* with the total of erroneous received packets.
2252 * - *oerrors* with the total of failed transmitted packets.
2254 * Zero if successful. Non-zero otherwise.
2256 int rte_eth_stats_get(uint8_t port_id, struct rte_eth_stats *stats);
2259 * Reset the general I/O statistics of an Ethernet device.
2262 * The port identifier of the Ethernet device.
2264 void rte_eth_stats_reset(uint8_t port_id);
2267 * Retrieve extended statistics of an Ethernet device.
2270 * The port identifier of the Ethernet device.
2272 * A pointer to a table of structure of type *rte_eth_xstats*
2273 * to be filled with device statistics names and values.
2274 * This parameter can be set to NULL if n is 0.
2276 * The size of the stats table, which should be large enough to store
2277 * all the statistics of the device.
2279 * - positive value lower or equal to n: success. The return value
2280 * is the number of entries filled in the stats table.
2281 * - positive value higher than n: error, the given statistics table
2282 * is too small. The return value corresponds to the size that should
2283 * be given to succeed. The entries in the table are not valid and
2284 * shall not be used by the caller.
2285 * - negative value on error (invalid port id)
2287 int rte_eth_xstats_get(uint8_t port_id, struct rte_eth_xstats *xstats,
2291 * Reset extended statistics of an Ethernet device.
2294 * The port identifier of the Ethernet device.
2296 void rte_eth_xstats_reset(uint8_t port_id);
2299 * Set a mapping for the specified transmit queue to the specified per-queue
2300 * statistics counter.
2303 * The port identifier of the Ethernet device.
2304 * @param tx_queue_id
2305 * The index of the transmit queue for which a queue stats mapping is required.
2306 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2307 * to rte_eth_dev_configure().
2309 * The per-queue packet statistics functionality number that the transmit
2310 * queue is to be assigned.
2311 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2313 * Zero if successful. Non-zero otherwise.
2315 int rte_eth_dev_set_tx_queue_stats_mapping(uint8_t port_id,
2316 uint16_t tx_queue_id, uint8_t stat_idx);
2319 * Set a mapping for the specified receive queue to the specified per-queue
2320 * statistics counter.
2323 * The port identifier of the Ethernet device.
2324 * @param rx_queue_id
2325 * The index of the receive queue for which a queue stats mapping is required.
2326 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2327 * to rte_eth_dev_configure().
2329 * The per-queue packet statistics functionality number that the receive
2330 * queue is to be assigned.
2331 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2333 * Zero if successful. Non-zero otherwise.
2335 int rte_eth_dev_set_rx_queue_stats_mapping(uint8_t port_id,
2336 uint16_t rx_queue_id,
2340 * Retrieve the Ethernet address of an Ethernet device.
2343 * The port identifier of the Ethernet device.
2345 * A pointer to a structure of type *ether_addr* to be filled with
2346 * the Ethernet address of the Ethernet device.
2348 void rte_eth_macaddr_get(uint8_t port_id, struct ether_addr *mac_addr);
2351 * Retrieve the contextual information of an Ethernet device.
2354 * The port identifier of the Ethernet device.
2356 * A pointer to a structure of type *rte_eth_dev_info* to be filled with
2357 * the contextual information of the Ethernet device.
2359 void rte_eth_dev_info_get(uint8_t port_id, struct rte_eth_dev_info *dev_info);
2362 * Retrieve the supported packet types of an Ethernet device.
2365 * Better to invoke this API after the device is already started or rx burst
2366 * function is decided, to obtain correct supported ptypes.
2368 * The port identifier of the Ethernet device.
2370 * A hint of what kind of packet type which the caller is interested in.
2372 * An array pointer to store adequent packet types, allocated by caller.
2374 * Size of the array pointed by param ptypes.
2376 * - (>0) Number of supported ptypes. If it exceeds param num, exceeding
2377 * packet types will not be filled in the given array.
2378 * - (0 or -ENOTSUP) if PMD does not fill the specified ptype.
2379 * - (-ENODEV) if *port_id* invalid.
2381 int rte_eth_dev_get_supported_ptypes(uint8_t port_id, uint32_t ptype_mask,
2382 uint32_t *ptypes, int num);
2385 * Retrieve the MTU of an Ethernet device.
2388 * The port identifier of the Ethernet device.
2390 * A pointer to a uint16_t where the retrieved MTU is to be stored.
2392 * - (0) if successful.
2393 * - (-ENODEV) if *port_id* invalid.
2395 int rte_eth_dev_get_mtu(uint8_t port_id, uint16_t *mtu);
2398 * Change the MTU of an Ethernet device.
2401 * The port identifier of the Ethernet device.
2403 * A uint16_t for the MTU to be applied.
2405 * - (0) if successful.
2406 * - (-ENOTSUP) if operation is not supported.
2407 * - (-ENODEV) if *port_id* invalid.
2408 * - (-EINVAL) if *mtu* invalid.
2410 int rte_eth_dev_set_mtu(uint8_t port_id, uint16_t mtu);
2413 * Enable/Disable hardware filtering by an Ethernet device of received
2414 * VLAN packets tagged with a given VLAN Tag Identifier.
2417 * The port identifier of the Ethernet device.
2419 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
2421 * If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*.
2422 * Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*.
2424 * - (0) if successful.
2425 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2426 * - (-ENODEV) if *port_id* invalid.
2427 * - (-ENOSYS) if VLAN filtering on *port_id* disabled.
2428 * - (-EINVAL) if *vlan_id* > 4095.
2430 int rte_eth_dev_vlan_filter(uint8_t port_id, uint16_t vlan_id, int on);
2433 * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
2434 * 82599/X540/X550 can support VLAN stripping at the rx queue level
2437 * The port identifier of the Ethernet device.
2438 * @param rx_queue_id
2439 * The index of the receive queue for which a queue stats mapping is required.
2440 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2441 * to rte_eth_dev_configure().
2443 * If 1, Enable VLAN Stripping of the receive queue of the Ethernet port.
2444 * If 0, Disable VLAN Stripping of the receive queue of the Ethernet port.
2446 * - (0) if successful.
2447 * - (-ENOSUP) if hardware-assisted VLAN stripping not configured.
2448 * - (-ENODEV) if *port_id* invalid.
2449 * - (-EINVAL) if *rx_queue_id* invalid.
2451 int rte_eth_dev_set_vlan_strip_on_queue(uint8_t port_id, uint16_t rx_queue_id,
2455 * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
2456 * the VLAN Header. This is a register setup available on some Intel NIC, not
2457 * but all, please check the data sheet for availability.
2460 * The port identifier of the Ethernet device.
2464 * The Tag Protocol ID
2466 * - (0) if successful.
2467 * - (-ENOSUP) if hardware-assisted VLAN TPID setup is not supported.
2468 * - (-ENODEV) if *port_id* invalid.
2470 int rte_eth_dev_set_vlan_ether_type(uint8_t port_id,
2471 enum rte_vlan_type vlan_type,
2475 * Set VLAN offload configuration on an Ethernet device
2476 * Enable/Disable Extended VLAN by an Ethernet device, This is a register setup
2477 * available on some Intel NIC, not but all, please check the data sheet for
2479 * Enable/Disable VLAN Strip can be done on rx queue for certain NIC, but here
2480 * the configuration is applied on the port level.
2483 * The port identifier of the Ethernet device.
2484 * @param offload_mask
2485 * The VLAN Offload bit mask can be mixed use with "OR"
2486 * ETH_VLAN_STRIP_OFFLOAD
2487 * ETH_VLAN_FILTER_OFFLOAD
2488 * ETH_VLAN_EXTEND_OFFLOAD
2490 * - (0) if successful.
2491 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2492 * - (-ENODEV) if *port_id* invalid.
2494 int rte_eth_dev_set_vlan_offload(uint8_t port_id, int offload_mask);
2497 * Read VLAN Offload configuration from an Ethernet device
2500 * The port identifier of the Ethernet device.
2502 * - (>0) if successful. Bit mask to indicate
2503 * ETH_VLAN_STRIP_OFFLOAD
2504 * ETH_VLAN_FILTER_OFFLOAD
2505 * ETH_VLAN_EXTEND_OFFLOAD
2506 * - (-ENODEV) if *port_id* invalid.
2508 int rte_eth_dev_get_vlan_offload(uint8_t port_id);
2511 * Set port based TX VLAN insersion on or off.
2514 * The port identifier of the Ethernet device.
2516 * Port based TX VLAN identifier togeth with user priority.
2518 * Turn on or off the port based TX VLAN insertion.
2521 * - (0) if successful.
2522 * - negative if failed.
2524 int rte_eth_dev_set_vlan_pvid(uint8_t port_id, uint16_t pvid, int on);
2528 * Retrieve a burst of input packets from a receive queue of an Ethernet
2529 * device. The retrieved packets are stored in *rte_mbuf* structures whose
2530 * pointers are supplied in the *rx_pkts* array.
2532 * The rte_eth_rx_burst() function loops, parsing the RX ring of the
2533 * receive queue, up to *nb_pkts* packets, and for each completed RX
2534 * descriptor in the ring, it performs the following operations:
2536 * - Initialize the *rte_mbuf* data structure associated with the
2537 * RX descriptor according to the information provided by the NIC into
2538 * that RX descriptor.
2540 * - Store the *rte_mbuf* data structure into the next entry of the
2543 * - Replenish the RX descriptor with a new *rte_mbuf* buffer
2544 * allocated from the memory pool associated with the receive queue at
2545 * initialization time.
2547 * When retrieving an input packet that was scattered by the controller
2548 * into multiple receive descriptors, the rte_eth_rx_burst() function
2549 * appends the associated *rte_mbuf* buffers to the first buffer of the
2552 * The rte_eth_rx_burst() function returns the number of packets
2553 * actually retrieved, which is the number of *rte_mbuf* data structures
2554 * effectively supplied into the *rx_pkts* array.
2555 * A return value equal to *nb_pkts* indicates that the RX queue contained
2556 * at least *rx_pkts* packets, and this is likely to signify that other
2557 * received packets remain in the input queue. Applications implementing
2558 * a "retrieve as much received packets as possible" policy can check this
2559 * specific case and keep invoking the rte_eth_rx_burst() function until
2560 * a value less than *nb_pkts* is returned.
2562 * This receive method has the following advantages:
2564 * - It allows a run-to-completion network stack engine to retrieve and
2565 * to immediately process received packets in a fast burst-oriented
2566 * approach, avoiding the overhead of unnecessary intermediate packet
2567 * queue/dequeue operations.
2569 * - Conversely, it also allows an asynchronous-oriented processing
2570 * method to retrieve bursts of received packets and to immediately
2571 * queue them for further parallel processing by another logical core,
2572 * for instance. However, instead of having received packets being
2573 * individually queued by the driver, this approach allows the invoker
2574 * of the rte_eth_rx_burst() function to queue a burst of retrieved
2575 * packets at a time and therefore dramatically reduce the cost of
2576 * enqueue/dequeue operations per packet.
2578 * - It allows the rte_eth_rx_burst() function of the driver to take
2579 * advantage of burst-oriented hardware features (CPU cache,
2580 * prefetch instructions, and so on) to minimize the number of CPU
2581 * cycles per packet.
2583 * To summarize, the proposed receive API enables many
2584 * burst-oriented optimizations in both synchronous and asynchronous
2585 * packet processing environments with no overhead in both cases.
2587 * The rte_eth_rx_burst() function does not provide any error
2588 * notification to avoid the corresponding overhead. As a hint, the
2589 * upper-level application might check the status of the device link once
2590 * being systematically returned a 0 value for a given number of tries.
2593 * The port identifier of the Ethernet device.
2595 * The index of the receive queue from which to retrieve input packets.
2596 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2597 * to rte_eth_dev_configure().
2599 * The address of an array of pointers to *rte_mbuf* structures that
2600 * must be large enough to store *nb_pkts* pointers in it.
2602 * The maximum number of packets to retrieve.
2604 * The number of packets actually retrieved, which is the number
2605 * of pointers to *rte_mbuf* structures effectively supplied to the
2608 static inline uint16_t
2609 rte_eth_rx_burst(uint8_t port_id, uint16_t queue_id,
2610 struct rte_mbuf **rx_pkts, const uint16_t nb_pkts)
2612 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2614 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2615 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
2616 RTE_FUNC_PTR_OR_ERR_RET(*dev->rx_pkt_burst, 0);
2618 if (queue_id >= dev->data->nb_rx_queues) {
2619 RTE_PMD_DEBUG_TRACE("Invalid RX queue_id=%d\n", queue_id);
2623 int16_t nb_rx = (*dev->rx_pkt_burst)(dev->data->rx_queues[queue_id],
2626 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
2627 struct rte_eth_rxtx_callback *cb = dev->post_rx_burst_cbs[queue_id];
2629 if (unlikely(cb != NULL)) {
2631 nb_rx = cb->fn.rx(port_id, queue_id, rx_pkts, nb_rx,
2632 nb_pkts, cb->param);
2634 } while (cb != NULL);
2642 * Get the number of used descriptors in a specific queue
2645 * The port identifier of the Ethernet device.
2647 * The queue id on the specific port.
2649 * The number of used descriptors in the specific queue, or:
2650 * (-EINVAL) if *port_id* is invalid
2651 * (-ENOTSUP) if the device does not support this function
2654 rte_eth_rx_queue_count(uint8_t port_id, uint16_t queue_id)
2656 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2657 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -EINVAL);
2658 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_queue_count, -ENOTSUP);
2659 return (*dev->dev_ops->rx_queue_count)(dev, queue_id);
2663 * Check if the DD bit of the specific RX descriptor in the queue has been set
2666 * The port identifier of the Ethernet device.
2668 * The queue id on the specific port.
2670 * The offset of the descriptor ID from tail.
2672 * - (1) if the specific DD bit is set.
2673 * - (0) if the specific DD bit is not set.
2674 * - (-ENODEV) if *port_id* invalid.
2675 * - (-ENOTSUP) if the device does not support this function
2678 rte_eth_rx_descriptor_done(uint8_t port_id, uint16_t queue_id, uint16_t offset)
2680 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2681 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
2682 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_descriptor_done, -ENOTSUP);
2683 return (*dev->dev_ops->rx_descriptor_done)( \
2684 dev->data->rx_queues[queue_id], offset);
2688 * Send a burst of output packets on a transmit queue of an Ethernet device.
2690 * The rte_eth_tx_burst() function is invoked to transmit output packets
2691 * on the output queue *queue_id* of the Ethernet device designated by its
2693 * The *nb_pkts* parameter is the number of packets to send which are
2694 * supplied in the *tx_pkts* array of *rte_mbuf* structures.
2695 * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
2696 * up to the number of transmit descriptors available in the TX ring of the
2698 * For each packet to send, the rte_eth_tx_burst() function performs
2699 * the following operations:
2701 * - Pick up the next available descriptor in the transmit ring.
2703 * - Free the network buffer previously sent with that descriptor, if any.
2705 * - Initialize the transmit descriptor with the information provided
2706 * in the *rte_mbuf data structure.
2708 * In the case of a segmented packet composed of a list of *rte_mbuf* buffers,
2709 * the rte_eth_tx_burst() function uses several transmit descriptors
2712 * The rte_eth_tx_burst() function returns the number of packets it
2713 * actually sent. A return value equal to *nb_pkts* means that all packets
2714 * have been sent, and this is likely to signify that other output packets
2715 * could be immediately transmitted again. Applications that implement a
2716 * "send as many packets to transmit as possible" policy can check this
2717 * specific case and keep invoking the rte_eth_tx_burst() function until
2718 * a value less than *nb_pkts* is returned.
2720 * It is the responsibility of the rte_eth_tx_burst() function to
2721 * transparently free the memory buffers of packets previously sent.
2722 * This feature is driven by the *tx_free_thresh* value supplied to the
2723 * rte_eth_dev_configure() function at device configuration time.
2724 * When the number of free TX descriptors drops below this threshold, the
2725 * rte_eth_tx_burst() function must [attempt to] free the *rte_mbuf* buffers
2726 * of those packets whose transmission was effectively completed.
2729 * The port identifier of the Ethernet device.
2731 * The index of the transmit queue through which output packets must be
2733 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2734 * to rte_eth_dev_configure().
2736 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
2737 * which contain the output packets.
2739 * The maximum number of packets to transmit.
2741 * The number of output packets actually stored in transmit descriptors of
2742 * the transmit ring. The return value can be less than the value of the
2743 * *tx_pkts* parameter when the transmit ring is full or has been filled up.
2745 static inline uint16_t
2746 rte_eth_tx_burst(uint8_t port_id, uint16_t queue_id,
2747 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
2749 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
2751 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2752 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
2753 RTE_FUNC_PTR_OR_ERR_RET(*dev->tx_pkt_burst, 0);
2755 if (queue_id >= dev->data->nb_tx_queues) {
2756 RTE_PMD_DEBUG_TRACE("Invalid TX queue_id=%d\n", queue_id);
2761 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
2762 struct rte_eth_rxtx_callback *cb = dev->pre_tx_burst_cbs[queue_id];
2764 if (unlikely(cb != NULL)) {
2766 nb_pkts = cb->fn.tx(port_id, queue_id, tx_pkts, nb_pkts,
2769 } while (cb != NULL);
2773 return (*dev->tx_pkt_burst)(dev->data->tx_queues[queue_id], tx_pkts, nb_pkts);
2776 typedef void (*buffer_tx_error_fn)(struct rte_mbuf **unsent, uint16_t count,
2780 * Structure used to buffer packets for future TX
2781 * Used by APIs rte_eth_tx_buffer and rte_eth_tx_buffer_flush
2783 struct rte_eth_dev_tx_buffer {
2784 buffer_tx_error_fn error_callback;
2785 void *error_userdata;
2786 uint16_t size; /**< Size of buffer for buffered tx */
2787 uint16_t length; /**< Number of packets in the array */
2788 struct rte_mbuf *pkts[];
2789 /**< Pending packets to be sent on explicit flush or when full */
2793 * Calculate the size of the tx buffer.
2796 * Number of stored packets.
2798 #define RTE_ETH_TX_BUFFER_SIZE(sz) \
2799 (sizeof(struct rte_eth_dev_tx_buffer) + (sz) * sizeof(struct rte_mbuf *))
2802 * Initialize default values for buffered transmitting
2805 * Tx buffer to be initialized.
2812 rte_eth_tx_buffer_init(struct rte_eth_dev_tx_buffer *buffer, uint16_t size);
2815 * Send any packets queued up for transmission on a port and HW queue
2817 * This causes an explicit flush of packets previously buffered via the
2818 * rte_eth_tx_buffer() function. It returns the number of packets successfully
2819 * sent to the NIC, and calls the error callback for any unsent packets. Unless
2820 * explicitly set up otherwise, the default callback simply frees the unsent
2821 * packets back to the owning mempool.
2824 * The port identifier of the Ethernet device.
2826 * The index of the transmit queue through which output packets must be
2828 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2829 * to rte_eth_dev_configure().
2831 * Buffer of packets to be transmit.
2833 * The number of packets successfully sent to the Ethernet device. The error
2834 * callback is called for any packets which could not be sent.
2836 static inline uint16_t
2837 rte_eth_tx_buffer_flush(uint8_t port_id, uint16_t queue_id,
2838 struct rte_eth_dev_tx_buffer *buffer)
2841 uint16_t to_send = buffer->length;
2846 sent = rte_eth_tx_burst(port_id, queue_id, buffer->pkts, to_send);
2850 /* All packets sent, or to be dealt with by callback below */
2851 if (unlikely(sent != to_send))
2852 buffer->error_callback(&buffer->pkts[sent], to_send - sent,
2853 buffer->error_userdata);
2859 * Buffer a single packet for future transmission on a port and queue
2861 * This function takes a single mbuf/packet and buffers it for later
2862 * transmission on the particular port and queue specified. Once the buffer is
2863 * full of packets, an attempt will be made to transmit all the buffered
2864 * packets. In case of error, where not all packets can be transmitted, a
2865 * callback is called with the unsent packets as a parameter. If no callback
2866 * is explicitly set up, the unsent packets are just freed back to the owning
2867 * mempool. The function returns the number of packets actually sent i.e.
2868 * 0 if no buffer flush occurred, otherwise the number of packets successfully
2872 * The port identifier of the Ethernet device.
2874 * The index of the transmit queue through which output packets must be
2876 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2877 * to rte_eth_dev_configure().
2879 * Buffer used to collect packets to be sent.
2881 * Pointer to the packet mbuf to be sent.
2883 * 0 = packet has been buffered for later transmission
2884 * N > 0 = packet has been buffered, and the buffer was subsequently flushed,
2885 * causing N packets to be sent, and the error callback to be called for
2888 static inline uint16_t __attribute__((always_inline))
2889 rte_eth_tx_buffer(uint8_t port_id, uint16_t queue_id,
2890 struct rte_eth_dev_tx_buffer *buffer, struct rte_mbuf *tx_pkt)
2892 buffer->pkts[buffer->length++] = tx_pkt;
2893 if (buffer->length < buffer->size)
2896 return rte_eth_tx_buffer_flush(port_id, queue_id, buffer);
2900 * Configure a callback for buffered packets which cannot be sent
2902 * Register a specific callback to be called when an attempt is made to send
2903 * all packets buffered on an ethernet port, but not all packets can
2904 * successfully be sent. The callback registered here will be called only
2905 * from calls to rte_eth_tx_buffer() and rte_eth_tx_buffer_flush() APIs.
2906 * The default callback configured for each queue by default just frees the
2907 * packets back to the calling mempool. If additional behaviour is required,
2908 * for example, to count dropped packets, or to retry transmission of packets
2909 * which cannot be sent, this function should be used to register a suitable
2910 * callback function to implement the desired behaviour.
2911 * The example callback "rte_eth_count_unsent_packet_callback()" is also
2912 * provided as reference.
2915 * The port identifier of the Ethernet device.
2917 * The function to be used as the callback.
2919 * Arbitrary parameter to be passed to the callback function
2921 * 0 on success, or -1 on error with rte_errno set appropriately
2924 rte_eth_tx_buffer_set_err_callback(struct rte_eth_dev_tx_buffer *buffer,
2925 buffer_tx_error_fn callback, void *userdata);
2928 * Callback function for silently dropping unsent buffered packets.
2930 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
2931 * adjust the default behavior when buffered packets cannot be sent. This
2932 * function drops any unsent packets silently and is used by tx buffered
2933 * operations as default behavior.
2935 * NOTE: this function should not be called directly, instead it should be used
2936 * as a callback for packet buffering.
2938 * NOTE: when configuring this function as a callback with
2939 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
2940 * should point to an uint64_t value.
2943 * The previously buffered packets which could not be sent
2945 * The number of unsent packets in the pkts array
2950 rte_eth_tx_buffer_drop_callback(struct rte_mbuf **pkts, uint16_t unsent,
2954 * Callback function for tracking unsent buffered packets.
2956 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
2957 * adjust the default behavior when buffered packets cannot be sent. This
2958 * function drops any unsent packets, but also updates a user-supplied counter
2959 * to track the overall number of packets dropped. The counter should be an
2960 * uint64_t variable.
2962 * NOTE: this function should not be called directly, instead it should be used
2963 * as a callback for packet buffering.
2965 * NOTE: when configuring this function as a callback with
2966 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
2967 * should point to an uint64_t value.
2970 * The previously buffered packets which could not be sent
2972 * The number of unsent packets in the pkts array
2974 * Pointer to an uint64_t value, which will be incremented by unsent
2977 rte_eth_tx_buffer_count_callback(struct rte_mbuf **pkts, uint16_t unsent,
2981 * The eth device event type for interrupt, and maybe others in the future.
2983 enum rte_eth_event_type {
2984 RTE_ETH_EVENT_UNKNOWN, /**< unknown event type */
2985 RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
2986 RTE_ETH_EVENT_QUEUE_STATE,
2987 /**< queue state event (enabled/disabled) */
2988 RTE_ETH_EVENT_INTR_RESET,
2989 /**< reset interrupt event, sent to VF on PF reset */
2990 RTE_ETH_EVENT_MAX /**< max value of this enum */
2993 typedef void (*rte_eth_dev_cb_fn)(uint8_t port_id, \
2994 enum rte_eth_event_type event, void *cb_arg);
2995 /**< user application callback to be registered for interrupts */
3000 * Register a callback function for specific port id.
3007 * User supplied callback function to be called.
3009 * Pointer to the parameters for the registered callback.
3012 * - On success, zero.
3013 * - On failure, a negative value.
3015 int rte_eth_dev_callback_register(uint8_t port_id,
3016 enum rte_eth_event_type event,
3017 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
3020 * Unregister a callback function for specific port id.
3027 * User supplied callback function to be called.
3029 * Pointer to the parameters for the registered callback. -1 means to
3030 * remove all for the same callback address and same event.
3033 * - On success, zero.
3034 * - On failure, a negative value.
3036 int rte_eth_dev_callback_unregister(uint8_t port_id,
3037 enum rte_eth_event_type event,
3038 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
3041 * @internal Executes all the user application registered callbacks for
3042 * the specific device. It is for DPDK internal user only. User
3043 * application should not call it directly.
3046 * Pointer to struct rte_eth_dev.
3048 * Eth device interrupt event type.
3053 void _rte_eth_dev_callback_process(struct rte_eth_dev *dev,
3054 enum rte_eth_event_type event);
3057 * When there is no rx packet coming in Rx Queue for a long time, we can
3058 * sleep lcore related to RX Queue for power saving, and enable rx interrupt
3059 * to be triggered when rx packect arrives.
3061 * The rte_eth_dev_rx_intr_enable() function enables rx queue
3062 * interrupt on specific rx queue of a port.
3065 * The port identifier of the Ethernet device.
3067 * The index of the receive queue from which to retrieve input packets.
3068 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3069 * to rte_eth_dev_configure().
3071 * - (0) if successful.
3072 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3074 * - (-ENODEV) if *port_id* invalid.
3076 int rte_eth_dev_rx_intr_enable(uint8_t port_id, uint16_t queue_id);
3079 * When lcore wakes up from rx interrupt indicating packet coming, disable rx
3080 * interrupt and returns to polling mode.
3082 * The rte_eth_dev_rx_intr_disable() function disables rx queue
3083 * interrupt on specific rx queue of a port.
3086 * The port identifier of the Ethernet device.
3088 * The index of the receive queue from which to retrieve input packets.
3089 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3090 * to rte_eth_dev_configure().
3092 * - (0) if successful.
3093 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3095 * - (-ENODEV) if *port_id* invalid.
3097 int rte_eth_dev_rx_intr_disable(uint8_t port_id, uint16_t queue_id);
3100 * RX Interrupt control per port.
3103 * The port identifier of the Ethernet device.
3105 * Epoll instance fd which the intr vector associated to.
3106 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
3108 * The operation be performed for the vector.
3109 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
3113 * - On success, zero.
3114 * - On failure, a negative value.
3116 int rte_eth_dev_rx_intr_ctl(uint8_t port_id, int epfd, int op, void *data);
3119 * RX Interrupt control per queue.
3122 * The port identifier of the Ethernet device.
3124 * The index of the receive queue from which to retrieve input packets.
3125 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
3126 * to rte_eth_dev_configure().
3128 * Epoll instance fd which the intr vector associated to.
3129 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
3131 * The operation be performed for the vector.
3132 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
3136 * - On success, zero.
3137 * - On failure, a negative value.
3139 int rte_eth_dev_rx_intr_ctl_q(uint8_t port_id, uint16_t queue_id,
3140 int epfd, int op, void *data);
3143 * Turn on the LED on the Ethernet device.
3144 * This function turns on the LED on the Ethernet device.
3147 * The port identifier of the Ethernet device.
3149 * - (0) if successful.
3150 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3152 * - (-ENODEV) if *port_id* invalid.
3154 int rte_eth_led_on(uint8_t port_id);
3157 * Turn off the LED on the Ethernet device.
3158 * This function turns off the LED on the Ethernet device.
3161 * The port identifier of the Ethernet device.
3163 * - (0) if successful.
3164 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
3166 * - (-ENODEV) if *port_id* invalid.
3168 int rte_eth_led_off(uint8_t port_id);
3171 * Get current status of the Ethernet link flow control for Ethernet device
3174 * The port identifier of the Ethernet device.
3176 * The pointer to the structure where to store the flow control parameters.
3178 * - (0) if successful.
3179 * - (-ENOTSUP) if hardware doesn't support flow control.
3180 * - (-ENODEV) if *port_id* invalid.
3182 int rte_eth_dev_flow_ctrl_get(uint8_t port_id,
3183 struct rte_eth_fc_conf *fc_conf);
3186 * Configure the Ethernet link flow control for Ethernet device
3189 * The port identifier of the Ethernet device.
3191 * The pointer to the structure of the flow control parameters.
3193 * - (0) if successful.
3194 * - (-ENOTSUP) if hardware doesn't support flow control mode.
3195 * - (-ENODEV) if *port_id* invalid.
3196 * - (-EINVAL) if bad parameter
3197 * - (-EIO) if flow control setup failure
3199 int rte_eth_dev_flow_ctrl_set(uint8_t port_id,
3200 struct rte_eth_fc_conf *fc_conf);
3203 * Configure the Ethernet priority flow control under DCB environment
3204 * for Ethernet device.
3207 * The port identifier of the Ethernet device.
3209 * The pointer to the structure of the priority flow control parameters.
3211 * - (0) if successful.
3212 * - (-ENOTSUP) if hardware doesn't support priority flow control mode.
3213 * - (-ENODEV) if *port_id* invalid.
3214 * - (-EINVAL) if bad parameter
3215 * - (-EIO) if flow control setup failure
3217 int rte_eth_dev_priority_flow_ctrl_set(uint8_t port_id,
3218 struct rte_eth_pfc_conf *pfc_conf);
3221 * Add a MAC address to an internal array of addresses used to enable whitelist
3222 * filtering to accept packets only if the destination MAC address matches.
3225 * The port identifier of the Ethernet device.
3227 * The MAC address to add.
3229 * VMDq pool index to associate address with (if VMDq is enabled). If VMDq is
3230 * not enabled, this should be set to 0.
3232 * - (0) if successfully added or *mac_addr" was already added.
3233 * - (-ENOTSUP) if hardware doesn't support this feature.
3234 * - (-ENODEV) if *port* is invalid.
3235 * - (-ENOSPC) if no more MAC addresses can be added.
3236 * - (-EINVAL) if MAC address is invalid.
3238 int rte_eth_dev_mac_addr_add(uint8_t port, struct ether_addr *mac_addr,
3242 * Remove a MAC address from the internal array of addresses.
3245 * The port identifier of the Ethernet device.
3247 * MAC address to remove.
3249 * - (0) if successful, or *mac_addr* didn't exist.
3250 * - (-ENOTSUP) if hardware doesn't support.
3251 * - (-ENODEV) if *port* invalid.
3252 * - (-EADDRINUSE) if attempting to remove the default MAC address
3254 int rte_eth_dev_mac_addr_remove(uint8_t port, struct ether_addr *mac_addr);
3257 * Set the default MAC address.
3260 * The port identifier of the Ethernet device.
3262 * New default MAC address.
3264 * - (0) if successful, or *mac_addr* didn't exist.
3265 * - (-ENOTSUP) if hardware doesn't support.
3266 * - (-ENODEV) if *port* invalid.
3267 * - (-EINVAL) if MAC address is invalid.
3269 int rte_eth_dev_default_mac_addr_set(uint8_t port, struct ether_addr *mac_addr);
3273 * Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3276 * The port identifier of the Ethernet device.
3280 * Redirection table size. The table size can be queried by
3281 * rte_eth_dev_info_get().
3283 * - (0) if successful.
3284 * - (-ENOTSUP) if hardware doesn't support.
3285 * - (-EINVAL) if bad parameter.
3287 int rte_eth_dev_rss_reta_update(uint8_t port,
3288 struct rte_eth_rss_reta_entry64 *reta_conf,
3289 uint16_t reta_size);
3292 * Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3295 * The port identifier of the Ethernet device.
3299 * Redirection table size. The table size can be queried by
3300 * rte_eth_dev_info_get().
3302 * - (0) if successful.
3303 * - (-ENOTSUP) if hardware doesn't support.
3304 * - (-EINVAL) if bad parameter.
3306 int rte_eth_dev_rss_reta_query(uint8_t port,
3307 struct rte_eth_rss_reta_entry64 *reta_conf,
3308 uint16_t reta_size);
3311 * Updates unicast hash table for receiving packet with the given destination
3312 * MAC address, and the packet is routed to all VFs for which the RX mode is
3313 * accept packets that match the unicast hash table.
3316 * The port identifier of the Ethernet device.
3318 * Unicast MAC address.
3320 * 1 - Set an unicast hash bit for receiving packets with the MAC address.
3321 * 0 - Clear an unicast hash bit.
3323 * - (0) if successful.
3324 * - (-ENOTSUP) if hardware doesn't support.
3325 * - (-ENODEV) if *port_id* invalid.
3326 * - (-EINVAL) if bad parameter.
3328 int rte_eth_dev_uc_hash_table_set(uint8_t port,struct ether_addr *addr,
3332 * Updates all unicast hash bitmaps for receiving packet with any Unicast
3333 * Ethernet MAC addresses,the packet is routed to all VFs for which the RX
3334 * mode is accept packets that match the unicast hash table.
3337 * The port identifier of the Ethernet device.
3339 * 1 - Set all unicast hash bitmaps for receiving all the Ethernet
3341 * 0 - Clear all unicast hash bitmaps
3343 * - (0) if successful.
3344 * - (-ENOTSUP) if hardware doesn't support.
3345 * - (-ENODEV) if *port_id* invalid.
3346 * - (-EINVAL) if bad parameter.
3348 int rte_eth_dev_uc_all_hash_table_set(uint8_t port,uint8_t on);
3351 * Set RX L2 Filtering mode of a VF of an Ethernet device.
3354 * The port identifier of the Ethernet device.
3358 * The RX mode mask, which is one or more of accepting Untagged Packets,
3359 * packets that match the PFUTA table, Broadcast and Multicast Promiscuous.
3360 * ETH_VMDQ_ACCEPT_UNTAG,ETH_VMDQ_ACCEPT_HASH_UC,
3361 * ETH_VMDQ_ACCEPT_BROADCAST and ETH_VMDQ_ACCEPT_MULTICAST will be used
3364 * 1 - Enable a VF RX mode.
3365 * 0 - Disable a VF RX mode.
3367 * - (0) if successful.
3368 * - (-ENOTSUP) if hardware doesn't support.
3369 * - (-ENOTSUP) if hardware doesn't support.
3370 * - (-EINVAL) if bad parameter.
3372 int rte_eth_dev_set_vf_rxmode(uint8_t port, uint16_t vf, uint16_t rx_mode,
3376 * Enable or disable a VF traffic transmit of the Ethernet device.
3379 * The port identifier of the Ethernet device.
3383 * 1 - Enable a VF traffic transmit.
3384 * 0 - Disable a VF traffic transmit.
3386 * - (0) if successful.
3387 * - (-ENODEV) if *port_id* invalid.
3388 * - (-ENOTSUP) if hardware doesn't support.
3389 * - (-EINVAL) if bad parameter.
3392 rte_eth_dev_set_vf_tx(uint8_t port,uint16_t vf, uint8_t on);
3395 * Enable or disable a VF traffic receive of an Ethernet device.
3398 * The port identifier of the Ethernet device.
3402 * 1 - Enable a VF traffic receive.
3403 * 0 - Disable a VF traffic receive.
3405 * - (0) if successful.
3406 * - (-ENOTSUP) if hardware doesn't support.
3407 * - (-ENODEV) if *port_id* invalid.
3408 * - (-EINVAL) if bad parameter.
3411 rte_eth_dev_set_vf_rx(uint8_t port,uint16_t vf, uint8_t on);
3414 * Enable/Disable hardware VF VLAN filtering by an Ethernet device of
3415 * received VLAN packets tagged with a given VLAN Tag Identifier.
3418 * The port identifier of the Ethernet device.
3420 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
3422 * Bitmap listing which VFs participate in the VLAN filtering.
3424 * 1 - Enable VFs VLAN filtering.
3425 * 0 - Disable VFs VLAN filtering.
3427 * - (0) if successful.
3428 * - (-ENOTSUP) if hardware doesn't support.
3429 * - (-ENODEV) if *port_id* invalid.
3430 * - (-EINVAL) if bad parameter.
3433 rte_eth_dev_set_vf_vlan_filter(uint8_t port, uint16_t vlan_id,
3438 * Set a traffic mirroring rule on an Ethernet device
3441 * The port identifier of the Ethernet device.
3442 * @param mirror_conf
3443 * The pointer to the traffic mirroring structure describing the mirroring rule.
3444 * The *rte_eth_vm_mirror_conf* structure includes the type of mirroring rule,
3445 * destination pool and the value of rule if enable vlan or pool mirroring.
3448 * The index of traffic mirroring rule, we support four separated rules.
3450 * 1 - Enable a mirroring rule.
3451 * 0 - Disable a mirroring rule.
3453 * - (0) if successful.
3454 * - (-ENOTSUP) if hardware doesn't support this feature.
3455 * - (-ENODEV) if *port_id* invalid.
3456 * - (-EINVAL) if the mr_conf information is not correct.
3458 int rte_eth_mirror_rule_set(uint8_t port_id,
3459 struct rte_eth_mirror_conf *mirror_conf,
3464 * Reset a traffic mirroring rule on an Ethernet device.
3467 * The port identifier of the Ethernet device.
3469 * The index of traffic mirroring rule, we support four separated rules.
3471 * - (0) if successful.
3472 * - (-ENOTSUP) if hardware doesn't support this feature.
3473 * - (-ENODEV) if *port_id* invalid.
3474 * - (-EINVAL) if bad parameter.
3476 int rte_eth_mirror_rule_reset(uint8_t port_id,
3480 * Set the rate limitation for a queue on an Ethernet device.
3483 * The port identifier of the Ethernet device.
3487 * The tx rate in Mbps. Allocated from the total port link speed.
3489 * - (0) if successful.
3490 * - (-ENOTSUP) if hardware doesn't support this feature.
3491 * - (-ENODEV) if *port_id* invalid.
3492 * - (-EINVAL) if bad parameter.
3494 int rte_eth_set_queue_rate_limit(uint8_t port_id, uint16_t queue_idx,
3498 * Set the rate limitation for a vf on an Ethernet device.
3501 * The port identifier of the Ethernet device.
3505 * The tx rate allocated from the total link speed for this VF id.
3507 * The queue mask which need to set the rate.
3509 * - (0) if successful.
3510 * - (-ENOTSUP) if hardware doesn't support this feature.
3511 * - (-ENODEV) if *port_id* invalid.
3512 * - (-EINVAL) if bad parameter.
3514 int rte_eth_set_vf_rate_limit(uint8_t port_id, uint16_t vf,
3515 uint16_t tx_rate, uint64_t q_msk);
3518 * Initialize bypass logic. This function needs to be called before
3519 * executing any other bypass API.
3522 * The port identifier of the Ethernet device.
3524 * - (0) if successful.
3525 * - (-ENOTSUP) if hardware doesn't support.
3526 * - (-EINVAL) if bad parameter.
3528 int rte_eth_dev_bypass_init(uint8_t port);
3531 * Return bypass state.
3534 * The port identifier of the Ethernet device.
3536 * The return bypass state.
3539 * - (3) Isolate mode
3541 * - (0) if successful.
3542 * - (-ENOTSUP) if hardware doesn't support.
3543 * - (-EINVAL) if bad parameter.
3545 int rte_eth_dev_bypass_state_show(uint8_t port, uint32_t *state);
3551 * The port identifier of the Ethernet device.
3553 * The current bypass state.
3556 * - (3) Isolate mode
3558 * - (0) if successful.
3559 * - (-ENOTSUP) if hardware doesn't support.
3560 * - (-EINVAL) if bad parameter.
3562 int rte_eth_dev_bypass_state_set(uint8_t port, uint32_t *new_state);
3565 * Return bypass state when given event occurs.
3568 * The port identifier of the Ethernet device.
3571 * - (1) Main power on (power button is pushed)
3572 * - (2) Auxiliary power on (power supply is being plugged)
3573 * - (3) Main power off (system shutdown and power supply is left plugged in)
3574 * - (4) Auxiliary power off (power supply is being unplugged)
3575 * - (5) Display or set the watchdog timer
3577 * The bypass state when given event occurred.
3580 * - (3) Isolate mode
3582 * - (0) if successful.
3583 * - (-ENOTSUP) if hardware doesn't support.
3584 * - (-EINVAL) if bad parameter.
3586 int rte_eth_dev_bypass_event_show(uint8_t port, uint32_t event, uint32_t *state);
3589 * Set bypass state when given event occurs.
3592 * The port identifier of the Ethernet device.
3595 * - (1) Main power on (power button is pushed)
3596 * - (2) Auxiliary power on (power supply is being plugged)
3597 * - (3) Main power off (system shutdown and power supply is left plugged in)
3598 * - (4) Auxiliary power off (power supply is being unplugged)
3599 * - (5) Display or set the watchdog timer
3601 * The assigned state when given event occurs.
3604 * - (3) Isolate mode
3606 * - (0) if successful.
3607 * - (-ENOTSUP) if hardware doesn't support.
3608 * - (-EINVAL) if bad parameter.
3610 int rte_eth_dev_bypass_event_store(uint8_t port, uint32_t event, uint32_t state);
3613 * Set bypass watchdog timeout count.
3616 * The port identifier of the Ethernet device.
3618 * The timeout to be set.
3619 * - (0) 0 seconds (timer is off)
3628 * - (0) if successful.
3629 * - (-ENOTSUP) if hardware doesn't support.
3630 * - (-EINVAL) if bad parameter.
3632 int rte_eth_dev_wd_timeout_store(uint8_t port, uint32_t timeout);
3635 * Get bypass firmware version.
3638 * The port identifier of the Ethernet device.
3640 * The firmware version
3642 * - (0) if successful.
3643 * - (-ENOTSUP) if hardware doesn't support.
3644 * - (-EINVAL) if bad parameter.
3646 int rte_eth_dev_bypass_ver_show(uint8_t port, uint32_t *ver);
3649 * Return bypass watchdog timeout in seconds
3652 * The port identifier of the Ethernet device.
3654 * The return watchdog timeout. "0" represents timer expired
3655 * - (0) 0 seconds (timer is off)
3664 * - (0) if successful.
3665 * - (-ENOTSUP) if hardware doesn't support.
3666 * - (-EINVAL) if bad parameter.
3668 int rte_eth_dev_bypass_wd_timeout_show(uint8_t port, uint32_t *wd_timeout);
3671 * Reset bypass watchdog timer
3674 * The port identifier of the Ethernet device.
3676 * - (0) if successful.
3677 * - (-ENOTSUP) if hardware doesn't support.
3678 * - (-EINVAL) if bad parameter.
3680 int rte_eth_dev_bypass_wd_reset(uint8_t port);
3683 * Configuration of Receive Side Scaling hash computation of Ethernet device.
3686 * The port identifier of the Ethernet device.
3688 * The new configuration to use for RSS hash computation on the port.
3690 * - (0) if successful.
3691 * - (-ENODEV) if port identifier is invalid.
3692 * - (-ENOTSUP) if hardware doesn't support.
3693 * - (-EINVAL) if bad parameter.
3695 int rte_eth_dev_rss_hash_update(uint8_t port_id,
3696 struct rte_eth_rss_conf *rss_conf);
3699 * Retrieve current configuration of Receive Side Scaling hash computation
3700 * of Ethernet device.
3703 * The port identifier of the Ethernet device.
3705 * Where to store the current RSS hash configuration of the Ethernet device.
3707 * - (0) if successful.
3708 * - (-ENODEV) if port identifier is invalid.
3709 * - (-ENOTSUP) if hardware doesn't support RSS.
3712 rte_eth_dev_rss_hash_conf_get(uint8_t port_id,
3713 struct rte_eth_rss_conf *rss_conf);
3716 * Add UDP tunneling port for a specific type of tunnel.
3717 * The packets with this UDP port will be identified as this type of tunnel.
3718 * Before enabling any offloading function for a tunnel, users can call this API
3719 * to change or add more UDP port for the tunnel. So the offloading function
3720 * can take effect on the packets with the sepcific UDP port.
3723 * The port identifier of the Ethernet device.
3725 * UDP tunneling configuration.
3728 * - (0) if successful.
3729 * - (-ENODEV) if port identifier is invalid.
3730 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3733 rte_eth_dev_udp_tunnel_port_add(uint8_t port_id,
3734 struct rte_eth_udp_tunnel *tunnel_udp);
3737 * Delete UDP tunneling port a specific type of tunnel.
3738 * The packets with this UDP port will not be identified as this type of tunnel
3740 * Before enabling any offloading function for a tunnel, users can call this API
3741 * to delete a UDP port for the tunnel. So the offloading function will not take
3742 * effect on the packets with the sepcific UDP port.
3745 * The port identifier of the Ethernet device.
3747 * UDP tunneling configuration.
3750 * - (0) if successful.
3751 * - (-ENODEV) if port identifier is invalid.
3752 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3755 rte_eth_dev_udp_tunnel_port_delete(uint8_t port_id,
3756 struct rte_eth_udp_tunnel *tunnel_udp);
3759 * Check whether the filter type is supported on an Ethernet device.
3760 * All the supported filter types are defined in 'rte_eth_ctrl.h'.
3763 * The port identifier of the Ethernet device.
3764 * @param filter_type
3767 * - (0) if successful.
3768 * - (-ENOTSUP) if hardware doesn't support this filter type.
3769 * - (-ENODEV) if *port_id* invalid.
3771 int rte_eth_dev_filter_supported(uint8_t port_id, enum rte_filter_type filter_type);
3774 * Take operations to assigned filter type on an Ethernet device.
3775 * All the supported operations and filter types are defined in 'rte_eth_ctrl.h'.
3778 * The port identifier of the Ethernet device.
3779 * @param filter_type
3782 * Type of operation.
3784 * A pointer to arguments defined specifically for the operation.
3786 * - (0) if successful.
3787 * - (-ENOTSUP) if hardware doesn't support.
3788 * - (-ENODEV) if *port_id* invalid.
3789 * - others depends on the specific operations implementation.
3791 int rte_eth_dev_filter_ctrl(uint8_t port_id, enum rte_filter_type filter_type,
3792 enum rte_filter_op filter_op, void *arg);
3795 * Get DCB information on an Ethernet device.
3798 * The port identifier of the Ethernet device.
3802 * - (0) if successful.
3803 * - (-ENODEV) if port identifier is invalid.
3804 * - (-ENOTSUP) if hardware doesn't support.
3806 int rte_eth_dev_get_dcb_info(uint8_t port_id,
3807 struct rte_eth_dcb_info *dcb_info);
3810 * Add a callback to be called on packet RX on a given port and queue.
3812 * This API configures a function to be called for each burst of
3813 * packets received on a given NIC port queue. The return value is a pointer
3814 * that can be used to later remove the callback using
3815 * rte_eth_remove_rx_callback().
3817 * Multiple functions are called in the order that they are added.
3820 * The port identifier of the Ethernet device.
3822 * The queue on the Ethernet device on which the callback is to be added.
3824 * The callback function
3826 * A generic pointer parameter which will be passed to each invocation of the
3827 * callback function on this port and queue.
3831 * On success, a pointer value which can later be used to remove the callback.
3833 void *rte_eth_add_rx_callback(uint8_t port_id, uint16_t queue_id,
3834 rte_rx_callback_fn fn, void *user_param);
3837 * Add a callback to be called on packet TX on a given port and queue.
3839 * This API configures a function to be called for each burst of
3840 * packets sent on a given NIC port queue. The return value is a pointer
3841 * that can be used to later remove the callback using
3842 * rte_eth_remove_tx_callback().
3844 * Multiple functions are called in the order that they are added.
3847 * The port identifier of the Ethernet device.
3849 * The queue on the Ethernet device on which the callback is to be added.
3851 * The callback function
3853 * A generic pointer parameter which will be passed to each invocation of the
3854 * callback function on this port and queue.
3858 * On success, a pointer value which can later be used to remove the callback.
3860 void *rte_eth_add_tx_callback(uint8_t port_id, uint16_t queue_id,
3861 rte_tx_callback_fn fn, void *user_param);
3864 * Remove an RX packet callback from a given port and queue.
3866 * This function is used to removed callbacks that were added to a NIC port
3867 * queue using rte_eth_add_rx_callback().
3869 * Note: the callback is removed from the callback list but it isn't freed
3870 * since the it may still be in use. The memory for the callback can be
3871 * subsequently freed back by the application by calling rte_free():
3873 * - Immediately - if the port is stopped, or the user knows that no
3874 * callbacks are in flight e.g. if called from the thread doing RX/TX
3877 * - After a short delay - where the delay is sufficient to allow any
3878 * in-flight callbacks to complete.
3881 * The port identifier of the Ethernet device.
3883 * The queue on the Ethernet device from which the callback is to be removed.
3885 * User supplied callback created via rte_eth_add_rx_callback().
3888 * - 0: Success. Callback was removed.
3889 * - -ENOTSUP: Callback support is not available.
3890 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
3891 * is NULL or not found for the port/queue.
3893 int rte_eth_remove_rx_callback(uint8_t port_id, uint16_t queue_id,
3894 struct rte_eth_rxtx_callback *user_cb);
3897 * Remove a TX packet callback from a given port and queue.
3899 * This function is used to removed callbacks that were added to a NIC port
3900 * queue using rte_eth_add_tx_callback().
3902 * Note: the callback is removed from the callback list but it isn't freed
3903 * since the it may still be in use. The memory for the callback can be
3904 * subsequently freed back by the application by calling rte_free():
3906 * - Immediately - if the port is stopped, or the user knows that no
3907 * callbacks are in flight e.g. if called from the thread doing RX/TX
3910 * - After a short delay - where the delay is sufficient to allow any
3911 * in-flight callbacks to complete.
3914 * The port identifier of the Ethernet device.
3916 * The queue on the Ethernet device from which the callback is to be removed.
3918 * User supplied callback created via rte_eth_add_tx_callback().
3921 * - 0: Success. Callback was removed.
3922 * - -ENOTSUP: Callback support is not available.
3923 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
3924 * is NULL or not found for the port/queue.
3926 int rte_eth_remove_tx_callback(uint8_t port_id, uint16_t queue_id,
3927 struct rte_eth_rxtx_callback *user_cb);
3930 * Retrieve information about given port's RX queue.
3933 * The port identifier of the Ethernet device.
3935 * The RX queue on the Ethernet device for which information
3936 * will be retrieved.
3938 * A pointer to a structure of type *rte_eth_rxq_info_info* to be filled with
3939 * the information of the Ethernet device.
3943 * - -ENOTSUP: routine is not supported by the device PMD.
3944 * - -EINVAL: The port_id or the queue_id is out of range.
3946 int rte_eth_rx_queue_info_get(uint8_t port_id, uint16_t queue_id,
3947 struct rte_eth_rxq_info *qinfo);
3950 * Retrieve information about given port's TX queue.
3953 * The port identifier of the Ethernet device.
3955 * The TX queue on the Ethernet device for which information
3956 * will be retrieved.
3958 * A pointer to a structure of type *rte_eth_txq_info_info* to be filled with
3959 * the information of the Ethernet device.
3963 * - -ENOTSUP: routine is not supported by the device PMD.
3964 * - -EINVAL: The port_id or the queue_id is out of range.
3966 int rte_eth_tx_queue_info_get(uint8_t port_id, uint16_t queue_id,
3967 struct rte_eth_txq_info *qinfo);
3970 * Retrieve number of available registers for access
3973 * The port identifier of the Ethernet device.
3975 * - (>=0) number of registers if successful.
3976 * - (-ENOTSUP) if hardware doesn't support.
3977 * - (-ENODEV) if *port_id* invalid.
3978 * - others depends on the specific operations implementation.
3980 int rte_eth_dev_get_reg_length(uint8_t port_id);
3983 * Retrieve device registers and register attributes
3986 * The port identifier of the Ethernet device.
3988 * The template includes buffer for register data and attribute to be filled.
3990 * - (0) if successful.
3991 * - (-ENOTSUP) if hardware doesn't support.
3992 * - (-ENODEV) if *port_id* invalid.
3993 * - others depends on the specific operations implementation.
3995 int rte_eth_dev_get_reg_info(uint8_t port_id, struct rte_dev_reg_info *info);
3998 * Retrieve size of device EEPROM
4001 * The port identifier of the Ethernet device.
4003 * - (>=0) EEPROM size if successful.
4004 * - (-ENOTSUP) if hardware doesn't support.
4005 * - (-ENODEV) if *port_id* invalid.
4006 * - others depends on the specific operations implementation.
4008 int rte_eth_dev_get_eeprom_length(uint8_t port_id);
4011 * Retrieve EEPROM and EEPROM attribute
4014 * The port identifier of the Ethernet device.
4016 * The template includes buffer for return EEPROM data and
4017 * EEPROM attributes to be filled.
4019 * - (0) if successful.
4020 * - (-ENOTSUP) if hardware doesn't support.
4021 * - (-ENODEV) if *port_id* invalid.
4022 * - others depends on the specific operations implementation.
4024 int rte_eth_dev_get_eeprom(uint8_t port_id, struct rte_dev_eeprom_info *info);
4027 * Program EEPROM with provided data
4030 * The port identifier of the Ethernet device.
4032 * The template includes EEPROM data for programming and
4033 * EEPROM attributes to be filled
4035 * - (0) if successful.
4036 * - (-ENOTSUP) if hardware doesn't support.
4037 * - (-ENODEV) if *port_id* invalid.
4038 * - others depends on the specific operations implementation.
4040 int rte_eth_dev_set_eeprom(uint8_t port_id, struct rte_dev_eeprom_info *info);
4043 * Set the list of multicast addresses to filter on an Ethernet device.
4046 * The port identifier of the Ethernet device.
4047 * @param mc_addr_set
4048 * The array of multicast addresses to set. Equal to NULL when the function
4049 * is invoked to flush the set of filtered addresses.
4051 * The number of multicast addresses in the *mc_addr_set* array. Equal to 0
4052 * when the function is invoked to flush the set of filtered addresses.
4054 * - (0) if successful.
4055 * - (-ENODEV) if *port_id* invalid.
4056 * - (-ENOTSUP) if PMD of *port_id* doesn't support multicast filtering.
4057 * - (-ENOSPC) if *port_id* has not enough multicast filtering resources.
4059 int rte_eth_dev_set_mc_addr_list(uint8_t port_id,
4060 struct ether_addr *mc_addr_set,
4061 uint32_t nb_mc_addr);
4064 * Enable IEEE1588/802.1AS timestamping for an Ethernet device.
4067 * The port identifier of the Ethernet device.
4071 * - -ENODEV: The port ID is invalid.
4072 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4074 int rte_eth_timesync_enable(uint8_t port_id);
4077 * Disable IEEE1588/802.1AS timestamping for an Ethernet device.
4080 * The port identifier of the Ethernet device.
4084 * - -ENODEV: The port ID is invalid.
4085 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4087 int rte_eth_timesync_disable(uint8_t port_id);
4090 * Read an IEEE1588/802.1AS RX timestamp from an Ethernet device.
4093 * The port identifier of the Ethernet device.
4095 * Pointer to the timestamp struct.
4097 * Device specific flags. Used to pass the RX timesync register index to
4098 * i40e. Unused in igb/ixgbe, pass 0 instead.
4102 * - -EINVAL: No timestamp is available.
4103 * - -ENODEV: The port ID is invalid.
4104 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4106 int rte_eth_timesync_read_rx_timestamp(uint8_t port_id,
4107 struct timespec *timestamp, uint32_t flags);
4110 * Read an IEEE1588/802.1AS TX timestamp from an Ethernet device.
4113 * The port identifier of the Ethernet device.
4115 * Pointer to the timestamp struct.
4119 * - -EINVAL: No timestamp is available.
4120 * - -ENODEV: The port ID is invalid.
4121 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4123 int rte_eth_timesync_read_tx_timestamp(uint8_t port_id,
4124 struct timespec *timestamp);
4127 * Adjust the timesync clock on an Ethernet device.
4129 * This is usually used in conjunction with other Ethdev timesync functions to
4130 * synchronize the device time using the IEEE1588/802.1AS protocol.
4133 * The port identifier of the Ethernet device.
4135 * The adjustment in nanoseconds.
4139 * - -ENODEV: The port ID is invalid.
4140 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4142 int rte_eth_timesync_adjust_time(uint8_t port_id, int64_t delta);
4145 * Read the time from the timesync clock on an Ethernet device.
4147 * This is usually used in conjunction with other Ethdev timesync functions to
4148 * synchronize the device time using the IEEE1588/802.1AS protocol.
4151 * The port identifier of the Ethernet device.
4153 * Pointer to the timespec struct that holds the time.
4158 int rte_eth_timesync_read_time(uint8_t port_id, struct timespec *time);
4161 * Set the time of the timesync clock on an Ethernet device.
4163 * This is usually used in conjunction with other Ethdev timesync functions to
4164 * synchronize the device time using the IEEE1588/802.1AS protocol.
4167 * The port identifier of the Ethernet device.
4169 * Pointer to the timespec struct that holds the time.
4173 * - -EINVAL: No timestamp is available.
4174 * - -ENODEV: The port ID is invalid.
4175 * - -ENOTSUP: The function is not supported by the Ethernet driver.
4177 int rte_eth_timesync_write_time(uint8_t port_id, const struct timespec *time);
4180 * Copy pci device info to the Ethernet device data.
4183 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure.
4185 * The *pci_dev* pointer is the address of the *rte_pci_device* structure.
4188 * - 0 on success, negative on error
4190 void rte_eth_copy_pci_info(struct rte_eth_dev *eth_dev,
4191 struct rte_pci_device *pci_dev);
4194 * Create memzone for HW rings.
4195 * malloc can't be used as the physical address is needed.
4196 * If the memzone is already created, then this function returns a ptr
4200 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
4202 * The name of the memory zone
4204 * The index of the queue to add to name
4206 * The sizeof of the memory area
4208 * Alignment for resulting memzone. Must be a power of 2.
4210 * The *socket_id* argument is the socket identifier in case of NUMA.
4212 const struct rte_memzone *
4213 rte_eth_dma_zone_reserve(const struct rte_eth_dev *eth_dev, const char *name,
4214 uint16_t queue_id, size_t size,
4215 unsigned align, int socket_id);
4218 * Config l2 tunnel ether type of an Ethernet device for filtering specific
4219 * tunnel packets by ether type.
4222 * The port identifier of the Ethernet device.
4224 * l2 tunnel configuration.
4227 * - (0) if successful.
4228 * - (-ENODEV) if port identifier is invalid.
4229 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4232 rte_eth_dev_l2_tunnel_eth_type_conf(uint8_t port_id,
4233 struct rte_eth_l2_tunnel_conf *l2_tunnel);
4236 * Enable/disable l2 tunnel offload functions. Include,
4237 * 1, The ability of parsing a type of l2 tunnel of an Ethernet device.
4238 * Filtering, forwarding and offloading this type of tunnel packets depend on
4240 * 2, Stripping the l2 tunnel tag.
4241 * 3, Insertion of the l2 tunnel tag.
4242 * 4, Forwarding the packets based on the l2 tunnel tag.
4245 * The port identifier of the Ethernet device.
4247 * l2 tunnel parameters.
4249 * Indicate the offload function.
4251 * Enable or disable this function.
4254 * - (0) if successful.
4255 * - (-ENODEV) if port identifier is invalid.
4256 * - (-ENOTSUP) if hardware doesn't support tunnel type.
4259 rte_eth_dev_l2_tunnel_offload_set(uint8_t port_id,
4260 struct rte_eth_l2_tunnel_conf *l2_tunnel,
4268 #endif /* _RTE_ETHDEV_H_ */