4 * Copyright(c) 2010-2014 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.
175 /* Use this macro to check if LRO API is supported */
176 #define RTE_ETHDEV_HAS_LRO_SUPPORT
179 #include <rte_interrupts.h>
182 #include <rte_devargs.h>
183 #include "rte_ether.h"
184 #include "rte_eth_ctrl.h"
189 * A structure used to retrieve statistics for an Ethernet port.
191 struct rte_eth_stats {
192 uint64_t ipackets; /**< Total number of successfully received packets. */
193 uint64_t opackets; /**< Total number of successfully transmitted packets.*/
194 uint64_t ibytes; /**< Total number of successfully received bytes. */
195 uint64_t obytes; /**< Total number of successfully transmitted bytes. */
196 uint64_t imissed; /**< Total of RX missed packets (e.g full FIFO). */
197 uint64_t ibadcrc; /**< Total of RX packets with CRC error. */
198 uint64_t ibadlen; /**< Total of RX packets with bad length. */
199 uint64_t ierrors; /**< Total number of erroneous received packets. */
200 uint64_t oerrors; /**< Total number of failed transmitted packets. */
201 uint64_t imcasts; /**< Total number of multicast received packets. */
202 uint64_t rx_nombuf; /**< Total number of RX mbuf allocation failures. */
203 uint64_t fdirmatch; /**< Total number of RX packets matching a filter. */
204 uint64_t fdirmiss; /**< Total number of RX packets not matching any filter. */
205 uint64_t tx_pause_xon; /**< Total nb. of XON pause frame sent. */
206 uint64_t rx_pause_xon; /**< Total nb. of XON pause frame received. */
207 uint64_t tx_pause_xoff; /**< Total nb. of XOFF pause frame sent. */
208 uint64_t rx_pause_xoff; /**< Total nb. of XOFF pause frame received. */
209 uint64_t q_ipackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
210 /**< Total number of queue RX packets. */
211 uint64_t q_opackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
212 /**< Total number of queue TX packets. */
213 uint64_t q_ibytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
214 /**< Total number of successfully received queue bytes. */
215 uint64_t q_obytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
216 /**< Total number of successfully transmitted queue bytes. */
217 uint64_t q_errors[RTE_ETHDEV_QUEUE_STAT_CNTRS];
218 /**< Total number of queue packets received that are dropped. */
220 /**< Total number of good packets received from loopback,VF Only */
222 /**< Total number of good packets transmitted to loopback,VF Only */
224 /**< Total number of good bytes received from loopback,VF Only */
226 /**< Total number of good bytes transmitted to loopback,VF Only */
230 * A structure used to retrieve link-level information of an Ethernet port.
232 struct rte_eth_link {
233 uint16_t link_speed; /**< ETH_LINK_SPEED_[10, 100, 1000, 10000] */
234 uint16_t link_duplex; /**< ETH_LINK_[HALF_DUPLEX, FULL_DUPLEX] */
235 uint8_t link_status : 1; /**< 1 -> link up, 0 -> link down */
236 }__attribute__((aligned(8))); /**< aligned for atomic64 read/write */
238 #define ETH_LINK_SPEED_AUTONEG 0 /**< Auto-negotiate link speed. */
239 #define ETH_LINK_SPEED_10 10 /**< 10 megabits/second. */
240 #define ETH_LINK_SPEED_100 100 /**< 100 megabits/second. */
241 #define ETH_LINK_SPEED_1000 1000 /**< 1 gigabits/second. */
242 #define ETH_LINK_SPEED_10000 10000 /**< 10 gigabits/second. */
243 #define ETH_LINK_SPEED_10G 10000 /**< alias of 10 gigabits/second. */
244 #define ETH_LINK_SPEED_20G 20000 /**< 20 gigabits/second. */
245 #define ETH_LINK_SPEED_40G 40000 /**< 40 gigabits/second. */
247 #define ETH_LINK_AUTONEG_DUPLEX 0 /**< Auto-negotiate duplex. */
248 #define ETH_LINK_HALF_DUPLEX 1 /**< Half-duplex connection. */
249 #define ETH_LINK_FULL_DUPLEX 2 /**< Full-duplex connection. */
252 * A structure used to configure the ring threshold registers of an RX/TX
253 * queue for an Ethernet port.
255 struct rte_eth_thresh {
256 uint8_t pthresh; /**< Ring prefetch threshold. */
257 uint8_t hthresh; /**< Ring host threshold. */
258 uint8_t wthresh; /**< Ring writeback threshold. */
262 * Simple flags are used for rte_eth_conf.rxmode.mq_mode.
264 #define ETH_MQ_RX_RSS_FLAG 0x1
265 #define ETH_MQ_RX_DCB_FLAG 0x2
266 #define ETH_MQ_RX_VMDQ_FLAG 0x4
269 * A set of values to identify what method is to be used to route
270 * packets to multiple queues.
272 enum rte_eth_rx_mq_mode {
273 /** None of DCB,RSS or VMDQ mode */
276 /** For RX side, only RSS is on */
277 ETH_MQ_RX_RSS = ETH_MQ_RX_RSS_FLAG,
278 /** For RX side,only DCB is on. */
279 ETH_MQ_RX_DCB = ETH_MQ_RX_DCB_FLAG,
280 /** Both DCB and RSS enable */
281 ETH_MQ_RX_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG,
283 /** Only VMDQ, no RSS nor DCB */
284 ETH_MQ_RX_VMDQ_ONLY = ETH_MQ_RX_VMDQ_FLAG,
285 /** RSS mode with VMDQ */
286 ETH_MQ_RX_VMDQ_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_VMDQ_FLAG,
287 /** Use VMDQ+DCB to route traffic to queues */
288 ETH_MQ_RX_VMDQ_DCB = ETH_MQ_RX_VMDQ_FLAG | ETH_MQ_RX_DCB_FLAG,
289 /** Enable both VMDQ and DCB in VMDq */
290 ETH_MQ_RX_VMDQ_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG |
295 * for rx mq mode backward compatible
297 #define ETH_RSS ETH_MQ_RX_RSS
298 #define VMDQ_DCB ETH_MQ_RX_VMDQ_DCB
299 #define ETH_DCB_RX ETH_MQ_RX_DCB
302 * A set of values to identify what method is to be used to transmit
303 * packets using multi-TCs.
305 enum rte_eth_tx_mq_mode {
306 ETH_MQ_TX_NONE = 0, /**< It is in neither DCB nor VT mode. */
307 ETH_MQ_TX_DCB, /**< For TX side,only DCB is on. */
308 ETH_MQ_TX_VMDQ_DCB, /**< For TX side,both DCB and VT is on. */
309 ETH_MQ_TX_VMDQ_ONLY, /**< Only VT on, no DCB */
313 * for tx mq mode backward compatible
315 #define ETH_DCB_NONE ETH_MQ_TX_NONE
316 #define ETH_VMDQ_DCB_TX ETH_MQ_TX_VMDQ_DCB
317 #define ETH_DCB_TX ETH_MQ_TX_DCB
320 * A structure used to configure the RX features of an Ethernet port.
322 struct rte_eth_rxmode {
323 /** The multi-queue packet distribution mode to be used, e.g. RSS. */
324 enum rte_eth_rx_mq_mode mq_mode;
325 uint32_t max_rx_pkt_len; /**< Only used if jumbo_frame enabled. */
326 uint16_t split_hdr_size; /**< hdr buf size (header_split enabled).*/
327 uint16_t header_split : 1, /**< Header Split enable. */
328 hw_ip_checksum : 1, /**< IP/UDP/TCP checksum offload enable. */
329 hw_vlan_filter : 1, /**< VLAN filter enable. */
330 hw_vlan_strip : 1, /**< VLAN strip enable. */
331 hw_vlan_extend : 1, /**< Extended VLAN enable. */
332 jumbo_frame : 1, /**< Jumbo Frame Receipt enable. */
333 hw_strip_crc : 1, /**< Enable CRC stripping by hardware. */
334 enable_scatter : 1, /**< Enable scatter packets rx handler */
335 enable_lro : 1; /**< Enable LRO */
339 * A structure used to configure the Receive Side Scaling (RSS) feature
340 * of an Ethernet port.
341 * If not NULL, the *rss_key* pointer of the *rss_conf* structure points
342 * to an array holding the RSS key to use for hashing specific header
343 * fields of received packets. The length of this array should be indicated
344 * by *rss_key_len* below. Otherwise, a default random hash key is used by
347 * The *rss_key_len* field of the *rss_conf* structure indicates the length
348 * in bytes of the array pointed by *rss_key*. To be compatible, this length
349 * will be checked in i40e only. Others assume 40 bytes to be used as before.
351 * The *rss_hf* field of the *rss_conf* structure indicates the different
352 * types of IPv4/IPv6 packets to which the RSS hashing must be applied.
353 * Supplying an *rss_hf* equal to zero disables the RSS feature.
355 struct rte_eth_rss_conf {
356 uint8_t *rss_key; /**< If not NULL, 40-byte hash key. */
357 uint8_t rss_key_len; /**< hash key length in bytes. */
358 uint64_t rss_hf; /**< Hash functions to apply - see below. */
362 * The RSS offload types are defined based on flow types which are defined
363 * in rte_eth_ctrl.h. Different NIC hardwares may support different RSS offload
364 * types. The supported flow types or RSS offload types can be queried by
365 * rte_eth_dev_info_get().
367 #define ETH_RSS_IPV4 (1ULL << RTE_ETH_FLOW_IPV4)
368 #define ETH_RSS_FRAG_IPV4 (1ULL << RTE_ETH_FLOW_FRAG_IPV4)
369 #define ETH_RSS_NONFRAG_IPV4_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_TCP)
370 #define ETH_RSS_NONFRAG_IPV4_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_UDP)
371 #define ETH_RSS_NONFRAG_IPV4_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_SCTP)
372 #define ETH_RSS_NONFRAG_IPV4_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_OTHER)
373 #define ETH_RSS_IPV6 (1ULL << RTE_ETH_FLOW_IPV6)
374 #define ETH_RSS_FRAG_IPV6 (1ULL << RTE_ETH_FLOW_FRAG_IPV6)
375 #define ETH_RSS_NONFRAG_IPV6_TCP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_TCP)
376 #define ETH_RSS_NONFRAG_IPV6_UDP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_UDP)
377 #define ETH_RSS_NONFRAG_IPV6_SCTP (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_SCTP)
378 #define ETH_RSS_NONFRAG_IPV6_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_OTHER)
379 #define ETH_RSS_L2_PAYLOAD (1ULL << RTE_ETH_FLOW_L2_PAYLOAD)
380 #define ETH_RSS_IPV6_EX (1ULL << RTE_ETH_FLOW_IPV6_EX)
381 #define ETH_RSS_IPV6_TCP_EX (1ULL << RTE_ETH_FLOW_IPV6_TCP_EX)
382 #define ETH_RSS_IPV6_UDP_EX (1ULL << RTE_ETH_FLOW_IPV6_UDP_EX)
384 #define ETH_RSS_IP ( \
386 ETH_RSS_FRAG_IPV4 | \
387 ETH_RSS_NONFRAG_IPV4_OTHER | \
389 ETH_RSS_FRAG_IPV6 | \
390 ETH_RSS_NONFRAG_IPV6_OTHER | \
393 #define ETH_RSS_UDP ( \
394 ETH_RSS_NONFRAG_IPV4_UDP | \
395 ETH_RSS_NONFRAG_IPV6_UDP | \
398 #define ETH_RSS_TCP ( \
399 ETH_RSS_NONFRAG_IPV4_TCP | \
400 ETH_RSS_NONFRAG_IPV6_TCP | \
403 #define ETH_RSS_SCTP ( \
404 ETH_RSS_NONFRAG_IPV4_SCTP | \
405 ETH_RSS_NONFRAG_IPV6_SCTP)
407 /**< Mask of valid RSS hash protocols */
408 #define ETH_RSS_PROTO_MASK ( \
410 ETH_RSS_FRAG_IPV4 | \
411 ETH_RSS_NONFRAG_IPV4_TCP | \
412 ETH_RSS_NONFRAG_IPV4_UDP | \
413 ETH_RSS_NONFRAG_IPV4_SCTP | \
414 ETH_RSS_NONFRAG_IPV4_OTHER | \
416 ETH_RSS_FRAG_IPV6 | \
417 ETH_RSS_NONFRAG_IPV6_TCP | \
418 ETH_RSS_NONFRAG_IPV6_UDP | \
419 ETH_RSS_NONFRAG_IPV6_SCTP | \
420 ETH_RSS_NONFRAG_IPV6_OTHER | \
421 ETH_RSS_L2_PAYLOAD | \
423 ETH_RSS_IPV6_TCP_EX | \
427 * Definitions used for redirection table entry size.
428 * Some RSS RETA sizes may not be supported by some drivers, check the
429 * documentation or the description of relevant functions for more details.
431 #define ETH_RSS_RETA_SIZE_64 64
432 #define ETH_RSS_RETA_SIZE_128 128
433 #define ETH_RSS_RETA_SIZE_512 512
434 #define RTE_RETA_GROUP_SIZE 64
436 /* Definitions used for VMDQ and DCB functionality */
437 #define ETH_VMDQ_MAX_VLAN_FILTERS 64 /**< Maximum nb. of VMDQ vlan filters. */
438 #define ETH_DCB_NUM_USER_PRIORITIES 8 /**< Maximum nb. of DCB priorities. */
439 #define ETH_VMDQ_DCB_NUM_QUEUES 128 /**< Maximum nb. of VMDQ DCB queues. */
440 #define ETH_DCB_NUM_QUEUES 128 /**< Maximum nb. of DCB queues. */
442 /* DCB capability defines */
443 #define ETH_DCB_PG_SUPPORT 0x00000001 /**< Priority Group(ETS) support. */
444 #define ETH_DCB_PFC_SUPPORT 0x00000002 /**< Priority Flow Control support. */
446 /* Definitions used for VLAN Offload functionality */
447 #define ETH_VLAN_STRIP_OFFLOAD 0x0001 /**< VLAN Strip On/Off */
448 #define ETH_VLAN_FILTER_OFFLOAD 0x0002 /**< VLAN Filter On/Off */
449 #define ETH_VLAN_EXTEND_OFFLOAD 0x0004 /**< VLAN Extend On/Off */
451 /* Definitions used for mask VLAN setting */
452 #define ETH_VLAN_STRIP_MASK 0x0001 /**< VLAN Strip setting mask */
453 #define ETH_VLAN_FILTER_MASK 0x0002 /**< VLAN Filter setting mask*/
454 #define ETH_VLAN_EXTEND_MASK 0x0004 /**< VLAN Extend setting mask*/
455 #define ETH_VLAN_ID_MAX 0x0FFF /**< VLAN ID is in lower 12 bits*/
457 /* Definitions used for receive MAC address */
458 #define ETH_NUM_RECEIVE_MAC_ADDR 128 /**< Maximum nb. of receive mac addr. */
460 /* Definitions used for unicast hash */
461 #define ETH_VMDQ_NUM_UC_HASH_ARRAY 128 /**< Maximum nb. of UC hash array. */
463 /* Definitions used for VMDQ pool rx mode setting */
464 #define ETH_VMDQ_ACCEPT_UNTAG 0x0001 /**< accept untagged packets. */
465 #define ETH_VMDQ_ACCEPT_HASH_MC 0x0002 /**< accept packets in multicast table . */
466 #define ETH_VMDQ_ACCEPT_HASH_UC 0x0004 /**< accept packets in unicast table. */
467 #define ETH_VMDQ_ACCEPT_BROADCAST 0x0008 /**< accept broadcast packets. */
468 #define ETH_VMDQ_ACCEPT_MULTICAST 0x0010 /**< multicast promiscuous. */
470 /** Maximum nb. of vlan per mirror rule */
471 #define ETH_MIRROR_MAX_VLANS 64
473 #define ETH_MIRROR_VIRTUAL_POOL_UP 0x01 /**< Virtual Pool uplink Mirroring. */
474 #define ETH_MIRROR_UPLINK_PORT 0x02 /**< Uplink Port Mirroring. */
475 #define ETH_MIRROR_DOWNLINK_PORT 0x04 /**< Downlink Port Mirroring. */
476 #define ETH_MIRROR_VLAN 0x08 /**< VLAN Mirroring. */
477 #define ETH_MIRROR_VIRTUAL_POOL_DOWN 0x10 /**< Virtual Pool downlink Mirroring. */
480 * A structure used to configure VLAN traffic mirror of an Ethernet port.
482 struct rte_eth_vlan_mirror {
483 uint64_t vlan_mask; /**< mask for valid VLAN ID. */
484 /** VLAN ID list for vlan mirroring. */
485 uint16_t vlan_id[ETH_MIRROR_MAX_VLANS];
489 * A structure used to configure traffic mirror of an Ethernet port.
491 struct rte_eth_mirror_conf {
492 uint8_t rule_type; /**< Mirroring rule type */
493 uint8_t dst_pool; /**< Destination pool for this mirror rule. */
494 uint64_t pool_mask; /**< Bitmap of pool for pool mirroring */
495 /** VLAN ID setting for VLAN mirroring. */
496 struct rte_eth_vlan_mirror vlan;
500 * A structure used to configure 64 entries of Redirection Table of the
501 * Receive Side Scaling (RSS) feature of an Ethernet port. To configure
502 * more than 64 entries supported by hardware, an array of this structure
505 struct rte_eth_rss_reta_entry64 {
507 /**< Mask bits indicate which entries need to be updated/queried. */
508 uint8_t reta[RTE_RETA_GROUP_SIZE];
509 /**< Group of 64 redirection table entries. */
513 * This enum indicates the possible number of traffic classes
514 * in DCB configratioins
516 enum rte_eth_nb_tcs {
517 ETH_4_TCS = 4, /**< 4 TCs with DCB. */
518 ETH_8_TCS = 8 /**< 8 TCs with DCB. */
522 * This enum indicates the possible number of queue pools
523 * in VMDQ configurations.
525 enum rte_eth_nb_pools {
526 ETH_8_POOLS = 8, /**< 8 VMDq pools. */
527 ETH_16_POOLS = 16, /**< 16 VMDq pools. */
528 ETH_32_POOLS = 32, /**< 32 VMDq pools. */
529 ETH_64_POOLS = 64 /**< 64 VMDq pools. */
532 /* This structure may be extended in future. */
533 struct rte_eth_dcb_rx_conf {
534 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs */
535 uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
536 /**< Possible DCB queue,4 or 8. */
539 struct rte_eth_vmdq_dcb_tx_conf {
540 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools. */
541 uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
542 /**< Possible DCB queue,4 or 8. */
545 struct rte_eth_dcb_tx_conf {
546 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs. */
547 uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
548 /**< Possible DCB queue,4 or 8. */
551 struct rte_eth_vmdq_tx_conf {
552 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq mode, 64 pools. */
556 * A structure used to configure the VMDQ+DCB feature
557 * of an Ethernet port.
559 * Using this feature, packets are routed to a pool of queues, based
560 * on the vlan id in the vlan tag, and then to a specific queue within
561 * that pool, using the user priority vlan tag field.
563 * A default pool may be used, if desired, to route all traffic which
564 * does not match the vlan filter rules.
566 struct rte_eth_vmdq_dcb_conf {
567 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools */
568 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
569 uint8_t default_pool; /**< The default pool, if applicable */
570 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
572 uint16_t vlan_id; /**< The vlan id of the received frame */
573 uint64_t pools; /**< Bitmask of pools for packet rx */
574 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
575 uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
576 /**< Selects a queue in a pool */
579 struct rte_eth_vmdq_rx_conf {
580 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq only mode, 8 or 64 pools */
581 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
582 uint8_t default_pool; /**< The default pool, if applicable */
583 uint8_t enable_loop_back; /**< Enable VT loop back */
584 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
585 uint32_t rx_mode; /**< Flags from ETH_VMDQ_ACCEPT_* */
587 uint16_t vlan_id; /**< The vlan id of the received frame */
588 uint64_t pools; /**< Bitmask of pools for packet rx */
589 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
593 * A structure used to configure the TX features of an Ethernet port.
595 struct rte_eth_txmode {
596 enum rte_eth_tx_mq_mode mq_mode; /**< TX multi-queues mode. */
598 /* For i40e specifically */
600 uint8_t hw_vlan_reject_tagged : 1,
601 /**< If set, reject sending out tagged pkts */
602 hw_vlan_reject_untagged : 1,
603 /**< If set, reject sending out untagged pkts */
604 hw_vlan_insert_pvid : 1;
605 /**< If set, enable port based VLAN insertion */
609 * A structure used to configure an RX ring of an Ethernet port.
611 struct rte_eth_rxconf {
612 struct rte_eth_thresh rx_thresh; /**< RX ring threshold registers. */
613 uint16_t rx_free_thresh; /**< Drives the freeing of RX descriptors. */
614 uint8_t rx_drop_en; /**< Drop packets if no descriptors are available. */
615 uint8_t rx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
618 #define ETH_TXQ_FLAGS_NOMULTSEGS 0x0001 /**< nb_segs=1 for all mbufs */
619 #define ETH_TXQ_FLAGS_NOREFCOUNT 0x0002 /**< refcnt can be ignored */
620 #define ETH_TXQ_FLAGS_NOMULTMEMP 0x0004 /**< all bufs come from same mempool */
621 #define ETH_TXQ_FLAGS_NOVLANOFFL 0x0100 /**< disable VLAN offload */
622 #define ETH_TXQ_FLAGS_NOXSUMSCTP 0x0200 /**< disable SCTP checksum offload */
623 #define ETH_TXQ_FLAGS_NOXSUMUDP 0x0400 /**< disable UDP checksum offload */
624 #define ETH_TXQ_FLAGS_NOXSUMTCP 0x0800 /**< disable TCP checksum offload */
625 #define ETH_TXQ_FLAGS_NOOFFLOADS \
626 (ETH_TXQ_FLAGS_NOVLANOFFL | ETH_TXQ_FLAGS_NOXSUMSCTP | \
627 ETH_TXQ_FLAGS_NOXSUMUDP | ETH_TXQ_FLAGS_NOXSUMTCP)
628 #define ETH_TXQ_FLAGS_NOXSUMS \
629 (ETH_TXQ_FLAGS_NOXSUMSCTP | ETH_TXQ_FLAGS_NOXSUMUDP | \
630 ETH_TXQ_FLAGS_NOXSUMTCP)
632 * A structure used to configure a TX ring of an Ethernet port.
634 struct rte_eth_txconf {
635 struct rte_eth_thresh tx_thresh; /**< TX ring threshold registers. */
636 uint16_t tx_rs_thresh; /**< Drives the setting of RS bit on TXDs. */
637 uint16_t tx_free_thresh; /**< Start freeing TX buffers if there are
638 less free descriptors than this value. */
640 uint32_t txq_flags; /**< Set flags for the Tx queue */
641 uint8_t tx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
645 * This enum indicates the flow control mode
647 enum rte_eth_fc_mode {
648 RTE_FC_NONE = 0, /**< Disable flow control. */
649 RTE_FC_RX_PAUSE, /**< RX pause frame, enable flowctrl on TX side. */
650 RTE_FC_TX_PAUSE, /**< TX pause frame, enable flowctrl on RX side. */
651 RTE_FC_FULL /**< Enable flow control on both side. */
655 * A structure used to configure Ethernet flow control parameter.
656 * These parameters will be configured into the register of the NIC.
657 * Please refer to the corresponding data sheet for proper value.
659 struct rte_eth_fc_conf {
660 uint32_t high_water; /**< High threshold value to trigger XOFF */
661 uint32_t low_water; /**< Low threshold value to trigger XON */
662 uint16_t pause_time; /**< Pause quota in the Pause frame */
663 uint16_t send_xon; /**< Is XON frame need be sent */
664 enum rte_eth_fc_mode mode; /**< Link flow control mode */
665 uint8_t mac_ctrl_frame_fwd; /**< Forward MAC control frames */
666 uint8_t autoneg; /**< Use Pause autoneg */
670 * A structure used to configure Ethernet priority flow control parameter.
671 * These parameters will be configured into the register of the NIC.
672 * Please refer to the corresponding data sheet for proper value.
674 struct rte_eth_pfc_conf {
675 struct rte_eth_fc_conf fc; /**< General flow control parameter. */
676 uint8_t priority; /**< VLAN User Priority. */
680 * Memory space that can be configured to store Flow Director filters
681 * in the board memory.
683 enum rte_fdir_pballoc_type {
684 RTE_FDIR_PBALLOC_64K = 0, /**< 64k. */
685 RTE_FDIR_PBALLOC_128K, /**< 128k. */
686 RTE_FDIR_PBALLOC_256K, /**< 256k. */
690 * Select report mode of FDIR hash information in RX descriptors.
692 enum rte_fdir_status_mode {
693 RTE_FDIR_NO_REPORT_STATUS = 0, /**< Never report FDIR hash. */
694 RTE_FDIR_REPORT_STATUS, /**< Only report FDIR hash for matching pkts. */
695 RTE_FDIR_REPORT_STATUS_ALWAYS, /**< Always report FDIR hash. */
699 * A structure used to configure the Flow Director (FDIR) feature
700 * of an Ethernet port.
702 * If mode is RTE_FDIR_DISABLE, the pballoc value is ignored.
704 struct rte_fdir_conf {
705 enum rte_fdir_mode mode; /**< Flow Director mode. */
706 enum rte_fdir_pballoc_type pballoc; /**< Space for FDIR filters. */
707 enum rte_fdir_status_mode status; /**< How to report FDIR hash. */
708 /** RX queue of packets matching a "drop" filter in perfect mode. */
710 struct rte_eth_fdir_masks mask;
711 struct rte_eth_fdir_flex_conf flex_conf;
712 /**< Flex payload configuration. */
716 * UDP tunneling configuration.
718 struct rte_eth_udp_tunnel {
724 * Possible l4type of FDIR filters.
727 RTE_FDIR_L4TYPE_NONE = 0, /**< None. */
728 RTE_FDIR_L4TYPE_UDP, /**< UDP. */
729 RTE_FDIR_L4TYPE_TCP, /**< TCP. */
730 RTE_FDIR_L4TYPE_SCTP, /**< SCTP. */
734 * Select IPv4 or IPv6 FDIR filters.
737 RTE_FDIR_IPTYPE_IPV4 = 0, /**< IPv4. */
738 RTE_FDIR_IPTYPE_IPV6 , /**< IPv6. */
742 * A structure used to define a FDIR packet filter.
744 struct rte_fdir_filter {
745 uint16_t flex_bytes; /**< Flex bytes value to match. */
746 uint16_t vlan_id; /**< VLAN ID value to match, 0 otherwise. */
747 uint16_t port_src; /**< Source port to match, 0 otherwise. */
748 uint16_t port_dst; /**< Destination port to match, 0 otherwise. */
750 uint32_t ipv4_addr; /**< IPv4 source address to match. */
751 uint32_t ipv6_addr[4]; /**< IPv6 source address to match. */
752 } ip_src; /**< IPv4/IPv6 source address to match (union of above). */
754 uint32_t ipv4_addr; /**< IPv4 destination address to match. */
755 uint32_t ipv6_addr[4]; /**< IPv6 destination address to match */
756 } ip_dst; /**< IPv4/IPv6 destination address to match (union of above). */
757 enum rte_l4type l4type; /**< l4type to match: NONE/UDP/TCP/SCTP. */
758 enum rte_iptype iptype; /**< IP packet type to match: IPv4 or IPv6. */
762 * A structure used to configure FDIR masks that are used by the device
763 * to match the various fields of RX packet headers.
764 * @note The only_ip_flow field has the opposite meaning compared to other
767 struct rte_fdir_masks {
768 /** When set to 1, packet l4type is \b NOT relevant in filters, and
769 source and destination port masks must be set to zero. */
770 uint8_t only_ip_flow;
771 /** If set to 1, vlan_id is relevant in filters. */
773 /** If set to 1, vlan_prio is relevant in filters. */
775 /** If set to 1, flexbytes is relevant in filters. */
777 /** If set to 1, set the IPv6 masks. Otherwise set the IPv4 masks. */
778 uint8_t set_ipv6_mask;
779 /** When set to 1, comparison of destination IPv6 address with IP6AT
780 registers is meaningful. */
781 uint8_t comp_ipv6_dst;
782 /** Mask of Destination IPv4 Address. All bits set to 1 define the
783 relevant bits to use in the destination address of an IPv4 packet
784 when matching it against FDIR filters. */
785 uint32_t dst_ipv4_mask;
786 /** Mask of Source IPv4 Address. All bits set to 1 define
787 the relevant bits to use in the source address of an IPv4 packet
788 when matching it against FDIR filters. */
789 uint32_t src_ipv4_mask;
790 /** Mask of Source IPv6 Address. All bits set to 1 define the
791 relevant BYTES to use in the source address of an IPv6 packet
792 when matching it against FDIR filters. */
793 uint16_t dst_ipv6_mask;
794 /** Mask of Destination IPv6 Address. All bits set to 1 define the
795 relevant BYTES to use in the destination address of an IPv6 packet
796 when matching it against FDIR filters. */
797 uint16_t src_ipv6_mask;
798 /** Mask of Source Port. All bits set to 1 define the relevant
799 bits to use in the source port of an IP packets when matching it
800 against FDIR filters. */
801 uint16_t src_port_mask;
802 /** Mask of Destination Port. All bits set to 1 define the relevant
803 bits to use in the destination port of an IP packet when matching it
804 against FDIR filters. */
805 uint16_t dst_port_mask;
809 * A structure used to report the status of the flow director filters in use.
811 struct rte_eth_fdir {
812 /** Number of filters with collision indication. */
814 /** Number of free (non programmed) filters. */
816 /** The Lookup hash value of the added filter that updated the value
817 of the MAXLEN field */
819 /** Longest linked list of filters in the table. */
821 /** Number of added filters. */
823 /** Number of removed filters. */
825 /** Number of failed added filters (no more space in device). */
827 /** Number of failed removed filters. */
832 * A structure used to enable/disable specific device interrupts.
834 struct rte_intr_conf {
835 /** enable/disable lsc interrupt. 0 (default) - disable, 1 enable */
840 * A structure used to configure an Ethernet port.
841 * Depending upon the RX multi-queue mode, extra advanced
842 * configuration settings may be needed.
844 struct rte_eth_conf {
846 /**< ETH_LINK_SPEED_10[0|00|000], or 0 for autonegotation */
847 uint16_t link_duplex;
848 /**< ETH_LINK_[HALF_DUPLEX|FULL_DUPLEX], or 0 for autonegotation */
849 struct rte_eth_rxmode rxmode; /**< Port RX configuration. */
850 struct rte_eth_txmode txmode; /**< Port TX configuration. */
851 uint32_t lpbk_mode; /**< Loopback operation mode. By default the value
852 is 0, meaning the loopback mode is disabled.
853 Read the datasheet of given ethernet controller
854 for details. The possible values of this field
855 are defined in implementation of each driver. */
857 struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
858 struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
859 /**< Port vmdq+dcb configuration. */
860 struct rte_eth_dcb_rx_conf dcb_rx_conf;
861 /**< Port dcb RX configuration. */
862 struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
863 /**< Port vmdq RX configuration. */
864 } rx_adv_conf; /**< Port RX filtering configuration (union). */
866 struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
867 /**< Port vmdq+dcb TX configuration. */
868 struct rte_eth_dcb_tx_conf dcb_tx_conf;
869 /**< Port dcb TX configuration. */
870 struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
871 /**< Port vmdq TX configuration. */
872 } tx_adv_conf; /**< Port TX DCB configuration (union). */
873 /** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
874 is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
875 uint32_t dcb_capability_en;
876 struct rte_fdir_conf fdir_conf; /**< FDIR configuration. */
877 struct rte_intr_conf intr_conf; /**< Interrupt mode configuration. */
881 * A structure used to retrieve the contextual information of
882 * an Ethernet device, such as the controlling driver of the device,
883 * its PCI context, etc...
887 * RX offload capabilities of a device.
889 #define DEV_RX_OFFLOAD_VLAN_STRIP 0x00000001
890 #define DEV_RX_OFFLOAD_IPV4_CKSUM 0x00000002
891 #define DEV_RX_OFFLOAD_UDP_CKSUM 0x00000004
892 #define DEV_RX_OFFLOAD_TCP_CKSUM 0x00000008
893 #define DEV_RX_OFFLOAD_TCP_LRO 0x00000010
894 #define DEV_RX_OFFLOAD_QINQ_STRIP 0x00000020
897 * TX offload capabilities of a device.
899 #define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001
900 #define DEV_TX_OFFLOAD_IPV4_CKSUM 0x00000002
901 #define DEV_TX_OFFLOAD_UDP_CKSUM 0x00000004
902 #define DEV_TX_OFFLOAD_TCP_CKSUM 0x00000008
903 #define DEV_TX_OFFLOAD_SCTP_CKSUM 0x00000010
904 #define DEV_TX_OFFLOAD_TCP_TSO 0x00000020
905 #define DEV_TX_OFFLOAD_UDP_TSO 0x00000040
906 #define DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000080 /**< Used for tunneling packet. */
907 #define DEV_TX_OFFLOAD_QINQ_INSERT 0x00000100
909 struct rte_eth_dev_info {
910 struct rte_pci_device *pci_dev; /**< Device PCI information. */
911 const char *driver_name; /**< Device Driver name. */
912 unsigned int if_index; /**< Index to bound host interface, or 0 if none.
913 Use if_indextoname() to translate into an interface name. */
914 uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
915 uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
916 uint16_t max_rx_queues; /**< Maximum number of RX queues. */
917 uint16_t max_tx_queues; /**< Maximum number of TX queues. */
918 uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
919 uint32_t max_hash_mac_addrs;
920 /** Maximum number of hash MAC addresses for MTA and UTA. */
921 uint16_t max_vfs; /**< Maximum number of VFs. */
922 uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
923 uint32_t rx_offload_capa; /**< Device RX offload capabilities. */
924 uint32_t tx_offload_capa; /**< Device TX offload capabilities. */
926 /**< Device redirection table size, the total number of entries. */
927 uint8_t hash_key_size; /**< Hash key size in bytes */
928 /** Bit mask of RSS offloads, the bit offset also means flow type */
929 uint64_t flow_type_rss_offloads;
930 struct rte_eth_rxconf default_rxconf; /**< Default RX configuration */
931 struct rte_eth_txconf default_txconf; /**< Default TX configuration */
932 uint16_t vmdq_queue_base; /**< First queue ID for VMDQ pools. */
933 uint16_t vmdq_queue_num; /**< Queue number for VMDQ pools. */
934 uint16_t vmdq_pool_base; /**< First ID of VMDQ pools. */
937 /** Maximum name length for extended statistics counters */
938 #define RTE_ETH_XSTATS_NAME_SIZE 64
941 * An Ethernet device extended statistic structure
943 * This structure is used by ethdev->eth_xstats_get() to provide
944 * statistics that are not provided in the generic rte_eth_stats
947 struct rte_eth_xstats {
948 char name[RTE_ETH_XSTATS_NAME_SIZE];
954 struct rte_eth_dev_callback;
955 /** @internal Structure to keep track of registered callbacks */
956 TAILQ_HEAD(rte_eth_dev_cb_list, rte_eth_dev_callback);
959 * Definitions of all functions exported by an Ethernet driver through the
960 * the generic structure of type *eth_dev_ops* supplied in the *rte_eth_dev*
961 * structure associated with an Ethernet device.
964 typedef int (*eth_dev_configure_t)(struct rte_eth_dev *dev);
965 /**< @internal Ethernet device configuration. */
967 typedef int (*eth_dev_start_t)(struct rte_eth_dev *dev);
968 /**< @internal Function used to start a configured Ethernet device. */
970 typedef void (*eth_dev_stop_t)(struct rte_eth_dev *dev);
971 /**< @internal Function used to stop a configured Ethernet device. */
973 typedef int (*eth_dev_set_link_up_t)(struct rte_eth_dev *dev);
974 /**< @internal Function used to link up a configured Ethernet device. */
976 typedef int (*eth_dev_set_link_down_t)(struct rte_eth_dev *dev);
977 /**< @internal Function used to link down a configured Ethernet device. */
979 typedef void (*eth_dev_close_t)(struct rte_eth_dev *dev);
980 /**< @internal Function used to close a configured Ethernet device. */
982 typedef void (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev);
983 /**< @internal Function used to enable the RX promiscuous mode of an Ethernet device. */
985 typedef void (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev);
986 /**< @internal Function used to disable the RX promiscuous mode of an Ethernet device. */
988 typedef void (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
989 /**< @internal Enable the receipt of all multicast packets by an Ethernet device. */
991 typedef void (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
992 /**< @internal Disable the receipt of all multicast packets by an Ethernet device. */
994 typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
995 int wait_to_complete);
996 /**< @internal Get link speed, duplex mode and state (up/down) of an Ethernet device. */
998 typedef void (*eth_stats_get_t)(struct rte_eth_dev *dev,
999 struct rte_eth_stats *igb_stats);
1000 /**< @internal Get global I/O statistics of an Ethernet device. */
1002 typedef void (*eth_stats_reset_t)(struct rte_eth_dev *dev);
1003 /**< @internal Reset global I/O statistics of an Ethernet device to 0. */
1005 typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev,
1006 struct rte_eth_xstats *stats, unsigned n);
1007 /**< @internal Get extended stats of an Ethernet device. */
1009 typedef void (*eth_xstats_reset_t)(struct rte_eth_dev *dev);
1010 /**< @internal Reset extended stats of an Ethernet device. */
1012 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
1016 /**< @internal Set a queue statistics mapping for a tx/rx queue of an Ethernet device. */
1018 typedef void (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
1019 struct rte_eth_dev_info *dev_info);
1020 /**< @internal Get specific informations of an Ethernet device. */
1022 typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
1024 /**< @internal Start rx and tx of a queue of an Ethernet device. */
1026 typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
1028 /**< @internal Stop rx and tx of a queue of an Ethernet device. */
1030 typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
1031 uint16_t rx_queue_id,
1032 uint16_t nb_rx_desc,
1033 unsigned int socket_id,
1034 const struct rte_eth_rxconf *rx_conf,
1035 struct rte_mempool *mb_pool);
1036 /**< @internal Set up a receive queue of an Ethernet device. */
1038 typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
1039 uint16_t tx_queue_id,
1040 uint16_t nb_tx_desc,
1041 unsigned int socket_id,
1042 const struct rte_eth_txconf *tx_conf);
1043 /**< @internal Setup a transmit queue of an Ethernet device. */
1045 typedef void (*eth_queue_release_t)(void *queue);
1046 /**< @internal Release memory resources allocated by given RX/TX queue. */
1048 typedef uint32_t (*eth_rx_queue_count_t)(struct rte_eth_dev *dev,
1049 uint16_t rx_queue_id);
1050 /**< @internal Get number of available descriptors on a receive queue of an Ethernet device. */
1052 typedef int (*eth_rx_descriptor_done_t)(void *rxq, uint16_t offset);
1053 /**< @internal Check DD bit of specific RX descriptor */
1055 typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);
1056 /**< @internal Set MTU. */
1058 typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
1061 /**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */
1063 typedef void (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
1065 /**< @internal set the outer VLAN-TPID by an Ethernet device. */
1067 typedef void (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
1068 /**< @internal set VLAN offload function by an Ethernet device. */
1070 typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
1073 /**< @internal set port based TX VLAN insertion by an Ethernet device. */
1075 typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
1076 uint16_t rx_queue_id,
1078 /**< @internal VLAN stripping enable/disable by an queue of Ethernet device. */
1080 typedef uint16_t (*eth_rx_burst_t)(void *rxq,
1081 struct rte_mbuf **rx_pkts,
1083 /**< @internal Retrieve input packets from a receive queue of an Ethernet device. */
1085 typedef uint16_t (*eth_tx_burst_t)(void *txq,
1086 struct rte_mbuf **tx_pkts,
1088 /**< @internal Send output packets on a transmit queue of an Ethernet device. */
1090 typedef int (*fdir_add_signature_filter_t)(struct rte_eth_dev *dev,
1091 struct rte_fdir_filter *fdir_ftr,
1093 /**< @internal Setup a new signature filter rule on an Ethernet device */
1095 typedef int (*fdir_update_signature_filter_t)(struct rte_eth_dev *dev,
1096 struct rte_fdir_filter *fdir_ftr,
1098 /**< @internal Update a signature filter rule on an Ethernet device */
1100 typedef int (*fdir_remove_signature_filter_t)(struct rte_eth_dev *dev,
1101 struct rte_fdir_filter *fdir_ftr);
1102 /**< @internal Remove a signature filter rule on an Ethernet device */
1104 typedef void (*fdir_infos_get_t)(struct rte_eth_dev *dev,
1105 struct rte_eth_fdir *fdir);
1106 /**< @internal Get information about fdir status */
1108 typedef int (*fdir_add_perfect_filter_t)(struct rte_eth_dev *dev,
1109 struct rte_fdir_filter *fdir_ftr,
1110 uint16_t soft_id, uint8_t rx_queue,
1112 /**< @internal Setup a new perfect filter rule on an Ethernet device */
1114 typedef int (*fdir_update_perfect_filter_t)(struct rte_eth_dev *dev,
1115 struct rte_fdir_filter *fdir_ftr,
1116 uint16_t soft_id, uint8_t rx_queue,
1118 /**< @internal Update a perfect filter rule on an Ethernet device */
1120 typedef int (*fdir_remove_perfect_filter_t)(struct rte_eth_dev *dev,
1121 struct rte_fdir_filter *fdir_ftr,
1123 /**< @internal Remove a perfect filter rule on an Ethernet device */
1125 typedef int (*fdir_set_masks_t)(struct rte_eth_dev *dev,
1126 struct rte_fdir_masks *fdir_masks);
1127 /**< @internal Setup flow director masks on an Ethernet device */
1129 typedef int (*flow_ctrl_get_t)(struct rte_eth_dev *dev,
1130 struct rte_eth_fc_conf *fc_conf);
1131 /**< @internal Get current flow control parameter on an Ethernet device */
1133 typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
1134 struct rte_eth_fc_conf *fc_conf);
1135 /**< @internal Setup flow control parameter on an Ethernet device */
1137 typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
1138 struct rte_eth_pfc_conf *pfc_conf);
1139 /**< @internal Setup priority flow control parameter on an Ethernet device */
1141 typedef int (*reta_update_t)(struct rte_eth_dev *dev,
1142 struct rte_eth_rss_reta_entry64 *reta_conf,
1143 uint16_t reta_size);
1144 /**< @internal Update RSS redirection table on an Ethernet device */
1146 typedef int (*reta_query_t)(struct rte_eth_dev *dev,
1147 struct rte_eth_rss_reta_entry64 *reta_conf,
1148 uint16_t reta_size);
1149 /**< @internal Query RSS redirection table on an Ethernet device */
1151 typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
1152 struct rte_eth_rss_conf *rss_conf);
1153 /**< @internal Update RSS hash configuration of an Ethernet device */
1155 typedef int (*rss_hash_conf_get_t)(struct rte_eth_dev *dev,
1156 struct rte_eth_rss_conf *rss_conf);
1157 /**< @internal Get current RSS hash configuration of an Ethernet device */
1159 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
1160 /**< @internal Turn on SW controllable LED on an Ethernet device */
1162 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
1163 /**< @internal Turn off SW controllable LED on an Ethernet device */
1165 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
1166 /**< @internal Remove MAC address from receive address register */
1168 typedef void (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
1169 struct ether_addr *mac_addr,
1172 /**< @internal Set a MAC address into Receive Address Address Register */
1174 typedef void (*eth_mac_addr_set_t)(struct rte_eth_dev *dev,
1175 struct ether_addr *mac_addr);
1176 /**< @internal Set a MAC address into Receive Address Address Register */
1178 typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
1179 struct ether_addr *mac_addr,
1181 /**< @internal Set a Unicast Hash bitmap */
1183 typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
1185 /**< @internal Set all Unicast Hash bitmap */
1187 typedef int (*eth_set_vf_rx_mode_t)(struct rte_eth_dev *dev,
1191 /**< @internal Set a VF receive mode */
1193 typedef int (*eth_set_vf_rx_t)(struct rte_eth_dev *dev,
1196 /**< @internal Set a VF receive mode */
1198 typedef int (*eth_set_vf_tx_t)(struct rte_eth_dev *dev,
1201 /**< @internal Enable or disable a VF transmit */
1203 typedef int (*eth_set_vf_vlan_filter_t)(struct rte_eth_dev *dev,
1207 /**< @internal Set VF VLAN pool filter */
1209 typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
1212 /**< @internal Set queue TX rate */
1214 typedef int (*eth_set_vf_rate_limit_t)(struct rte_eth_dev *dev,
1218 /**< @internal Set VF TX rate */
1220 typedef int (*eth_mirror_rule_set_t)(struct rte_eth_dev *dev,
1221 struct rte_eth_mirror_conf *mirror_conf,
1224 /**< @internal Add a traffic mirroring rule on an Ethernet device */
1226 typedef int (*eth_mirror_rule_reset_t)(struct rte_eth_dev *dev,
1228 /**< @internal Remove a traffic mirroring rule on an Ethernet device */
1230 typedef int (*eth_udp_tunnel_add_t)(struct rte_eth_dev *dev,
1231 struct rte_eth_udp_tunnel *tunnel_udp);
1232 /**< @internal Add tunneling UDP info */
1234 typedef int (*eth_udp_tunnel_del_t)(struct rte_eth_dev *dev,
1235 struct rte_eth_udp_tunnel *tunnel_udp);
1236 /**< @internal Delete tunneling UDP info */
1238 typedef int (*eth_set_mc_addr_list_t)(struct rte_eth_dev *dev,
1239 struct ether_addr *mc_addr_set,
1240 uint32_t nb_mc_addr);
1241 /**< @internal set the list of multicast addresses on an Ethernet device */
1243 #ifdef RTE_NIC_BYPASS
1246 RTE_BYPASS_MODE_NONE,
1247 RTE_BYPASS_MODE_NORMAL,
1248 RTE_BYPASS_MODE_BYPASS,
1249 RTE_BYPASS_MODE_ISOLATE,
1250 RTE_BYPASS_MODE_NUM,
1253 #define RTE_BYPASS_MODE_VALID(x) \
1254 ((x) > RTE_BYPASS_MODE_NONE && (x) < RTE_BYPASS_MODE_NUM)
1257 RTE_BYPASS_EVENT_NONE,
1258 RTE_BYPASS_EVENT_START,
1259 RTE_BYPASS_EVENT_OS_ON = RTE_BYPASS_EVENT_START,
1260 RTE_BYPASS_EVENT_POWER_ON,
1261 RTE_BYPASS_EVENT_OS_OFF,
1262 RTE_BYPASS_EVENT_POWER_OFF,
1263 RTE_BYPASS_EVENT_TIMEOUT,
1264 RTE_BYPASS_EVENT_NUM
1267 #define RTE_BYPASS_EVENT_VALID(x) \
1268 ((x) > RTE_BYPASS_EVENT_NONE && (x) < RTE_BYPASS_MODE_NUM)
1271 RTE_BYPASS_TMT_OFF, /* timeout disabled. */
1272 RTE_BYPASS_TMT_1_5_SEC, /* timeout for 1.5 seconds */
1273 RTE_BYPASS_TMT_2_SEC, /* timeout for 2 seconds */
1274 RTE_BYPASS_TMT_3_SEC, /* timeout for 3 seconds */
1275 RTE_BYPASS_TMT_4_SEC, /* timeout for 4 seconds */
1276 RTE_BYPASS_TMT_8_SEC, /* timeout for 8 seconds */
1277 RTE_BYPASS_TMT_16_SEC, /* timeout for 16 seconds */
1278 RTE_BYPASS_TMT_32_SEC, /* timeout for 32 seconds */
1282 #define RTE_BYPASS_TMT_VALID(x) \
1283 ((x) == RTE_BYPASS_TMT_OFF || \
1284 ((x) > RTE_BYPASS_TMT_OFF && (x) < RTE_BYPASS_TMT_NUM))
1286 typedef void (*bypass_init_t)(struct rte_eth_dev *dev);
1287 typedef int32_t (*bypass_state_set_t)(struct rte_eth_dev *dev, uint32_t *new_state);
1288 typedef int32_t (*bypass_state_show_t)(struct rte_eth_dev *dev, uint32_t *state);
1289 typedef int32_t (*bypass_event_set_t)(struct rte_eth_dev *dev, uint32_t state, uint32_t event);
1290 typedef int32_t (*bypass_event_show_t)(struct rte_eth_dev *dev, uint32_t event_shift, uint32_t *event);
1291 typedef int32_t (*bypass_wd_timeout_set_t)(struct rte_eth_dev *dev, uint32_t timeout);
1292 typedef int32_t (*bypass_wd_timeout_show_t)(struct rte_eth_dev *dev, uint32_t *wd_timeout);
1293 typedef int32_t (*bypass_ver_show_t)(struct rte_eth_dev *dev, uint32_t *ver);
1294 typedef int32_t (*bypass_wd_reset_t)(struct rte_eth_dev *dev);
1297 typedef int (*eth_filter_ctrl_t)(struct rte_eth_dev *dev,
1298 enum rte_filter_type filter_type,
1299 enum rte_filter_op filter_op,
1301 /**< @internal Take operations to assigned filter type on an Ethernet device */
1304 * @internal A structure containing the functions exported by an Ethernet driver.
1306 struct eth_dev_ops {
1307 eth_dev_configure_t dev_configure; /**< Configure device. */
1308 eth_dev_start_t dev_start; /**< Start device. */
1309 eth_dev_stop_t dev_stop; /**< Stop device. */
1310 eth_dev_set_link_up_t dev_set_link_up; /**< Device link up. */
1311 eth_dev_set_link_down_t dev_set_link_down; /**< Device link down. */
1312 eth_dev_close_t dev_close; /**< Close device. */
1313 eth_promiscuous_enable_t promiscuous_enable; /**< Promiscuous ON. */
1314 eth_promiscuous_disable_t promiscuous_disable;/**< Promiscuous OFF. */
1315 eth_allmulticast_enable_t allmulticast_enable;/**< RX multicast ON. */
1316 eth_allmulticast_disable_t allmulticast_disable;/**< RX multicast OF. */
1317 eth_link_update_t link_update; /**< Get device link state. */
1318 eth_stats_get_t stats_get; /**< Get generic device statistics. */
1319 eth_stats_reset_t stats_reset; /**< Reset generic device statistics. */
1320 eth_xstats_get_t xstats_get; /**< Get extended device statistics. */
1321 eth_xstats_reset_t xstats_reset; /**< Reset extended device statistics. */
1322 eth_queue_stats_mapping_set_t queue_stats_mapping_set;
1323 /**< Configure per queue stat counter mapping. */
1324 eth_dev_infos_get_t dev_infos_get; /**< Get device info. */
1325 mtu_set_t mtu_set; /**< Set MTU. */
1326 vlan_filter_set_t vlan_filter_set; /**< Filter VLAN Setup. */
1327 vlan_tpid_set_t vlan_tpid_set; /**< Outer VLAN TPID Setup. */
1328 vlan_strip_queue_set_t vlan_strip_queue_set; /**< VLAN Stripping on queue. */
1329 vlan_offload_set_t vlan_offload_set; /**< Set VLAN Offload. */
1330 vlan_pvid_set_t vlan_pvid_set; /**< Set port based TX VLAN insertion */
1331 eth_queue_start_t rx_queue_start;/**< Start RX for a queue.*/
1332 eth_queue_stop_t rx_queue_stop;/**< Stop RX for a queue.*/
1333 eth_queue_start_t tx_queue_start;/**< Start TX for a queue.*/
1334 eth_queue_stop_t tx_queue_stop;/**< Stop TX for a queue.*/
1335 eth_rx_queue_setup_t rx_queue_setup;/**< Set up device RX queue.*/
1336 eth_queue_release_t rx_queue_release;/**< Release RX queue.*/
1337 eth_rx_queue_count_t rx_queue_count; /**< Get Rx queue count. */
1338 eth_rx_descriptor_done_t rx_descriptor_done; /**< Check rxd DD bit */
1339 eth_tx_queue_setup_t tx_queue_setup;/**< Set up device TX queue.*/
1340 eth_queue_release_t tx_queue_release;/**< Release TX queue.*/
1341 eth_dev_led_on_t dev_led_on; /**< Turn on LED. */
1342 eth_dev_led_off_t dev_led_off; /**< Turn off LED. */
1343 flow_ctrl_get_t flow_ctrl_get; /**< Get flow control. */
1344 flow_ctrl_set_t flow_ctrl_set; /**< Setup flow control. */
1345 priority_flow_ctrl_set_t priority_flow_ctrl_set; /**< Setup priority flow control.*/
1346 eth_mac_addr_remove_t mac_addr_remove; /**< Remove MAC address */
1347 eth_mac_addr_add_t mac_addr_add; /**< Add a MAC address */
1348 eth_mac_addr_set_t mac_addr_set; /**< Set a MAC address */
1349 eth_uc_hash_table_set_t uc_hash_table_set; /**< Set Unicast Table Array */
1350 eth_uc_all_hash_table_set_t uc_all_hash_table_set; /**< Set Unicast hash bitmap */
1351 eth_mirror_rule_set_t mirror_rule_set; /**< Add a traffic mirror rule.*/
1352 eth_mirror_rule_reset_t mirror_rule_reset; /**< reset a traffic mirror rule.*/
1353 eth_set_vf_rx_mode_t set_vf_rx_mode; /**< Set VF RX mode */
1354 eth_set_vf_rx_t set_vf_rx; /**< enable/disable a VF receive */
1355 eth_set_vf_tx_t set_vf_tx; /**< enable/disable a VF transmit */
1356 eth_set_vf_vlan_filter_t set_vf_vlan_filter; /**< Set VF VLAN filter */
1357 eth_udp_tunnel_add_t udp_tunnel_add;
1358 eth_udp_tunnel_del_t udp_tunnel_del;
1359 eth_set_queue_rate_limit_t set_queue_rate_limit; /**< Set queue rate limit */
1360 eth_set_vf_rate_limit_t set_vf_rate_limit; /**< Set VF rate limit */
1362 /** Add a signature filter. */
1363 fdir_add_signature_filter_t fdir_add_signature_filter;
1364 /** Update a signature filter. */
1365 fdir_update_signature_filter_t fdir_update_signature_filter;
1366 /** Remove a signature filter. */
1367 fdir_remove_signature_filter_t fdir_remove_signature_filter;
1368 /** Get information about FDIR status. */
1369 fdir_infos_get_t fdir_infos_get;
1370 /** Add a perfect filter. */
1371 fdir_add_perfect_filter_t fdir_add_perfect_filter;
1372 /** Update a perfect filter. */
1373 fdir_update_perfect_filter_t fdir_update_perfect_filter;
1374 /** Remove a perfect filter. */
1375 fdir_remove_perfect_filter_t fdir_remove_perfect_filter;
1376 /** Setup masks for FDIR filtering. */
1377 fdir_set_masks_t fdir_set_masks;
1378 /** Update redirection table. */
1379 reta_update_t reta_update;
1380 /** Query redirection table. */
1381 reta_query_t reta_query;
1382 /* bypass control */
1383 #ifdef RTE_NIC_BYPASS
1384 bypass_init_t bypass_init;
1385 bypass_state_set_t bypass_state_set;
1386 bypass_state_show_t bypass_state_show;
1387 bypass_event_set_t bypass_event_set;
1388 bypass_event_show_t bypass_event_show;
1389 bypass_wd_timeout_set_t bypass_wd_timeout_set;
1390 bypass_wd_timeout_show_t bypass_wd_timeout_show;
1391 bypass_ver_show_t bypass_ver_show;
1392 bypass_wd_reset_t bypass_wd_reset;
1395 /** Configure RSS hash protocols. */
1396 rss_hash_update_t rss_hash_update;
1397 /** Get current RSS hash configuration. */
1398 rss_hash_conf_get_t rss_hash_conf_get;
1399 eth_filter_ctrl_t filter_ctrl; /**< common filter control*/
1400 eth_set_mc_addr_list_t set_mc_addr_list; /**< set list of mcast addrs */
1404 * Function type used for RX packet processing packet callbacks.
1406 * The callback function is called on RX with a burst of packets that have
1407 * been received on the given port and queue.
1410 * The Ethernet port on which RX is being performed.
1412 * The queue on the Ethernet port which is being used to receive the packets.
1414 * The burst of packets that have just been received.
1416 * The number of packets in the burst pointed to by "pkts".
1418 * The max number of packets that can be stored in the "pkts" array.
1420 * The arbitrary user parameter passed in by the application when the callback
1421 * was originally configured.
1423 * The number of packets returned to the user.
1425 typedef uint16_t (*rte_rx_callback_fn)(uint8_t port, uint16_t queue,
1426 struct rte_mbuf *pkts[], uint16_t nb_pkts, uint16_t max_pkts,
1430 * Function type used for TX packet processing packet callbacks.
1432 * The callback function is called on TX with a burst of packets immediately
1433 * before the packets are put onto the hardware queue for transmission.
1436 * The Ethernet port on which TX is being performed.
1438 * The queue on the Ethernet port which is being used to transmit the packets.
1440 * The burst of packets that are about to be transmitted.
1442 * The number of packets in the burst pointed to by "pkts".
1444 * The arbitrary user parameter passed in by the application when the callback
1445 * was originally configured.
1447 * The number of packets to be written to the NIC.
1449 typedef uint16_t (*rte_tx_callback_fn)(uint8_t port, uint16_t queue,
1450 struct rte_mbuf *pkts[], uint16_t nb_pkts, void *user_param);
1454 * Structure used to hold information about the callbacks to be called for a
1455 * queue on RX and TX.
1457 struct rte_eth_rxtx_callback {
1458 struct rte_eth_rxtx_callback *next;
1460 rte_rx_callback_fn rx;
1461 rte_tx_callback_fn tx;
1467 * The eth device type.
1469 enum rte_eth_dev_type {
1470 RTE_ETH_DEV_UNKNOWN, /**< unknown device type */
1472 /**< Physical function and Virtual function of PCI devices */
1473 RTE_ETH_DEV_VIRTUAL, /**< non hardware device */
1474 RTE_ETH_DEV_MAX /**< max value of this enum */
1479 * The generic data structure associated with each ethernet device.
1481 * Pointers to burst-oriented packet receive and transmit functions are
1482 * located at the beginning of the structure, along with the pointer to
1483 * where all the data elements for the particular device are stored in shared
1484 * memory. This split allows the function pointer and driver data to be per-
1485 * process, while the actual configuration data for the device is shared.
1487 struct rte_eth_dev {
1488 eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
1489 eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
1490 struct rte_eth_dev_data *data; /**< Pointer to device data */
1491 const struct eth_driver *driver;/**< Driver for this device */
1492 const struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
1493 struct rte_pci_device *pci_dev; /**< PCI info. supplied by probing */
1494 /** User application callbacks for NIC interrupts */
1495 struct rte_eth_dev_cb_list link_intr_cbs;
1497 * User-supplied functions called from rx_burst to post-process
1498 * received packets before passing them to the user
1500 struct rte_eth_rxtx_callback *post_rx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
1502 * User-supplied functions called from tx_burst to pre-process
1503 * received packets before passing them to the driver for transmission.
1505 struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
1506 uint8_t attached; /**< Flag indicating the port is attached */
1507 enum rte_eth_dev_type dev_type; /**< Flag indicating the device type */
1510 struct rte_eth_dev_sriov {
1511 uint8_t active; /**< SRIOV is active with 16, 32 or 64 pools */
1512 uint8_t nb_q_per_pool; /**< rx queue number per pool */
1513 uint16_t def_vmdq_idx; /**< Default pool num used for PF */
1514 uint16_t def_pool_q_idx; /**< Default pool queue start reg index */
1516 #define RTE_ETH_DEV_SRIOV(dev) ((dev)->data->sriov)
1518 #define RTE_ETH_NAME_MAX_LEN (32)
1522 * The data part, with no function pointers, associated with each ethernet device.
1524 * This structure is safe to place in shared memory to be common among different
1525 * processes in a multi-process configuration.
1527 struct rte_eth_dev_data {
1528 char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
1530 void **rx_queues; /**< Array of pointers to RX queues. */
1531 void **tx_queues; /**< Array of pointers to TX queues. */
1532 uint16_t nb_rx_queues; /**< Number of RX queues. */
1533 uint16_t nb_tx_queues; /**< Number of TX queues. */
1535 struct rte_eth_dev_sriov sriov; /**< SRIOV data */
1537 void *dev_private; /**< PMD-specific private data */
1539 struct rte_eth_link dev_link;
1540 /**< Link-level information & status */
1542 struct rte_eth_conf dev_conf; /**< Configuration applied to device. */
1543 uint16_t mtu; /**< Maximum Transmission Unit. */
1545 uint32_t min_rx_buf_size;
1546 /**< Common rx buffer size handled by all queues */
1548 uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
1549 struct ether_addr* mac_addrs;/**< Device Ethernet Link address. */
1550 uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
1551 /** bitmap array of associating Ethernet MAC addresses to pools */
1552 struct ether_addr* hash_mac_addrs;
1553 /** Device Ethernet MAC addresses of hash filtering. */
1554 uint8_t port_id; /**< Device [external] port identifier. */
1555 uint8_t promiscuous : 1, /**< RX promiscuous mode ON(1) / OFF(0). */
1556 scattered_rx : 1, /**< RX of scattered packets is ON(1) / OFF(0) */
1557 lro : 1, /**< RX LRO is ON(1) / OFF(0) */
1558 all_multicast : 1, /**< RX all multicast mode ON(1) / OFF(0). */
1559 dev_started : 1; /**< Device state: STARTED(1) / STOPPED(0). */
1564 * The pool of *rte_eth_dev* structures. The size of the pool
1565 * is configured at compile-time in the <rte_ethdev.c> file.
1567 extern struct rte_eth_dev rte_eth_devices[];
1570 * Get the total number of Ethernet devices that have been successfully
1571 * initialized by the [matching] Ethernet driver during the PCI probing phase.
1572 * All devices whose port identifier is in the range
1573 * [0, rte_eth_dev_count() - 1] can be operated on by network applications
1574 * immediately after invoking rte_eal_init().
1575 * If the application unplugs a port using hotplug function, The enabled port
1576 * numbers may be noncontiguous. In the case, the applications need to manage
1577 * enabled port by themselves.
1580 * - The total number of usable Ethernet devices.
1582 extern uint8_t rte_eth_dev_count(void);
1585 * Function for internal use by port hotplug functions.
1586 * Returns a ethdev slot specified by the unique identifier name.
1588 * The pointer to the Unique identifier name for each Ethernet device
1590 * - The pointer to the ethdev slot, on success. NULL on error
1592 extern struct rte_eth_dev *rte_eth_dev_allocated(const char *name);
1595 * Function for internal use by dummy drivers primarily, e.g. ring-based
1597 * Allocates a new ethdev slot for an ethernet device and returns the pointer
1598 * to that slot for the driver to use.
1600 * @param name Unique identifier name for each Ethernet device
1601 * @param type Device type of this Ethernet device
1603 * - Slot in the rte_dev_devices array for a new device;
1605 struct rte_eth_dev *rte_eth_dev_allocate(const char *name,
1606 enum rte_eth_dev_type type);
1609 * Function for internal use by dummy drivers primarily, e.g. ring-based
1611 * Release the specified ethdev port.
1614 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure.
1616 * - 0 on success, negative on error
1618 int rte_eth_dev_release_port(struct rte_eth_dev *eth_dev);
1621 * Attach a new Ethernet device specified by aruguments.
1624 * A pointer to a strings array describing the new device
1625 * to be attached. The strings should be a pci address like
1626 * '0000:01:00.0' or virtual device name like 'eth_pcap0'.
1628 * A pointer to a port identifier actually attached.
1630 * 0 on success and port_id is filled, negative on error
1632 int rte_eth_dev_attach(const char *devargs, uint8_t *port_id);
1635 * Detach a Ethernet device specified by port identifier.
1638 * The port identifier of the device to detach.
1640 * A pointer to a device name actually detached.
1642 * 0 on success and devname is filled, negative on error
1644 int rte_eth_dev_detach(uint8_t port_id, char *devname);
1649 * Initialization function of an Ethernet driver invoked for each matching
1650 * Ethernet PCI device detected during the PCI probing phase.
1653 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1654 * associated with the matching device and which have been [automatically]
1655 * allocated in the *rte_eth_devices* array.
1656 * The *eth_dev* structure is supplied to the driver initialization function
1657 * with the following fields already initialized:
1659 * - *pci_dev*: Holds the pointers to the *rte_pci_device* structure which
1660 * contains the generic PCI information of the matching device.
1662 * - *driver*: Holds the pointer to the *eth_driver* structure.
1664 * - *dev_private*: Holds a pointer to the device private data structure.
1666 * - *mtu*: Contains the default Ethernet maximum frame length (1500).
1668 * - *port_id*: Contains the port index of the device (actually the index
1669 * of the *eth_dev* structure in the *rte_eth_devices* array).
1672 * - 0: Success, the device is properly initialized by the driver.
1673 * In particular, the driver MUST have set up the *dev_ops* pointer
1674 * of the *eth_dev* structure.
1675 * - <0: Error code of the device initialization failure.
1677 typedef int (*eth_dev_init_t)(struct rte_eth_dev *eth_dev);
1681 * Finalization function of an Ethernet driver invoked for each matching
1682 * Ethernet PCI device detected during the PCI closing phase.
1685 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1686 * associated with the matching device and which have been [automatically]
1687 * allocated in the *rte_eth_devices* array.
1689 * - 0: Success, the device is properly finalized by the driver.
1690 * In particular, the driver MUST free the *dev_ops* pointer
1691 * of the *eth_dev* structure.
1692 * - <0: Error code of the device initialization failure.
1694 typedef int (*eth_dev_uninit_t)(struct rte_eth_dev *eth_dev);
1698 * The structure associated with a PMD Ethernet driver.
1700 * Each Ethernet driver acts as a PCI driver and is represented by a generic
1701 * *eth_driver* structure that holds:
1703 * - An *rte_pci_driver* structure (which must be the first field).
1705 * - The *eth_dev_init* function invoked for each matching PCI device.
1707 * - The *eth_dev_uninit* function invoked for each matching PCI device.
1709 * - The size of the private data to allocate for each matching device.
1712 struct rte_pci_driver pci_drv; /**< The PMD is also a PCI driver. */
1713 eth_dev_init_t eth_dev_init; /**< Device init function. */
1714 eth_dev_uninit_t eth_dev_uninit; /**< Device uninit function. */
1715 unsigned int dev_private_size; /**< Size of device private data. */
1720 * A function invoked by the initialization function of an Ethernet driver
1721 * to simultaneously register itself as a PCI driver and as an Ethernet
1722 * Poll Mode Driver (PMD).
1725 * The pointer to the *eth_driver* structure associated with
1726 * the Ethernet driver.
1728 extern void rte_eth_driver_register(struct eth_driver *eth_drv);
1731 * Configure an Ethernet device.
1732 * This function must be invoked first before any other function in the
1733 * Ethernet API. This function can also be re-invoked when a device is in the
1737 * The port identifier of the Ethernet device to configure.
1738 * @param nb_rx_queue
1739 * The number of receive queues to set up for the Ethernet device.
1740 * @param nb_tx_queue
1741 * The number of transmit queues to set up for the Ethernet device.
1743 * The pointer to the configuration data to be used for the Ethernet device.
1744 * The *rte_eth_conf* structure includes:
1745 * - the hardware offload features to activate, with dedicated fields for
1746 * each statically configurable offload hardware feature provided by
1747 * Ethernet devices, such as IP checksum or VLAN tag stripping for
1749 * - the Receive Side Scaling (RSS) configuration when using multiple RX
1752 * Embedding all configuration information in a single data structure
1753 * is the more flexible method that allows the addition of new features
1754 * without changing the syntax of the API.
1756 * - 0: Success, device configured.
1757 * - <0: Error code returned by the driver configuration function.
1759 extern int rte_eth_dev_configure(uint8_t port_id,
1760 uint16_t nb_rx_queue,
1761 uint16_t nb_tx_queue,
1762 const struct rte_eth_conf *eth_conf);
1765 * Allocate and set up a receive queue for an Ethernet device.
1767 * The function allocates a contiguous block of memory for *nb_rx_desc*
1768 * receive descriptors from a memory zone associated with *socket_id*
1769 * and initializes each receive descriptor with a network buffer allocated
1770 * from the memory pool *mb_pool*.
1773 * The port identifier of the Ethernet device.
1774 * @param rx_queue_id
1775 * The index of the receive queue to set up.
1776 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1777 * to rte_eth_dev_configure().
1779 * The number of receive descriptors to allocate for the receive ring.
1781 * The *socket_id* argument is the socket identifier in case of NUMA.
1782 * The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1783 * the DMA memory allocated for the receive descriptors of the ring.
1785 * The pointer to the configuration data to be used for the receive queue.
1786 * NULL value is allowed, in which case default RX configuration
1788 * The *rx_conf* structure contains an *rx_thresh* structure with the values
1789 * of the Prefetch, Host, and Write-Back threshold registers of the receive
1792 * The pointer to the memory pool from which to allocate *rte_mbuf* network
1793 * memory buffers to populate each descriptor of the receive ring.
1795 * - 0: Success, receive queue correctly set up.
1796 * - -EINVAL: The size of network buffers which can be allocated from the
1797 * memory pool does not fit the various buffer sizes allowed by the
1798 * device controller.
1799 * - -ENOMEM: Unable to allocate the receive ring descriptors or to
1800 * allocate network memory buffers from the memory pool when
1801 * initializing receive descriptors.
1803 extern int rte_eth_rx_queue_setup(uint8_t port_id, uint16_t rx_queue_id,
1804 uint16_t nb_rx_desc, unsigned int socket_id,
1805 const struct rte_eth_rxconf *rx_conf,
1806 struct rte_mempool *mb_pool);
1809 * Allocate and set up a transmit queue for an Ethernet device.
1812 * The port identifier of the Ethernet device.
1813 * @param tx_queue_id
1814 * The index of the transmit queue to set up.
1815 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1816 * to rte_eth_dev_configure().
1818 * The number of transmit descriptors to allocate for the transmit ring.
1820 * The *socket_id* argument is the socket identifier in case of NUMA.
1821 * Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1822 * the DMA memory allocated for the transmit descriptors of the ring.
1824 * The pointer to the configuration data to be used for the transmit queue.
1825 * NULL value is allowed, in which case default RX configuration
1827 * The *tx_conf* structure contains the following data:
1828 * - The *tx_thresh* structure with the values of the Prefetch, Host, and
1829 * Write-Back threshold registers of the transmit ring.
1830 * When setting Write-Back threshold to the value greater then zero,
1831 * *tx_rs_thresh* value should be explicitly set to one.
1832 * - The *tx_free_thresh* value indicates the [minimum] number of network
1833 * buffers that must be pending in the transmit ring to trigger their
1834 * [implicit] freeing by the driver transmit function.
1835 * - The *tx_rs_thresh* value indicates the [minimum] number of transmit
1836 * descriptors that must be pending in the transmit ring before setting the
1837 * RS bit on a descriptor by the driver transmit function.
1838 * The *tx_rs_thresh* value should be less or equal then
1839 * *tx_free_thresh* value, and both of them should be less then
1841 * - The *txq_flags* member contains flags to pass to the TX queue setup
1842 * function to configure the behavior of the TX queue. This should be set
1843 * to 0 if no special configuration is required.
1845 * Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces
1846 * the transmit function to use default values.
1848 * - 0: Success, the transmit queue is correctly set up.
1849 * - -ENOMEM: Unable to allocate the transmit ring descriptors.
1851 extern int rte_eth_tx_queue_setup(uint8_t port_id, uint16_t tx_queue_id,
1852 uint16_t nb_tx_desc, unsigned int socket_id,
1853 const struct rte_eth_txconf *tx_conf);
1856 * Return the NUMA socket to which an Ethernet device is connected
1859 * The port identifier of the Ethernet device
1861 * The NUMA socket id to which the Ethernet device is connected or
1862 * a default of zero if the socket could not be determined.
1863 * -1 is returned is the port_id value is out of range.
1865 extern int rte_eth_dev_socket_id(uint8_t port_id);
1868 * Allocate mbuf from mempool, setup the DMA physical address
1869 * and then start RX for specified queue of a port. It is used
1870 * when rx_deferred_start flag of the specified queue is true.
1873 * The port identifier of the Ethernet device
1874 * @param rx_queue_id
1875 * The index of the rx queue to update the ring.
1876 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1877 * to rte_eth_dev_configure().
1879 * - 0: Success, the transmit queue is correctly set up.
1880 * - -EINVAL: The port_id or the queue_id out of range.
1881 * - -ENOTSUP: The function not supported in PMD driver.
1883 extern int rte_eth_dev_rx_queue_start(uint8_t port_id, uint16_t rx_queue_id);
1886 * Stop specified RX queue of a port
1889 * The port identifier of the Ethernet device
1890 * @param rx_queue_id
1891 * The index of the rx queue to update the ring.
1892 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1893 * to rte_eth_dev_configure().
1895 * - 0: Success, the transmit queue is correctly set up.
1896 * - -EINVAL: The port_id or the queue_id out of range.
1897 * - -ENOTSUP: The function not supported in PMD driver.
1899 extern int rte_eth_dev_rx_queue_stop(uint8_t port_id, uint16_t rx_queue_id);
1902 * Start TX for specified queue of a port. It is used when tx_deferred_start
1903 * flag of the specified queue is true.
1906 * The port identifier of the Ethernet device
1907 * @param tx_queue_id
1908 * The index of the tx queue to update the ring.
1909 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1910 * to rte_eth_dev_configure().
1912 * - 0: Success, the transmit queue is correctly set up.
1913 * - -EINVAL: The port_id or the queue_id out of range.
1914 * - -ENOTSUP: The function not supported in PMD driver.
1916 extern int rte_eth_dev_tx_queue_start(uint8_t port_id, uint16_t tx_queue_id);
1919 * Stop specified TX queue of a port
1922 * The port identifier of the Ethernet device
1923 * @param tx_queue_id
1924 * The index of the tx queue to update the ring.
1925 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1926 * to rte_eth_dev_configure().
1928 * - 0: Success, the transmit queue is correctly set up.
1929 * - -EINVAL: The port_id or the queue_id out of range.
1930 * - -ENOTSUP: The function not supported in PMD driver.
1932 extern int rte_eth_dev_tx_queue_stop(uint8_t port_id, uint16_t tx_queue_id);
1937 * Start an Ethernet device.
1939 * The device start step is the last one and consists of setting the configured
1940 * offload features and in starting the transmit and the receive units of the
1942 * On success, all basic functions exported by the Ethernet API (link status,
1943 * receive/transmit, and so on) can be invoked.
1946 * The port identifier of the Ethernet device.
1948 * - 0: Success, Ethernet device started.
1949 * - <0: Error code of the driver device start function.
1951 extern int rte_eth_dev_start(uint8_t port_id);
1954 * Stop an Ethernet device. The device can be restarted with a call to
1955 * rte_eth_dev_start()
1958 * The port identifier of the Ethernet device.
1960 extern void rte_eth_dev_stop(uint8_t port_id);
1964 * Link up an Ethernet device.
1966 * Set device link up will re-enable the device rx/tx
1967 * functionality after it is previously set device linked down.
1970 * The port identifier of the Ethernet device.
1972 * - 0: Success, Ethernet device linked up.
1973 * - <0: Error code of the driver device link up function.
1975 extern int rte_eth_dev_set_link_up(uint8_t port_id);
1978 * Link down an Ethernet device.
1979 * The device rx/tx functionality will be disabled if success,
1980 * and it can be re-enabled with a call to
1981 * rte_eth_dev_set_link_up()
1984 * The port identifier of the Ethernet device.
1986 extern int rte_eth_dev_set_link_down(uint8_t port_id);
1989 * Close an Ethernet device. The device cannot be restarted!
1992 * The port identifier of the Ethernet device.
1994 extern void rte_eth_dev_close(uint8_t port_id);
1997 * Enable receipt in promiscuous mode for an Ethernet device.
2000 * The port identifier of the Ethernet device.
2002 extern void rte_eth_promiscuous_enable(uint8_t port_id);
2005 * Disable receipt in promiscuous mode for an Ethernet device.
2008 * The port identifier of the Ethernet device.
2010 extern void rte_eth_promiscuous_disable(uint8_t port_id);
2013 * Return the value of promiscuous mode for an Ethernet device.
2016 * The port identifier of the Ethernet device.
2018 * - (1) if promiscuous is enabled
2019 * - (0) if promiscuous is disabled.
2022 extern int rte_eth_promiscuous_get(uint8_t port_id);
2025 * Enable the receipt of any multicast frame by an Ethernet device.
2028 * The port identifier of the Ethernet device.
2030 extern void rte_eth_allmulticast_enable(uint8_t port_id);
2033 * Disable the receipt of all multicast frames by an Ethernet device.
2036 * The port identifier of the Ethernet device.
2038 extern void rte_eth_allmulticast_disable(uint8_t port_id);
2041 * Return the value of allmulticast mode for an Ethernet device.
2044 * The port identifier of the Ethernet device.
2046 * - (1) if allmulticast is enabled
2047 * - (0) if allmulticast is disabled.
2050 extern int rte_eth_allmulticast_get(uint8_t port_id);
2053 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2054 * or FULL-DUPLEX) of the physical link of an Ethernet device. It might need
2055 * to wait up to 9 seconds in it.
2058 * The port identifier of the Ethernet device.
2060 * A pointer to an *rte_eth_link* structure to be filled with
2061 * the status, the speed and the mode of the Ethernet device link.
2063 extern void rte_eth_link_get(uint8_t port_id, struct rte_eth_link *link);
2066 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2067 * or FULL-DUPLEX) of the physical link of an Ethernet device. It is a no-wait
2068 * version of rte_eth_link_get().
2071 * The port identifier of the Ethernet device.
2073 * A pointer to an *rte_eth_link* structure to be filled with
2074 * the status, the speed and the mode of the Ethernet device link.
2076 extern void rte_eth_link_get_nowait(uint8_t port_id,
2077 struct rte_eth_link *link);
2080 * Retrieve the general I/O statistics of an Ethernet device.
2083 * The port identifier of the Ethernet device.
2085 * A pointer to a structure of type *rte_eth_stats* to be filled with
2086 * the values of device counters for the following set of statistics:
2087 * - *ipackets* with the total of successfully received packets.
2088 * - *opackets* with the total of successfully transmitted packets.
2089 * - *ibytes* with the total of successfully received bytes.
2090 * - *obytes* with the total of successfully transmitted bytes.
2091 * - *ierrors* with the total of erroneous received packets.
2092 * - *oerrors* with the total of failed transmitted packets.
2094 * Zero if successful. Non-zero otherwise.
2096 extern int rte_eth_stats_get(uint8_t port_id, struct rte_eth_stats *stats);
2099 * Reset the general I/O statistics of an Ethernet device.
2102 * The port identifier of the Ethernet device.
2104 extern void rte_eth_stats_reset(uint8_t port_id);
2107 * Retrieve extended statistics of an Ethernet device.
2110 * The port identifier of the Ethernet device.
2112 * A pointer to a table of structure of type *rte_eth_xstats*
2113 * to be filled with device statistics names and values.
2114 * This parameter can be set to NULL if n is 0.
2116 * The size of the stats table, which should be large enough to store
2117 * all the statistics of the device.
2119 * - positive value lower or equal to n: success. The return value
2120 * is the number of entries filled in the stats table.
2121 * - positive value higher than n: error, the given statistics table
2122 * is too small. The return value corresponds to the size that should
2123 * be given to succeed. The entries in the table are not valid and
2124 * shall not be used by the caller.
2125 * - negative value on error (invalid port id)
2127 extern int rte_eth_xstats_get(uint8_t port_id,
2128 struct rte_eth_xstats *xstats, unsigned n);
2131 * Reset extended statistics of an Ethernet device.
2134 * The port identifier of the Ethernet device.
2136 extern void rte_eth_xstats_reset(uint8_t port_id);
2139 * Set a mapping for the specified transmit queue to the specified per-queue
2140 * statistics counter.
2143 * The port identifier of the Ethernet device.
2144 * @param tx_queue_id
2145 * The index of the transmit queue for which a queue stats mapping is required.
2146 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2147 * to rte_eth_dev_configure().
2149 * The per-queue packet statistics functionality number that the transmit
2150 * queue is to be assigned.
2151 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2153 * Zero if successful. Non-zero otherwise.
2155 extern int rte_eth_dev_set_tx_queue_stats_mapping(uint8_t port_id,
2156 uint16_t tx_queue_id,
2160 * Set a mapping for the specified receive queue to the specified per-queue
2161 * statistics counter.
2164 * The port identifier of the Ethernet device.
2165 * @param rx_queue_id
2166 * The index of the receive queue for which a queue stats mapping is required.
2167 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2168 * to rte_eth_dev_configure().
2170 * The per-queue packet statistics functionality number that the receive
2171 * queue is to be assigned.
2172 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2174 * Zero if successful. Non-zero otherwise.
2176 extern int rte_eth_dev_set_rx_queue_stats_mapping(uint8_t port_id,
2177 uint16_t rx_queue_id,
2181 * Retrieve the Ethernet address of an Ethernet device.
2184 * The port identifier of the Ethernet device.
2186 * A pointer to a structure of type *ether_addr* to be filled with
2187 * the Ethernet address of the Ethernet device.
2189 extern void rte_eth_macaddr_get(uint8_t port_id, struct ether_addr *mac_addr);
2192 * Retrieve the contextual information of an Ethernet device.
2195 * The port identifier of the Ethernet device.
2197 * A pointer to a structure of type *rte_eth_dev_info* to be filled with
2198 * the contextual information of the Ethernet device.
2200 extern void rte_eth_dev_info_get(uint8_t port_id,
2201 struct rte_eth_dev_info *dev_info);
2204 * Retrieve the MTU of an Ethernet device.
2207 * The port identifier of the Ethernet device.
2209 * A pointer to a uint16_t where the retrieved MTU is to be stored.
2211 * - (0) if successful.
2212 * - (-ENODEV) if *port_id* invalid.
2214 extern int rte_eth_dev_get_mtu(uint8_t port_id, uint16_t *mtu);
2217 * Change the MTU of an Ethernet device.
2220 * The port identifier of the Ethernet device.
2222 * A uint16_t for the MTU to be applied.
2224 * - (0) if successful.
2225 * - (-ENOTSUP) if operation is not supported.
2226 * - (-ENODEV) if *port_id* invalid.
2227 * - (-EINVAL) if *mtu* invalid.
2229 extern int rte_eth_dev_set_mtu(uint8_t port_id, uint16_t mtu);
2232 * Enable/Disable hardware filtering by an Ethernet device of received
2233 * VLAN packets tagged with a given VLAN Tag Identifier.
2236 * The port identifier of the Ethernet device.
2238 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
2240 * If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*.
2241 * Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*.
2243 * - (0) if successful.
2244 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2245 * - (-ENODEV) if *port_id* invalid.
2246 * - (-ENOSYS) if VLAN filtering on *port_id* disabled.
2247 * - (-EINVAL) if *vlan_id* > 4095.
2249 extern int rte_eth_dev_vlan_filter(uint8_t port_id, uint16_t vlan_id , int on);
2252 * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
2253 * 82599/X540/X550 can support VLAN stripping at the rx queue level
2256 * The port identifier of the Ethernet device.
2257 * @param rx_queue_id
2258 * The index of the receive queue for which a queue stats mapping is required.
2259 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2260 * to rte_eth_dev_configure().
2262 * If 1, Enable VLAN Stripping of the receive queue of the Ethernet port.
2263 * If 0, Disable VLAN Stripping of the receive queue of the Ethernet port.
2265 * - (0) if successful.
2266 * - (-ENOSUP) if hardware-assisted VLAN stripping not configured.
2267 * - (-ENODEV) if *port_id* invalid.
2268 * - (-EINVAL) if *rx_queue_id* invalid.
2270 extern int rte_eth_dev_set_vlan_strip_on_queue(uint8_t port_id,
2271 uint16_t rx_queue_id, int on);
2274 * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
2275 * the VLAN Header. This is a register setup available on some Intel NIC, not
2276 * but all, please check the data sheet for availability.
2279 * The port identifier of the Ethernet device.
2281 * The Tag Protocol ID
2283 * - (0) if successful.
2284 * - (-ENOSUP) if hardware-assisted VLAN TPID setup is not supported.
2285 * - (-ENODEV) if *port_id* invalid.
2287 extern int rte_eth_dev_set_vlan_ether_type(uint8_t port_id, uint16_t tag_type);
2290 * Set VLAN offload configuration on an Ethernet device
2291 * Enable/Disable Extended VLAN by an Ethernet device, This is a register setup
2292 * available on some Intel NIC, not but all, please check the data sheet for
2294 * Enable/Disable VLAN Strip can be done on rx queue for certain NIC, but here
2295 * the configuration is applied on the port level.
2298 * The port identifier of the Ethernet device.
2299 * @param offload_mask
2300 * The VLAN Offload bit mask can be mixed use with "OR"
2301 * ETH_VLAN_STRIP_OFFLOAD
2302 * ETH_VLAN_FILTER_OFFLOAD
2303 * ETH_VLAN_EXTEND_OFFLOAD
2305 * - (0) if successful.
2306 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2307 * - (-ENODEV) if *port_id* invalid.
2309 extern int rte_eth_dev_set_vlan_offload(uint8_t port_id, int offload_mask);
2312 * Read VLAN Offload configuration from an Ethernet device
2315 * The port identifier of the Ethernet device.
2317 * - (>0) if successful. Bit mask to indicate
2318 * ETH_VLAN_STRIP_OFFLOAD
2319 * ETH_VLAN_FILTER_OFFLOAD
2320 * ETH_VLAN_EXTEND_OFFLOAD
2321 * - (-ENODEV) if *port_id* invalid.
2323 extern int rte_eth_dev_get_vlan_offload(uint8_t port_id);
2326 * Set port based TX VLAN insersion on or off.
2329 * The port identifier of the Ethernet device.
2331 * Port based TX VLAN identifier togeth with user priority.
2333 * Turn on or off the port based TX VLAN insertion.
2336 * - (0) if successful.
2337 * - negative if failed.
2339 extern int rte_eth_dev_set_vlan_pvid(uint8_t port_id, uint16_t pvid, int on);
2343 * Retrieve a burst of input packets from a receive queue of an Ethernet
2344 * device. The retrieved packets are stored in *rte_mbuf* structures whose
2345 * pointers are supplied in the *rx_pkts* array.
2347 * The rte_eth_rx_burst() function loops, parsing the RX ring of the
2348 * receive queue, up to *nb_pkts* packets, and for each completed RX
2349 * descriptor in the ring, it performs the following operations:
2351 * - Initialize the *rte_mbuf* data structure associated with the
2352 * RX descriptor according to the information provided by the NIC into
2353 * that RX descriptor.
2355 * - Store the *rte_mbuf* data structure into the next entry of the
2358 * - Replenish the RX descriptor with a new *rte_mbuf* buffer
2359 * allocated from the memory pool associated with the receive queue at
2360 * initialization time.
2362 * When retrieving an input packet that was scattered by the controller
2363 * into multiple receive descriptors, the rte_eth_rx_burst() function
2364 * appends the associated *rte_mbuf* buffers to the first buffer of the
2367 * The rte_eth_rx_burst() function returns the number of packets
2368 * actually retrieved, which is the number of *rte_mbuf* data structures
2369 * effectively supplied into the *rx_pkts* array.
2370 * A return value equal to *nb_pkts* indicates that the RX queue contained
2371 * at least *rx_pkts* packets, and this is likely to signify that other
2372 * received packets remain in the input queue. Applications implementing
2373 * a "retrieve as much received packets as possible" policy can check this
2374 * specific case and keep invoking the rte_eth_rx_burst() function until
2375 * a value less than *nb_pkts* is returned.
2377 * This receive method has the following advantages:
2379 * - It allows a run-to-completion network stack engine to retrieve and
2380 * to immediately process received packets in a fast burst-oriented
2381 * approach, avoiding the overhead of unnecessary intermediate packet
2382 * queue/dequeue operations.
2384 * - Conversely, it also allows an asynchronous-oriented processing
2385 * method to retrieve bursts of received packets and to immediately
2386 * queue them for further parallel processing by another logical core,
2387 * for instance. However, instead of having received packets being
2388 * individually queued by the driver, this approach allows the invoker
2389 * of the rte_eth_rx_burst() function to queue a burst of retrieved
2390 * packets at a time and therefore dramatically reduce the cost of
2391 * enqueue/dequeue operations per packet.
2393 * - It allows the rte_eth_rx_burst() function of the driver to take
2394 * advantage of burst-oriented hardware features (CPU cache,
2395 * prefetch instructions, and so on) to minimize the number of CPU
2396 * cycles per packet.
2398 * To summarize, the proposed receive API enables many
2399 * burst-oriented optimizations in both synchronous and asynchronous
2400 * packet processing environments with no overhead in both cases.
2402 * The rte_eth_rx_burst() function does not provide any error
2403 * notification to avoid the corresponding overhead. As a hint, the
2404 * upper-level application might check the status of the device link once
2405 * being systematically returned a 0 value for a given number of tries.
2408 * The port identifier of the Ethernet device.
2410 * The index of the receive queue from which to retrieve input packets.
2411 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2412 * to rte_eth_dev_configure().
2414 * The address of an array of pointers to *rte_mbuf* structures that
2415 * must be large enough to store *nb_pkts* pointers in it.
2417 * The maximum number of packets to retrieve.
2419 * The number of packets actually retrieved, which is the number
2420 * of pointers to *rte_mbuf* structures effectively supplied to the
2423 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2424 extern uint16_t rte_eth_rx_burst(uint8_t port_id, uint16_t queue_id,
2425 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
2427 static inline uint16_t
2428 rte_eth_rx_burst(uint8_t port_id, uint16_t queue_id,
2429 struct rte_mbuf **rx_pkts, const uint16_t nb_pkts)
2431 struct rte_eth_dev *dev;
2433 dev = &rte_eth_devices[port_id];
2435 int16_t nb_rx = (*dev->rx_pkt_burst)(dev->data->rx_queues[queue_id],
2438 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
2439 struct rte_eth_rxtx_callback *cb = dev->post_rx_burst_cbs[queue_id];
2441 if (unlikely(cb != NULL)) {
2443 nb_rx = cb->fn.rx(port_id, queue_id, rx_pkts, nb_rx,
2444 nb_pkts, cb->param);
2446 } while (cb != NULL);
2455 * Get the number of used descriptors in a specific queue
2458 * The port identifier of the Ethernet device.
2460 * The queue id on the specific port.
2462 * The number of used descriptors in the specific queue.
2464 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2465 extern uint32_t rte_eth_rx_queue_count(uint8_t port_id, uint16_t queue_id);
2467 static inline uint32_t
2468 rte_eth_rx_queue_count(uint8_t port_id, uint16_t queue_id)
2470 struct rte_eth_dev *dev;
2472 dev = &rte_eth_devices[port_id];
2473 return (*dev->dev_ops->rx_queue_count)(dev, queue_id);
2478 * Check if the DD bit of the specific RX descriptor in the queue has been set
2481 * The port identifier of the Ethernet device.
2483 * The queue id on the specific port.
2485 * The offset of the descriptor ID from tail.
2487 * - (1) if the specific DD bit is set.
2488 * - (0) if the specific DD bit is not set.
2489 * - (-ENODEV) if *port_id* invalid.
2491 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2492 extern int rte_eth_rx_descriptor_done(uint8_t port_id,
2497 rte_eth_rx_descriptor_done(uint8_t port_id, uint16_t queue_id, uint16_t offset)
2499 struct rte_eth_dev *dev;
2501 dev = &rte_eth_devices[port_id];
2502 return (*dev->dev_ops->rx_descriptor_done)( \
2503 dev->data->rx_queues[queue_id], offset);
2508 * Send a burst of output packets on a transmit queue of an Ethernet device.
2510 * The rte_eth_tx_burst() function is invoked to transmit output packets
2511 * on the output queue *queue_id* of the Ethernet device designated by its
2513 * The *nb_pkts* parameter is the number of packets to send which are
2514 * supplied in the *tx_pkts* array of *rte_mbuf* structures.
2515 * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
2516 * up to the number of transmit descriptors available in the TX ring of the
2518 * For each packet to send, the rte_eth_tx_burst() function performs
2519 * the following operations:
2521 * - Pick up the next available descriptor in the transmit ring.
2523 * - Free the network buffer previously sent with that descriptor, if any.
2525 * - Initialize the transmit descriptor with the information provided
2526 * in the *rte_mbuf data structure.
2528 * In the case of a segmented packet composed of a list of *rte_mbuf* buffers,
2529 * the rte_eth_tx_burst() function uses several transmit descriptors
2532 * The rte_eth_tx_burst() function returns the number of packets it
2533 * actually sent. A return value equal to *nb_pkts* means that all packets
2534 * have been sent, and this is likely to signify that other output packets
2535 * could be immediately transmitted again. Applications that implement a
2536 * "send as many packets to transmit as possible" policy can check this
2537 * specific case and keep invoking the rte_eth_tx_burst() function until
2538 * a value less than *nb_pkts* is returned.
2540 * It is the responsibility of the rte_eth_tx_burst() function to
2541 * transparently free the memory buffers of packets previously sent.
2542 * This feature is driven by the *tx_free_thresh* value supplied to the
2543 * rte_eth_dev_configure() function at device configuration time.
2544 * When the number of free TX descriptors drops below this threshold, the
2545 * rte_eth_tx_burst() function must [attempt to] free the *rte_mbuf* buffers
2546 * of those packets whose transmission was effectively completed.
2549 * The port identifier of the Ethernet device.
2551 * The index of the transmit queue through which output packets must be
2553 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2554 * to rte_eth_dev_configure().
2556 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
2557 * which contain the output packets.
2559 * The maximum number of packets to transmit.
2561 * The number of output packets actually stored in transmit descriptors of
2562 * the transmit ring. The return value can be less than the value of the
2563 * *tx_pkts* parameter when the transmit ring is full or has been filled up.
2565 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2566 extern uint16_t rte_eth_tx_burst(uint8_t port_id, uint16_t queue_id,
2567 struct rte_mbuf **tx_pkts, uint16_t nb_pkts);
2569 static inline uint16_t
2570 rte_eth_tx_burst(uint8_t port_id, uint16_t queue_id,
2571 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
2573 struct rte_eth_dev *dev;
2575 dev = &rte_eth_devices[port_id];
2577 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
2578 struct rte_eth_rxtx_callback *cb = dev->pre_tx_burst_cbs[queue_id];
2580 if (unlikely(cb != NULL)) {
2582 nb_pkts = cb->fn.tx(port_id, queue_id, tx_pkts, nb_pkts,
2585 } while (cb != NULL);
2589 return (*dev->tx_pkt_burst)(dev->data->tx_queues[queue_id], tx_pkts, nb_pkts);
2594 * Setup a new signature filter rule on an Ethernet device
2597 * The port identifier of the Ethernet device.
2598 * @param fdir_filter
2599 * The pointer to the fdir filter structure describing the signature filter
2601 * The *rte_fdir_filter* structure includes the values of the different fields
2602 * to match: source and destination IP addresses, vlan id, flexbytes, source
2603 * and destination ports, and so on.
2605 * The index of the RX queue where to store RX packets matching the added
2606 * signature filter defined in fdir_filter.
2608 * - (0) if successful.
2609 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2610 * - (-ENODEV) if *port_id* invalid.
2611 * - (-ENOSYS) if the FDIR mode is not configured in signature mode
2613 * - (-EINVAL) if the fdir_filter information is not correct.
2615 int rte_eth_dev_fdir_add_signature_filter(uint8_t port_id,
2616 struct rte_fdir_filter *fdir_filter,
2620 * Update a signature filter rule on an Ethernet device.
2621 * If the rule doesn't exits, it is created.
2624 * The port identifier of the Ethernet device.
2626 * The pointer to the structure describing the signature filter rule.
2627 * The *rte_fdir_filter* structure includes the values of the different fields
2628 * to match: source and destination IP addresses, vlan id, flexbytes, source
2629 * and destination ports, and so on.
2631 * The index of the RX queue where to store RX packets matching the added
2632 * signature filter defined in fdir_ftr.
2634 * - (0) if successful.
2635 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2636 * - (-ENODEV) if *port_id* invalid.
2637 * - (-ENOSYS) if the flow director mode is not configured in signature mode
2639 * - (-EINVAL) if the fdir_filter information is not correct.
2641 int rte_eth_dev_fdir_update_signature_filter(uint8_t port_id,
2642 struct rte_fdir_filter *fdir_ftr,
2646 * Remove a signature filter rule on an Ethernet device.
2649 * The port identifier of the Ethernet device.
2651 * The pointer to the structure describing the signature filter rule.
2652 * The *rte_fdir_filter* structure includes the values of the different fields
2653 * to match: source and destination IP addresses, vlan id, flexbytes, source
2654 * and destination ports, and so on.
2656 * - (0) if successful.
2657 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2658 * - (-ENODEV) if *port_id* invalid.
2659 * - (-ENOSYS) if the flow director mode is not configured in signature mode
2661 * - (-EINVAL) if the fdir_filter information is not correct.
2663 int rte_eth_dev_fdir_remove_signature_filter(uint8_t port_id,
2664 struct rte_fdir_filter *fdir_ftr);
2667 * Retrieve the flow director information of an Ethernet device.
2670 * The port identifier of the Ethernet device.
2672 * A pointer to a structure of type *rte_eth_dev_fdir* to be filled with
2673 * the flow director information of the Ethernet device.
2675 * - (0) if successful.
2676 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2677 * - (-ENODEV) if *port_id* invalid.
2678 * - (-ENOSYS) if the flow director mode is not configured on *port_id*.
2680 int rte_eth_dev_fdir_get_infos(uint8_t port_id, struct rte_eth_fdir *fdir);
2683 * Add a new perfect filter rule on an Ethernet device.
2686 * The port identifier of the Ethernet device.
2687 * @param fdir_filter
2688 * The pointer to the structure describing the perfect filter rule.
2689 * The *rte_fdir_filter* structure includes the values of the different fields
2690 * to match: source and destination IP addresses, vlan id, flexbytes, source
2691 * and destination ports, and so on.
2692 * IPv6 are not supported.
2694 * The 16-bit value supplied in the field hash.fdir.id of mbuf for RX
2695 * packets matching the perfect filter.
2697 * The index of the RX queue where to store RX packets matching the added
2698 * perfect filter defined in fdir_filter.
2700 * If drop is set to 1, matching RX packets are stored into the RX drop
2701 * queue defined in the rte_fdir_conf.
2703 * - (0) if successful.
2704 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2705 * - (-ENODEV) if *port_id* invalid.
2706 * - (-ENOSYS) if the flow director mode is not configured in perfect mode
2708 * - (-EINVAL) if the fdir_filter information is not correct.
2710 int rte_eth_dev_fdir_add_perfect_filter(uint8_t port_id,
2711 struct rte_fdir_filter *fdir_filter,
2712 uint16_t soft_id, uint8_t rx_queue,
2716 * Update a perfect filter rule on an Ethernet device.
2717 * If the rule doesn't exits, it is created.
2720 * The port identifier of the Ethernet device.
2721 * @param fdir_filter
2722 * The pointer to the structure describing the perfect filter rule.
2723 * The *rte_fdir_filter* structure includes the values of the different fields
2724 * to match: source and destination IP addresses, vlan id, flexbytes, source
2725 * and destination ports, and so on.
2726 * IPv6 are not supported.
2728 * The 16-bit value supplied in the field hash.fdir.id of mbuf for RX
2729 * packets matching the perfect filter.
2731 * The index of the RX queue where to store RX packets matching the added
2732 * perfect filter defined in fdir_filter.
2734 * If drop is set to 1, matching RX packets are stored into the RX drop
2735 * queue defined in the rte_fdir_conf.
2737 * - (0) if successful.
2738 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2739 * - (-ENODEV) if *port_id* invalid.
2740 * - (-ENOSYS) if the flow director mode is not configured in perfect mode
2742 * - (-EINVAL) if the fdir_filter information is not correct.
2744 int rte_eth_dev_fdir_update_perfect_filter(uint8_t port_id,
2745 struct rte_fdir_filter *fdir_filter,
2746 uint16_t soft_id, uint8_t rx_queue,
2750 * Remove a perfect filter rule on an Ethernet device.
2753 * The port identifier of the Ethernet device.
2754 * @param fdir_filter
2755 * The pointer to the structure describing the perfect filter rule.
2756 * The *rte_fdir_filter* structure includes the values of the different fields
2757 * to match: source and destination IP addresses, vlan id, flexbytes, source
2758 * and destination ports, and so on.
2759 * IPv6 are not supported.
2761 * The soft_id value provided when adding/updating the removed filter.
2763 * - (0) if successful.
2764 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2765 * - (-ENODEV) if *port_id* invalid.
2766 * - (-ENOSYS) if the flow director mode is not configured in perfect mode
2768 * - (-EINVAL) if the fdir_filter information is not correct.
2770 int rte_eth_dev_fdir_remove_perfect_filter(uint8_t port_id,
2771 struct rte_fdir_filter *fdir_filter,
2774 * Configure globally the masks for flow director mode for an Ethernet device.
2775 * For example, the device can match packets with only the first 24 bits of
2776 * the IPv4 source address.
2778 * The following fields can be masked: IPv4 addresses and L4 port numbers.
2779 * The following fields can be either enabled or disabled completely for the
2780 * matching functionality: VLAN ID tag; VLAN Priority + CFI bit; Flexible 2-byte
2782 * IPv6 masks are not supported.
2784 * All filters must comply with the masks previously configured.
2785 * For example, with a mask equal to 255.255.255.0 for the source IPv4 address,
2786 * all IPv4 filters must be created with a source IPv4 address that fits the
2789 * This function flushes all filters that have been previously added in
2793 * The port identifier of the Ethernet device.
2795 * The pointer to the fdir mask structure describing relevant headers fields
2796 * and relevant bits to use when matching packets addresses and ports.
2797 * IPv6 masks are not supported.
2799 * - (0) if successful.
2800 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2801 * - (-ENODEV) if *port_id* invalid.
2802 * - (-ENOSYS) if the flow director mode is not configured in perfect
2803 * mode on *port_id*.
2804 * - (-EINVAL) if the fdir_filter information is not correct
2806 int rte_eth_dev_fdir_set_masks(uint8_t port_id,
2807 struct rte_fdir_masks *fdir_mask);
2810 * The eth device event type for interrupt, and maybe others in the future.
2812 enum rte_eth_event_type {
2813 RTE_ETH_EVENT_UNKNOWN, /**< unknown event type */
2814 RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
2815 RTE_ETH_EVENT_MAX /**< max value of this enum */
2818 typedef void (*rte_eth_dev_cb_fn)(uint8_t port_id, \
2819 enum rte_eth_event_type event, void *cb_arg);
2820 /**< user application callback to be registered for interrupts */
2825 * Register a callback function for specific port id.
2832 * User supplied callback function to be called.
2834 * Pointer to the parameters for the registered callback.
2837 * - On success, zero.
2838 * - On failure, a negative value.
2840 int rte_eth_dev_callback_register(uint8_t port_id,
2841 enum rte_eth_event_type event,
2842 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
2845 * Unregister a callback function for specific port id.
2852 * User supplied callback function to be called.
2854 * Pointer to the parameters for the registered callback. -1 means to
2855 * remove all for the same callback address and same event.
2858 * - On success, zero.
2859 * - On failure, a negative value.
2861 int rte_eth_dev_callback_unregister(uint8_t port_id,
2862 enum rte_eth_event_type event,
2863 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
2866 * @internal Executes all the user application registered callbacks for
2867 * the specific device. It is for DPDK internal user only. User
2868 * application should not call it directly.
2871 * Pointer to struct rte_eth_dev.
2873 * Eth device interrupt event type.
2878 void _rte_eth_dev_callback_process(struct rte_eth_dev *dev,
2879 enum rte_eth_event_type event);
2882 * Turn on the LED on the Ethernet device.
2883 * This function turns on the LED on the Ethernet device.
2886 * The port identifier of the Ethernet device.
2888 * - (0) if successful.
2889 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
2891 * - (-ENODEV) if *port_id* invalid.
2893 int rte_eth_led_on(uint8_t port_id);
2896 * Turn off the LED on the Ethernet device.
2897 * This function turns off the LED on the Ethernet device.
2900 * The port identifier of the Ethernet device.
2902 * - (0) if successful.
2903 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
2905 * - (-ENODEV) if *port_id* invalid.
2907 int rte_eth_led_off(uint8_t port_id);
2910 * Get current status of the Ethernet link flow control for Ethernet device
2913 * The port identifier of the Ethernet device.
2915 * The pointer to the structure where to store the flow control parameters.
2917 * - (0) if successful.
2918 * - (-ENOTSUP) if hardware doesn't support flow control.
2919 * - (-ENODEV) if *port_id* invalid.
2921 int rte_eth_dev_flow_ctrl_get(uint8_t port_id,
2922 struct rte_eth_fc_conf *fc_conf);
2925 * Configure the Ethernet link flow control for Ethernet device
2928 * The port identifier of the Ethernet device.
2930 * The pointer to the structure of the flow control parameters.
2932 * - (0) if successful.
2933 * - (-ENOTSUP) if hardware doesn't support flow control mode.
2934 * - (-ENODEV) if *port_id* invalid.
2935 * - (-EINVAL) if bad parameter
2936 * - (-EIO) if flow control setup failure
2938 int rte_eth_dev_flow_ctrl_set(uint8_t port_id,
2939 struct rte_eth_fc_conf *fc_conf);
2942 * Configure the Ethernet priority flow control under DCB environment
2943 * for Ethernet device.
2946 * The port identifier of the Ethernet device.
2948 * The pointer to the structure of the priority flow control parameters.
2950 * - (0) if successful.
2951 * - (-ENOTSUP) if hardware doesn't support priority flow control mode.
2952 * - (-ENODEV) if *port_id* invalid.
2953 * - (-EINVAL) if bad parameter
2954 * - (-EIO) if flow control setup failure
2956 int rte_eth_dev_priority_flow_ctrl_set(uint8_t port_id,
2957 struct rte_eth_pfc_conf *pfc_conf);
2960 * Add a MAC address to an internal array of addresses used to enable whitelist
2961 * filtering to accept packets only if the destination MAC address matches.
2964 * The port identifier of the Ethernet device.
2966 * The MAC address to add.
2968 * VMDq pool index to associate address with (if VMDq is enabled). If VMDq is
2969 * not enabled, this should be set to 0.
2971 * - (0) if successfully added or *mac_addr" was already added.
2972 * - (-ENOTSUP) if hardware doesn't support this feature.
2973 * - (-ENODEV) if *port* is invalid.
2974 * - (-ENOSPC) if no more MAC addresses can be added.
2975 * - (-EINVAL) if MAC address is invalid.
2977 int rte_eth_dev_mac_addr_add(uint8_t port, struct ether_addr *mac_addr,
2981 * Remove a MAC address from the internal array of addresses.
2984 * The port identifier of the Ethernet device.
2986 * MAC address to remove.
2988 * - (0) if successful, or *mac_addr* didn't exist.
2989 * - (-ENOTSUP) if hardware doesn't support.
2990 * - (-ENODEV) if *port* invalid.
2991 * - (-EADDRINUSE) if attempting to remove the default MAC address
2993 int rte_eth_dev_mac_addr_remove(uint8_t port, struct ether_addr *mac_addr);
2996 * Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
2999 * The port identifier of the Ethernet device.
3003 * Redirection table size. The table size can be queried by
3004 * rte_eth_dev_info_get().
3006 * - (0) if successful.
3007 * - (-ENOTSUP) if hardware doesn't support.
3008 * - (-EINVAL) if bad parameter.
3010 int rte_eth_dev_rss_reta_update(uint8_t port,
3011 struct rte_eth_rss_reta_entry64 *reta_conf,
3012 uint16_t reta_size);
3015 * Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3018 * The port identifier of the Ethernet device.
3022 * Redirection table size. The table size can be queried by
3023 * rte_eth_dev_info_get().
3025 * - (0) if successful.
3026 * - (-ENOTSUP) if hardware doesn't support.
3027 * - (-EINVAL) if bad parameter.
3029 int rte_eth_dev_rss_reta_query(uint8_t port,
3030 struct rte_eth_rss_reta_entry64 *reta_conf,
3031 uint16_t reta_size);
3034 * Updates unicast hash table for receiving packet with the given destination
3035 * MAC address, and the packet is routed to all VFs for which the RX mode is
3036 * accept packets that match the unicast hash table.
3039 * The port identifier of the Ethernet device.
3041 * Unicast MAC address.
3043 * 1 - Set an unicast hash bit for receiving packets with the MAC address.
3044 * 0 - Clear an unicast hash bit.
3046 * - (0) if successful.
3047 * - (-ENOTSUP) if hardware doesn't support.
3048 * - (-ENODEV) if *port_id* invalid.
3049 * - (-EINVAL) if bad parameter.
3051 int rte_eth_dev_uc_hash_table_set(uint8_t port,struct ether_addr *addr,
3055 * Updates all unicast hash bitmaps for receiving packet with any Unicast
3056 * Ethernet MAC addresses,the packet is routed to all VFs for which the RX
3057 * mode is accept packets that match the unicast hash table.
3060 * The port identifier of the Ethernet device.
3062 * 1 - Set all unicast hash bitmaps for receiving all the Ethernet
3064 * 0 - Clear all unicast hash bitmaps
3066 * - (0) if successful.
3067 * - (-ENOTSUP) if hardware doesn't support.
3068 * - (-ENODEV) if *port_id* invalid.
3069 * - (-EINVAL) if bad parameter.
3071 int rte_eth_dev_uc_all_hash_table_set(uint8_t port,uint8_t on);
3074 * Set RX L2 Filtering mode of a VF of an Ethernet device.
3077 * The port identifier of the Ethernet device.
3081 * The RX mode mask, which is one or more of accepting Untagged Packets,
3082 * packets that match the PFUTA table, Broadcast and Multicast Promiscuous.
3083 * ETH_VMDQ_ACCEPT_UNTAG,ETH_VMDQ_ACCEPT_HASH_UC,
3084 * ETH_VMDQ_ACCEPT_BROADCAST and ETH_VMDQ_ACCEPT_MULTICAST will be used
3087 * 1 - Enable a VF RX mode.
3088 * 0 - Disable a VF RX mode.
3090 * - (0) if successful.
3091 * - (-ENOTSUP) if hardware doesn't support.
3092 * - (-ENOTSUP) if hardware doesn't support.
3093 * - (-EINVAL) if bad parameter.
3095 int rte_eth_dev_set_vf_rxmode(uint8_t port, uint16_t vf, uint16_t rx_mode,
3099 * Enable or disable a VF traffic transmit of the Ethernet device.
3102 * The port identifier of the Ethernet device.
3106 * 1 - Enable a VF traffic transmit.
3107 * 0 - Disable a VF traffic transmit.
3109 * - (0) if successful.
3110 * - (-ENODEV) if *port_id* invalid.
3111 * - (-ENOTSUP) if hardware doesn't support.
3112 * - (-EINVAL) if bad parameter.
3115 rte_eth_dev_set_vf_tx(uint8_t port,uint16_t vf, uint8_t on);
3118 * Enable or disable a VF traffic receive of an Ethernet device.
3121 * The port identifier of the Ethernet device.
3125 * 1 - Enable a VF traffic receive.
3126 * 0 - Disable a VF traffic receive.
3128 * - (0) if successful.
3129 * - (-ENOTSUP) if hardware doesn't support.
3130 * - (-ENODEV) if *port_id* invalid.
3131 * - (-EINVAL) if bad parameter.
3134 rte_eth_dev_set_vf_rx(uint8_t port,uint16_t vf, uint8_t on);
3137 * Enable/Disable hardware VF VLAN filtering by an Ethernet device of
3138 * received VLAN packets tagged with a given VLAN Tag Identifier.
3141 * The port identifier of the Ethernet device.
3143 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
3145 * Bitmap listing which VFs participate in the VLAN filtering.
3147 * 1 - Enable VFs VLAN filtering.
3148 * 0 - Disable VFs VLAN filtering.
3150 * - (0) if successful.
3151 * - (-ENOTSUP) if hardware doesn't support.
3152 * - (-ENODEV) if *port_id* invalid.
3153 * - (-EINVAL) if bad parameter.
3156 rte_eth_dev_set_vf_vlan_filter(uint8_t port, uint16_t vlan_id,
3161 * Set a traffic mirroring rule on an Ethernet device
3164 * The port identifier of the Ethernet device.
3165 * @param mirror_conf
3166 * The pointer to the traffic mirroring structure describing the mirroring rule.
3167 * The *rte_eth_vm_mirror_conf* structure includes the type of mirroring rule,
3168 * destination pool and the value of rule if enable vlan or pool mirroring.
3171 * The index of traffic mirroring rule, we support four separated rules.
3173 * 1 - Enable a mirroring rule.
3174 * 0 - Disable a mirroring rule.
3176 * - (0) if successful.
3177 * - (-ENOTSUP) if hardware doesn't support this feature.
3178 * - (-ENODEV) if *port_id* invalid.
3179 * - (-EINVAL) if the mr_conf information is not correct.
3181 int rte_eth_mirror_rule_set(uint8_t port_id,
3182 struct rte_eth_mirror_conf *mirror_conf,
3187 * Reset a traffic mirroring rule on an Ethernet device.
3190 * The port identifier of the Ethernet device.
3192 * The index of traffic mirroring rule, we support four separated rules.
3194 * - (0) if successful.
3195 * - (-ENOTSUP) if hardware doesn't support this feature.
3196 * - (-ENODEV) if *port_id* invalid.
3197 * - (-EINVAL) if bad parameter.
3199 int rte_eth_mirror_rule_reset(uint8_t port_id,
3203 * Set the rate limitation for a queue on an Ethernet device.
3206 * The port identifier of the Ethernet device.
3210 * The tx rate allocated from the total link speed for this queue.
3212 * - (0) if successful.
3213 * - (-ENOTSUP) if hardware doesn't support this feature.
3214 * - (-ENODEV) if *port_id* invalid.
3215 * - (-EINVAL) if bad parameter.
3217 int rte_eth_set_queue_rate_limit(uint8_t port_id, uint16_t queue_idx,
3221 * Set the rate limitation for a vf on an Ethernet device.
3224 * The port identifier of the Ethernet device.
3228 * The tx rate allocated from the total link speed for this VF id.
3230 * The queue mask which need to set the rate.
3232 * - (0) if successful.
3233 * - (-ENOTSUP) if hardware doesn't support this feature.
3234 * - (-ENODEV) if *port_id* invalid.
3235 * - (-EINVAL) if bad parameter.
3237 int rte_eth_set_vf_rate_limit(uint8_t port_id, uint16_t vf,
3238 uint16_t tx_rate, uint64_t q_msk);
3241 * Initialize bypass logic. This function needs to be called before
3242 * executing any other bypass API.
3245 * The port identifier of the Ethernet device.
3247 * - (0) if successful.
3248 * - (-ENOTSUP) if hardware doesn't support.
3249 * - (-EINVAL) if bad parameter.
3251 int rte_eth_dev_bypass_init(uint8_t port);
3254 * Return bypass state.
3257 * The port identifier of the Ethernet device.
3259 * The return bypass state.
3262 * - (3) Isolate mode
3264 * - (0) if successful.
3265 * - (-ENOTSUP) if hardware doesn't support.
3266 * - (-EINVAL) if bad parameter.
3268 int rte_eth_dev_bypass_state_show(uint8_t port, uint32_t *state);
3274 * The port identifier of the Ethernet device.
3276 * The current bypass state.
3279 * - (3) Isolate mode
3281 * - (0) if successful.
3282 * - (-ENOTSUP) if hardware doesn't support.
3283 * - (-EINVAL) if bad parameter.
3285 int rte_eth_dev_bypass_state_set(uint8_t port, uint32_t *new_state);
3288 * Return bypass state when given event occurs.
3291 * The port identifier of the Ethernet device.
3294 * - (1) Main power on (power button is pushed)
3295 * - (2) Auxiliary power on (power supply is being plugged)
3296 * - (3) Main power off (system shutdown and power supply is left plugged in)
3297 * - (4) Auxiliary power off (power supply is being unplugged)
3298 * - (5) Display or set the watchdog timer
3300 * The bypass state when given event occurred.
3303 * - (3) Isolate mode
3305 * - (0) if successful.
3306 * - (-ENOTSUP) if hardware doesn't support.
3307 * - (-EINVAL) if bad parameter.
3309 int rte_eth_dev_bypass_event_show(uint8_t port, uint32_t event, uint32_t *state);
3312 * Set bypass state when given event occurs.
3315 * The port identifier of the Ethernet device.
3318 * - (1) Main power on (power button is pushed)
3319 * - (2) Auxiliary power on (power supply is being plugged)
3320 * - (3) Main power off (system shutdown and power supply is left plugged in)
3321 * - (4) Auxiliary power off (power supply is being unplugged)
3322 * - (5) Display or set the watchdog timer
3324 * The assigned state when given event occurs.
3327 * - (3) Isolate mode
3329 * - (0) if successful.
3330 * - (-ENOTSUP) if hardware doesn't support.
3331 * - (-EINVAL) if bad parameter.
3333 int rte_eth_dev_bypass_event_store(uint8_t port, uint32_t event, uint32_t state);
3336 * Set bypass watchdog timeout count.
3339 * The port identifier of the Ethernet device.
3341 * The timeout to be set.
3342 * - (0) 0 seconds (timer is off)
3351 * - (0) if successful.
3352 * - (-ENOTSUP) if hardware doesn't support.
3353 * - (-EINVAL) if bad parameter.
3355 int rte_eth_dev_wd_timeout_store(uint8_t port, uint32_t timeout);
3358 * Get bypass firmware version.
3361 * The port identifier of the Ethernet device.
3363 * The firmware version
3365 * - (0) if successful.
3366 * - (-ENOTSUP) if hardware doesn't support.
3367 * - (-EINVAL) if bad parameter.
3369 int rte_eth_dev_bypass_ver_show(uint8_t port, uint32_t *ver);
3372 * Return bypass watchdog timeout in seconds
3375 * The port identifier of the Ethernet device.
3377 * The return watchdog timeout. "0" represents timer expired
3378 * - (0) 0 seconds (timer is off)
3387 * - (0) if successful.
3388 * - (-ENOTSUP) if hardware doesn't support.
3389 * - (-EINVAL) if bad parameter.
3391 int rte_eth_dev_bypass_wd_timeout_show(uint8_t port, uint32_t *wd_timeout);
3394 * Reset bypass watchdog timer
3397 * The port identifier of the Ethernet device.
3399 * - (0) if successful.
3400 * - (-ENOTSUP) if hardware doesn't support.
3401 * - (-EINVAL) if bad parameter.
3403 int rte_eth_dev_bypass_wd_reset(uint8_t port);
3406 * Configuration of Receive Side Scaling hash computation of Ethernet device.
3409 * The port identifier of the Ethernet device.
3411 * The new configuration to use for RSS hash computation on the port.
3413 * - (0) if successful.
3414 * - (-ENODEV) if port identifier is invalid.
3415 * - (-ENOTSUP) if hardware doesn't support.
3416 * - (-EINVAL) if bad parameter.
3418 int rte_eth_dev_rss_hash_update(uint8_t port_id,
3419 struct rte_eth_rss_conf *rss_conf);
3422 * Retrieve current configuration of Receive Side Scaling hash computation
3423 * of Ethernet device.
3426 * The port identifier of the Ethernet device.
3428 * Where to store the current RSS hash configuration of the Ethernet device.
3430 * - (0) if successful.
3431 * - (-ENODEV) if port identifier is invalid.
3432 * - (-ENOTSUP) if hardware doesn't support RSS.
3435 rte_eth_dev_rss_hash_conf_get(uint8_t port_id,
3436 struct rte_eth_rss_conf *rss_conf);
3439 * Add UDP tunneling port of an Ethernet device for filtering a specific
3440 * tunneling packet by UDP port number.
3443 * The port identifier of the Ethernet device.
3445 * UDP tunneling configuration.
3448 * - (0) if successful.
3449 * - (-ENODEV) if port identifier is invalid.
3450 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3453 rte_eth_dev_udp_tunnel_add(uint8_t port_id,
3454 struct rte_eth_udp_tunnel *tunnel_udp);
3457 * Detete UDP tunneling port configuration of Ethernet device
3460 * The port identifier of the Ethernet device.
3462 * UDP tunneling configuration.
3465 * - (0) if successful.
3466 * - (-ENODEV) if port identifier is invalid.
3467 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3470 rte_eth_dev_udp_tunnel_delete(uint8_t port_id,
3471 struct rte_eth_udp_tunnel *tunnel_udp);
3474 * Check whether the filter type is supported on an Ethernet device.
3475 * All the supported filter types are defined in 'rte_eth_ctrl.h'.
3478 * The port identifier of the Ethernet device.
3479 * @param filter_type
3482 * - (0) if successful.
3483 * - (-ENOTSUP) if hardware doesn't support this filter type.
3484 * - (-ENODEV) if *port_id* invalid.
3486 int rte_eth_dev_filter_supported(uint8_t port_id, enum rte_filter_type filter_type);
3489 * Take operations to assigned filter type on an Ethernet device.
3490 * All the supported operations and filter types are defined in 'rte_eth_ctrl.h'.
3493 * The port identifier of the Ethernet device.
3494 * @param filter_type
3497 * Type of operation.
3499 * A pointer to arguments defined specifically for the operation.
3501 * - (0) if successful.
3502 * - (-ENOTSUP) if hardware doesn't support.
3503 * - (-ENODEV) if *port_id* invalid.
3504 * - others depends on the specific operations implementation.
3506 int rte_eth_dev_filter_ctrl(uint8_t port_id, enum rte_filter_type filter_type,
3507 enum rte_filter_op filter_op, void *arg);
3510 * Add a callback to be called on packet RX on a given port and queue.
3512 * This API configures a function to be called for each burst of
3513 * packets received on a given NIC port queue. The return value is a pointer
3514 * that can be used to later remove the callback using
3515 * rte_eth_remove_rx_callback().
3518 * The port identifier of the Ethernet device.
3520 * The queue on the Ethernet device on which the callback is to be added.
3522 * The callback function
3524 * A generic pointer parameter which will be passed to each invocation of the
3525 * callback function on this port and queue.
3529 * On success, a pointer value which can later be used to remove the callback.
3531 void *rte_eth_add_rx_callback(uint8_t port_id, uint16_t queue_id,
3532 rte_rx_callback_fn fn, void *user_param);
3535 * Add a callback to be called on packet TX on a given port and queue.
3537 * This API configures a function to be called for each burst of
3538 * packets sent on a given NIC port queue. The return value is a pointer
3539 * that can be used to later remove the callback using
3540 * rte_eth_remove_tx_callback().
3543 * The port identifier of the Ethernet device.
3545 * The queue on the Ethernet device on which the callback is to be added.
3547 * The callback function
3549 * A generic pointer parameter which will be passed to each invocation of the
3550 * callback function on this port and queue.
3554 * On success, a pointer value which can later be used to remove the callback.
3556 void *rte_eth_add_tx_callback(uint8_t port_id, uint16_t queue_id,
3557 rte_tx_callback_fn fn, void *user_param);
3560 * Remove an RX packet callback from a given port and queue.
3562 * This function is used to removed callbacks that were added to a NIC port
3563 * queue using rte_eth_add_rx_callback().
3565 * Note: the callback is removed from the callback list but it isn't freed
3566 * since the it may still be in use. The memory for the callback can be
3567 * subsequently freed back by the application by calling rte_free():
3569 * - Immediately - if the port is stopped, or the user knows that no
3570 * callbacks are in flight e.g. if called from the thread doing RX/TX
3573 * - After a short delay - where the delay is sufficient to allow any
3574 * in-flight callbacks to complete.
3577 * The port identifier of the Ethernet device.
3579 * The queue on the Ethernet device from which the callback is to be removed.
3581 * User supplied callback created via rte_eth_add_rx_callback().
3584 * - 0: Success. Callback was removed.
3585 * - -ENOTSUP: Callback support is not available.
3586 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
3587 * is NULL or not found for the port/queue.
3589 int rte_eth_remove_rx_callback(uint8_t port_id, uint16_t queue_id,
3590 struct rte_eth_rxtx_callback *user_cb);
3593 * Remove a TX packet callback from a given port and queue.
3595 * This function is used to removed callbacks that were added to a NIC port
3596 * queue using rte_eth_add_tx_callback().
3598 * Note: the callback is removed from the callback list but it isn't freed
3599 * since the it may still be in use. The memory for the callback can be
3600 * subsequently freed back by the application by calling rte_free():
3602 * - Immediately - if the port is stopped, or the user knows that no
3603 * callbacks are in flight e.g. if called from the thread doing RX/TX
3606 * - After a short delay - where the delay is sufficient to allow any
3607 * in-flight callbacks to complete.
3610 * The port identifier of the Ethernet device.
3612 * The queue on the Ethernet device from which the callback is to be removed.
3614 * User supplied callback created via rte_eth_add_tx_callback().
3617 * - 0: Success. Callback was removed.
3618 * - -ENOTSUP: Callback support is not available.
3619 * - -EINVAL: The port_id or the queue_id is out of range, or the callback
3620 * is NULL or not found for the port/queue.
3622 int rte_eth_remove_tx_callback(uint8_t port_id, uint16_t queue_id,
3623 struct rte_eth_rxtx_callback *user_cb);
3630 * Set the list of multicast addresses to filter on an Ethernet device.
3633 * The port identifier of the Ethernet device.
3634 * @param mc_addr_set
3635 * The array of multicast addresses to set. Equal to NULL when the function
3636 * is invoked to flush the set of filtered addresses.
3638 * The number of multicast addresses in the *mc_addr_set* array. Equal to 0
3639 * when the function is invoked to flush the set of filtered addresses.
3641 * - (0) if successful.
3642 * - (-ENODEV) if *port_id* invalid.
3643 * - (-ENOTSUP) if PMD of *port_id* doesn't support multicast filtering.
3644 * - (-ENOSPC) if *port_id* has not enough multicast filtering resources.
3646 int rte_eth_dev_set_mc_addr_list(uint8_t port_id,
3647 struct ether_addr *mc_addr_set,
3648 uint32_t nb_mc_addr);
3650 #endif /* _RTE_ETHDEV_H_ */