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.
176 #include <rte_interrupts.h>
178 #include <rte_mbuf.h>
179 #include "rte_ether.h"
180 #include "rte_eth_ctrl.h"
183 * A structure used to retrieve statistics for an Ethernet port.
185 struct rte_eth_stats {
186 uint64_t ipackets; /**< Total number of successfully received packets. */
187 uint64_t opackets; /**< Total number of successfully transmitted packets.*/
188 uint64_t ibytes; /**< Total number of successfully received bytes. */
189 uint64_t obytes; /**< Total number of successfully transmitted bytes. */
190 uint64_t imissed; /**< Total of RX missed packets (e.g full FIFO). */
191 uint64_t ibadcrc; /**< Total of RX packets with CRC error. */
192 uint64_t ibadlen; /**< Total of RX packets with bad length. */
193 uint64_t ierrors; /**< Total number of erroneous received packets. */
194 uint64_t oerrors; /**< Total number of failed transmitted packets. */
195 uint64_t imcasts; /**< Total number of multicast received packets. */
196 uint64_t rx_nombuf; /**< Total number of RX mbuf allocation failures. */
197 uint64_t fdirmatch; /**< Total number of RX packets matching a filter. */
198 uint64_t fdirmiss; /**< Total number of RX packets not matching any filter. */
199 uint64_t tx_pause_xon; /**< Total nb. of XON pause frame sent. */
200 uint64_t rx_pause_xon; /**< Total nb. of XON pause frame received. */
201 uint64_t tx_pause_xoff; /**< Total nb. of XOFF pause frame sent. */
202 uint64_t rx_pause_xoff; /**< Total nb. of XOFF pause frame received. */
203 uint64_t q_ipackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
204 /**< Total number of queue RX packets. */
205 uint64_t q_opackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
206 /**< Total number of queue TX packets. */
207 uint64_t q_ibytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
208 /**< Total number of successfully received queue bytes. */
209 uint64_t q_obytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
210 /**< Total number of successfully transmitted queue bytes. */
211 uint64_t q_errors[RTE_ETHDEV_QUEUE_STAT_CNTRS];
212 /**< Total number of queue packets received that are dropped. */
214 /**< Total number of good packets received from loopback,VF Only */
216 /**< Total number of good packets transmitted to loopback,VF Only */
218 /**< Total number of good bytes received from loopback,VF Only */
220 /**< Total number of good bytes transmitted to loopback,VF Only */
224 * A structure used to retrieve link-level information of an Ethernet port.
226 struct rte_eth_link {
227 uint16_t link_speed; /**< ETH_LINK_SPEED_[10, 100, 1000, 10000] */
228 uint16_t link_duplex; /**< ETH_LINK_[HALF_DUPLEX, FULL_DUPLEX] */
229 uint8_t link_status : 1; /**< 1 -> link up, 0 -> link down */
230 }__attribute__((aligned(8))); /**< aligned for atomic64 read/write */
232 #define ETH_LINK_SPEED_AUTONEG 0 /**< Auto-negotiate link speed. */
233 #define ETH_LINK_SPEED_10 10 /**< 10 megabits/second. */
234 #define ETH_LINK_SPEED_100 100 /**< 100 megabits/second. */
235 #define ETH_LINK_SPEED_1000 1000 /**< 1 gigabits/second. */
236 #define ETH_LINK_SPEED_10000 10000 /**< 10 gigabits/second. */
237 #define ETH_LINK_SPEED_10G 10000 /**< alias of 10 gigabits/second. */
238 #define ETH_LINK_SPEED_20G 20000 /**< 20 gigabits/second. */
239 #define ETH_LINK_SPEED_40G 40000 /**< 40 gigabits/second. */
241 #define ETH_LINK_AUTONEG_DUPLEX 0 /**< Auto-negotiate duplex. */
242 #define ETH_LINK_HALF_DUPLEX 1 /**< Half-duplex connection. */
243 #define ETH_LINK_FULL_DUPLEX 2 /**< Full-duplex connection. */
246 * A structure used to configure the ring threshold registers of an RX/TX
247 * queue for an Ethernet port.
249 struct rte_eth_thresh {
250 uint8_t pthresh; /**< Ring prefetch threshold. */
251 uint8_t hthresh; /**< Ring host threshold. */
252 uint8_t wthresh; /**< Ring writeback threshold. */
256 * Simple flags are used for rte_eth_conf.rxmode.mq_mode.
258 #define ETH_MQ_RX_RSS_FLAG 0x1
259 #define ETH_MQ_RX_DCB_FLAG 0x2
260 #define ETH_MQ_RX_VMDQ_FLAG 0x4
263 * A set of values to identify what method is to be used to route
264 * packets to multiple queues.
266 enum rte_eth_rx_mq_mode {
267 /** None of DCB,RSS or VMDQ mode */
270 /** For RX side, only RSS is on */
271 ETH_MQ_RX_RSS = ETH_MQ_RX_RSS_FLAG,
272 /** For RX side,only DCB is on. */
273 ETH_MQ_RX_DCB = ETH_MQ_RX_DCB_FLAG,
274 /** Both DCB and RSS enable */
275 ETH_MQ_RX_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG,
277 /** Only VMDQ, no RSS nor DCB */
278 ETH_MQ_RX_VMDQ_ONLY = ETH_MQ_RX_VMDQ_FLAG,
279 /** RSS mode with VMDQ */
280 ETH_MQ_RX_VMDQ_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_VMDQ_FLAG,
281 /** Use VMDQ+DCB to route traffic to queues */
282 ETH_MQ_RX_VMDQ_DCB = ETH_MQ_RX_VMDQ_FLAG | ETH_MQ_RX_DCB_FLAG,
283 /** Enable both VMDQ and DCB in VMDq */
284 ETH_MQ_RX_VMDQ_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG |
289 * for rx mq mode backward compatible
291 #define ETH_RSS ETH_MQ_RX_RSS
292 #define VMDQ_DCB ETH_MQ_RX_VMDQ_DCB
293 #define ETH_DCB_RX ETH_MQ_RX_DCB
296 * A set of values to identify what method is to be used to transmit
297 * packets using multi-TCs.
299 enum rte_eth_tx_mq_mode {
300 ETH_MQ_TX_NONE = 0, /**< It is in neither DCB nor VT mode. */
301 ETH_MQ_TX_DCB, /**< For TX side,only DCB is on. */
302 ETH_MQ_TX_VMDQ_DCB, /**< For TX side,both DCB and VT is on. */
303 ETH_MQ_TX_VMDQ_ONLY, /**< Only VT on, no DCB */
307 * for tx mq mode backward compatible
309 #define ETH_DCB_NONE ETH_MQ_TX_NONE
310 #define ETH_VMDQ_DCB_TX ETH_MQ_TX_VMDQ_DCB
311 #define ETH_DCB_TX ETH_MQ_TX_DCB
314 * A structure used to configure the RX features of an Ethernet port.
316 struct rte_eth_rxmode {
317 /** The multi-queue packet distribution mode to be used, e.g. RSS. */
318 enum rte_eth_rx_mq_mode mq_mode;
319 uint32_t max_rx_pkt_len; /**< Only used if jumbo_frame enabled. */
320 uint16_t split_hdr_size; /**< hdr buf size (header_split enabled).*/
321 uint8_t header_split : 1, /**< Header Split enable. */
322 hw_ip_checksum : 1, /**< IP/UDP/TCP checksum offload enable. */
323 hw_vlan_filter : 1, /**< VLAN filter enable. */
324 hw_vlan_strip : 1, /**< VLAN strip enable. */
325 hw_vlan_extend : 1, /**< Extended VLAN enable. */
326 jumbo_frame : 1, /**< Jumbo Frame Receipt enable. */
327 hw_strip_crc : 1, /**< Enable CRC stripping by hardware. */
328 enable_scatter : 1; /**< Enable scatter packets rx handler */
332 * A structure used to configure the Receive Side Scaling (RSS) feature
333 * of an Ethernet port.
334 * If not NULL, the *rss_key* pointer of the *rss_conf* structure points
335 * to an array holding the RSS key to use for hashing specific header
336 * fields of received packets. The length of this array should be indicated
337 * by *rss_key_len* below. Otherwise, a default random hash key is used by
340 * The *rss_key_len* field of the *rss_conf* structure indicates the length
341 * in bytes of the array pointed by *rss_key*. To be compatible, this length
342 * will be checked in i40e only. Others assume 40 bytes to be used as before.
344 * The *rss_hf* field of the *rss_conf* structure indicates the different
345 * types of IPv4/IPv6 packets to which the RSS hashing must be applied.
346 * Supplying an *rss_hf* equal to zero disables the RSS feature.
348 struct rte_eth_rss_conf {
349 uint8_t *rss_key; /**< If not NULL, 40-byte hash key. */
350 uint8_t rss_key_len; /**< hash key length in bytes. */
351 uint64_t rss_hf; /**< Hash functions to apply - see below. */
354 /* Supported RSS offloads */
356 #define ETH_RSS_IPV4_SHIFT 0
357 #define ETH_RSS_IPV4_TCP_SHIFT 1
358 #define ETH_RSS_IPV6_SHIFT 2
359 #define ETH_RSS_IPV6_EX_SHIFT 3
360 #define ETH_RSS_IPV6_TCP_SHIFT 4
361 #define ETH_RSS_IPV6_TCP_EX_SHIFT 5
362 #define ETH_RSS_IPV4_UDP_SHIFT 6
363 #define ETH_RSS_IPV6_UDP_SHIFT 7
364 #define ETH_RSS_IPV6_UDP_EX_SHIFT 8
366 #define ETH_RSS_NONF_IPV4_UDP_SHIFT 31
367 #define ETH_RSS_NONF_IPV4_TCP_SHIFT 33
368 #define ETH_RSS_NONF_IPV4_SCTP_SHIFT 34
369 #define ETH_RSS_NONF_IPV4_OTHER_SHIFT 35
370 #define ETH_RSS_FRAG_IPV4_SHIFT 36
371 #define ETH_RSS_NONF_IPV6_UDP_SHIFT 41
372 #define ETH_RSS_NONF_IPV6_TCP_SHIFT 43
373 #define ETH_RSS_NONF_IPV6_SCTP_SHIFT 44
374 #define ETH_RSS_NONF_IPV6_OTHER_SHIFT 45
375 #define ETH_RSS_FRAG_IPV6_SHIFT 46
376 #define ETH_RSS_FCOE_OX_SHIFT 48
377 #define ETH_RSS_FCOE_RX_SHIFT 49
378 #define ETH_RSS_FCOE_OTHER_SHIFT 50
379 #define ETH_RSS_L2_PAYLOAD_SHIFT 63
382 #define ETH_RSS_IPV4 (1 << ETH_RSS_IPV4_SHIFT)
383 #define ETH_RSS_IPV4_TCP (1 << ETH_RSS_IPV4_TCP_SHIFT)
384 #define ETH_RSS_IPV6 (1 << ETH_RSS_IPV6_SHIFT)
385 #define ETH_RSS_IPV6_EX (1 << ETH_RSS_IPV6_EX_SHIFT)
386 #define ETH_RSS_IPV6_TCP (1 << ETH_RSS_IPV6_TCP_SHIFT)
387 #define ETH_RSS_IPV6_TCP_EX (1 << ETH_RSS_IPV6_TCP_EX_SHIFT)
388 #define ETH_RSS_IPV4_UDP (1 << ETH_RSS_IPV4_UDP_SHIFT)
389 #define ETH_RSS_IPV6_UDP (1 << ETH_RSS_IPV6_UDP_SHIFT)
390 #define ETH_RSS_IPV6_UDP_EX (1 << ETH_RSS_IPV6_UDP_EX_SHIFT)
392 #define ETH_RSS_NONF_IPV4_UDP (1ULL << ETH_RSS_NONF_IPV4_UDP_SHIFT)
393 #define ETH_RSS_NONF_IPV4_TCP (1ULL << ETH_RSS_NONF_IPV4_TCP_SHIFT)
394 #define ETH_RSS_NONF_IPV4_SCTP (1ULL << ETH_RSS_NONF_IPV4_SCTP_SHIFT)
395 #define ETH_RSS_NONF_IPV4_OTHER (1ULL << ETH_RSS_NONF_IPV4_OTHER_SHIFT)
396 #define ETH_RSS_FRAG_IPV4 (1ULL << ETH_RSS_FRAG_IPV4_SHIFT)
397 #define ETH_RSS_NONF_IPV6_UDP (1ULL << ETH_RSS_NONF_IPV6_UDP_SHIFT)
398 #define ETH_RSS_NONF_IPV6_TCP (1ULL << ETH_RSS_NONF_IPV6_TCP_SHIFT)
399 #define ETH_RSS_NONF_IPV6_SCTP (1ULL << ETH_RSS_NONF_IPV6_SCTP_SHIFT)
400 #define ETH_RSS_NONF_IPV6_OTHER (1ULL << ETH_RSS_NONF_IPV6_OTHER_SHIFT)
401 #define ETH_RSS_FRAG_IPV6 (1ULL << ETH_RSS_FRAG_IPV6_SHIFT)
402 /* FCOE relevant should not be used */
403 #define ETH_RSS_FCOE_OX (1ULL << ETH_RSS_FCOE_OX_SHIFT)
404 #define ETH_RSS_FCOE_RX (1ULL << ETH_RSS_FCOE_RX_SHIFT)
405 #define ETH_RSS_FCOE_OTHER (1ULL << ETH_RSS_FCOE_OTHER_SHIFT)
406 #define ETH_RSS_L2_PAYLOAD (1ULL << ETH_RSS_L2_PAYLOAD_SHIFT)
408 #define ETH_RSS_IP ( \
411 ETH_RSS_NONF_IPV4_OTHER | \
412 ETH_RSS_FRAG_IPV4 | \
413 ETH_RSS_NONF_IPV6_OTHER | \
415 #define ETH_RSS_UDP ( \
420 ETH_RSS_IPV6_UDP_EX | \
421 ETH_RSS_NONF_IPV4_UDP | \
422 ETH_RSS_NONF_IPV6_UDP)
423 /**< Mask of valid RSS hash protocols */
424 #define ETH_RSS_PROTO_MASK ( \
430 ETH_RSS_IPV6_TCP_EX | \
433 ETH_RSS_IPV6_UDP_EX | \
434 ETH_RSS_NONF_IPV4_UDP | \
435 ETH_RSS_NONF_IPV4_TCP | \
436 ETH_RSS_NONF_IPV4_SCTP | \
437 ETH_RSS_NONF_IPV4_OTHER | \
438 ETH_RSS_FRAG_IPV4 | \
439 ETH_RSS_NONF_IPV6_UDP | \
440 ETH_RSS_NONF_IPV6_TCP | \
441 ETH_RSS_NONF_IPV6_SCTP | \
442 ETH_RSS_NONF_IPV6_OTHER | \
443 ETH_RSS_FRAG_IPV6 | \
446 /* Definitions used for redirection table entry size */
447 #define ETH_RSS_RETA_NUM_ENTRIES 128
448 #define ETH_RSS_RETA_MAX_QUEUE 16
450 /* Definitions used for VMDQ and DCB functionality */
451 #define ETH_VMDQ_MAX_VLAN_FILTERS 64 /**< Maximum nb. of VMDQ vlan filters. */
452 #define ETH_DCB_NUM_USER_PRIORITIES 8 /**< Maximum nb. of DCB priorities. */
453 #define ETH_VMDQ_DCB_NUM_QUEUES 128 /**< Maximum nb. of VMDQ DCB queues. */
454 #define ETH_DCB_NUM_QUEUES 128 /**< Maximum nb. of DCB queues. */
456 /* DCB capability defines */
457 #define ETH_DCB_PG_SUPPORT 0x00000001 /**< Priority Group(ETS) support. */
458 #define ETH_DCB_PFC_SUPPORT 0x00000002 /**< Priority Flow Control support. */
460 /* Definitions used for VLAN Offload functionality */
461 #define ETH_VLAN_STRIP_OFFLOAD 0x0001 /**< VLAN Strip On/Off */
462 #define ETH_VLAN_FILTER_OFFLOAD 0x0002 /**< VLAN Filter On/Off */
463 #define ETH_VLAN_EXTEND_OFFLOAD 0x0004 /**< VLAN Extend On/Off */
465 /* Definitions used for mask VLAN setting */
466 #define ETH_VLAN_STRIP_MASK 0x0001 /**< VLAN Strip setting mask */
467 #define ETH_VLAN_FILTER_MASK 0x0002 /**< VLAN Filter setting mask*/
468 #define ETH_VLAN_EXTEND_MASK 0x0004 /**< VLAN Extend setting mask*/
469 #define ETH_VLAN_ID_MAX 0x0FFF /**< VLAN ID is in lower 12 bits*/
471 /* Definitions used for receive MAC address */
472 #define ETH_NUM_RECEIVE_MAC_ADDR 128 /**< Maximum nb. of receive mac addr. */
474 /* Definitions used for unicast hash */
475 #define ETH_VMDQ_NUM_UC_HASH_ARRAY 128 /**< Maximum nb. of UC hash array. */
477 /* Definitions used for VMDQ pool rx mode setting */
478 #define ETH_VMDQ_ACCEPT_UNTAG 0x0001 /**< accept untagged packets. */
479 #define ETH_VMDQ_ACCEPT_HASH_MC 0x0002 /**< accept packets in multicast table . */
480 #define ETH_VMDQ_ACCEPT_HASH_UC 0x0004 /**< accept packets in unicast table. */
481 #define ETH_VMDQ_ACCEPT_BROADCAST 0x0008 /**< accept broadcast packets. */
482 #define ETH_VMDQ_ACCEPT_MULTICAST 0x0010 /**< multicast promiscuous. */
484 /* Definitions used for VMDQ mirror rules setting */
485 #define ETH_VMDQ_NUM_MIRROR_RULE 4 /**< Maximum nb. of mirror rules. . */
487 #define ETH_VMDQ_POOL_MIRROR 0x0001 /**< Virtual Pool Mirroring. */
488 #define ETH_VMDQ_UPLINK_MIRROR 0x0002 /**< Uplink Port Mirroring. */
489 #define ETH_VMDQ_DOWNLIN_MIRROR 0x0004 /**< Downlink Port Mirroring. */
490 #define ETH_VMDQ_VLAN_MIRROR 0x0008 /**< VLAN Mirroring. */
493 * A structure used to configure VLAN traffic mirror of an Ethernet port.
495 struct rte_eth_vlan_mirror {
496 uint64_t vlan_mask; /**< mask for valid VLAN ID. */
497 uint16_t vlan_id[ETH_VMDQ_MAX_VLAN_FILTERS];
498 /** VLAN ID list for vlan mirror. */
502 * A structure used to configure traffic mirror of an Ethernet port.
504 struct rte_eth_vmdq_mirror_conf {
505 uint8_t rule_type_mask; /**< Mirroring rule type mask we want to set */
506 uint8_t dst_pool; /**< Destination pool for this mirror rule. */
507 uint64_t pool_mask; /**< Bitmap of pool for pool mirroring */
508 struct rte_eth_vlan_mirror vlan; /**< VLAN ID setting for VLAN mirroring */
512 * A structure used to configure Redirection Table of the Receive Side
513 * Scaling (RSS) feature of an Ethernet port.
515 struct rte_eth_rss_reta {
516 /** First 64 mask bits indicate which entry(s) need to updated/queried. */
518 /** Second 64 mask bits indicate which entry(s) need to updated/queried. */
520 uint8_t reta[ETH_RSS_RETA_NUM_ENTRIES]; /**< 128 RETA entries*/
524 * This enum indicates the possible number of traffic classes
525 * in DCB configratioins
527 enum rte_eth_nb_tcs {
528 ETH_4_TCS = 4, /**< 4 TCs with DCB. */
529 ETH_8_TCS = 8 /**< 8 TCs with DCB. */
533 * This enum indicates the possible number of queue pools
534 * in VMDQ configurations.
536 enum rte_eth_nb_pools {
537 ETH_8_POOLS = 8, /**< 8 VMDq pools. */
538 ETH_16_POOLS = 16, /**< 16 VMDq pools. */
539 ETH_32_POOLS = 32, /**< 32 VMDq pools. */
540 ETH_64_POOLS = 64 /**< 64 VMDq pools. */
543 /* This structure may be extended in future. */
544 struct rte_eth_dcb_rx_conf {
545 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs */
546 uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
547 /**< Possible DCB queue,4 or 8. */
550 struct rte_eth_vmdq_dcb_tx_conf {
551 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools. */
552 uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
553 /**< Possible DCB queue,4 or 8. */
556 struct rte_eth_dcb_tx_conf {
557 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs. */
558 uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
559 /**< Possible DCB queue,4 or 8. */
562 struct rte_eth_vmdq_tx_conf {
563 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq mode, 64 pools. */
567 * A structure used to configure the VMDQ+DCB feature
568 * of an Ethernet port.
570 * Using this feature, packets are routed to a pool of queues, based
571 * on the vlan id in the vlan tag, and then to a specific queue within
572 * that pool, using the user priority vlan tag field.
574 * A default pool may be used, if desired, to route all traffic which
575 * does not match the vlan filter rules.
577 struct rte_eth_vmdq_dcb_conf {
578 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools */
579 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
580 uint8_t default_pool; /**< The default pool, if applicable */
581 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
583 uint16_t vlan_id; /**< The vlan id of the received frame */
584 uint64_t pools; /**< Bitmask of pools for packet rx */
585 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
586 uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
587 /**< Selects a queue in a pool */
590 struct rte_eth_vmdq_rx_conf {
591 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq only mode, 8 or 64 pools */
592 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
593 uint8_t default_pool; /**< The default pool, if applicable */
594 uint8_t enable_loop_back; /**< Enable VT loop back */
595 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
596 uint32_t rx_mode; /**< Flags from ETH_VMDQ_ACCEPT_* */
598 uint16_t vlan_id; /**< The vlan id of the received frame */
599 uint64_t pools; /**< Bitmask of pools for packet rx */
600 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
604 * A structure used to configure the TX features of an Ethernet port.
606 struct rte_eth_txmode {
607 enum rte_eth_tx_mq_mode mq_mode; /**< TX multi-queues mode. */
609 /* For i40e specifically */
611 uint8_t hw_vlan_reject_tagged : 1,
612 /**< If set, reject sending out tagged pkts */
613 hw_vlan_reject_untagged : 1,
614 /**< If set, reject sending out untagged pkts */
615 hw_vlan_insert_pvid : 1;
616 /**< If set, enable port based VLAN insertion */
620 * A structure used to configure an RX ring of an Ethernet port.
622 struct rte_eth_rxconf {
623 struct rte_eth_thresh rx_thresh; /**< RX ring threshold registers. */
624 uint16_t rx_free_thresh; /**< Drives the freeing of RX descriptors. */
625 uint8_t rx_drop_en; /**< Drop packets if no descriptors are available. */
626 uint8_t rx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
629 #define ETH_TXQ_FLAGS_NOMULTSEGS 0x0001 /**< nb_segs=1 for all mbufs */
630 #define ETH_TXQ_FLAGS_NOREFCOUNT 0x0002 /**< refcnt can be ignored */
631 #define ETH_TXQ_FLAGS_NOMULTMEMP 0x0004 /**< all bufs come from same mempool */
632 #define ETH_TXQ_FLAGS_NOVLANOFFL 0x0100 /**< disable VLAN offload */
633 #define ETH_TXQ_FLAGS_NOXSUMSCTP 0x0200 /**< disable SCTP checksum offload */
634 #define ETH_TXQ_FLAGS_NOXSUMUDP 0x0400 /**< disable UDP checksum offload */
635 #define ETH_TXQ_FLAGS_NOXSUMTCP 0x0800 /**< disable TCP checksum offload */
636 #define ETH_TXQ_FLAGS_NOOFFLOADS \
637 (ETH_TXQ_FLAGS_NOVLANOFFL | ETH_TXQ_FLAGS_NOXSUMSCTP | \
638 ETH_TXQ_FLAGS_NOXSUMUDP | ETH_TXQ_FLAGS_NOXSUMTCP)
640 * A structure used to configure a TX ring of an Ethernet port.
642 struct rte_eth_txconf {
643 struct rte_eth_thresh tx_thresh; /**< TX ring threshold registers. */
644 uint16_t tx_rs_thresh; /**< Drives the setting of RS bit on TXDs. */
645 uint16_t tx_free_thresh; /**< Drives the freeing of TX buffers. */
646 uint32_t txq_flags; /**< Set flags for the Tx queue */
647 uint8_t tx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
651 * This enum indicates the flow control mode
653 enum rte_eth_fc_mode {
654 RTE_FC_NONE = 0, /**< Disable flow control. */
655 RTE_FC_RX_PAUSE, /**< RX pause frame, enable flowctrl on TX side. */
656 RTE_FC_TX_PAUSE, /**< TX pause frame, enable flowctrl on RX side. */
657 RTE_FC_FULL /**< Enable flow control on both side. */
661 * A structure used to configure Ethernet flow control parameter.
662 * These parameters will be configured into the register of the NIC.
663 * Please refer to the corresponding data sheet for proper value.
665 struct rte_eth_fc_conf {
666 uint32_t high_water; /**< High threshold value to trigger XOFF */
667 uint32_t low_water; /**< Low threshold value to trigger XON */
668 uint16_t pause_time; /**< Pause quota in the Pause frame */
669 uint16_t send_xon; /**< Is XON frame need be sent */
670 enum rte_eth_fc_mode mode; /**< Link flow control mode */
671 uint8_t mac_ctrl_frame_fwd; /**< Forward MAC control frames */
672 uint8_t autoneg; /**< Use Pause autoneg */
676 * A structure used to configure Ethernet priority flow control parameter.
677 * These parameters will be configured into the register of the NIC.
678 * Please refer to the corresponding data sheet for proper value.
680 struct rte_eth_pfc_conf {
681 struct rte_eth_fc_conf fc; /**< General flow control parameter. */
682 uint8_t priority; /**< VLAN User Priority. */
686 * Flow Director setting modes: none (default), signature or perfect.
689 RTE_FDIR_MODE_NONE = 0, /**< Disable FDIR support. */
690 RTE_FDIR_MODE_SIGNATURE, /**< Enable FDIR signature filter mode. */
691 RTE_FDIR_MODE_PERFECT, /**< Enable FDIR perfect filter mode. */
695 * Memory space that can be configured to store Flow Director filters
696 * in the board memory.
698 enum rte_fdir_pballoc_type {
699 RTE_FDIR_PBALLOC_64K = 0, /**< 64k. */
700 RTE_FDIR_PBALLOC_128K, /**< 128k. */
701 RTE_FDIR_PBALLOC_256K, /**< 256k. */
705 * Select report mode of FDIR hash information in RX descriptors.
707 enum rte_fdir_status_mode {
708 RTE_FDIR_NO_REPORT_STATUS = 0, /**< Never report FDIR hash. */
709 RTE_FDIR_REPORT_STATUS, /**< Only report FDIR hash for matching pkts. */
710 RTE_FDIR_REPORT_STATUS_ALWAYS, /**< Always report FDIR hash. */
714 * A structure used to configure the Flow Director (FDIR) feature
715 * of an Ethernet port.
717 * If mode is RTE_FDIR_DISABLE, the pballoc value is ignored.
719 struct rte_fdir_conf {
720 enum rte_fdir_mode mode; /**< Flow Director mode. */
721 enum rte_fdir_pballoc_type pballoc; /**< Space for FDIR filters. */
722 enum rte_fdir_status_mode status; /**< How to report FDIR hash. */
723 /** Offset of flexbytes field in RX packets (in 16-bit word units). */
724 uint8_t flexbytes_offset;
725 /** RX queue of packets matching a "drop" filter in perfect mode. */
730 * UDP tunneling configuration.
732 struct rte_eth_udp_tunnel {
738 * Possible l4type of FDIR filters.
741 RTE_FDIR_L4TYPE_NONE = 0, /**< None. */
742 RTE_FDIR_L4TYPE_UDP, /**< UDP. */
743 RTE_FDIR_L4TYPE_TCP, /**< TCP. */
744 RTE_FDIR_L4TYPE_SCTP, /**< SCTP. */
748 * Select IPv4 or IPv6 FDIR filters.
751 RTE_FDIR_IPTYPE_IPV4 = 0, /**< IPv4. */
752 RTE_FDIR_IPTYPE_IPV6 , /**< IPv6. */
756 * A structure used to define a FDIR packet filter.
758 struct rte_fdir_filter {
759 uint16_t flex_bytes; /**< Flex bytes value to match. */
760 uint16_t vlan_id; /**< VLAN ID value to match, 0 otherwise. */
761 uint16_t port_src; /**< Source port to match, 0 otherwise. */
762 uint16_t port_dst; /**< Destination port to match, 0 otherwise. */
764 uint32_t ipv4_addr; /**< IPv4 source address to match. */
765 uint32_t ipv6_addr[4]; /**< IPv6 source address to match. */
766 } ip_src; /**< IPv4/IPv6 source address to match (union of above). */
768 uint32_t ipv4_addr; /**< IPv4 destination address to match. */
769 uint32_t ipv6_addr[4]; /**< IPv6 destination address to match */
770 } ip_dst; /**< IPv4/IPv6 destination address to match (union of above). */
771 enum rte_l4type l4type; /**< l4type to match: NONE/UDP/TCP/SCTP. */
772 enum rte_iptype iptype; /**< IP packet type to match: IPv4 or IPv6. */
776 * A structure used to configure FDIR masks that are used by the device
777 * to match the various fields of RX packet headers.
778 * @note The only_ip_flow field has the opposite meaning compared to other
781 struct rte_fdir_masks {
782 /** When set to 1, packet l4type is \b NOT relevant in filters, and
783 source and destination port masks must be set to zero. */
784 uint8_t only_ip_flow;
785 /** If set to 1, vlan_id is relevant in filters. */
787 /** If set to 1, vlan_prio is relevant in filters. */
789 /** If set to 1, flexbytes is relevant in filters. */
791 /** If set to 1, set the IPv6 masks. Otherwise set the IPv4 masks. */
792 uint8_t set_ipv6_mask;
793 /** When set to 1, comparison of destination IPv6 address with IP6AT
794 registers is meaningful. */
795 uint8_t comp_ipv6_dst;
796 /** Mask of Destination IPv4 Address. All bits set to 1 define the
797 relevant bits to use in the destination address of an IPv4 packet
798 when matching it against FDIR filters. */
799 uint32_t dst_ipv4_mask;
800 /** Mask of Source IPv4 Address. All bits set to 1 define
801 the relevant bits to use in the source address of an IPv4 packet
802 when matching it against FDIR filters. */
803 uint32_t src_ipv4_mask;
804 /** Mask of Source IPv6 Address. All bits set to 1 define the
805 relevant BYTES to use in the source address of an IPv6 packet
806 when matching it against FDIR filters. */
807 uint16_t dst_ipv6_mask;
808 /** Mask of Destination IPv6 Address. All bits set to 1 define the
809 relevant BYTES to use in the destination address of an IPv6 packet
810 when matching it against FDIR filters. */
811 uint16_t src_ipv6_mask;
812 /** Mask of Source Port. All bits set to 1 define the relevant
813 bits to use in the source port of an IP packets when matching it
814 against FDIR filters. */
815 uint16_t src_port_mask;
816 /** Mask of Destination Port. All bits set to 1 define the relevant
817 bits to use in the destination port of an IP packet when matching it
818 against FDIR filters. */
819 uint16_t dst_port_mask;
823 * A structure used to report the status of the flow director filters in use.
825 struct rte_eth_fdir {
826 /** Number of filters with collision indication. */
828 /** Number of free (non programmed) filters. */
830 /** The Lookup hash value of the added filter that updated the value
831 of the MAXLEN field */
833 /** Longest linked list of filters in the table. */
835 /** Number of added filters. */
837 /** Number of removed filters. */
839 /** Number of failed added filters (no more space in device). */
841 /** Number of failed removed filters. */
846 * A structure used to enable/disable specific device interrupts.
848 struct rte_intr_conf {
849 /** enable/disable lsc interrupt. 0 (default) - disable, 1 enable */
854 * A structure used to configure an Ethernet port.
855 * Depending upon the RX multi-queue mode, extra advanced
856 * configuration settings may be needed.
858 struct rte_eth_conf {
860 /**< ETH_LINK_SPEED_10[0|00|000], or 0 for autonegotation */
861 uint16_t link_duplex;
862 /**< ETH_LINK_[HALF_DUPLEX|FULL_DUPLEX], or 0 for autonegotation */
863 struct rte_eth_rxmode rxmode; /**< Port RX configuration. */
864 struct rte_eth_txmode txmode; /**< Port TX configuration. */
865 uint32_t lpbk_mode; /**< Loopback operation mode. By default the value
866 is 0, meaning the loopback mode is disabled.
867 Read the datasheet of given ethernet controller
868 for details. The possible values of this field
869 are defined in implementation of each driver. */
871 struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
872 struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
873 /**< Port vmdq+dcb configuration. */
874 struct rte_eth_dcb_rx_conf dcb_rx_conf;
875 /**< Port dcb RX configuration. */
876 struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
877 /**< Port vmdq RX configuration. */
878 } rx_adv_conf; /**< Port RX filtering configuration (union). */
880 struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
881 /**< Port vmdq+dcb TX configuration. */
882 struct rte_eth_dcb_tx_conf dcb_tx_conf;
883 /**< Port dcb TX configuration. */
884 struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
885 /**< Port vmdq TX configuration. */
886 } tx_adv_conf; /**< Port TX DCB configuration (union). */
887 /** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
888 is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
889 uint32_t dcb_capability_en;
890 struct rte_fdir_conf fdir_conf; /**< FDIR configuration. */
891 struct rte_intr_conf intr_conf; /**< Interrupt mode configuration. */
895 * A structure used to retrieve the contextual information of
896 * an Ethernet device, such as the controlling driver of the device,
897 * its PCI context, etc...
901 * RX offload capabilities of a device.
903 #define DEV_RX_OFFLOAD_VLAN_STRIP 0x00000001
904 #define DEV_RX_OFFLOAD_IPV4_CKSUM 0x00000002
905 #define DEV_RX_OFFLOAD_UDP_CKSUM 0x00000004
906 #define DEV_RX_OFFLOAD_TCP_CKSUM 0x00000008
907 #define DEV_RX_OFFLOAD_TCP_LRO 0x00000010
910 * TX offload capabilities of a device.
912 #define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001
913 #define DEV_TX_OFFLOAD_IPV4_CKSUM 0x00000002
914 #define DEV_TX_OFFLOAD_UDP_CKSUM 0x00000004
915 #define DEV_TX_OFFLOAD_TCP_CKSUM 0x00000008
916 #define DEV_TX_OFFLOAD_SCTP_CKSUM 0x00000010
917 #define DEV_TX_OFFLOAD_TCP_TSO 0x00000020
918 #define DEV_TX_OFFLOAD_UDP_TSO 0x00000040
920 struct rte_eth_dev_info {
921 struct rte_pci_device *pci_dev; /**< Device PCI information. */
922 const char *driver_name; /**< Device Driver name. */
923 unsigned int if_index; /**< Index to bound host interface, or 0 if none.
924 Use if_indextoname() to translate into an interface name. */
925 uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
926 uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
927 uint16_t max_rx_queues; /**< Maximum number of RX queues. */
928 uint16_t max_tx_queues; /**< Maximum number of TX queues. */
929 uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
930 uint32_t max_hash_mac_addrs;
931 /** Maximum number of hash MAC addresses for MTA and UTA. */
932 uint16_t max_vfs; /**< Maximum number of VFs. */
933 uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
934 uint32_t rx_offload_capa; /**< Device RX offload capabilities. */
935 uint32_t tx_offload_capa; /**< Device TX offload capabilities. */
936 struct rte_eth_rxconf default_rxconf; /**< Default RX configuration */
937 struct rte_eth_txconf default_txconf; /**< Default TX configuration */
938 uint16_t vmdq_queue_base; /**< First queue ID for VMDQ pools. */
939 uint16_t vmdq_queue_num; /**< Queue number for VMDQ pools. */
940 uint16_t vmdq_pool_base; /**< First ID of VMDQ pools. */
943 /** Maximum name length for extended statistics counters */
944 #define RTE_ETH_XSTATS_NAME_SIZE 64
947 * An Ethernet device extended statistic structure
949 * This structure is used by ethdev->eth_xstats_get() to provide
950 * statistics that are not provided in the generic rte_eth_stats
953 struct rte_eth_xstats {
954 char name[RTE_ETH_XSTATS_NAME_SIZE];
960 struct rte_eth_dev_callback;
961 /** @internal Structure to keep track of registered callbacks */
962 TAILQ_HEAD(rte_eth_dev_cb_list, rte_eth_dev_callback);
964 #define TCP_UGR_FLAG 0x20
965 #define TCP_ACK_FLAG 0x10
966 #define TCP_PSH_FLAG 0x08
967 #define TCP_RST_FLAG 0x04
968 #define TCP_SYN_FLAG 0x02
969 #define TCP_FIN_FLAG 0x01
970 #define TCP_FLAG_ALL 0x3F
973 * A structure used to define an ethertype filter.
975 struct rte_ethertype_filter {
976 uint16_t ethertype; /**< little endian. */
977 uint8_t priority_en; /**< compare priority enable. */
982 * A structure used to define an syn filter.
984 struct rte_syn_filter {
985 uint8_t hig_pri; /**< 1 means higher pri than 2tuple, 5tupe,
986 and flex filter, 0 means lower pri. */
990 * A structure used to define a 2tuple filter.
992 struct rte_2tuple_filter {
993 uint16_t dst_port; /**< big endian. */
996 uint16_t priority; /**< used when more than one filter matches. */
997 uint8_t dst_port_mask:1, /**< if mask is 1b, means not compare. */
1002 * A structure used to define a flex filter.
1004 struct rte_flex_filter {
1006 uint32_t dwords[32]; /**< flex bytes in big endian. */
1007 uint8_t mask[16]; /**< if mask bit is 1b, do not compare
1008 corresponding byte in dwords. */
1013 * A structure used to define a 5tuple filter.
1015 struct rte_5tuple_filter {
1016 uint32_t dst_ip; /**< destination IP address in big endian. */
1017 uint32_t src_ip; /**< source IP address in big endian. */
1018 uint16_t dst_port; /**< destination port in big endian. */
1019 uint16_t src_port; /**< source Port big endian. */
1020 uint8_t protocol; /**< l4 protocol. */
1021 uint8_t tcp_flags; /**< tcp flags. */
1022 uint16_t priority; /**< seven evels (001b-111b), 111b is highest,
1023 used when more than one filter matches. */
1024 uint8_t dst_ip_mask:1, /**< if mask is 1b, do not compare dst ip. */
1025 src_ip_mask:1, /**< if mask is 1b, do not compare src ip. */
1026 dst_port_mask:1, /**< if mask is 1b, do not compare dst port. */
1027 src_port_mask:1, /**< if mask is 1b, do not compare src port. */
1028 protocol_mask:1; /**< if mask is 1b, do not compare protocol. */
1032 * Definitions of all functions exported by an Ethernet driver through the
1033 * the generic structure of type *eth_dev_ops* supplied in the *rte_eth_dev*
1034 * structure associated with an Ethernet device.
1037 typedef int (*eth_dev_configure_t)(struct rte_eth_dev *dev);
1038 /**< @internal Ethernet device configuration. */
1040 typedef int (*eth_dev_start_t)(struct rte_eth_dev *dev);
1041 /**< @internal Function used to start a configured Ethernet device. */
1043 typedef void (*eth_dev_stop_t)(struct rte_eth_dev *dev);
1044 /**< @internal Function used to stop a configured Ethernet device. */
1046 typedef int (*eth_dev_set_link_up_t)(struct rte_eth_dev *dev);
1047 /**< @internal Function used to link up a configured Ethernet device. */
1049 typedef int (*eth_dev_set_link_down_t)(struct rte_eth_dev *dev);
1050 /**< @internal Function used to link down a configured Ethernet device. */
1052 typedef void (*eth_dev_close_t)(struct rte_eth_dev *dev);
1053 /**< @internal Function used to close a configured Ethernet device. */
1055 typedef void (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev);
1056 /**< @internal Function used to enable the RX promiscuous mode of an Ethernet device. */
1058 typedef void (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev);
1059 /**< @internal Function used to disable the RX promiscuous mode of an Ethernet device. */
1061 typedef void (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
1062 /**< @internal Enable the receipt of all multicast packets by an Ethernet device. */
1064 typedef void (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
1065 /**< @internal Disable the receipt of all multicast packets by an Ethernet device. */
1067 typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
1068 int wait_to_complete);
1069 /**< @internal Get link speed, duplex mode and state (up/down) of an Ethernet device. */
1071 typedef void (*eth_stats_get_t)(struct rte_eth_dev *dev,
1072 struct rte_eth_stats *igb_stats);
1073 /**< @internal Get global I/O statistics of an Ethernet device. */
1075 typedef void (*eth_stats_reset_t)(struct rte_eth_dev *dev);
1076 /**< @internal Reset global I/O statistics of an Ethernet device to 0. */
1078 typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev,
1079 struct rte_eth_xstats *stats, unsigned n);
1080 /**< @internal Get extended stats of an Ethernet device. */
1082 typedef void (*eth_xstats_reset_t)(struct rte_eth_dev *dev);
1083 /**< @internal Reset extended stats of an Ethernet device. */
1085 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
1089 /**< @internal Set a queue statistics mapping for a tx/rx queue of an Ethernet device. */
1091 typedef void (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
1092 struct rte_eth_dev_info *dev_info);
1093 /**< @internal Get specific informations of an Ethernet device. */
1095 typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
1097 /**< @internal Start rx and tx of a queue of an Ethernet device. */
1099 typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
1101 /**< @internal Stop rx and tx of a queue of an Ethernet device. */
1103 typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
1104 uint16_t rx_queue_id,
1105 uint16_t nb_rx_desc,
1106 unsigned int socket_id,
1107 const struct rte_eth_rxconf *rx_conf,
1108 struct rte_mempool *mb_pool);
1109 /**< @internal Set up a receive queue of an Ethernet device. */
1111 typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
1112 uint16_t tx_queue_id,
1113 uint16_t nb_tx_desc,
1114 unsigned int socket_id,
1115 const struct rte_eth_txconf *tx_conf);
1116 /**< @internal Setup a transmit queue of an Ethernet device. */
1118 typedef void (*eth_queue_release_t)(void *queue);
1119 /**< @internal Release memory resources allocated by given RX/TX queue. */
1121 typedef uint32_t (*eth_rx_queue_count_t)(struct rte_eth_dev *dev,
1122 uint16_t rx_queue_id);
1123 /**< @Get number of available descriptors on a receive queue of an Ethernet device. */
1125 typedef int (*eth_rx_descriptor_done_t)(void *rxq, uint16_t offset);
1126 /**< @Check DD bit of specific RX descriptor */
1128 typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);
1129 /**< @internal Set MTU. */
1131 typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
1134 /**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */
1136 typedef void (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
1138 /**< @internal set the outer VLAN-TPID by an Ethernet device. */
1140 typedef void (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
1141 /**< @internal set VLAN offload function by an Ethernet device. */
1143 typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
1146 /**< @internal set port based TX VLAN insertion by an Ethernet device. */
1148 typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
1149 uint16_t rx_queue_id,
1151 /**< @internal VLAN stripping enable/disable by an queue of Ethernet device. */
1153 typedef uint16_t (*eth_rx_burst_t)(void *rxq,
1154 struct rte_mbuf **rx_pkts,
1156 /**< @internal Retrieve input packets from a receive queue of an Ethernet device. */
1158 typedef uint16_t (*eth_tx_burst_t)(void *txq,
1159 struct rte_mbuf **tx_pkts,
1161 /**< @internal Send output packets on a transmit queue of an Ethernet device. */
1163 typedef int (*fdir_add_signature_filter_t)(struct rte_eth_dev *dev,
1164 struct rte_fdir_filter *fdir_ftr,
1166 /**< @internal Setup a new signature filter rule on an Ethernet device */
1168 typedef int (*fdir_update_signature_filter_t)(struct rte_eth_dev *dev,
1169 struct rte_fdir_filter *fdir_ftr,
1171 /**< @internal Update a signature filter rule on an Ethernet device */
1173 typedef int (*fdir_remove_signature_filter_t)(struct rte_eth_dev *dev,
1174 struct rte_fdir_filter *fdir_ftr);
1175 /**< @internal Remove a signature filter rule on an Ethernet device */
1177 typedef void (*fdir_infos_get_t)(struct rte_eth_dev *dev,
1178 struct rte_eth_fdir *fdir);
1179 /**< @internal Get information about fdir status */
1181 typedef int (*fdir_add_perfect_filter_t)(struct rte_eth_dev *dev,
1182 struct rte_fdir_filter *fdir_ftr,
1183 uint16_t soft_id, uint8_t rx_queue,
1185 /**< @internal Setup a new perfect filter rule on an Ethernet device */
1187 typedef int (*fdir_update_perfect_filter_t)(struct rte_eth_dev *dev,
1188 struct rte_fdir_filter *fdir_ftr,
1189 uint16_t soft_id, uint8_t rx_queue,
1191 /**< @internal Update a perfect filter rule on an Ethernet device */
1193 typedef int (*fdir_remove_perfect_filter_t)(struct rte_eth_dev *dev,
1194 struct rte_fdir_filter *fdir_ftr,
1196 /**< @internal Remove a perfect filter rule on an Ethernet device */
1198 typedef int (*fdir_set_masks_t)(struct rte_eth_dev *dev,
1199 struct rte_fdir_masks *fdir_masks);
1200 /**< @internal Setup flow director masks on an Ethernet device */
1202 typedef int (*flow_ctrl_get_t)(struct rte_eth_dev *dev,
1203 struct rte_eth_fc_conf *fc_conf);
1204 /**< @internal Get current flow control parameter on an Ethernet device */
1206 typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
1207 struct rte_eth_fc_conf *fc_conf);
1208 /**< @internal Setup flow control parameter on an Ethernet device */
1210 typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
1211 struct rte_eth_pfc_conf *pfc_conf);
1212 /**< @internal Setup priority flow control parameter on an Ethernet device */
1214 typedef int (*reta_update_t)(struct rte_eth_dev *dev,
1215 struct rte_eth_rss_reta *reta_conf);
1216 /**< @internal Update RSS redirection table on an Ethernet device */
1218 typedef int (*reta_query_t)(struct rte_eth_dev *dev,
1219 struct rte_eth_rss_reta *reta_conf);
1220 /**< @internal Query RSS redirection table on an Ethernet device */
1222 typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
1223 struct rte_eth_rss_conf *rss_conf);
1224 /**< @internal Update RSS hash configuration of an Ethernet device */
1226 typedef int (*rss_hash_conf_get_t)(struct rte_eth_dev *dev,
1227 struct rte_eth_rss_conf *rss_conf);
1228 /**< @internal Get current RSS hash configuration of an Ethernet device */
1230 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
1231 /**< @internal Turn on SW controllable LED on an Ethernet device */
1233 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
1234 /**< @internal Turn off SW controllable LED on an Ethernet device */
1236 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
1237 /**< @internal Remove MAC address from receive address register */
1239 typedef void (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
1240 struct ether_addr *mac_addr,
1243 /**< @internal Set a MAC address into Receive Address Address Register */
1245 typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
1246 struct ether_addr *mac_addr,
1248 /**< @internal Set a Unicast Hash bitmap */
1250 typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
1252 /**< @internal Set all Unicast Hash bitmap */
1254 typedef int (*eth_set_vf_rx_mode_t)(struct rte_eth_dev *dev,
1258 /**< @internal Set a VF receive mode */
1260 typedef int (*eth_set_vf_rx_t)(struct rte_eth_dev *dev,
1263 /**< @internal Set a VF receive mode */
1265 typedef int (*eth_set_vf_tx_t)(struct rte_eth_dev *dev,
1268 /**< @internal Enable or disable a VF transmit */
1270 typedef int (*eth_set_vf_vlan_filter_t)(struct rte_eth_dev *dev,
1274 /**< @internal Set VF VLAN pool filter */
1276 typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
1279 /**< @internal Set queue TX rate */
1281 typedef int (*eth_set_vf_rate_limit_t)(struct rte_eth_dev *dev,
1285 /**< @internal Set VF TX rate */
1287 typedef int (*eth_mirror_rule_set_t)(struct rte_eth_dev *dev,
1288 struct rte_eth_vmdq_mirror_conf *mirror_conf,
1291 /**< @internal Add a traffic mirroring rule on an Ethernet device */
1293 typedef int (*eth_mirror_rule_reset_t)(struct rte_eth_dev *dev,
1295 /**< @internal Remove a traffic mirroring rule on an Ethernet device */
1297 typedef int (*eth_udp_tunnel_add_t)(struct rte_eth_dev *dev,
1298 struct rte_eth_udp_tunnel *tunnel_udp);
1299 /**< @internal Add tunneling UDP info */
1301 typedef int (*eth_udp_tunnel_del_t)(struct rte_eth_dev *dev,
1302 struct rte_eth_udp_tunnel *tunnel_udp);
1303 /**< @internal Delete tunneling UDP info */
1306 #ifdef RTE_NIC_BYPASS
1309 RTE_BYPASS_MODE_NONE,
1310 RTE_BYPASS_MODE_NORMAL,
1311 RTE_BYPASS_MODE_BYPASS,
1312 RTE_BYPASS_MODE_ISOLATE,
1313 RTE_BYPASS_MODE_NUM,
1316 #define RTE_BYPASS_MODE_VALID(x) \
1317 ((x) > RTE_BYPASS_MODE_NONE && (x) < RTE_BYPASS_MODE_NUM)
1320 RTE_BYPASS_EVENT_NONE,
1321 RTE_BYPASS_EVENT_START,
1322 RTE_BYPASS_EVENT_OS_ON = RTE_BYPASS_EVENT_START,
1323 RTE_BYPASS_EVENT_POWER_ON,
1324 RTE_BYPASS_EVENT_OS_OFF,
1325 RTE_BYPASS_EVENT_POWER_OFF,
1326 RTE_BYPASS_EVENT_TIMEOUT,
1327 RTE_BYPASS_EVENT_NUM
1330 #define RTE_BYPASS_EVENT_VALID(x) \
1331 ((x) > RTE_BYPASS_EVENT_NONE && (x) < RTE_BYPASS_MODE_NUM)
1334 RTE_BYPASS_TMT_OFF, /* timeout disabled. */
1335 RTE_BYPASS_TMT_1_5_SEC, /* timeout for 1.5 seconds */
1336 RTE_BYPASS_TMT_2_SEC, /* timeout for 2 seconds */
1337 RTE_BYPASS_TMT_3_SEC, /* timeout for 3 seconds */
1338 RTE_BYPASS_TMT_4_SEC, /* timeout for 4 seconds */
1339 RTE_BYPASS_TMT_8_SEC, /* timeout for 8 seconds */
1340 RTE_BYPASS_TMT_16_SEC, /* timeout for 16 seconds */
1341 RTE_BYPASS_TMT_32_SEC, /* timeout for 32 seconds */
1345 #define RTE_BYPASS_TMT_VALID(x) \
1346 ((x) == RTE_BYPASS_TMT_OFF || \
1347 ((x) > RTE_BYPASS_TMT_OFF && (x) < RTE_BYPASS_TMT_NUM))
1349 typedef void (*bypass_init_t)(struct rte_eth_dev *dev);
1350 typedef int32_t (*bypass_state_set_t)(struct rte_eth_dev *dev, uint32_t *new_state);
1351 typedef int32_t (*bypass_state_show_t)(struct rte_eth_dev *dev, uint32_t *state);
1352 typedef int32_t (*bypass_event_set_t)(struct rte_eth_dev *dev, uint32_t state, uint32_t event);
1353 typedef int32_t (*bypass_event_show_t)(struct rte_eth_dev *dev, uint32_t event_shift, uint32_t *event);
1354 typedef int32_t (*bypass_wd_timeout_set_t)(struct rte_eth_dev *dev, uint32_t timeout);
1355 typedef int32_t (*bypass_wd_timeout_show_t)(struct rte_eth_dev *dev, uint32_t *wd_timeout);
1356 typedef int32_t (*bypass_ver_show_t)(struct rte_eth_dev *dev, uint32_t *ver);
1357 typedef int32_t (*bypass_wd_reset_t)(struct rte_eth_dev *dev);
1360 typedef int (*eth_add_syn_filter_t)(struct rte_eth_dev *dev,
1361 struct rte_syn_filter *filter, uint16_t rx_queue);
1362 /**< @internal add syn filter rule on an Ethernet device */
1364 typedef int (*eth_remove_syn_filter_t)(struct rte_eth_dev *dev);
1365 /**< @internal remove syn filter rule on an Ethernet device */
1367 typedef int (*eth_get_syn_filter_t)(struct rte_eth_dev *dev,
1368 struct rte_syn_filter *filter, uint16_t *rx_queue);
1369 /**< @internal Get syn filter rule on an Ethernet device */
1371 typedef int (*eth_add_ethertype_filter_t)(struct rte_eth_dev *dev,
1372 uint16_t index, struct rte_ethertype_filter *filter,
1374 /**< @internal Setup a new ethertype filter rule on an Ethernet device */
1376 typedef int (*eth_remove_ethertype_filter_t)(struct rte_eth_dev *dev,
1378 /**< @internal Remove an ethertype filter rule on an Ethernet device */
1380 typedef int (*eth_get_ethertype_filter_t)(struct rte_eth_dev *dev,
1381 uint16_t index, struct rte_ethertype_filter *filter,
1382 uint16_t *rx_queue);
1383 /**< @internal Get an ethertype filter rule on an Ethernet device */
1385 typedef int (*eth_add_2tuple_filter_t)(struct rte_eth_dev *dev,
1386 uint16_t index, struct rte_2tuple_filter *filter,
1388 /**< @internal Setup a new 2tuple filter rule on an Ethernet device */
1390 typedef int (*eth_remove_2tuple_filter_t)(struct rte_eth_dev *dev,
1392 /**< @internal Remove a 2tuple filter rule on an Ethernet device */
1394 typedef int (*eth_get_2tuple_filter_t)(struct rte_eth_dev *dev,
1395 uint16_t index, struct rte_2tuple_filter *filter,
1396 uint16_t *rx_queue);
1397 /**< @internal Get a 2tuple filter rule on an Ethernet device */
1399 typedef int (*eth_add_5tuple_filter_t)(struct rte_eth_dev *dev,
1400 uint16_t index, struct rte_5tuple_filter *filter,
1402 /**< @internal Setup a new 5tuple filter rule on an Ethernet device */
1404 typedef int (*eth_remove_5tuple_filter_t)(struct rte_eth_dev *dev,
1406 /**< @internal Remove a 5tuple filter rule on an Ethernet device */
1408 typedef int (*eth_get_5tuple_filter_t)(struct rte_eth_dev *dev,
1409 uint16_t index, struct rte_5tuple_filter *filter,
1410 uint16_t *rx_queue);
1411 /**< @internal Get a 5tuple filter rule on an Ethernet device */
1413 typedef int (*eth_add_flex_filter_t)(struct rte_eth_dev *dev,
1414 uint16_t index, struct rte_flex_filter *filter,
1416 /**< @internal Setup a new flex filter rule on an Ethernet device */
1418 typedef int (*eth_remove_flex_filter_t)(struct rte_eth_dev *dev,
1420 /**< @internal Remove a flex filter rule on an Ethernet device */
1422 typedef int (*eth_get_flex_filter_t)(struct rte_eth_dev *dev,
1423 uint16_t index, struct rte_flex_filter *filter,
1424 uint16_t *rx_queue);
1425 /**< @internal Get a flex filter rule on an Ethernet device */
1427 typedef int (*eth_filter_ctrl_t)(struct rte_eth_dev *dev,
1428 enum rte_filter_type filter_type,
1429 enum rte_filter_op filter_op,
1431 /**< @internal Take operations to assigned filter type on an Ethernet device */
1434 * @internal A structure containing the functions exported by an Ethernet driver.
1436 struct eth_dev_ops {
1437 eth_dev_configure_t dev_configure; /**< Configure device. */
1438 eth_dev_start_t dev_start; /**< Start device. */
1439 eth_dev_stop_t dev_stop; /**< Stop device. */
1440 eth_dev_set_link_up_t dev_set_link_up; /**< Device link up. */
1441 eth_dev_set_link_down_t dev_set_link_down; /**< Device link down. */
1442 eth_dev_close_t dev_close; /**< Close device. */
1443 eth_promiscuous_enable_t promiscuous_enable; /**< Promiscuous ON. */
1444 eth_promiscuous_disable_t promiscuous_disable;/**< Promiscuous OFF. */
1445 eth_allmulticast_enable_t allmulticast_enable;/**< RX multicast ON. */
1446 eth_allmulticast_disable_t allmulticast_disable;/**< RX multicast OF. */
1447 eth_link_update_t link_update; /**< Get device link state. */
1448 eth_stats_get_t stats_get; /**< Get generic device statistics. */
1449 eth_stats_reset_t stats_reset; /**< Reset generic device statistics. */
1450 eth_xstats_get_t xstats_get; /**< Get extended device statistics. */
1451 eth_xstats_reset_t xstats_reset; /**< Reset extended device statistics. */
1452 eth_queue_stats_mapping_set_t queue_stats_mapping_set;
1453 /**< Configure per queue stat counter mapping. */
1454 eth_dev_infos_get_t dev_infos_get; /**< Get device info. */
1455 mtu_set_t mtu_set; /**< Set MTU. */
1456 vlan_filter_set_t vlan_filter_set; /**< Filter VLAN Setup. */
1457 vlan_tpid_set_t vlan_tpid_set; /**< Outer VLAN TPID Setup. */
1458 vlan_strip_queue_set_t vlan_strip_queue_set; /**< VLAN Stripping on queue. */
1459 vlan_offload_set_t vlan_offload_set; /**< Set VLAN Offload. */
1460 vlan_pvid_set_t vlan_pvid_set; /**< Set port based TX VLAN insertion */
1461 eth_queue_start_t rx_queue_start;/**< Start RX for a queue.*/
1462 eth_queue_stop_t rx_queue_stop;/**< Stop RX for a queue.*/
1463 eth_queue_start_t tx_queue_start;/**< Start TX for a queue.*/
1464 eth_queue_stop_t tx_queue_stop;/**< Stop TX for a queue.*/
1465 eth_rx_queue_setup_t rx_queue_setup;/**< Set up device RX queue.*/
1466 eth_queue_release_t rx_queue_release;/**< Release RX queue.*/
1467 eth_rx_queue_count_t rx_queue_count; /**< Get Rx queue count. */
1468 eth_rx_descriptor_done_t rx_descriptor_done; /**< Check rxd DD bit */
1469 eth_tx_queue_setup_t tx_queue_setup;/**< Set up device TX queue.*/
1470 eth_queue_release_t tx_queue_release;/**< Release TX queue.*/
1471 eth_dev_led_on_t dev_led_on; /**< Turn on LED. */
1472 eth_dev_led_off_t dev_led_off; /**< Turn off LED. */
1473 flow_ctrl_get_t flow_ctrl_get; /**< Get flow control. */
1474 flow_ctrl_set_t flow_ctrl_set; /**< Setup flow control. */
1475 priority_flow_ctrl_set_t priority_flow_ctrl_set; /**< Setup priority flow control.*/
1476 eth_mac_addr_remove_t mac_addr_remove; /**< Remove MAC address */
1477 eth_mac_addr_add_t mac_addr_add; /**< Add a MAC address */
1478 eth_uc_hash_table_set_t uc_hash_table_set; /**< Set Unicast Table Array */
1479 eth_uc_all_hash_table_set_t uc_all_hash_table_set; /**< Set Unicast hash bitmap */
1480 eth_mirror_rule_set_t mirror_rule_set; /**< Add a traffic mirror rule.*/
1481 eth_mirror_rule_reset_t mirror_rule_reset; /**< reset a traffic mirror rule.*/
1482 eth_set_vf_rx_mode_t set_vf_rx_mode; /**< Set VF RX mode */
1483 eth_set_vf_rx_t set_vf_rx; /**< enable/disable a VF receive */
1484 eth_set_vf_tx_t set_vf_tx; /**< enable/disable a VF transmit */
1485 eth_set_vf_vlan_filter_t set_vf_vlan_filter; /**< Set VF VLAN filter */
1486 eth_udp_tunnel_add_t udp_tunnel_add;
1487 eth_udp_tunnel_del_t udp_tunnel_del;
1488 eth_set_queue_rate_limit_t set_queue_rate_limit; /**< Set queue rate limit */
1489 eth_set_vf_rate_limit_t set_vf_rate_limit; /**< Set VF rate limit */
1491 /** Add a signature filter. */
1492 fdir_add_signature_filter_t fdir_add_signature_filter;
1493 /** Update a signature filter. */
1494 fdir_update_signature_filter_t fdir_update_signature_filter;
1495 /** Remove a signature filter. */
1496 fdir_remove_signature_filter_t fdir_remove_signature_filter;
1497 /** Get information about FDIR status. */
1498 fdir_infos_get_t fdir_infos_get;
1499 /** Add a perfect filter. */
1500 fdir_add_perfect_filter_t fdir_add_perfect_filter;
1501 /** Update a perfect filter. */
1502 fdir_update_perfect_filter_t fdir_update_perfect_filter;
1503 /** Remove a perfect filter. */
1504 fdir_remove_perfect_filter_t fdir_remove_perfect_filter;
1505 /** Setup masks for FDIR filtering. */
1506 fdir_set_masks_t fdir_set_masks;
1507 /** Update redirection table. */
1508 reta_update_t reta_update;
1509 /** Query redirection table. */
1510 reta_query_t reta_query;
1511 /* bypass control */
1512 #ifdef RTE_NIC_BYPASS
1513 bypass_init_t bypass_init;
1514 bypass_state_set_t bypass_state_set;
1515 bypass_state_show_t bypass_state_show;
1516 bypass_event_set_t bypass_event_set;
1517 bypass_event_show_t bypass_event_show;
1518 bypass_wd_timeout_set_t bypass_wd_timeout_set;
1519 bypass_wd_timeout_show_t bypass_wd_timeout_show;
1520 bypass_ver_show_t bypass_ver_show;
1521 bypass_wd_reset_t bypass_wd_reset;
1524 /** Configure RSS hash protocols. */
1525 rss_hash_update_t rss_hash_update;
1526 /** Get current RSS hash configuration. */
1527 rss_hash_conf_get_t rss_hash_conf_get;
1528 eth_add_syn_filter_t add_syn_filter; /**< add syn filter. */
1529 eth_remove_syn_filter_t remove_syn_filter; /**< remove syn filter. */
1530 eth_get_syn_filter_t get_syn_filter; /**< get syn filter. */
1531 eth_add_ethertype_filter_t add_ethertype_filter; /**< add ethertype filter. */
1532 eth_remove_ethertype_filter_t remove_ethertype_filter; /**< remove ethertype filter. */
1533 eth_get_ethertype_filter_t get_ethertype_filter; /**< get ethertype filter. */
1534 eth_add_2tuple_filter_t add_2tuple_filter; /**< add 2tuple filter. */
1535 eth_remove_2tuple_filter_t remove_2tuple_filter; /**< remove 2tuple filter. */
1536 eth_get_2tuple_filter_t get_2tuple_filter; /**< get 2tuple filter. */
1537 eth_add_5tuple_filter_t add_5tuple_filter; /**< add 5tuple filter. */
1538 eth_remove_5tuple_filter_t remove_5tuple_filter; /**< remove 5tuple filter. */
1539 eth_get_5tuple_filter_t get_5tuple_filter; /**< get 5tuple filter. */
1540 eth_add_flex_filter_t add_flex_filter; /**< add flex filter. */
1541 eth_remove_flex_filter_t remove_flex_filter; /**< remove flex filter. */
1542 eth_get_flex_filter_t get_flex_filter; /**< get flex filter. */
1543 eth_filter_ctrl_t filter_ctrl; /**< common filter control*/
1548 * The generic data structure associated with each ethernet device.
1550 * Pointers to burst-oriented packet receive and transmit functions are
1551 * located at the beginning of the structure, along with the pointer to
1552 * where all the data elements for the particular device are stored in shared
1553 * memory. This split allows the function pointer and driver data to be per-
1554 * process, while the actual configuration data for the device is shared.
1556 struct rte_eth_dev {
1557 eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
1558 eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
1559 struct rte_eth_dev_data *data; /**< Pointer to device data */
1560 const struct eth_driver *driver;/**< Driver for this device */
1561 struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
1562 struct rte_pci_device *pci_dev; /**< PCI info. supplied by probing */
1563 struct rte_eth_dev_cb_list callbacks; /**< User application callbacks */
1566 struct rte_eth_dev_sriov {
1567 uint8_t active; /**< SRIOV is active with 16, 32 or 64 pools */
1568 uint8_t nb_q_per_pool; /**< rx queue number per pool */
1569 uint16_t def_vmdq_idx; /**< Default pool num used for PF */
1570 uint16_t def_pool_q_idx; /**< Default pool queue start reg index */
1572 #define RTE_ETH_DEV_SRIOV(dev) ((dev)->data->sriov)
1574 #define RTE_ETH_NAME_MAX_LEN (32)
1578 * The data part, with no function pointers, associated with each ethernet device.
1580 * This structure is safe to place in shared memory to be common among different
1581 * processes in a multi-process configuration.
1583 struct rte_eth_dev_data {
1584 char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
1586 void **rx_queues; /**< Array of pointers to RX queues. */
1587 void **tx_queues; /**< Array of pointers to TX queues. */
1588 uint16_t nb_rx_queues; /**< Number of RX queues. */
1589 uint16_t nb_tx_queues; /**< Number of TX queues. */
1591 struct rte_eth_dev_sriov sriov; /**< SRIOV data */
1593 void *dev_private; /**< PMD-specific private data */
1595 struct rte_eth_link dev_link;
1596 /**< Link-level information & status */
1598 struct rte_eth_conf dev_conf; /**< Configuration applied to device. */
1599 uint16_t mtu; /**< Maximum Transmission Unit. */
1601 uint32_t min_rx_buf_size;
1602 /**< Common rx buffer size handled by all queues */
1604 uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
1605 struct ether_addr* mac_addrs;/**< Device Ethernet Link address. */
1606 uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
1607 /** bitmap array of associating Ethernet MAC addresses to pools */
1608 struct ether_addr* hash_mac_addrs;
1609 /** Device Ethernet MAC addresses of hash filtering. */
1610 uint8_t port_id; /**< Device [external] port identifier. */
1611 uint8_t promiscuous : 1, /**< RX promiscuous mode ON(1) / OFF(0). */
1612 scattered_rx : 1, /**< RX of scattered packets is ON(1) / OFF(0) */
1613 all_multicast : 1, /**< RX all multicast mode ON(1) / OFF(0). */
1614 dev_started : 1; /**< Device state: STARTED(1) / STOPPED(0). */
1619 * The pool of *rte_eth_dev* structures. The size of the pool
1620 * is configured at compile-time in the <rte_ethdev.c> file.
1622 extern struct rte_eth_dev rte_eth_devices[];
1625 * Get the total number of Ethernet devices that have been successfully
1626 * initialized by the [matching] Ethernet driver during the PCI probing phase.
1627 * All devices whose port identifier is in the range
1628 * [0, rte_eth_dev_count() - 1] can be operated on by network applications.
1631 * - The total number of usable Ethernet devices.
1633 extern uint8_t rte_eth_dev_count(void);
1636 * Function for internal use by dummy drivers primarily, e.g. ring-based
1638 * Allocates a new ethdev slot for an ethernet device and returns the pointer
1639 * to that slot for the driver to use.
1641 * @param name Unique identifier name for each Ethernet device
1643 * - Slot in the rte_dev_devices array for a new device;
1645 struct rte_eth_dev *rte_eth_dev_allocate(const char *name);
1650 * Initialization function of an Ethernet driver invoked for each matching
1651 * Ethernet PCI device detected during the PCI probing phase.
1654 * The pointer to the [matching] Ethernet driver structure supplied by
1655 * the PMD when it registered itself.
1657 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1658 * associated with the matching device and which have been [automatically]
1659 * allocated in the *rte_eth_devices* array.
1660 * The *eth_dev* structure is supplied to the driver initialization function
1661 * with the following fields already initialized:
1663 * - *pci_dev*: Holds the pointers to the *rte_pci_device* structure which
1664 * contains the generic PCI information of the matching device.
1666 * - *dev_private*: Holds a pointer to the device private data structure.
1668 * - *max_frame_size*: Contains the default Ethernet maximum frame length
1671 * - *port_id*: Contains the port index of the device (actually the index
1672 * of the *eth_dev* structure in the *rte_eth_devices* array).
1675 * - 0: Success, the device is properly initialized by the driver.
1676 * In particular, the driver MUST have set up the *dev_ops* pointer
1677 * of the *eth_dev* structure.
1678 * - <0: Error code of the device initialization failure.
1680 typedef int (*eth_dev_init_t)(struct eth_driver *eth_drv,
1681 struct rte_eth_dev *eth_dev);
1685 * The structure associated with a PMD Ethernet driver.
1687 * Each Ethernet driver acts as a PCI driver and is represented by a generic
1688 * *eth_driver* structure that holds:
1690 * - An *rte_pci_driver* structure (which must be the first field).
1692 * - The *eth_dev_init* function invoked for each matching PCI device.
1694 * - The size of the private data to allocate for each matching device.
1697 struct rte_pci_driver pci_drv; /**< The PMD is also a PCI driver. */
1698 eth_dev_init_t eth_dev_init; /**< Device init function. */
1699 unsigned int dev_private_size; /**< Size of device private data. */
1704 * A function invoked by the initialization function of an Ethernet driver
1705 * to simultaneously register itself as a PCI driver and as an Ethernet
1706 * Poll Mode Driver (PMD).
1709 * The pointer to the *eth_driver* structure associated with
1710 * the Ethernet driver.
1712 extern void rte_eth_driver_register(struct eth_driver *eth_drv);
1715 * Configure an Ethernet device.
1716 * This function must be invoked first before any other function in the
1717 * Ethernet API. This function can also be re-invoked when a device is in the
1721 * The port identifier of the Ethernet device to configure.
1722 * @param nb_rx_queue
1723 * The number of receive queues to set up for the Ethernet device.
1724 * @param nb_tx_queue
1725 * The number of transmit queues to set up for the Ethernet device.
1727 * The pointer to the configuration data to be used for the Ethernet device.
1728 * The *rte_eth_conf* structure includes:
1729 * - the hardware offload features to activate, with dedicated fields for
1730 * each statically configurable offload hardware feature provided by
1731 * Ethernet devices, such as IP checksum or VLAN tag stripping for
1733 * - the Receive Side Scaling (RSS) configuration when using multiple RX
1736 * Embedding all configuration information in a single data structure
1737 * is the more flexible method that allows the addition of new features
1738 * without changing the syntax of the API.
1740 * - 0: Success, device configured.
1741 * - <0: Error code returned by the driver configuration function.
1743 extern int rte_eth_dev_configure(uint8_t port_id,
1744 uint16_t nb_rx_queue,
1745 uint16_t nb_tx_queue,
1746 const struct rte_eth_conf *eth_conf);
1749 * Allocate and set up a receive queue for an Ethernet device.
1751 * The function allocates a contiguous block of memory for *nb_rx_desc*
1752 * receive descriptors from a memory zone associated with *socket_id*
1753 * and initializes each receive descriptor with a network buffer allocated
1754 * from the memory pool *mb_pool*.
1757 * The port identifier of the Ethernet device.
1758 * @param rx_queue_id
1759 * The index of the receive queue to set up.
1760 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1761 * to rte_eth_dev_configure().
1763 * The number of receive descriptors to allocate for the receive ring.
1765 * The *socket_id* argument is the socket identifier in case of NUMA.
1766 * The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1767 * the DMA memory allocated for the receive descriptors of the ring.
1769 * The pointer to the configuration data to be used for the receive queue.
1770 * NULL value is allowed, in which case default RX configuration
1772 * The *rx_conf* structure contains an *rx_thresh* structure with the values
1773 * of the Prefetch, Host, and Write-Back threshold registers of the receive
1776 * The pointer to the memory pool from which to allocate *rte_mbuf* network
1777 * memory buffers to populate each descriptor of the receive ring.
1779 * - 0: Success, receive queue correctly set up.
1780 * - -EINVAL: The size of network buffers which can be allocated from the
1781 * memory pool does not fit the various buffer sizes allowed by the
1782 * device controller.
1783 * - -ENOMEM: Unable to allocate the receive ring descriptors or to
1784 * allocate network memory buffers from the memory pool when
1785 * initializing receive descriptors.
1787 extern int rte_eth_rx_queue_setup(uint8_t port_id, uint16_t rx_queue_id,
1788 uint16_t nb_rx_desc, unsigned int socket_id,
1789 const struct rte_eth_rxconf *rx_conf,
1790 struct rte_mempool *mb_pool);
1793 * Allocate and set up a transmit queue for an Ethernet device.
1796 * The port identifier of the Ethernet device.
1797 * @param tx_queue_id
1798 * The index of the transmit queue to set up.
1799 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1800 * to rte_eth_dev_configure().
1802 * The number of transmit descriptors to allocate for the transmit ring.
1804 * The *socket_id* argument is the socket identifier in case of NUMA.
1805 * Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1806 * the DMA memory allocated for the transmit descriptors of the ring.
1808 * The pointer to the configuration data to be used for the transmit queue.
1809 * NULL value is allowed, in which case default RX configuration
1811 * The *tx_conf* structure contains the following data:
1812 * - The *tx_thresh* structure with the values of the Prefetch, Host, and
1813 * Write-Back threshold registers of the transmit ring.
1814 * When setting Write-Back threshold to the value greater then zero,
1815 * *tx_rs_thresh* value should be explicitly set to one.
1816 * - The *tx_free_thresh* value indicates the [minimum] number of network
1817 * buffers that must be pending in the transmit ring to trigger their
1818 * [implicit] freeing by the driver transmit function.
1819 * - The *tx_rs_thresh* value indicates the [minimum] number of transmit
1820 * descriptors that must be pending in the transmit ring before setting the
1821 * RS bit on a descriptor by the driver transmit function.
1822 * The *tx_rs_thresh* value should be less or equal then
1823 * *tx_free_thresh* value, and both of them should be less then
1825 * - The *txq_flags* member contains flags to pass to the TX queue setup
1826 * function to configure the behavior of the TX queue. This should be set
1827 * to 0 if no special configuration is required.
1829 * Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces
1830 * the transmit function to use default values.
1832 * - 0: Success, the transmit queue is correctly set up.
1833 * - -ENOMEM: Unable to allocate the transmit ring descriptors.
1835 extern int rte_eth_tx_queue_setup(uint8_t port_id, uint16_t tx_queue_id,
1836 uint16_t nb_tx_desc, unsigned int socket_id,
1837 const struct rte_eth_txconf *tx_conf);
1840 * Return the NUMA socket to which an Ethernet device is connected
1843 * The port identifier of the Ethernet device
1845 * The NUMA socket id to which the Ethernet device is connected or
1846 * a default of zero if the socket could not be determined.
1847 * -1 is returned is the port_id value is out of range.
1849 extern int rte_eth_dev_socket_id(uint8_t port_id);
1852 * Allocate mbuf from mempool, setup the DMA physical address
1853 * and then start RX for specified queue of a port. It is used
1854 * when rx_deferred_start flag of the specified queue is true.
1857 * The port identifier of the Ethernet device
1858 * @param rx_queue_id
1859 * The index of the rx queue to update the ring.
1860 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1861 * to rte_eth_dev_configure().
1863 * - 0: Success, the transmit queue is correctly set up.
1864 * - -EINVAL: The port_id or the queue_id out of range.
1865 * - -ENOTSUP: The function not supported in PMD driver.
1867 extern int rte_eth_dev_rx_queue_start(uint8_t port_id, uint16_t rx_queue_id);
1870 * Stop specified RX queue of a port
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_stop(uint8_t port_id, uint16_t rx_queue_id);
1886 * Start TX for specified queue of a port. It is used when tx_deferred_start
1887 * flag of the specified queue is true.
1890 * The port identifier of the Ethernet device
1891 * @param tx_queue_id
1892 * The index of the tx queue to update the ring.
1893 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1894 * to rte_eth_dev_configure().
1896 * - 0: Success, the transmit queue is correctly set up.
1897 * - -EINVAL: The port_id or the queue_id out of range.
1898 * - -ENOTSUP: The function not supported in PMD driver.
1900 extern int rte_eth_dev_tx_queue_start(uint8_t port_id, uint16_t tx_queue_id);
1903 * Stop specified TX queue of a port
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_stop(uint8_t port_id, uint16_t tx_queue_id);
1921 * Start an Ethernet device.
1923 * The device start step is the last one and consists of setting the configured
1924 * offload features and in starting the transmit and the receive units of the
1926 * On success, all basic functions exported by the Ethernet API (link status,
1927 * receive/transmit, and so on) can be invoked.
1930 * The port identifier of the Ethernet device.
1932 * - 0: Success, Ethernet device started.
1933 * - <0: Error code of the driver device start function.
1935 extern int rte_eth_dev_start(uint8_t port_id);
1938 * Stop an Ethernet device. The device can be restarted with a call to
1939 * rte_eth_dev_start()
1942 * The port identifier of the Ethernet device.
1944 extern void rte_eth_dev_stop(uint8_t port_id);
1948 * Link up an Ethernet device.
1950 * Set device link up will re-enable the device rx/tx
1951 * functionality after it is previously set device linked down.
1954 * The port identifier of the Ethernet device.
1956 * - 0: Success, Ethernet device linked up.
1957 * - <0: Error code of the driver device link up function.
1959 extern int rte_eth_dev_set_link_up(uint8_t port_id);
1962 * Link down an Ethernet device.
1963 * The device rx/tx functionality will be disabled if success,
1964 * and it can be re-enabled with a call to
1965 * rte_eth_dev_set_link_up()
1968 * The port identifier of the Ethernet device.
1970 extern int rte_eth_dev_set_link_down(uint8_t port_id);
1973 * Close an Ethernet device. The device cannot be restarted!
1976 * The port identifier of the Ethernet device.
1978 extern void rte_eth_dev_close(uint8_t port_id);
1981 * Enable receipt in promiscuous mode for an Ethernet device.
1984 * The port identifier of the Ethernet device.
1986 extern void rte_eth_promiscuous_enable(uint8_t port_id);
1989 * Disable receipt in promiscuous mode for an Ethernet device.
1992 * The port identifier of the Ethernet device.
1994 extern void rte_eth_promiscuous_disable(uint8_t port_id);
1997 * Return the value of promiscuous mode for an Ethernet device.
2000 * The port identifier of the Ethernet device.
2002 * - (1) if promiscuous is enabled
2003 * - (0) if promiscuous is disabled.
2006 extern int rte_eth_promiscuous_get(uint8_t port_id);
2009 * Enable the receipt of any multicast frame by an Ethernet device.
2012 * The port identifier of the Ethernet device.
2014 extern void rte_eth_allmulticast_enable(uint8_t port_id);
2017 * Disable the receipt of all multicast frames by an Ethernet device.
2020 * The port identifier of the Ethernet device.
2022 extern void rte_eth_allmulticast_disable(uint8_t port_id);
2025 * Return the value of allmulticast mode for an Ethernet device.
2028 * The port identifier of the Ethernet device.
2030 * - (1) if allmulticast is enabled
2031 * - (0) if allmulticast is disabled.
2034 extern int rte_eth_allmulticast_get(uint8_t port_id);
2037 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2038 * or FULL-DUPLEX) of the physical link of an Ethernet device. It might need
2039 * to wait up to 9 seconds in it.
2042 * The port identifier of the Ethernet device.
2044 * A pointer to an *rte_eth_link* structure to be filled with
2045 * the status, the speed and the mode of the Ethernet device link.
2047 extern void rte_eth_link_get(uint8_t port_id, struct rte_eth_link *link);
2050 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2051 * or FULL-DUPLEX) of the physical link of an Ethernet device. It is a no-wait
2052 * version of rte_eth_link_get().
2055 * The port identifier of the Ethernet device.
2057 * A pointer to an *rte_eth_link* structure to be filled with
2058 * the status, the speed and the mode of the Ethernet device link.
2060 extern void rte_eth_link_get_nowait(uint8_t port_id,
2061 struct rte_eth_link *link);
2064 * Retrieve the general I/O statistics of an Ethernet device.
2067 * The port identifier of the Ethernet device.
2069 * A pointer to a structure of type *rte_eth_stats* to be filled with
2070 * the values of device counters for the following set of statistics:
2071 * - *ipackets* with the total of successfully received packets.
2072 * - *opackets* with the total of successfully transmitted packets.
2073 * - *ibytes* with the total of successfully received bytes.
2074 * - *obytes* with the total of successfully transmitted bytes.
2075 * - *ierrors* with the total of erroneous received packets.
2076 * - *oerrors* with the total of failed transmitted packets.
2078 extern void rte_eth_stats_get(uint8_t port_id, struct rte_eth_stats *stats);
2081 * Reset the general I/O statistics of an Ethernet device.
2084 * The port identifier of the Ethernet device.
2086 extern void rte_eth_stats_reset(uint8_t port_id);
2089 * Retrieve extended statistics of an Ethernet device.
2092 * The port identifier of the Ethernet device.
2094 * A pointer to a table of structure of type *rte_eth_xstats*
2095 * to be filled with device statistics names and values.
2096 * This parameter can be set to NULL if n is 0.
2098 * The size of the stats table, which should be large enough to store
2099 * all the statistics of the device.
2101 * - positive value lower or equal to n: success. The return value
2102 * is the number of entries filled in the stats table.
2103 * - positive value higher than n: error, the given statistics table
2104 * is too small. The return value corresponds to the size that should
2105 * be given to succeed. The entries in the table are not valid and
2106 * shall not be used by the caller.
2107 * - negative value on error (invalid port id)
2109 extern int rte_eth_xstats_get(uint8_t port_id,
2110 struct rte_eth_xstats *xstats, unsigned n);
2113 * Reset extended statistics of an Ethernet device.
2116 * The port identifier of the Ethernet device.
2118 extern void rte_eth_xstats_reset(uint8_t port_id);
2121 * Set a mapping for the specified transmit queue to the specified per-queue
2122 * statistics counter.
2125 * The port identifier of the Ethernet device.
2126 * @param tx_queue_id
2127 * The index of the transmit queue for which a queue stats mapping is required.
2128 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2129 * to rte_eth_dev_configure().
2131 * The per-queue packet statistics functionality number that the transmit
2132 * queue is to be assigned.
2133 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2135 * Zero if successful. Non-zero otherwise.
2137 extern int rte_eth_dev_set_tx_queue_stats_mapping(uint8_t port_id,
2138 uint16_t tx_queue_id,
2142 * Set a mapping for the specified receive queue to the specified per-queue
2143 * statistics counter.
2146 * The port identifier of the Ethernet device.
2147 * @param rx_queue_id
2148 * The index of the receive queue for which a queue stats mapping is required.
2149 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2150 * to rte_eth_dev_configure().
2152 * The per-queue packet statistics functionality number that the receive
2153 * queue is to be assigned.
2154 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2156 * Zero if successful. Non-zero otherwise.
2158 extern int rte_eth_dev_set_rx_queue_stats_mapping(uint8_t port_id,
2159 uint16_t rx_queue_id,
2163 * Retrieve the Ethernet address of an Ethernet device.
2166 * The port identifier of the Ethernet device.
2168 * A pointer to a structure of type *ether_addr* to be filled with
2169 * the Ethernet address of the Ethernet device.
2171 extern void rte_eth_macaddr_get(uint8_t port_id, struct ether_addr *mac_addr);
2174 * Retrieve the contextual information of an Ethernet device.
2177 * The port identifier of the Ethernet device.
2179 * A pointer to a structure of type *rte_eth_dev_info* to be filled with
2180 * the contextual information of the Ethernet device.
2182 extern void rte_eth_dev_info_get(uint8_t port_id,
2183 struct rte_eth_dev_info *dev_info);
2186 * Retrieve the MTU of an Ethernet device.
2189 * The port identifier of the Ethernet device.
2191 * A pointer to a uint16_t where the retrieved MTU is to be stored.
2193 * - (0) if successful.
2194 * - (-ENODEV) if *port_id* invalid.
2196 extern int rte_eth_dev_get_mtu(uint8_t port_id, uint16_t *mtu);
2199 * Change the MTU of an Ethernet device.
2202 * The port identifier of the Ethernet device.
2204 * A uint16_t for the MTU to be applied.
2206 * - (0) if successful.
2207 * - (-ENOTSUP) if operation is not supported.
2208 * - (-ENODEV) if *port_id* invalid.
2209 * - (-EINVAL) if *mtu* invalid.
2211 extern int rte_eth_dev_set_mtu(uint8_t port_id, uint16_t mtu);
2214 * Enable/Disable hardware filtering by an Ethernet device of received
2215 * VLAN packets tagged with a given VLAN Tag Identifier.
2218 * The port identifier of the Ethernet device.
2220 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
2222 * If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*.
2223 * Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*.
2225 * - (0) if successful.
2226 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2227 * - (-ENODEV) if *port_id* invalid.
2228 * - (-ENOSYS) if VLAN filtering on *port_id* disabled.
2229 * - (-EINVAL) if *vlan_id* > 4095.
2231 extern int rte_eth_dev_vlan_filter(uint8_t port_id, uint16_t vlan_id , int on);
2234 * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
2235 * 82599/X540/X550 can support VLAN stripping at the rx queue level
2238 * The port identifier of the Ethernet device.
2239 * @param rx_queue_id
2240 * The index of the receive queue for which a queue stats mapping is required.
2241 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2242 * to rte_eth_dev_configure().
2244 * If 1, Enable VLAN Stripping of the receive queue of the Ethernet port.
2245 * If 0, Disable VLAN Stripping of the receive queue of the Ethernet port.
2247 * - (0) if successful.
2248 * - (-ENOSUP) if hardware-assisted VLAN stripping not configured.
2249 * - (-ENODEV) if *port_id* invalid.
2250 * - (-EINVAL) if *rx_queue_id* invalid.
2252 extern int rte_eth_dev_set_vlan_strip_on_queue(uint8_t port_id,
2253 uint16_t rx_queue_id, int on);
2256 * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
2257 * the VLAN Header. This is a register setup available on some Intel NIC, not
2258 * but all, please check the data sheet for availability.
2261 * The port identifier of the Ethernet device.
2263 * The Tag Protocol ID
2265 * - (0) if successful.
2266 * - (-ENOSUP) if hardware-assisted VLAN TPID setup is not supported.
2267 * - (-ENODEV) if *port_id* invalid.
2269 extern int rte_eth_dev_set_vlan_ether_type(uint8_t port_id, uint16_t tag_type);
2272 * Set VLAN offload configuration on an Ethernet device
2273 * Enable/Disable Extended VLAN by an Ethernet device, This is a register setup
2274 * available on some Intel NIC, not but all, please check the data sheet for
2276 * Enable/Disable VLAN Strip can be done on rx queue for certain NIC, but here
2277 * the configuration is applied on the port level.
2280 * The port identifier of the Ethernet device.
2281 * @param offload_mask
2282 * The VLAN Offload bit mask can be mixed use with "OR"
2283 * ETH_VLAN_STRIP_OFFLOAD
2284 * ETH_VLAN_FILTER_OFFLOAD
2285 * ETH_VLAN_EXTEND_OFFLOAD
2287 * - (0) if successful.
2288 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2289 * - (-ENODEV) if *port_id* invalid.
2291 extern int rte_eth_dev_set_vlan_offload(uint8_t port_id, int offload_mask);
2294 * Read VLAN Offload configuration from an Ethernet device
2297 * The port identifier of the Ethernet device.
2299 * - (>0) if successful. Bit mask to indicate
2300 * ETH_VLAN_STRIP_OFFLOAD
2301 * ETH_VLAN_FILTER_OFFLOAD
2302 * ETH_VLAN_EXTEND_OFFLOAD
2303 * - (-ENODEV) if *port_id* invalid.
2305 extern int rte_eth_dev_get_vlan_offload(uint8_t port_id);
2308 * Set port based TX VLAN insersion on or off.
2311 * The port identifier of the Ethernet device.
2313 * Port based TX VLAN identifier togeth with user priority.
2315 * Turn on or off the port based TX VLAN insertion.
2318 * - (0) if successful.
2319 * - negative if failed.
2321 extern int rte_eth_dev_set_vlan_pvid(uint8_t port_id, uint16_t pvid, int on);
2325 * Retrieve a burst of input packets from a receive queue of an Ethernet
2326 * device. The retrieved packets are stored in *rte_mbuf* structures whose
2327 * pointers are supplied in the *rx_pkts* array.
2329 * The rte_eth_rx_burst() function loops, parsing the RX ring of the
2330 * receive queue, up to *nb_pkts* packets, and for each completed RX
2331 * descriptor in the ring, it performs the following operations:
2333 * - Initialize the *rte_mbuf* data structure associated with the
2334 * RX descriptor according to the information provided by the NIC into
2335 * that RX descriptor.
2337 * - Store the *rte_mbuf* data structure into the next entry of the
2340 * - Replenish the RX descriptor with a new *rte_mbuf* buffer
2341 * allocated from the memory pool associated with the receive queue at
2342 * initialization time.
2344 * When retrieving an input packet that was scattered by the controller
2345 * into multiple receive descriptors, the rte_eth_rx_burst() function
2346 * appends the associated *rte_mbuf* buffers to the first buffer of the
2349 * The rte_eth_rx_burst() function returns the number of packets
2350 * actually retrieved, which is the number of *rte_mbuf* data structures
2351 * effectively supplied into the *rx_pkts* array.
2352 * A return value equal to *nb_pkts* indicates that the RX queue contained
2353 * at least *rx_pkts* packets, and this is likely to signify that other
2354 * received packets remain in the input queue. Applications implementing
2355 * a "retrieve as much received packets as possible" policy can check this
2356 * specific case and keep invoking the rte_eth_rx_burst() function until
2357 * a value less than *nb_pkts* is returned.
2359 * This receive method has the following advantages:
2361 * - It allows a run-to-completion network stack engine to retrieve and
2362 * to immediately process received packets in a fast burst-oriented
2363 * approach, avoiding the overhead of unnecessary intermediate packet
2364 * queue/dequeue operations.
2366 * - Conversely, it also allows an asynchronous-oriented processing
2367 * method to retrieve bursts of received packets and to immediately
2368 * queue them for further parallel processing by another logical core,
2369 * for instance. However, instead of having received packets being
2370 * individually queued by the driver, this approach allows the invoker
2371 * of the rte_eth_rx_burst() function to queue a burst of retrieved
2372 * packets at a time and therefore dramatically reduce the cost of
2373 * enqueue/dequeue operations per packet.
2375 * - It allows the rte_eth_rx_burst() function of the driver to take
2376 * advantage of burst-oriented hardware features (CPU cache,
2377 * prefetch instructions, and so on) to minimize the number of CPU
2378 * cycles per packet.
2380 * To summarize, the proposed receive API enables many
2381 * burst-oriented optimizations in both synchronous and asynchronous
2382 * packet processing environments with no overhead in both cases.
2384 * The rte_eth_rx_burst() function does not provide any error
2385 * notification to avoid the corresponding overhead. As a hint, the
2386 * upper-level application might check the status of the device link once
2387 * being systematically returned a 0 value for a given number of tries.
2390 * The port identifier of the Ethernet device.
2392 * The index of the receive queue from which to retrieve input packets.
2393 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
2394 * to rte_eth_dev_configure().
2396 * The address of an array of pointers to *rte_mbuf* structures that
2397 * must be large enough to store *nb_pkts* pointers in it.
2399 * The maximum number of packets to retrieve.
2401 * The number of packets actually retrieved, which is the number
2402 * of pointers to *rte_mbuf* structures effectively supplied to the
2405 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2406 extern uint16_t rte_eth_rx_burst(uint8_t port_id, uint16_t queue_id,
2407 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
2409 static inline uint16_t
2410 rte_eth_rx_burst(uint8_t port_id, uint16_t queue_id,
2411 struct rte_mbuf **rx_pkts, uint16_t nb_pkts)
2413 struct rte_eth_dev *dev;
2415 dev = &rte_eth_devices[port_id];
2416 return (*dev->rx_pkt_burst)(dev->data->rx_queues[queue_id], rx_pkts, nb_pkts);
2421 * Get the number of used descriptors in a specific queue
2424 * The port identifier of the Ethernet device.
2426 * The queue id on the specific port.
2428 * The number of used descriptors in the specific queue.
2430 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2431 extern uint32_t rte_eth_rx_queue_count(uint8_t port_id, uint16_t queue_id);
2433 static inline uint32_t
2434 rte_eth_rx_queue_count(uint8_t port_id, uint16_t queue_id)
2436 struct rte_eth_dev *dev;
2438 dev = &rte_eth_devices[port_id];
2439 return (*dev->dev_ops->rx_queue_count)(dev, queue_id);
2444 * Check if the DD bit of the specific RX descriptor in the queue has been set
2447 * The port identifier of the Ethernet device.
2449 * The queue id on the specific port.
2451 * The offset of the descriptor ID from tail.
2453 * - (1) if the specific DD bit is set.
2454 * - (0) if the specific DD bit is not set.
2455 * - (-ENODEV) if *port_id* invalid.
2457 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2458 extern int rte_eth_rx_descriptor_done(uint8_t port_id,
2463 rte_eth_rx_descriptor_done(uint8_t port_id, uint16_t queue_id, uint16_t offset)
2465 struct rte_eth_dev *dev;
2467 dev = &rte_eth_devices[port_id];
2468 return (*dev->dev_ops->rx_descriptor_done)( \
2469 dev->data->rx_queues[queue_id], offset);
2474 * Send a burst of output packets on a transmit queue of an Ethernet device.
2476 * The rte_eth_tx_burst() function is invoked to transmit output packets
2477 * on the output queue *queue_id* of the Ethernet device designated by its
2479 * The *nb_pkts* parameter is the number of packets to send which are
2480 * supplied in the *tx_pkts* array of *rte_mbuf* structures.
2481 * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
2482 * up to the number of transmit descriptors available in the TX ring of the
2484 * For each packet to send, the rte_eth_tx_burst() function performs
2485 * the following operations:
2487 * - Pick up the next available descriptor in the transmit ring.
2489 * - Free the network buffer previously sent with that descriptor, if any.
2491 * - Initialize the transmit descriptor with the information provided
2492 * in the *rte_mbuf data structure.
2494 * In the case of a segmented packet composed of a list of *rte_mbuf* buffers,
2495 * the rte_eth_tx_burst() function uses several transmit descriptors
2498 * The rte_eth_tx_burst() function returns the number of packets it
2499 * actually sent. A return value equal to *nb_pkts* means that all packets
2500 * have been sent, and this is likely to signify that other output packets
2501 * could be immediately transmitted again. Applications that implement a
2502 * "send as many packets to transmit as possible" policy can check this
2503 * specific case and keep invoking the rte_eth_tx_burst() function until
2504 * a value less than *nb_pkts* is returned.
2506 * It is the responsibility of the rte_eth_tx_burst() function to
2507 * transparently free the memory buffers of packets previously sent.
2508 * This feature is driven by the *tx_free_thresh* value supplied to the
2509 * rte_eth_dev_configure() function at device configuration time.
2510 * When the number of previously sent packets reached the "minimum transmit
2511 * packets to free" threshold, the rte_eth_tx_burst() function must
2512 * [attempt to] free the *rte_mbuf* buffers of those packets whose
2513 * transmission was effectively completed.
2516 * The port identifier of the Ethernet device.
2518 * The index of the transmit queue through which output packets must be
2520 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
2521 * to rte_eth_dev_configure().
2523 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
2524 * which contain the output packets.
2526 * The maximum number of packets to transmit.
2528 * The number of output packets actually stored in transmit descriptors of
2529 * the transmit ring. The return value can be less than the value of the
2530 * *tx_pkts* parameter when the transmit ring is full or has been filled up.
2532 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
2533 extern uint16_t rte_eth_tx_burst(uint8_t port_id, uint16_t queue_id,
2534 struct rte_mbuf **tx_pkts, uint16_t nb_pkts);
2536 static inline uint16_t
2537 rte_eth_tx_burst(uint8_t port_id, uint16_t queue_id,
2538 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
2540 struct rte_eth_dev *dev;
2542 dev = &rte_eth_devices[port_id];
2543 return (*dev->tx_pkt_burst)(dev->data->tx_queues[queue_id], tx_pkts, nb_pkts);
2548 * Setup a new signature filter rule on an Ethernet device
2551 * The port identifier of the Ethernet device.
2552 * @param fdir_filter
2553 * The pointer to the fdir filter structure describing the signature filter
2555 * The *rte_fdir_filter* structure includes the values of the different fields
2556 * to match: source and destination IP addresses, vlan id, flexbytes, source
2557 * and destination ports, and so on.
2559 * The index of the RX queue where to store RX packets matching the added
2560 * signature filter defined in fdir_filter.
2562 * - (0) if successful.
2563 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2564 * - (-ENODEV) if *port_id* invalid.
2565 * - (-ENOSYS) if the FDIR mode is not configured in signature mode
2567 * - (-EINVAL) if the fdir_filter information is not correct.
2569 int rte_eth_dev_fdir_add_signature_filter(uint8_t port_id,
2570 struct rte_fdir_filter *fdir_filter,
2574 * Update a signature filter rule on an Ethernet device.
2575 * If the rule doesn't exits, it is created.
2578 * The port identifier of the Ethernet device.
2580 * The pointer to the structure describing the signature filter rule.
2581 * The *rte_fdir_filter* structure includes the values of the different fields
2582 * to match: source and destination IP addresses, vlan id, flexbytes, source
2583 * and destination ports, and so on.
2585 * The index of the RX queue where to store RX packets matching the added
2586 * signature filter defined in fdir_ftr.
2588 * - (0) if successful.
2589 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2590 * - (-ENODEV) if *port_id* invalid.
2591 * - (-ENOSYS) if the flow director mode is not configured in signature mode
2593 * - (-EINVAL) if the fdir_filter information is not correct.
2595 int rte_eth_dev_fdir_update_signature_filter(uint8_t port_id,
2596 struct rte_fdir_filter *fdir_ftr,
2600 * Remove a signature filter rule on an Ethernet device.
2603 * The port identifier of the Ethernet device.
2605 * The pointer to the structure describing the signature filter rule.
2606 * The *rte_fdir_filter* structure includes the values of the different fields
2607 * to match: source and destination IP addresses, vlan id, flexbytes, source
2608 * and destination ports, and so on.
2610 * - (0) if successful.
2611 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2612 * - (-ENODEV) if *port_id* invalid.
2613 * - (-ENOSYS) if the flow director mode is not configured in signature mode
2615 * - (-EINVAL) if the fdir_filter information is not correct.
2617 int rte_eth_dev_fdir_remove_signature_filter(uint8_t port_id,
2618 struct rte_fdir_filter *fdir_ftr);
2621 * Retrieve the flow director information of an Ethernet device.
2624 * The port identifier of the Ethernet device.
2626 * A pointer to a structure of type *rte_eth_dev_fdir* to be filled with
2627 * the flow director information of the Ethernet device.
2629 * - (0) if successful.
2630 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2631 * - (-ENODEV) if *port_id* invalid.
2632 * - (-ENOSYS) if the flow director mode is not configured on *port_id*.
2634 int rte_eth_dev_fdir_get_infos(uint8_t port_id, struct rte_eth_fdir *fdir);
2637 * Add a new perfect filter rule on an Ethernet device.
2640 * The port identifier of the Ethernet device.
2641 * @param fdir_filter
2642 * The pointer to the structure describing the perfect filter rule.
2643 * The *rte_fdir_filter* structure includes the values of the different fields
2644 * to match: source and destination IP addresses, vlan id, flexbytes, source
2645 * and destination ports, and so on.
2646 * IPv6 are not supported.
2648 * The 16-bit value supplied in the field hash.fdir.id of mbuf for RX
2649 * packets matching the perfect filter.
2651 * The index of the RX queue where to store RX packets matching the added
2652 * perfect filter defined in fdir_filter.
2654 * If drop is set to 1, matching RX packets are stored into the RX drop
2655 * queue defined in the rte_fdir_conf.
2657 * - (0) if successful.
2658 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2659 * - (-ENODEV) if *port_id* invalid.
2660 * - (-ENOSYS) if the flow director mode is not configured in perfect mode
2662 * - (-EINVAL) if the fdir_filter information is not correct.
2664 int rte_eth_dev_fdir_add_perfect_filter(uint8_t port_id,
2665 struct rte_fdir_filter *fdir_filter,
2666 uint16_t soft_id, uint8_t rx_queue,
2670 * Update a perfect filter rule on an Ethernet device.
2671 * If the rule doesn't exits, it is created.
2674 * The port identifier of the Ethernet device.
2675 * @param fdir_filter
2676 * The pointer to the structure describing the perfect filter rule.
2677 * The *rte_fdir_filter* structure includes the values of the different fields
2678 * to match: source and destination IP addresses, vlan id, flexbytes, source
2679 * and destination ports, and so on.
2680 * IPv6 are not supported.
2682 * The 16-bit value supplied in the field hash.fdir.id of mbuf for RX
2683 * packets matching the perfect filter.
2685 * The index of the RX queue where to store RX packets matching the added
2686 * perfect filter defined in fdir_filter.
2688 * If drop is set to 1, matching RX packets are stored into the RX drop
2689 * queue defined in the rte_fdir_conf.
2691 * - (0) if successful.
2692 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2693 * - (-ENODEV) if *port_id* invalid.
2694 * - (-ENOSYS) if the flow director mode is not configured in perfect mode
2696 * - (-EINVAL) if the fdir_filter information is not correct.
2698 int rte_eth_dev_fdir_update_perfect_filter(uint8_t port_id,
2699 struct rte_fdir_filter *fdir_filter,
2700 uint16_t soft_id, uint8_t rx_queue,
2704 * Remove a perfect filter rule on an Ethernet device.
2707 * The port identifier of the Ethernet device.
2708 * @param fdir_filter
2709 * The pointer to the structure describing the perfect filter rule.
2710 * The *rte_fdir_filter* structure includes the values of the different fields
2711 * to match: source and destination IP addresses, vlan id, flexbytes, source
2712 * and destination ports, and so on.
2713 * IPv6 are not supported.
2715 * The soft_id value provided when adding/updating the removed filter.
2717 * - (0) if successful.
2718 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2719 * - (-ENODEV) if *port_id* invalid.
2720 * - (-ENOSYS) if the flow director mode is not configured in perfect mode
2722 * - (-EINVAL) if the fdir_filter information is not correct.
2724 int rte_eth_dev_fdir_remove_perfect_filter(uint8_t port_id,
2725 struct rte_fdir_filter *fdir_filter,
2728 * Configure globally the masks for flow director mode for an Ethernet device.
2729 * For example, the device can match packets with only the first 24 bits of
2730 * the IPv4 source address.
2732 * The following fields can be masked: IPv4 addresses and L4 port numbers.
2733 * The following fields can be either enabled or disabled completely for the
2734 * matching functionality: VLAN ID tag; VLAN Priority + CFI bit; Flexible 2-byte
2736 * IPv6 masks are not supported.
2738 * All filters must comply with the masks previously configured.
2739 * For example, with a mask equal to 255.255.255.0 for the source IPv4 address,
2740 * all IPv4 filters must be created with a source IPv4 address that fits the
2743 * This function flushes all filters that have been previously added in
2747 * The port identifier of the Ethernet device.
2749 * The pointer to the fdir mask structure describing relevant headers fields
2750 * and relevant bits to use when matching packets addresses and ports.
2751 * IPv6 masks are not supported.
2753 * - (0) if successful.
2754 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2755 * - (-ENODEV) if *port_id* invalid.
2756 * - (-ENOSYS) if the flow director mode is not configured in perfect
2757 * mode on *port_id*.
2758 * - (-EINVAL) if the fdir_filter information is not correct
2760 int rte_eth_dev_fdir_set_masks(uint8_t port_id,
2761 struct rte_fdir_masks *fdir_mask);
2764 * The eth device event type for interrupt, and maybe others in the future.
2766 enum rte_eth_event_type {
2767 RTE_ETH_EVENT_UNKNOWN, /**< unknown event type */
2768 RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
2769 RTE_ETH_EVENT_MAX /**< max value of this enum */
2772 typedef void (*rte_eth_dev_cb_fn)(uint8_t port_id, \
2773 enum rte_eth_event_type event, void *cb_arg);
2774 /**< user application callback to be registered for interrupts */
2779 * Register a callback function for specific port id.
2786 * User supplied callback function to be called.
2788 * Pointer to the parameters for the registered callback.
2791 * - On success, zero.
2792 * - On failure, a negative value.
2794 int rte_eth_dev_callback_register(uint8_t port_id,
2795 enum rte_eth_event_type event,
2796 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
2799 * Unregister a callback function for specific port id.
2806 * User supplied callback function to be called.
2808 * Pointer to the parameters for the registered callback. -1 means to
2809 * remove all for the same callback address and same event.
2812 * - On success, zero.
2813 * - On failure, a negative value.
2815 int rte_eth_dev_callback_unregister(uint8_t port_id,
2816 enum rte_eth_event_type event,
2817 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
2820 * @internal Executes all the user application registered callbacks for
2821 * the specific device. It is for DPDK internal user only. User
2822 * application should not call it directly.
2825 * Pointer to struct rte_eth_dev.
2827 * Eth device interrupt event type.
2832 void _rte_eth_dev_callback_process(struct rte_eth_dev *dev,
2833 enum rte_eth_event_type event);
2836 * Turn on the LED on the Ethernet device.
2837 * This function turns on the LED on the Ethernet device.
2840 * The port identifier of the Ethernet device.
2842 * - (0) if successful.
2843 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
2845 * - (-ENODEV) if *port_id* invalid.
2847 int rte_eth_led_on(uint8_t port_id);
2850 * Turn off the LED on the Ethernet device.
2851 * This function turns off the LED on the Ethernet device.
2854 * The port identifier of the Ethernet device.
2856 * - (0) if successful.
2857 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
2859 * - (-ENODEV) if *port_id* invalid.
2861 int rte_eth_led_off(uint8_t port_id);
2864 * Get current status of the Ethernet link flow control for Ethernet device
2867 * The port identifier of the Ethernet device.
2869 * The pointer to the structure where to store the flow control parameters.
2871 * - (0) if successful.
2872 * - (-ENOTSUP) if hardware doesn't support flow control.
2873 * - (-ENODEV) if *port_id* invalid.
2875 int rte_eth_dev_flow_ctrl_get(uint8_t port_id,
2876 struct rte_eth_fc_conf *fc_conf);
2879 * Configure the Ethernet link flow control for Ethernet device
2882 * The port identifier of the Ethernet device.
2884 * The pointer to the structure of the flow control parameters.
2886 * - (0) if successful.
2887 * - (-ENOTSUP) if hardware doesn't support flow control mode.
2888 * - (-ENODEV) if *port_id* invalid.
2889 * - (-EINVAL) if bad parameter
2890 * - (-EIO) if flow control setup failure
2892 int rte_eth_dev_flow_ctrl_set(uint8_t port_id,
2893 struct rte_eth_fc_conf *fc_conf);
2896 * Configure the Ethernet priority flow control under DCB environment
2897 * for Ethernet device.
2900 * The port identifier of the Ethernet device.
2902 * The pointer to the structure of the priority flow control parameters.
2904 * - (0) if successful.
2905 * - (-ENOTSUP) if hardware doesn't support priority flow control mode.
2906 * - (-ENODEV) if *port_id* invalid.
2907 * - (-EINVAL) if bad parameter
2908 * - (-EIO) if flow control setup failure
2910 int rte_eth_dev_priority_flow_ctrl_set(uint8_t port_id,
2911 struct rte_eth_pfc_conf *pfc_conf);
2914 * Add a MAC address to an internal array of addresses used to enable whitelist
2915 * filtering to accept packets only if the destination MAC address matches.
2918 * The port identifier of the Ethernet device.
2920 * The MAC address to add.
2922 * VMDq pool index to associate address with (if VMDq is enabled). If VMDq is
2923 * not enabled, this should be set to 0.
2925 * - (0) if successfully added or *mac_addr" was already added.
2926 * - (-ENOTSUP) if hardware doesn't support this feature.
2927 * - (-ENODEV) if *port* is invalid.
2928 * - (-ENOSPC) if no more MAC addresses can be added.
2929 * - (-EINVAL) if MAC address is invalid.
2931 int rte_eth_dev_mac_addr_add(uint8_t port, struct ether_addr *mac_addr,
2935 * Remove a MAC address from the internal array of addresses.
2938 * The port identifier of the Ethernet device.
2940 * MAC address to remove.
2942 * - (0) if successful, or *mac_addr* didn't exist.
2943 * - (-ENOTSUP) if hardware doesn't support.
2944 * - (-ENODEV) if *port* invalid.
2945 * - (-EADDRINUSE) if attempting to remove the default MAC address
2947 int rte_eth_dev_mac_addr_remove(uint8_t port, struct ether_addr *mac_addr);
2950 * Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
2953 * The port identifier of the Ethernet device.
2957 * - (0) if successful.
2958 * - (-ENOTSUP) if hardware doesn't support.
2959 * - (-EINVAL) if bad parameter.
2961 int rte_eth_dev_rss_reta_update(uint8_t port,
2962 struct rte_eth_rss_reta *reta_conf);
2965 * Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
2968 * The port identifier of the Ethernet device.
2972 * - (0) if successful.
2973 * - (-ENOTSUP) if hardware doesn't support.
2974 * - (-EINVAL) if bad parameter.
2976 int rte_eth_dev_rss_reta_query(uint8_t port,
2977 struct rte_eth_rss_reta *reta_conf);
2980 * Updates unicast hash table for receiving packet with the given destination
2981 * MAC address, and the packet is routed to all VFs for which the RX mode is
2982 * accept packets that match the unicast hash table.
2985 * The port identifier of the Ethernet device.
2987 * Unicast MAC address.
2989 * 1 - Set an unicast hash bit for receiving packets with the MAC address.
2990 * 0 - Clear an unicast hash bit.
2992 * - (0) if successful.
2993 * - (-ENOTSUP) if hardware doesn't support.
2994 * - (-ENODEV) if *port_id* invalid.
2995 * - (-EINVAL) if bad parameter.
2997 int rte_eth_dev_uc_hash_table_set(uint8_t port,struct ether_addr *addr,
3001 * Updates all unicast hash bitmaps for receiving packet with any Unicast
3002 * Ethernet MAC addresses,the packet is routed to all VFs for which the RX
3003 * mode is accept packets that match the unicast hash table.
3006 * The port identifier of the Ethernet device.
3008 * 1 - Set all unicast hash bitmaps for receiving all the Ethernet
3010 * 0 - Clear all unicast hash bitmaps
3012 * - (0) if successful.
3013 * - (-ENOTSUP) if hardware doesn't support.
3014 * - (-ENODEV) if *port_id* invalid.
3015 * - (-EINVAL) if bad parameter.
3017 int rte_eth_dev_uc_all_hash_table_set(uint8_t port,uint8_t on);
3020 * Set RX L2 Filtering mode of a VF of an Ethernet device.
3023 * The port identifier of the Ethernet device.
3027 * The RX mode mask, which is one or more of accepting Untagged Packets,
3028 * packets that match the PFUTA table, Broadcast and Multicast Promiscuous.
3029 * ETH_VMDQ_ACCEPT_UNTAG,ETH_VMDQ_ACCEPT_HASH_UC,
3030 * ETH_VMDQ_ACCEPT_BROADCAST and ETH_VMDQ_ACCEPT_MULTICAST will be used
3033 * 1 - Enable a VF RX mode.
3034 * 0 - Disable a VF RX mode.
3036 * - (0) if successful.
3037 * - (-ENOTSUP) if hardware doesn't support.
3038 * - (-ENOTSUP) if hardware doesn't support.
3039 * - (-EINVAL) if bad parameter.
3041 int rte_eth_dev_set_vf_rxmode(uint8_t port, uint16_t vf, uint16_t rx_mode,
3045 * Enable or disable a VF traffic transmit of the Ethernet device.
3048 * The port identifier of the Ethernet device.
3052 * 1 - Enable a VF traffic transmit.
3053 * 0 - Disable a VF traffic transmit.
3055 * - (0) if successful.
3056 * - (-ENODEV) if *port_id* invalid.
3057 * - (-ENOTSUP) if hardware doesn't support.
3058 * - (-EINVAL) if bad parameter.
3061 rte_eth_dev_set_vf_tx(uint8_t port,uint16_t vf, uint8_t on);
3064 * Enable or disable a VF traffic receive of an Ethernet device.
3067 * The port identifier of the Ethernet device.
3071 * 1 - Enable a VF traffic receive.
3072 * 0 - Disable a VF traffic receive.
3074 * - (0) if successful.
3075 * - (-ENOTSUP) if hardware doesn't support.
3076 * - (-ENODEV) if *port_id* invalid.
3077 * - (-EINVAL) if bad parameter.
3080 rte_eth_dev_set_vf_rx(uint8_t port,uint16_t vf, uint8_t on);
3083 * Enable/Disable hardware VF VLAN filtering by an Ethernet device of
3084 * received VLAN packets tagged with a given VLAN Tag Identifier.
3087 * The port identifier of the Ethernet device.
3089 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
3091 * Bitmap listing which VFs participate in the VLAN filtering.
3093 * 1 - Enable VFs VLAN filtering.
3094 * 0 - Disable VFs VLAN filtering.
3096 * - (0) if successful.
3097 * - (-ENOTSUP) if hardware doesn't support.
3098 * - (-ENODEV) if *port_id* invalid.
3099 * - (-EINVAL) if bad parameter.
3102 rte_eth_dev_set_vf_vlan_filter(uint8_t port, uint16_t vlan_id,
3107 * Set a traffic mirroring rule on an Ethernet device
3110 * The port identifier of the Ethernet device.
3111 * @param mirror_conf
3112 * The pointer to the traffic mirroring structure describing the mirroring rule.
3113 * The *rte_eth_vm_mirror_conf* structure includes the type of mirroring rule,
3114 * destination pool and the value of rule if enable vlan or pool mirroring.
3117 * The index of traffic mirroring rule, we support four separated rules.
3119 * 1 - Enable a mirroring rule.
3120 * 0 - Disable a mirroring rule.
3122 * - (0) if successful.
3123 * - (-ENOTSUP) if hardware doesn't support this feature.
3124 * - (-ENODEV) if *port_id* invalid.
3125 * - (-EINVAL) if the mr_conf information is not correct.
3127 int rte_eth_mirror_rule_set(uint8_t port_id,
3128 struct rte_eth_vmdq_mirror_conf *mirror_conf,
3133 * Reset a traffic mirroring rule on an Ethernet device.
3136 * The port identifier of the Ethernet device.
3138 * The index of traffic mirroring rule, we support four separated rules.
3140 * - (0) if successful.
3141 * - (-ENOTSUP) if hardware doesn't support this feature.
3142 * - (-ENODEV) if *port_id* invalid.
3143 * - (-EINVAL) if bad parameter.
3145 int rte_eth_mirror_rule_reset(uint8_t port_id,
3149 * Set the rate limitation for a queue on an Ethernet device.
3152 * The port identifier of the Ethernet device.
3156 * The tx rate allocated from the total link speed for this queue.
3158 * - (0) if successful.
3159 * - (-ENOTSUP) if hardware doesn't support this feature.
3160 * - (-ENODEV) if *port_id* invalid.
3161 * - (-EINVAL) if bad parameter.
3163 int rte_eth_set_queue_rate_limit(uint8_t port_id, uint16_t queue_idx,
3167 * Set the rate limitation for a vf on an Ethernet device.
3170 * The port identifier of the Ethernet device.
3174 * The tx rate allocated from the total link speed for this VF id.
3176 * The queue mask which need to set the rate.
3178 * - (0) if successful.
3179 * - (-ENOTSUP) if hardware doesn't support this feature.
3180 * - (-ENODEV) if *port_id* invalid.
3181 * - (-EINVAL) if bad parameter.
3183 int rte_eth_set_vf_rate_limit(uint8_t port_id, uint16_t vf,
3184 uint16_t tx_rate, uint64_t q_msk);
3187 * Initialize bypass logic. This function needs to be called before
3188 * executing any other bypass API.
3191 * The port identifier of the Ethernet device.
3193 * - (0) if successful.
3194 * - (-ENOTSUP) if hardware doesn't support.
3195 * - (-EINVAL) if bad parameter.
3197 int rte_eth_dev_bypass_init(uint8_t port);
3200 * Return bypass state.
3203 * The port identifier of the Ethernet device.
3205 * The return bypass state.
3208 * - (3) Isolate mode
3210 * - (0) if successful.
3211 * - (-ENOTSUP) if hardware doesn't support.
3212 * - (-EINVAL) if bad parameter.
3214 int rte_eth_dev_bypass_state_show(uint8_t port, uint32_t *state);
3220 * The port identifier of the Ethernet device.
3222 * The current bypass state.
3225 * - (3) Isolate mode
3227 * - (0) if successful.
3228 * - (-ENOTSUP) if hardware doesn't support.
3229 * - (-EINVAL) if bad parameter.
3231 int rte_eth_dev_bypass_state_set(uint8_t port, uint32_t *new_state);
3234 * Return bypass state when given event occurs.
3237 * The port identifier of the Ethernet device.
3240 * - (1) Main power on (power button is pushed)
3241 * - (2) Auxiliary power on (power supply is being plugged)
3242 * - (3) Main power off (system shutdown and power supply is left plugged in)
3243 * - (4) Auxiliary power off (power supply is being unplugged)
3244 * - (5) Display or set the watchdog timer
3246 * The bypass state when given event occurred.
3249 * - (3) Isolate mode
3251 * - (0) if successful.
3252 * - (-ENOTSUP) if hardware doesn't support.
3253 * - (-EINVAL) if bad parameter.
3255 int rte_eth_dev_bypass_event_show(uint8_t port, uint32_t event, uint32_t *state);
3258 * Set bypass state when given event occurs.
3261 * The port identifier of the Ethernet device.
3264 * - (1) Main power on (power button is pushed)
3265 * - (2) Auxiliary power on (power supply is being plugged)
3266 * - (3) Main power off (system shutdown and power supply is left plugged in)
3267 * - (4) Auxiliary power off (power supply is being unplugged)
3268 * - (5) Display or set the watchdog timer
3270 * The assigned state when given event occurs.
3273 * - (3) Isolate mode
3275 * - (0) if successful.
3276 * - (-ENOTSUP) if hardware doesn't support.
3277 * - (-EINVAL) if bad parameter.
3279 int rte_eth_dev_bypass_event_store(uint8_t port, uint32_t event, uint32_t state);
3282 * Set bypass watchdog timeout count.
3285 * The port identifier of the Ethernet device.
3287 * The timeout to be set.
3288 * - (0) 0 seconds (timer is off)
3297 * - (0) if successful.
3298 * - (-ENOTSUP) if hardware doesn't support.
3299 * - (-EINVAL) if bad parameter.
3301 int rte_eth_dev_wd_timeout_store(uint8_t port, uint32_t timeout);
3304 * Get bypass firmware version.
3307 * The port identifier of the Ethernet device.
3309 * The firmware version
3311 * - (0) if successful.
3312 * - (-ENOTSUP) if hardware doesn't support.
3313 * - (-EINVAL) if bad parameter.
3315 int rte_eth_dev_bypass_ver_show(uint8_t port, uint32_t *ver);
3318 * Return bypass watchdog timeout in seconds
3321 * The port identifier of the Ethernet device.
3323 * The return watchdog timeout. "0" represents timer expired
3324 * - (0) 0 seconds (timer is off)
3333 * - (0) if successful.
3334 * - (-ENOTSUP) if hardware doesn't support.
3335 * - (-EINVAL) if bad parameter.
3337 int rte_eth_dev_bypass_wd_timeout_show(uint8_t port, uint32_t *wd_timeout);
3340 * Reset bypass watchdog timer
3343 * The port identifier of the Ethernet device.
3345 * - (0) if successful.
3346 * - (-ENOTSUP) if hardware doesn't support.
3347 * - (-EINVAL) if bad parameter.
3349 int rte_eth_dev_bypass_wd_reset(uint8_t port);
3352 * Configuration of Receive Side Scaling hash computation of Ethernet device.
3355 * The port identifier of the Ethernet device.
3357 * The new configuration to use for RSS hash computation on the port.
3359 * - (0) if successful.
3360 * - (-ENODEV) if port identifier is invalid.
3361 * - (-ENOTSUP) if hardware doesn't support.
3362 * - (-EINVAL) if bad parameter.
3364 int rte_eth_dev_rss_hash_update(uint8_t port_id,
3365 struct rte_eth_rss_conf *rss_conf);
3368 * Retrieve current configuration of Receive Side Scaling hash computation
3369 * of Ethernet device.
3372 * The port identifier of the Ethernet device.
3374 * Where to store the current RSS hash configuration of the Ethernet device.
3376 * - (0) if successful.
3377 * - (-ENODEV) if port identifier is invalid.
3378 * - (-ENOTSUP) if hardware doesn't support RSS.
3381 rte_eth_dev_rss_hash_conf_get(uint8_t port_id,
3382 struct rte_eth_rss_conf *rss_conf);
3385 * Add UDP tunneling port of an Ethernet device for filtering a specific
3386 * tunneling packet by UDP port number.
3389 * The port identifier of the Ethernet device.
3391 * UDP tunneling configuration.
3394 * - (0) if successful.
3395 * - (-ENODEV) if port identifier is invalid.
3396 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3399 rte_eth_dev_udp_tunnel_add(uint8_t port_id,
3400 struct rte_eth_udp_tunnel *tunnel_udp);
3403 * Detete UDP tunneling port configuration of Ethernet device
3406 * The port identifier of the Ethernet device.
3408 * UDP tunneling configuration.
3411 * - (0) if successful.
3412 * - (-ENODEV) if port identifier is invalid.
3413 * - (-ENOTSUP) if hardware doesn't support tunnel type.
3416 rte_eth_dev_udp_tunnel_delete(uint8_t port_id,
3417 struct rte_eth_udp_tunnel *tunnel_udp);
3423 * The port identifier of the Ethernet device.
3425 * The index of RX queue where to store RX packets matching the syn filter.
3427 * The pointer to the structure describing the syn filter rule.
3429 * - (0) if successful.
3430 * - (-ENOTSUP) if hardware doesn't support.
3431 * - (-EINVAL) if bad parameter.
3433 int rte_eth_dev_add_syn_filter(uint8_t port_id,
3434 struct rte_syn_filter *filter, uint16_t rx_queue);
3440 * The port identifier of the Ethernet device.
3442 * - (0) if successful.
3443 * - (-ENOTSUP) if hardware doesn't support.
3444 * - (-EINVAL) if bad parameter.
3446 int rte_eth_dev_remove_syn_filter(uint8_t port_id);
3452 * The port identifier of the Ethernet device.
3454 * The pointer to the structure describing the syn filter.
3456 * A pointer to get the queue index of syn filter.
3458 * - (0) if successful.
3459 * - (-ENOTSUP) if hardware doesn't support.
3460 * - (-EINVAL) if bad parameter.
3462 int rte_eth_dev_get_syn_filter(uint8_t port_id,
3463 struct rte_syn_filter *filter, uint16_t *rx_queue);
3466 * Add a new ethertype filter rule on an Ethernet device.
3469 * The port identifier of the Ethernet device.
3471 * The identifier of ethertype filter.
3473 * The pointer to the structure describing the ethertype filter rule.
3474 * The *rte_ethertype_filter* structure includes the values of the different
3475 * fields to match: ethertype and priority in vlan tag.
3476 * priority in vlan tag is not supported for E1000 dev.
3478 * The index of the RX queue where to store RX packets matching the added
3481 * - (0) if successful.
3482 * - (-ENOTSUP) if hardware doesn't support ethertype filter.
3483 * - (-ENODEV) if *port_id* invalid.
3484 * - (-EINVAL) if the filter information is not correct.
3486 int rte_eth_dev_add_ethertype_filter(uint8_t port_id, uint16_t index,
3487 struct rte_ethertype_filter *filter, uint16_t rx_queue);
3490 * remove an ethertype filter rule on an Ethernet device.
3493 * The port identifier of the Ethernet device.
3495 * The identifier of ethertype filter.
3497 * - (0) if successful.
3498 * - (-ENOTSUP) if hardware doesn't support ethertype filter.
3499 * - (-ENODEV) if *port_id* invalid.
3500 * - (-EINVAL) if the filter information is not correct.
3502 int rte_eth_dev_remove_ethertype_filter(uint8_t port_id,
3506 * Get an ethertype filter rule on an Ethernet device.
3509 * The port identifier of the Ethernet device.
3511 * The identifier of ethertype filter.
3513 * A pointer to a structure of type *rte_ethertype_filter* to be filled with
3514 * the information of the Ethertype filter.
3516 * A pointer to get the queue index.
3518 * - (0) if successful.
3519 * - (-ENOTSUP) if hardware doesn't support ethertype filter.
3520 * - (-ENODEV) if *port_id* invalid.
3521 * - (-EINVAL) if the filter information is not correct.
3522 * - (-ENOENT) if no enabled filter in this index.
3524 int rte_eth_dev_get_ethertype_filter(uint8_t port_id, uint16_t index,
3525 struct rte_ethertype_filter *filter, uint16_t *rx_queue);
3528 * Add a new 2tuple filter rule on an Ethernet device.
3531 * The port identifier of the Ethernet device.
3533 * The identifier of 2tuple filter.
3535 * The pointer to the structure describing the 2tuple filter rule.
3536 * The *rte_2tuple_filter* structure includes the values of the different
3537 * fields to match: protocol, dst_port and
3538 * tcp_flags if the protocol is tcp type.
3540 * The index of the RX queue where to store RX packets matching the added
3543 * - (0) if successful.
3544 * - (-ENOTSUP) if hardware doesn't support 2tuple filter.
3545 * - (-ENODEV) if *port_id* invalid.
3546 * - (-EINVAL) if the filter information is not correct.
3548 int rte_eth_dev_add_2tuple_filter(uint8_t port_id, uint16_t index,
3549 struct rte_2tuple_filter *filter, uint16_t rx_queue);
3552 * remove a 2tuple filter rule on an Ethernet device.
3555 * The port identifier of the Ethernet device.
3557 * The identifier of 2tuple filter.
3559 * - (0) if successful.
3560 * - (-ENOTSUP) if hardware doesn't support 2tuple filter.
3561 * - (-ENODEV) if *port_id* invalid.
3562 * - (-EINVAL) if the filter information is not correct.
3564 int rte_eth_dev_remove_2tuple_filter(uint8_t port_id, uint16_t index);
3567 * Get an 2tuple filter rule on an Ethernet device.
3570 * The port identifier of the Ethernet device.
3572 * The identifier of 2tuple filter.
3574 * A pointer to a structure of type *rte_2tuple_filter* to be filled with
3575 * the information of the 2tuple filter.
3577 * A pointer to get the queue index.
3579 * - (0) if successful.
3580 * - (-ENOTSUP) if hardware doesn't support 2tuple filter.
3581 * - (-ENODEV) if *port_id* invalid.
3582 * - (-EINVAL) if the filter information is not correct.
3583 * - (-ENOENT) if no enabled filter in this index.
3585 int rte_eth_dev_get_2tuple_filter(uint8_t port_id, uint16_t index,
3586 struct rte_2tuple_filter *filter, uint16_t *rx_queue);
3589 * Add a new 5tuple filter rule on an Ethernet device.
3592 * The port identifier of the Ethernet device.
3594 * The identifier of 5tuple filter.
3596 * The pointer to the structure describing the 5tuple filter rule.
3597 * The *rte_5tuple_filter* structure includes the values of the different
3598 * fields to match: dst src IP, dst src port, protocol and relative masks
3600 * The index of the RX queue where to store RX packets matching the added
3603 * - (0) if successful.
3604 * - (-ENOTSUP) if hardware doesn't support 5tuple filter.
3605 * - (-ENODEV) if *port_id* invalid.
3606 * - (-EINVAL) if the filter information is not correct.
3608 int rte_eth_dev_add_5tuple_filter(uint8_t port_id, uint16_t index,
3609 struct rte_5tuple_filter *filter, uint16_t rx_queue);
3612 * remove a 5tuple filter rule on an Ethernet device.
3615 * The port identifier of the Ethernet device.
3617 * The identifier of 5tuple filter.
3619 * - (0) if successful.
3620 * - (-ENOTSUP) if hardware doesn't support 5tuple filter.
3621 * - (-ENODEV) if *port_id* invalid.
3622 * - (-EINVAL) if the filter information is not correct.
3624 int rte_eth_dev_remove_5tuple_filter(uint8_t port_id, uint16_t index);
3627 * Get an 5tuple filter rule on an Ethernet device.
3630 * The port identifier of the Ethernet device.
3632 * The identifier of 5tuple filter.
3634 * A pointer to a structure of type *rte_5tuple_filter* to be filled with
3635 * the information of the 5tuple filter.
3637 * A pointer to get the queue index.
3639 * - (0) if successful.
3640 * - (-ENOTSUP) if hardware doesn't support 5tuple filter.
3641 * - (-ENODEV) if *port_id* invalid.
3642 * - (-EINVAL) if the filter information is not correct.
3644 int rte_eth_dev_get_5tuple_filter(uint8_t port_id, uint16_t index,
3645 struct rte_5tuple_filter *filter, uint16_t *rx_queue);
3648 * Add a new flex filter rule on an Ethernet device.
3651 * The port identifier of the Ethernet device.
3653 * The identifier of flex filter.
3655 * The pointer to the structure describing the flex filter rule.
3656 * The *rte_flex_filter* structure includes the values of the different fields
3657 * to match: the dwords (first len bytes of packet ) and relative masks.
3659 * The index of the RX queue where to store RX packets matching the added
3662 * - (0) if successful.
3663 * - (-ENOTSUP) if hardware doesn't support flex filter.
3664 * - (-ENODEV) if *port_id* invalid.
3665 * - (-EINVAL) if the filter information is not correct.
3666 * - (-ENOENT) if no enabled filter in this index.
3668 int rte_eth_dev_add_flex_filter(uint8_t port_id, uint16_t index,
3669 struct rte_flex_filter *filter, uint16_t rx_queue);
3672 * remove a flex filter rule on an Ethernet device.
3675 * The port identifier of the Ethernet device.
3677 * The identifier of flex filter.
3679 * - (0) if successful.
3680 * - (-ENOTSUP) if hardware doesn't support flex filter.
3681 * - (-ENODEV) if *port_id* invalid.
3682 * - (-EINVAL) if the filter information is not correct.
3684 int rte_eth_dev_remove_flex_filter(uint8_t port_id, uint16_t index);
3687 * Get an flex filter rule on an Ethernet device.
3690 * The port identifier of the Ethernet device.
3692 * The identifier of flex filter.
3694 * A pointer to a structure of type *rte_flex_filter* to be filled with
3695 * the information of the flex filter.
3697 * A pointer to get the queue index.
3699 * - (0) if successful.
3700 * - (-ENOTSUP) if hardware doesn't support flex filter.
3701 * - (-ENODEV) if *port_id* invalid.
3702 * - (-EINVAL) if the filter information is not correct.
3703 * - (-ENOENT) if no enabled filter in this index.
3705 int rte_eth_dev_get_flex_filter(uint8_t port_id, uint16_t index,
3706 struct rte_flex_filter *filter, uint16_t *rx_queue);
3709 * Check whether the filter type is supported on an Ethernet device.
3710 * All the supported filter types are defined in 'rte_eth_ctrl.h'.
3713 * The port identifier of the Ethernet device.
3714 * @param filter_type
3717 * - (0) if successful.
3718 * - (-ENOTSUP) if hardware doesn't support this filter type.
3719 * - (-ENODEV) if *port_id* invalid.
3721 int rte_eth_dev_filter_supported(uint8_t port_id, enum rte_filter_type filter_type);
3724 * Take operations to assigned filter type on an Ethernet device.
3725 * All the supported operations and filter types are defined in 'rte_eth_ctrl.h'.
3728 * The port identifier of the Ethernet device.
3729 * @param filter_type
3732 * Type of operation.
3734 * A pointer to arguments defined specifically for the operation.
3736 * - (0) if successful.
3737 * - (-ENOTSUP) if hardware doesn't support.
3738 * - (-ENODEV) if *port_id* invalid.
3739 * - others depends on the specific operations implementation.
3741 int rte_eth_dev_filter_ctrl(uint8_t port_id, enum rte_filter_type filter_type,
3742 enum rte_filter_op filter_op, void *arg);
3748 #endif /* _RTE_ETHDEV_H_ */