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"
182 * A structure used to retrieve statistics for an Ethernet port.
184 struct rte_eth_stats {
185 uint64_t ipackets; /**< Total number of successfully received packets. */
186 uint64_t opackets; /**< Total number of successfully transmitted packets.*/
187 uint64_t ibytes; /**< Total number of successfully received bytes. */
188 uint64_t obytes; /**< Total number of successfully transmitted bytes. */
189 uint64_t ierrors; /**< Total number of erroneous received packets. */
190 uint64_t oerrors; /**< Total number of failed transmitted packets. */
191 uint64_t imcasts; /**< Total number of multicast received packets. */
192 uint64_t rx_nombuf; /**< Total number of RX mbuf allocation failures. */
193 uint64_t fdirmatch; /**< Total number of RX packets matching a filter. */
194 uint64_t fdirmiss; /**< Total number of RX packets not matching any filter. */
195 uint64_t tx_pause_xon; /**< Total nb. of XON pause frame sent. */
196 uint64_t rx_pause_xon; /**< Total nb. of XON pause frame received. */
197 uint64_t tx_pause_xoff; /**< Total nb. of XOFF pause frame sent. */
198 uint64_t rx_pause_xoff; /**< Total nb. of XOFF pause frame received. */
199 uint64_t q_ipackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
200 /**< Total number of queue RX packets. */
201 uint64_t q_opackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
202 /**< Total number of queue TX packets. */
203 uint64_t q_ibytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
204 /**< Total number of successfully received queue bytes. */
205 uint64_t q_obytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
206 /**< Total number of successfully transmitted queue bytes. */
207 uint64_t q_errors[RTE_ETHDEV_QUEUE_STAT_CNTRS];
208 /**< Total number of queue packets received that are dropped. */
210 /**< Total number of good packets received from loopback,VF Only */
212 /**< Total number of good packets transmitted to loopback,VF Only */
214 /**< Total number of good bytes received from loopback,VF Only */
216 /**< Total number of good bytes transmitted to loopback,VF Only */
220 * A structure used to retrieve link-level information of an Ethernet port.
222 struct rte_eth_link {
223 uint16_t link_speed; /**< ETH_LINK_SPEED_[10, 100, 1000, 10000] */
224 uint16_t link_duplex; /**< ETH_LINK_[HALF_DUPLEX, FULL_DUPLEX] */
225 uint8_t link_status : 1; /**< 1 -> link up, 0 -> link down */
226 }__attribute__((aligned(8))); /**< aligned for atomic64 read/write */
228 #define ETH_LINK_SPEED_AUTONEG 0 /**< Auto-negotiate link speed. */
229 #define ETH_LINK_SPEED_10 10 /**< 10 megabits/second. */
230 #define ETH_LINK_SPEED_100 100 /**< 100 megabits/second. */
231 #define ETH_LINK_SPEED_1000 1000 /**< 1 gigabits/second. */
232 #define ETH_LINK_SPEED_10000 10000 /**< 10 gigabits/second. */
234 #define ETH_LINK_AUTONEG_DUPLEX 0 /**< Auto-negotiate duplex. */
235 #define ETH_LINK_HALF_DUPLEX 1 /**< Half-duplex connection. */
236 #define ETH_LINK_FULL_DUPLEX 2 /**< Full-duplex connection. */
239 * A structure used to configure the ring threshold registers of an RX/TX
240 * queue for an Ethernet port.
242 struct rte_eth_thresh {
243 uint8_t pthresh; /**< Ring prefetch threshold. */
244 uint8_t hthresh; /**< Ring host threshold. */
245 uint8_t wthresh; /**< Ring writeback threshold. */
249 * A set of values to identify what method is to be used to route
250 * packets to multiple queues.
252 enum rte_eth_rx_mq_mode {
253 ETH_MQ_RX_NONE = 0, /**< None of DCB,RSS or VMDQ mode */
255 ETH_MQ_RX_RSS, /**< For RX side, only RSS is on */
256 ETH_MQ_RX_DCB, /**< For RX side,only DCB is on. */
257 ETH_MQ_RX_DCB_RSS, /**< Both DCB and RSS enable */
259 ETH_MQ_RX_VMDQ_ONLY, /**< Only VMDQ, no RSS nor DCB */
260 ETH_MQ_RX_VMDQ_RSS, /**< RSS mode with VMDQ */
261 ETH_MQ_RX_VMDQ_DCB, /**< Use VMDQ+DCB to route traffic to queues */
262 ETH_MQ_RX_VMDQ_DCB_RSS, /**< Enable both VMDQ and DCB in VMDq */
266 * for rx mq mode backward compatible
268 #define ETH_RSS ETH_MQ_RX_RSS
269 #define VMDQ_DCB ETH_MQ_RX_VMDQ_DCB
270 #define ETH_DCB_RX ETH_MQ_RX_DCB
273 * A set of values to identify what method is to be used to transmit
274 * packets using multi-TCs.
276 enum rte_eth_tx_mq_mode {
277 ETH_MQ_TX_NONE = 0, /**< It is in neither DCB nor VT mode. */
278 ETH_MQ_TX_DCB, /**< For TX side,only DCB is on. */
279 ETH_MQ_TX_VMDQ_DCB, /**< For TX side,both DCB and VT is on. */
280 ETH_MQ_TX_VMDQ_ONLY, /**< Only VT on, no DCB */
284 * for tx mq mode backward compatible
286 #define ETH_DCB_NONE ETH_MQ_TX_NONE
287 #define ETH_VMDQ_DCB_TX ETH_MQ_TX_VMDQ_DCB
288 #define ETH_DCB_TX ETH_MQ_TX_DCB
291 * A structure used to configure the RX features of an Ethernet port.
293 struct rte_eth_rxmode {
294 /** The multi-queue packet distribution mode to be used, e.g. RSS. */
295 enum rte_eth_rx_mq_mode mq_mode;
296 uint32_t max_rx_pkt_len; /**< Only used if jumbo_frame enabled. */
297 uint16_t split_hdr_size; /**< hdr buf size (header_split enabled).*/
298 uint8_t header_split : 1, /**< Header Split enable. */
299 hw_ip_checksum : 1, /**< IP/UDP/TCP checksum offload enable. */
300 hw_vlan_filter : 1, /**< VLAN filter enable. */
301 hw_vlan_strip : 1, /**< VLAN strip enable. */
302 hw_vlan_extend : 1, /**< Extended VLAN enable. */
303 jumbo_frame : 1, /**< Jumbo Frame Receipt enable. */
304 hw_strip_crc : 1; /**< Enable CRC stripping by hardware. */
308 * A structure used to configure the Receive Side Scaling (RSS) feature
309 * of an Ethernet port.
310 * If not NULL, the *rss_key* pointer of the *rss_conf* structure points
311 * to an array of 40 bytes holding the RSS key to use for hashing specific
312 * header fields of received packets.
313 * Otherwise, a default random hash key is used by the device driver.
315 * The *rss_hf* field of the *rss_conf* structure indicates the different
316 * types of IPv4/IPv6 packets to which the RSS hashing must be applied.
317 * Supplying an *rss_hf* equal to zero disables the RSS feature.
319 struct rte_eth_rss_conf {
320 uint8_t *rss_key; /**< If not NULL, 40-byte hash key. */
321 uint16_t rss_hf; /**< Hash functions to apply - see below. */
324 #define ETH_RSS_IPV4 0x0001 /**< IPv4 packet. */
325 #define ETH_RSS_IPV4_TCP 0x0002 /**< IPv4/TCP packet. */
326 #define ETH_RSS_IPV6 0x0004 /**< IPv6 packet. */
327 #define ETH_RSS_IPV6_EX 0x0008 /**< IPv6 packet with extension headers.*/
328 #define ETH_RSS_IPV6_TCP 0x0010 /**< IPv6/TCP packet. */
329 #define ETH_RSS_IPV6_TCP_EX 0x0020 /**< IPv6/TCP with extension headers. */
330 /* Intel RSS extensions to UDP packets */
331 #define ETH_RSS_IPV4_UDP 0x0040 /**< IPv4/UDP packet. */
332 #define ETH_RSS_IPV6_UDP 0x0080 /**< IPv6/UDP packet. */
333 #define ETH_RSS_IPV6_UDP_EX 0x0100 /**< IPv6/UDP with extension headers. */
335 #define ETH_RSS_PROTO_MASK 0x01FF /**< Mask of valid RSS hash protocols */
336 /* Definitions used for redirection table entry size */
337 #define ETH_RSS_RETA_NUM_ENTRIES 128
338 #define ETH_RSS_RETA_MAX_QUEUE 16
340 /* Definitions used for VMDQ and DCB functionality */
341 #define ETH_VMDQ_MAX_VLAN_FILTERS 64 /**< Maximum nb. of VMDQ vlan filters. */
342 #define ETH_DCB_NUM_USER_PRIORITIES 8 /**< Maximum nb. of DCB priorities. */
343 #define ETH_VMDQ_DCB_NUM_QUEUES 128 /**< Maximum nb. of VMDQ DCB queues. */
344 #define ETH_DCB_NUM_QUEUES 128 /**< Maximum nb. of DCB queues. */
346 /* DCB capability defines */
347 #define ETH_DCB_PG_SUPPORT 0x00000001 /**< Priority Group(ETS) support. */
348 #define ETH_DCB_PFC_SUPPORT 0x00000002 /**< Priority Flow Control support. */
350 /* Definitions used for VLAN Offload functionality */
351 #define ETH_VLAN_STRIP_OFFLOAD 0x0001 /**< VLAN Strip On/Off */
352 #define ETH_VLAN_FILTER_OFFLOAD 0x0002 /**< VLAN Filter On/Off */
353 #define ETH_VLAN_EXTEND_OFFLOAD 0x0004 /**< VLAN Extend On/Off */
355 /* Definitions used for mask VLAN setting */
356 #define ETH_VLAN_STRIP_MASK 0x0001 /**< VLAN Strip setting mask */
357 #define ETH_VLAN_FILTER_MASK 0x0002 /**< VLAN Filter setting mask*/
358 #define ETH_VLAN_EXTEND_MASK 0x0004 /**< VLAN Extend setting mask*/
359 #define ETH_VLAN_ID_MAX 0x0FFF /**< VLAN ID is in lower 12 bits*/
361 /* Definitions used for receive MAC address */
362 #define ETH_NUM_RECEIVE_MAC_ADDR 128 /**< Maximum nb. of receive mac addr. */
365 /* Definitions used for unicast hash */
366 #define ETH_VMDQ_NUM_UC_HASH_ARRAY 128 /**< Maximum nb. of UC hash array. */
368 /* Definitions used for VMDQ pool rx mode setting */
369 #define ETH_VMDQ_ACCEPT_UNTAG 0x0001 /**< accept untagged packets. */
370 #define ETH_VMDQ_ACCEPT_HASH_MC 0x0002 /**< accept packets in multicast table . */
371 #define ETH_VMDQ_ACCEPT_HASH_UC 0x0004 /**< accept packets in unicast table. */
372 #define ETH_VMDQ_ACCEPT_BROADCAST 0x0008 /**< accept broadcast packets. */
373 #define ETH_VMDQ_ACCEPT_MULTICAST 0x0010 /**< multicast promiscuous. */
375 /* Definitions used for VMDQ mirror rules setting */
376 #define ETH_VMDQ_NUM_MIRROR_RULE 4 /**< Maximum nb. of mirror rules. . */
378 #define ETH_VMDQ_POOL_MIRROR 0x0001 /**< Virtual Pool Mirroring. */
379 #define ETH_VMDQ_UPLINK_MIRROR 0x0002 /**< Uplink Port Mirroring. */
380 #define ETH_VMDQ_DOWNLIN_MIRROR 0x0004 /**< Downlink Port Mirroring. */
381 #define ETH_VMDQ_VLAN_MIRROR 0x0008 /**< VLAN Mirroring. */
384 * A structure used to configure VLAN traffic mirror of an Ethernet port.
386 struct rte_eth_vlan_mirror {
387 uint64_t vlan_mask; /**< mask for valid VLAN ID. */
388 uint16_t vlan_id[ETH_VMDQ_MAX_VLAN_FILTERS];
389 /** VLAN ID list for vlan mirror. */
393 * A structure used to configure traffic mirror of an Ethernet port.
395 struct rte_eth_vmdq_mirror_conf {
396 uint8_t rule_type_mask; /**< Mirroring rule type mask we want to set */
397 uint8_t dst_pool; /**< Destination pool for this mirror rule. */
398 uint64_t pool_mask; /**< Bitmap of pool for pool mirroring */
399 struct rte_eth_vlan_mirror vlan; /**< VLAN ID setting for VLAN mirroring */
403 * A structure used to configure Redirection Table of the Receive Side
404 * Scaling (RSS) feature of an Ethernet port.
406 struct rte_eth_rss_reta {
407 /** First 64 mask bits indicate which entry(s) need to updated/queried. */
409 /** Second 64 mask bits indicate which entry(s) need to updated/queried. */
411 uint8_t reta[ETH_RSS_RETA_NUM_ENTRIES]; /**< 128 RETA entries*/
415 * This enum indicates the possible number of traffic classes
416 * in DCB configratioins
418 enum rte_eth_nb_tcs {
419 ETH_4_TCS = 4, /**< 4 TCs with DCB. */
420 ETH_8_TCS = 8 /**< 8 TCs with DCB. */
424 * This enum indicates the possible number of queue pools
425 * in VMDQ configurations.
427 enum rte_eth_nb_pools {
428 ETH_8_POOLS = 8, /**< 8 VMDq pools. */
429 ETH_16_POOLS = 16, /**< 16 VMDq pools. */
430 ETH_32_POOLS = 32, /**< 32 VMDq pools. */
431 ETH_64_POOLS = 64 /**< 64 VMDq pools. */
434 /* This structure may be extended in future. */
435 struct rte_eth_dcb_rx_conf {
436 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs */
437 uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
438 /**< Possible DCB queue,4 or 8. */
441 struct rte_eth_vmdq_dcb_tx_conf {
442 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools. */
443 uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
444 /**< Possible DCB queue,4 or 8. */
447 struct rte_eth_dcb_tx_conf {
448 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs. */
449 uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
450 /**< Possible DCB queue,4 or 8. */
453 struct rte_eth_vmdq_tx_conf {
454 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq mode, 64 pools. */
458 * A structure used to configure the VMDQ+DCB feature
459 * of an Ethernet port.
461 * Using this feature, packets are routed to a pool of queues, based
462 * on the vlan id in the vlan tag, and then to a specific queue within
463 * that pool, using the user priority vlan tag field.
465 * A default pool may be used, if desired, to route all traffic which
466 * does not match the vlan filter rules.
468 struct rte_eth_vmdq_dcb_conf {
469 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools */
470 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
471 uint8_t default_pool; /**< The default pool, if applicable */
472 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
474 uint16_t vlan_id; /**< The vlan id of the received frame */
475 uint64_t pools; /**< Bitmask of pools for packet rx */
476 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
477 uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
478 /**< Selects a queue in a pool */
481 struct rte_eth_vmdq_rx_conf {
482 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq only mode, 8 or 64 pools */
483 uint8_t enable_default_pool; /**< If non-zero, use a default pool */
484 uint8_t default_pool; /**< The default pool, if applicable */
485 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
487 uint16_t vlan_id; /**< The vlan id of the received frame */
488 uint64_t pools; /**< Bitmask of pools for packet rx */
489 } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
493 * A structure used to configure the TX features of an Ethernet port.
495 struct rte_eth_txmode {
496 enum rte_eth_tx_mq_mode mq_mode; /**< TX multi-queues mode. */
500 * A structure used to configure an RX ring of an Ethernet port.
502 struct rte_eth_rxconf {
503 struct rte_eth_thresh rx_thresh; /**< RX ring threshold registers. */
504 uint16_t rx_free_thresh; /**< Drives the freeing of RX descriptors. */
505 uint8_t rx_drop_en; /**< Drop packets if no descriptors are available. */
508 #define ETH_TXQ_FLAGS_NOMULTSEGS 0x0001 /**< nb_segs=1 for all mbufs */
509 #define ETH_TXQ_FLAGS_NOREFCOUNT 0x0002 /**< refcnt can be ignored */
510 #define ETH_TXQ_FLAGS_NOMULTMEMP 0x0004 /**< all bufs come from same mempool */
511 #define ETH_TXQ_FLAGS_NOVLANOFFL 0x0100 /**< disable VLAN offload */
512 #define ETH_TXQ_FLAGS_NOXSUMSCTP 0x0200 /**< disable SCTP checksum offload */
513 #define ETH_TXQ_FLAGS_NOXSUMUDP 0x0400 /**< disable UDP checksum offload */
514 #define ETH_TXQ_FLAGS_NOXSUMTCP 0x0800 /**< disable TCP checksum offload */
515 #define ETH_TXQ_FLAGS_NOOFFLOADS \
516 (ETH_TXQ_FLAGS_NOVLANOFFL | ETH_TXQ_FLAGS_NOXSUMSCTP | \
517 ETH_TXQ_FLAGS_NOXSUMUDP | ETH_TXQ_FLAGS_NOXSUMTCP)
519 * A structure used to configure a TX ring of an Ethernet port.
521 struct rte_eth_txconf {
522 struct rte_eth_thresh tx_thresh; /**< TX ring threshold registers. */
523 uint16_t tx_rs_thresh; /**< Drives the setting of RS bit on TXDs. */
524 uint16_t tx_free_thresh; /**< Drives the freeing of TX buffers. */
525 uint32_t txq_flags; /**< Set flags for the Tx queue */
529 * This enum indicates the flow control mode
531 enum rte_eth_fc_mode {
532 RTE_FC_NONE = 0, /**< Disable flow control. */
533 RTE_FC_RX_PAUSE, /**< RX pause frame, enable flowctrl on TX side. */
534 RTE_FC_TX_PAUSE, /**< TX pause frame, enable flowctrl on RX side. */
535 RTE_FC_FULL /**< Enable flow control on both side. */
539 * A structure used to configure Ethernet flow control parameter.
540 * These parameters will be configured into the register of the NIC.
541 * Please refer to the corresponding data sheet for proper value.
543 struct rte_eth_fc_conf {
544 uint32_t high_water; /**< High threshold value to trigger XOFF */
545 uint32_t low_water; /**< Low threshold value to trigger XON */
546 uint16_t pause_time; /**< Pause quota in the Pause frame */
547 uint16_t send_xon; /**< Is XON frame need be sent */
548 enum rte_eth_fc_mode mode; /**< Link flow control mode */
549 uint8_t mac_ctrl_frame_fwd; /**< Forward MAC control frames */
553 * A structure used to configure Ethernet priority flow control parameter.
554 * These parameters will be configured into the register of the NIC.
555 * Please refer to the corresponding data sheet for proper value.
557 struct rte_eth_pfc_conf {
558 struct rte_eth_fc_conf fc; /**< General flow control parameter. */
559 uint8_t priority; /**< VLAN User Priority. */
563 * Flow Director setting modes: none (default), signature or perfect.
566 RTE_FDIR_MODE_NONE = 0, /**< Disable FDIR support. */
567 RTE_FDIR_MODE_SIGNATURE, /**< Enable FDIR signature filter mode. */
568 RTE_FDIR_MODE_PERFECT, /**< Enable FDIR perfect filter mode. */
572 * Memory space that can be configured to store Flow Director filters
573 * in the board memory.
575 enum rte_fdir_pballoc_type {
576 RTE_FDIR_PBALLOC_64K = 0, /**< 64k. */
577 RTE_FDIR_PBALLOC_128K, /**< 128k. */
578 RTE_FDIR_PBALLOC_256K, /**< 256k. */
582 * Select report mode of FDIR hash information in RX descriptors.
584 enum rte_fdir_status_mode {
585 RTE_FDIR_NO_REPORT_STATUS = 0, /**< Never report FDIR hash. */
586 RTE_FDIR_REPORT_STATUS, /**< Only report FDIR hash for matching pkts. */
587 RTE_FDIR_REPORT_STATUS_ALWAYS, /**< Always report FDIR hash. */
591 * A structure used to configure the Flow Director (FDIR) feature
592 * of an Ethernet port.
594 * If mode is RTE_FDIR_DISABLE, the pballoc value is ignored.
596 struct rte_fdir_conf {
597 enum rte_fdir_mode mode; /**< Flow Director mode. */
598 enum rte_fdir_pballoc_type pballoc; /**< Space for FDIR filters. */
599 enum rte_fdir_status_mode status; /**< How to report FDIR hash. */
600 /** Offset of flexbytes field in RX packets (in 16-bit word units). */
601 uint8_t flexbytes_offset;
602 /** RX queue of packets matching a "drop" filter in perfect mode. */
607 * Possible l4type of FDIR filters.
610 RTE_FDIR_L4TYPE_NONE = 0, /**< None. */
611 RTE_FDIR_L4TYPE_UDP, /**< UDP. */
612 RTE_FDIR_L4TYPE_TCP, /**< TCP. */
613 RTE_FDIR_L4TYPE_SCTP, /**< SCTP. */
617 * Select IPv4 or IPv6 FDIR filters.
620 RTE_FDIR_IPTYPE_IPV4 = 0, /**< IPv4. */
621 RTE_FDIR_IPTYPE_IPV6 , /**< IPv6. */
625 * A structure used to define a FDIR packet filter.
627 struct rte_fdir_filter {
628 uint16_t flex_bytes; /**< Flex bytes value to match. */
629 uint16_t vlan_id; /**< VLAN ID value to match, 0 otherwise. */
630 uint16_t port_src; /**< Source port to match, 0 otherwise. */
631 uint16_t port_dst; /**< Destination port to match, 0 otherwise. */
633 uint32_t ipv4_addr; /**< IPv4 source address to match. */
634 uint32_t ipv6_addr[4]; /**< IPv6 source address to match. */
635 } ip_src; /**< IPv4/IPv6 source address to match (union of above). */
637 uint32_t ipv4_addr; /**< IPv4 destination address to match. */
638 uint32_t ipv6_addr[4]; /**< IPv6 destination address to match */
639 } ip_dst; /**< IPv4/IPv6 destination address to match (union of above). */
640 enum rte_l4type l4type; /**< l4type to match: NONE/UDP/TCP/SCTP. */
641 enum rte_iptype iptype; /**< IP packet type to match: IPv4 or IPv6. */
645 * A structure used to configure FDIR masks that are used by the device
646 * to match the various fields of RX packet headers.
647 * @note The only_ip_flow field has the opposite meaning compared to other
650 struct rte_fdir_masks {
651 /** When set to 1, packet l4type is \b NOT relevant in filters, and
652 source and destination port masks must be set to zero. */
653 uint8_t only_ip_flow;
654 /** If set to 1, vlan_id is relevant in filters. */
656 /** If set to 1, vlan_prio is relevant in filters. */
658 /** If set to 1, flexbytes is relevant in filters. */
660 /** If set to 1, set the IPv6 masks. Otherwise set the IPv4 masks. */
661 uint8_t set_ipv6_mask;
662 /** When set to 1, comparison of destination IPv6 address with IP6AT
663 registers is meaningful. */
664 uint8_t comp_ipv6_dst;
665 /** Mask of Destination IPv4 Address. All bits set to 1 define the
666 relevant bits to use in the destination address of an IPv4 packet
667 when matching it against FDIR filters. */
668 uint32_t dst_ipv4_mask;
669 /** Mask of Source IPv4 Address. All bits set to 1 define
670 the relevant bits to use in the source address of an IPv4 packet
671 when matching it against FDIR filters. */
672 uint32_t src_ipv4_mask;
673 /** Mask of Source IPv6 Address. All bits set to 1 define the
674 relevant BYTES to use in the source address of an IPv6 packet
675 when matching it against FDIR filters. */
676 uint16_t dst_ipv6_mask;
677 /** Mask of Destination IPv6 Address. All bits set to 1 define the
678 relevant BYTES to use in the destination address of an IPv6 packet
679 when matching it against FDIR filters. */
680 uint16_t src_ipv6_mask;
681 /** Mask of Source Port. All bits set to 1 define the relevant
682 bits to use in the source port of an IP packets when matching it
683 against FDIR filters. */
684 uint16_t src_port_mask;
685 /** Mask of Destination Port. All bits set to 1 define the relevant
686 bits to use in the destination port of an IP packet when matching it
687 against FDIR filters. */
688 uint16_t dst_port_mask;
692 * A structure used to report the status of the flow director filters in use.
694 struct rte_eth_fdir {
695 /** Number of filters with collision indication. */
697 /** Number of free (non programmed) filters. */
699 /** The Lookup hash value of the added filter that updated the value
700 of the MAXLEN field */
702 /** Longest linked list of filters in the table. */
704 /** Number of added filters. */
706 /** Number of removed filters. */
708 /** Number of failed added filters (no more space in device). */
710 /** Number of failed removed filters. */
715 * A structure used to enable/disable specific device interrupts.
717 struct rte_intr_conf {
718 /** enable/disable lsc interrupt. 0 (default) - disable, 1 enable */
723 * A structure used to configure an Ethernet port.
724 * Depending upon the RX multi-queue mode, extra advanced
725 * configuration settings may be needed.
727 struct rte_eth_conf {
729 /**< ETH_LINK_SPEED_10[0|00|000], or 0 for autonegotation */
730 uint16_t link_duplex;
731 /**< ETH_LINK_[HALF_DUPLEX|FULL_DUPLEX], or 0 for autonegotation */
732 struct rte_eth_rxmode rxmode; /**< Port RX configuration. */
733 struct rte_eth_txmode txmode; /**< Port TX configuration. */
734 uint32_t lpbk_mode; /**< Loopback operation mode. By default the value
735 is 0, meaning the loopback mode is disabled.
736 Read the datasheet of given ethernet controller
737 for details. The possible values of this field
738 are defined in implementation of each driver. */
740 struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
741 struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
742 /**< Port vmdq+dcb configuration. */
743 struct rte_eth_dcb_rx_conf dcb_rx_conf;
744 /**< Port dcb RX configuration. */
745 struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
746 /**< Port vmdq RX configuration. */
747 } rx_adv_conf; /**< Port RX filtering configuration (union). */
749 struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
750 /**< Port vmdq+dcb TX configuration. */
751 struct rte_eth_dcb_tx_conf dcb_tx_conf;
752 /**< Port dcb TX configuration. */
753 struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
754 /**< Port vmdq TX configuration. */
755 } tx_adv_conf; /**< Port TX DCB configuration (union). */
756 /** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
757 is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
758 uint32_t dcb_capability_en;
759 struct rte_fdir_conf fdir_conf; /**< FDIR configuration. */
760 struct rte_intr_conf intr_conf; /**< Interrupt mode configuration. */
764 * A structure used to retrieve the contextual information of
765 * an Ethernet device, such as the controlling driver of the device,
766 * its PCI context, etc...
770 * RX offload capabilities of a device.
772 #define DEV_RX_OFFLOAD_VLAN_STRIP 0x00000001
773 #define DEV_RX_OFFLOAD_IPV4_CKSUM 0x00000002
774 #define DEV_RX_OFFLOAD_UDP_CKSUM 0x00000004
775 #define DEV_RX_OFFLOAD_TCP_CKSUM 0x00000008
776 #define DEV_RX_OFFLOAD_TCP_LRO 0x00000010
779 * TX offload capabilities of a device.
781 #define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001
782 #define DEV_TX_OFFLOAD_IPV4_CKSUM 0x00000002
783 #define DEV_TX_OFFLOAD_UDP_CKSUM 0x00000004
784 #define DEV_TX_OFFLOAD_TCP_CKSUM 0x00000008
785 #define DEV_TX_OFFLOAD_SCTP_CKSUM 0x00000010
786 #define DEV_TX_OFFLOAD_TCP_TSO 0x00000020
787 #define DEV_TX_OFFLOAD_UDP_TSO 0x00000040
789 struct rte_eth_dev_info {
790 struct rte_pci_device *pci_dev; /**< Device PCI information. */
791 const char *driver_name; /**< Device Driver name. */
792 unsigned int if_index; /**< Index to bound host interface, or 0 if none.
793 Use if_indextoname() to translate into an interface name. */
794 uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
795 uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
796 uint16_t max_rx_queues; /**< Maximum number of RX queues. */
797 uint16_t max_tx_queues; /**< Maximum number of TX queues. */
798 uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
799 uint32_t max_hash_mac_addrs;
800 /** Maximum number of hash MAC addresses for MTA and UTA. */
801 uint16_t max_vfs; /**< Maximum number of VFs. */
802 uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
803 uint32_t rx_offload_capa; /**< Device RX offload capabilities. */
804 uint32_t tx_offload_capa; /**< Device TX offload capabilities. */
809 struct rte_eth_dev_callback;
810 /** @internal Structure to keep track of registered callbacks */
811 TAILQ_HEAD(rte_eth_dev_cb_list, rte_eth_dev_callback);
814 * Definitions of all functions exported by an Ethernet driver through the
815 * the generic structure of type *eth_dev_ops* supplied in the *rte_eth_dev*
816 * structure associated with an Ethernet device.
819 typedef int (*eth_dev_configure_t)(struct rte_eth_dev *dev);
820 /**< @internal Ethernet device configuration. */
822 typedef int (*eth_dev_start_t)(struct rte_eth_dev *dev);
823 /**< @internal Function used to start a configured Ethernet device. */
825 typedef void (*eth_dev_stop_t)(struct rte_eth_dev *dev);
826 /**< @internal Function used to stop a configured Ethernet device. */
828 typedef void (*eth_dev_close_t)(struct rte_eth_dev *dev);
829 /**< @internal Function used to close a configured Ethernet device. */
831 typedef void (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev);
832 /**< @internal Function used to enable the RX promiscuous mode of an Ethernet device. */
834 typedef void (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev);
835 /**< @internal Function used to disable the RX promiscuous mode of an Ethernet device. */
837 typedef void (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
838 /**< @internal Enable the receipt of all multicast packets by an Ethernet device. */
840 typedef void (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
841 /**< @internal Disable the receipt of all multicast packets by an Ethernet device. */
843 typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
844 int wait_to_complete);
845 /**< @internal Get link speed, duplex mode and state (up/down) of an Ethernet device. */
847 typedef void (*eth_stats_get_t)(struct rte_eth_dev *dev,
848 struct rte_eth_stats *igb_stats);
849 /**< @internal Get global I/O statistics of an Ethernet device. */
851 typedef void (*eth_stats_reset_t)(struct rte_eth_dev *dev);
852 /**< @internal Reset global I/O statistics of an Ethernet device to 0. */
854 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
858 /**< @internal Set a queue statistics mapping for a tx/rx queue of an Ethernet device. */
860 typedef void (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
861 struct rte_eth_dev_info *dev_info);
862 /**< @internal Get specific informations of an Ethernet device. */
864 typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
865 uint16_t rx_queue_id,
867 unsigned int socket_id,
868 const struct rte_eth_rxconf *rx_conf,
869 struct rte_mempool *mb_pool);
870 /**< @internal Set up a receive queue of an Ethernet device. */
872 typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
873 uint16_t tx_queue_id,
875 unsigned int socket_id,
876 const struct rte_eth_txconf *tx_conf);
877 /**< @internal Setup a transmit queue of an Ethernet device. */
879 typedef void (*eth_queue_release_t)(void *queue);
880 /**< @internal Release memory resources allocated by given RX/TX queue. */
882 typedef uint32_t (*eth_rx_queue_count_t)(struct rte_eth_dev *dev,
883 uint16_t rx_queue_id);
884 /**< @Get number of available descriptors on a receive queue of an Ethernet device. */
886 typedef int (*eth_rx_descriptor_done_t)(void *rxq, uint16_t offset);
887 /**< @Check DD bit of specific RX descriptor */
889 typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
892 /**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */
894 typedef void (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
896 /**< @internal set the outer VLAN-TPID by an Ethernet device. */
898 typedef void (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
899 /**< @internal set VLAN offload function by an Ethernet device. */
901 typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
902 uint16_t rx_queue_id,
904 /**< @internal VLAN stripping enable/disable by an queue of Ethernet device. */
906 typedef uint16_t (*eth_rx_burst_t)(void *rxq,
907 struct rte_mbuf **rx_pkts,
909 /**< @internal Retrieve input packets from a receive queue of an Ethernet device. */
911 typedef uint16_t (*eth_tx_burst_t)(void *txq,
912 struct rte_mbuf **tx_pkts,
914 /**< @internal Send output packets on a transmit queue of an Ethernet device. */
916 typedef int (*fdir_add_signature_filter_t)(struct rte_eth_dev *dev,
917 struct rte_fdir_filter *fdir_ftr,
919 /**< @internal Setup a new signature filter rule on an Ethernet device */
921 typedef int (*fdir_update_signature_filter_t)(struct rte_eth_dev *dev,
922 struct rte_fdir_filter *fdir_ftr,
924 /**< @internal Update a signature filter rule on an Ethernet device */
926 typedef int (*fdir_remove_signature_filter_t)(struct rte_eth_dev *dev,
927 struct rte_fdir_filter *fdir_ftr);
928 /**< @internal Remove a signature filter rule on an Ethernet device */
930 typedef void (*fdir_infos_get_t)(struct rte_eth_dev *dev,
931 struct rte_eth_fdir *fdir);
932 /**< @internal Get information about fdir status */
934 typedef int (*fdir_add_perfect_filter_t)(struct rte_eth_dev *dev,
935 struct rte_fdir_filter *fdir_ftr,
936 uint16_t soft_id, uint8_t rx_queue,
938 /**< @internal Setup a new perfect filter rule on an Ethernet device */
940 typedef int (*fdir_update_perfect_filter_t)(struct rte_eth_dev *dev,
941 struct rte_fdir_filter *fdir_ftr,
942 uint16_t soft_id, uint8_t rx_queue,
944 /**< @internal Update a perfect filter rule on an Ethernet device */
946 typedef int (*fdir_remove_perfect_filter_t)(struct rte_eth_dev *dev,
947 struct rte_fdir_filter *fdir_ftr,
949 /**< @internal Remove a perfect filter rule on an Ethernet device */
951 typedef int (*fdir_set_masks_t)(struct rte_eth_dev *dev,
952 struct rte_fdir_masks *fdir_masks);
953 /**< @internal Setup flow director masks on an Ethernet device */
955 typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
956 struct rte_eth_fc_conf *fc_conf);
957 /**< @internal Setup flow control parameter on an Ethernet device */
959 typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
960 struct rte_eth_pfc_conf *pfc_conf);
961 /**< @internal Setup priority flow control parameter on an Ethernet device */
963 typedef int (*reta_update_t)(struct rte_eth_dev *dev,
964 struct rte_eth_rss_reta *reta_conf);
965 /**< @internal Update RSS redirection table on an Ethernet device */
967 typedef int (*reta_query_t)(struct rte_eth_dev *dev,
968 struct rte_eth_rss_reta *reta_conf);
969 /**< @internal Query RSS redirection table on an Ethernet device */
971 typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
972 struct rte_eth_rss_conf *rss_conf);
973 /**< @internal Update RSS hash configuration of an Ethernet device */
975 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
976 /**< @internal Turn on SW controllable LED on an Ethernet device */
978 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
979 /**< @internal Turn off SW controllable LED on an Ethernet device */
981 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
982 /**< @internal Remove MAC address from receive address register */
984 typedef void (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
985 struct ether_addr *mac_addr,
988 /**< @internal Set a MAC address into Receive Address Address Register */
990 typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
991 struct ether_addr *mac_addr,
993 /**< @internal Set a Unicast Hash bitmap */
995 typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
997 /**< @internal Set all Unicast Hash bitmap */
999 typedef int (*eth_set_vf_rx_mode_t)(struct rte_eth_dev *dev,
1003 /**< @internal Set a VF receive mode */
1005 typedef int (*eth_set_vf_rx_t)(struct rte_eth_dev *dev,
1008 /**< @internal Set a VF receive mode */
1010 typedef int (*eth_set_vf_tx_t)(struct rte_eth_dev *dev,
1013 /**< @internal Enable or disable a VF transmit */
1015 typedef int (*eth_set_vf_vlan_filter_t)(struct rte_eth_dev *dev,
1019 /**< @internal Set VF VLAN pool filter */
1021 typedef int (*eth_mirror_rule_set_t)(struct rte_eth_dev *dev,
1022 struct rte_eth_vmdq_mirror_conf *mirror_conf,
1025 /**< @internal Add a traffic mirroring rule on an Ethernet device */
1027 typedef int (*eth_mirror_rule_reset_t)(struct rte_eth_dev *dev,
1029 /**< @internal Remove a traffic mirroring rule on an Ethernet device */
1031 #ifdef RTE_NIC_BYPASS
1034 RTE_BYPASS_MODE_NONE,
1035 RTE_BYPASS_MODE_NORMAL,
1036 RTE_BYPASS_MODE_BYPASS,
1037 RTE_BYPASS_MODE_ISOLATE,
1038 RTE_BYPASS_MODE_NUM,
1041 #define RTE_BYPASS_MODE_VALID(x) \
1042 ((x) > RTE_BYPASS_MODE_NONE && (x) < RTE_BYPASS_MODE_NUM)
1045 RTE_BYPASS_EVENT_NONE,
1046 RTE_BYPASS_EVENT_START,
1047 RTE_BYPASS_EVENT_OS_ON = RTE_BYPASS_EVENT_START,
1048 RTE_BYPASS_EVENT_POWER_ON,
1049 RTE_BYPASS_EVENT_OS_OFF,
1050 RTE_BYPASS_EVENT_POWER_OFF,
1051 RTE_BYPASS_EVENT_TIMEOUT,
1052 RTE_BYPASS_EVENT_NUM
1055 #define RTE_BYPASS_EVENT_VALID(x) \
1056 ((x) > RTE_BYPASS_EVENT_NONE && (x) < RTE_BYPASS_MODE_NUM)
1059 RTE_BYPASS_TMT_OFF, /* timeout disabled. */
1060 RTE_BYPASS_TMT_1_5_SEC, /* timeout for 1.5 seconds */
1061 RTE_BYPASS_TMT_2_SEC, /* timeout for 2 seconds */
1062 RTE_BYPASS_TMT_3_SEC, /* timeout for 3 seconds */
1063 RTE_BYPASS_TMT_4_SEC, /* timeout for 4 seconds */
1064 RTE_BYPASS_TMT_8_SEC, /* timeout for 8 seconds */
1065 RTE_BYPASS_TMT_16_SEC, /* timeout for 16 seconds */
1066 RTE_BYPASS_TMT_32_SEC, /* timeout for 32 seconds */
1070 #define RTE_BYPASS_TMT_VALID(x) \
1071 ((x) == RTE_BYPASS_TMT_OFF || \
1072 ((x) > RTE_BYPASS_TMT_OFF && (x) < RTE_BYPASS_TMT_NUM))
1074 typedef void (*bypass_init_t)(struct rte_eth_dev *dev);
1075 typedef int32_t (*bypass_state_set_t)(struct rte_eth_dev *dev, uint32_t *new_state);
1076 typedef int32_t (*bypass_state_show_t)(struct rte_eth_dev *dev, uint32_t *state);
1077 typedef int32_t (*bypass_event_set_t)(struct rte_eth_dev *dev, uint32_t state, uint32_t event);
1078 typedef int32_t (*bypass_event_show_t)(struct rte_eth_dev *dev, uint32_t event_shift, uint32_t *event);
1079 typedef int32_t (*bypass_wd_timeout_set_t)(struct rte_eth_dev *dev, uint32_t timeout);
1080 typedef int32_t (*bypass_wd_timeout_show_t)(struct rte_eth_dev *dev, uint32_t *wd_timeout);
1081 typedef int32_t (*bypass_ver_show_t)(struct rte_eth_dev *dev, uint32_t *ver);
1082 typedef int32_t (*bypass_wd_reset_t)(struct rte_eth_dev *dev);
1087 * @internal A structure containing the functions exported by an Ethernet driver.
1089 struct eth_dev_ops {
1090 eth_dev_configure_t dev_configure; /**< Configure device. */
1091 eth_dev_start_t dev_start; /**< Start device. */
1092 eth_dev_stop_t dev_stop; /**< Stop device. */
1093 eth_dev_close_t dev_close; /**< Close device. */
1094 eth_promiscuous_enable_t promiscuous_enable; /**< Promiscuous ON. */
1095 eth_promiscuous_disable_t promiscuous_disable;/**< Promiscuous OFF. */
1096 eth_allmulticast_enable_t allmulticast_enable;/**< RX multicast ON. */
1097 eth_allmulticast_disable_t allmulticast_disable;/**< RX multicast OF. */
1098 eth_link_update_t link_update; /**< Get device link state. */
1099 eth_stats_get_t stats_get; /**< Get device statistics. */
1100 eth_stats_reset_t stats_reset; /**< Reset device statistics. */
1101 eth_queue_stats_mapping_set_t queue_stats_mapping_set;
1102 /**< Configure per queue stat counter mapping. */
1103 eth_dev_infos_get_t dev_infos_get; /**< Get device info. */
1104 vlan_filter_set_t vlan_filter_set; /**< Filter VLAN Setup. */
1105 vlan_tpid_set_t vlan_tpid_set; /**< Outer VLAN TPID Setup. */
1106 vlan_strip_queue_set_t vlan_strip_queue_set; /**< VLAN Stripping on queue. */
1107 vlan_offload_set_t vlan_offload_set; /**< Set VLAN Offload. */
1108 eth_rx_queue_setup_t rx_queue_setup;/**< Set up device RX queue.*/
1109 eth_queue_release_t rx_queue_release;/**< Release RX queue.*/
1110 eth_rx_queue_count_t rx_queue_count; /**< Get Rx queue count. */
1111 eth_rx_descriptor_done_t rx_descriptor_done; /**< Check rxd DD bit */
1112 eth_tx_queue_setup_t tx_queue_setup;/**< Set up device TX queue.*/
1113 eth_queue_release_t tx_queue_release;/**< Release TX queue.*/
1114 eth_dev_led_on_t dev_led_on; /**< Turn on LED. */
1115 eth_dev_led_off_t dev_led_off; /**< Turn off LED. */
1116 flow_ctrl_set_t flow_ctrl_set; /**< Setup flow control. */
1117 priority_flow_ctrl_set_t priority_flow_ctrl_set; /**< Setup priority flow control.*/
1118 eth_mac_addr_remove_t mac_addr_remove; /**< Remove MAC address */
1119 eth_mac_addr_add_t mac_addr_add; /**< Add a MAC address */
1120 eth_uc_hash_table_set_t uc_hash_table_set; /**< Set Unicast Table Array */
1121 eth_uc_all_hash_table_set_t uc_all_hash_table_set; /**< Set Unicast hash bitmap */
1122 eth_mirror_rule_set_t mirror_rule_set; /**< Add a traffic mirror rule.*/
1123 eth_mirror_rule_reset_t mirror_rule_reset; /**< reset a traffic mirror rule.*/
1124 eth_set_vf_rx_mode_t set_vf_rx_mode; /**< Set VF RX mode */
1125 eth_set_vf_rx_t set_vf_rx; /**< enable/disable a VF receive */
1126 eth_set_vf_tx_t set_vf_tx; /**< enable/disable a VF transmit */
1127 eth_set_vf_vlan_filter_t set_vf_vlan_filter; /**< Set VF VLAN filter */
1129 /** Add a signature filter. */
1130 fdir_add_signature_filter_t fdir_add_signature_filter;
1131 /** Update a signature filter. */
1132 fdir_update_signature_filter_t fdir_update_signature_filter;
1133 /** Remove a signature filter. */
1134 fdir_remove_signature_filter_t fdir_remove_signature_filter;
1135 /** Get information about FDIR status. */
1136 fdir_infos_get_t fdir_infos_get;
1137 /** Add a perfect filter. */
1138 fdir_add_perfect_filter_t fdir_add_perfect_filter;
1139 /** Update a perfect filter. */
1140 fdir_update_perfect_filter_t fdir_update_perfect_filter;
1141 /** Remove a perfect filter. */
1142 fdir_remove_perfect_filter_t fdir_remove_perfect_filter;
1143 /** Setup masks for FDIR filtering. */
1144 fdir_set_masks_t fdir_set_masks;
1145 /** Update redirection table. */
1146 reta_update_t reta_update;
1147 /** Query redirection table. */
1148 reta_query_t reta_query;
1149 /* bypass control */
1150 #ifdef RTE_NIC_BYPASS
1151 bypass_init_t bypass_init;
1152 bypass_state_set_t bypass_state_set;
1153 bypass_state_show_t bypass_state_show;
1154 bypass_event_set_t bypass_event_set;
1155 bypass_event_show_t bypass_event_show;
1156 bypass_wd_timeout_set_t bypass_wd_timeout_set;
1157 bypass_wd_timeout_show_t bypass_wd_timeout_show;
1158 bypass_ver_show_t bypass_ver_show;
1159 bypass_wd_reset_t bypass_wd_reset;
1162 /** Configure RSS hash protocols. */
1163 rss_hash_update_t rss_hash_update;
1168 * The generic data structure associated with each ethernet device.
1170 * Pointers to burst-oriented packet receive and transmit functions are
1171 * located at the beginning of the structure, along with the pointer to
1172 * where all the data elements for the particular device are stored in shared
1173 * memory. This split allows the function pointer and driver data to be per-
1174 * process, while the actual configuration data for the device is shared.
1176 struct rte_eth_dev {
1177 eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
1178 eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
1179 struct rte_eth_dev_data *data; /**< Pointer to device data */
1180 const struct eth_driver *driver;/**< Driver for this device */
1181 struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
1182 struct rte_pci_device *pci_dev; /**< PCI info. supplied by probing */
1183 struct rte_eth_dev_cb_list callbacks; /**< User application callbacks */
1186 struct rte_eth_dev_sriov {
1187 uint8_t active; /**< SRIOV is active with 16, 32 or 64 pools */
1188 uint8_t nb_q_per_pool; /**< rx queue number per pool */
1189 uint16_t def_vmdq_idx; /**< Default pool num used for PF */
1190 uint16_t def_pool_q_idx; /**< Default pool queue start reg index */
1192 #define RTE_ETH_DEV_SRIOV(dev) ((dev)->data->sriov)
1196 * The data part, with no function pointers, associated with each ethernet device.
1198 * This structure is safe to place in shared memory to be common among different
1199 * processes in a multi-process configuration.
1201 struct rte_eth_dev_data {
1202 void **rx_queues; /**< Array of pointers to RX queues. */
1203 void **tx_queues; /**< Array of pointers to TX queues. */
1204 uint16_t nb_rx_queues; /**< Number of RX queues. */
1205 uint16_t nb_tx_queues; /**< Number of TX queues. */
1207 struct rte_eth_dev_sriov sriov; /**< SRIOV data */
1209 void *dev_private; /**< PMD-specific private data */
1211 struct rte_eth_link dev_link;
1212 /**< Link-level information & status */
1214 struct rte_eth_conf dev_conf; /**< Configuration applied to device. */
1215 uint16_t max_frame_size; /**< Default is ETHER_MAX_LEN (1518). */
1217 uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
1218 struct ether_addr* mac_addrs;/**< Device Ethernet Link address. */
1219 uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
1220 /** bitmap array of associating Ethernet MAC addresses to pools */
1221 struct ether_addr* hash_mac_addrs;
1222 /** Device Ethernet MAC addresses of hash filtering. */
1223 uint8_t port_id; /**< Device [external] port identifier. */
1224 uint8_t promiscuous : 1, /**< RX promiscuous mode ON(1) / OFF(0). */
1225 scattered_rx : 1, /**< RX of scattered packets is ON(1) / OFF(0) */
1226 all_multicast : 1, /**< RX all multicast mode ON(1) / OFF(0). */
1227 dev_started : 1; /**< Device state: STARTED(1) / STOPPED(0). */
1232 * The pool of *rte_eth_dev* structures. The size of the pool
1233 * is configured at compile-time in the <rte_ethdev.c> file.
1235 extern struct rte_eth_dev rte_eth_devices[];
1238 * Get the total number of Ethernet devices that have been successfully
1239 * initialized by the [matching] Ethernet driver during the PCI probing phase.
1240 * All devices whose port identifier is in the range
1241 * [0, rte_eth_dev_count() - 1] can be operated on by network applications.
1244 * - The total number of usable Ethernet devices.
1246 extern uint8_t rte_eth_dev_count(void);
1249 * Function for internal use by dummy drivers primarily, e.g. ring-based
1251 * Allocates a new ethdev slot for an ethernet device and returns the pointer
1252 * to that slot for the driver to use.
1255 * - Slot in the rte_dev_devices array for a new device;
1257 struct rte_eth_dev *rte_eth_dev_allocate(void);
1262 * Initialization function of an Ethernet driver invoked for each matching
1263 * Ethernet PCI device detected during the PCI probing phase.
1266 * The pointer to the [matching] Ethernet driver structure supplied by
1267 * the PMD when it registered itself.
1269 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1270 * associated with the matching device and which have been [automatically]
1271 * allocated in the *rte_eth_devices* array.
1272 * The *eth_dev* structure is supplied to the driver initialization function
1273 * with the following fields already initialized:
1275 * - *pci_dev*: Holds the pointers to the *rte_pci_device* structure which
1276 * contains the generic PCI information of the matching device.
1278 * - *dev_private*: Holds a pointer to the device private data structure.
1280 * - *max_frame_size*: Contains the default Ethernet maximum frame length
1283 * - *port_id*: Contains the port index of the device (actually the index
1284 * of the *eth_dev* structure in the *rte_eth_devices* array).
1287 * - 0: Success, the device is properly initialized by the driver.
1288 * In particular, the driver MUST have set up the *dev_ops* pointer
1289 * of the *eth_dev* structure.
1290 * - <0: Error code of the device initialization failure.
1292 typedef int (*eth_dev_init_t)(struct eth_driver *eth_drv,
1293 struct rte_eth_dev *eth_dev);
1297 * The structure associated with a PMD Ethernet driver.
1299 * Each Ethernet driver acts as a PCI driver and is represented by a generic
1300 * *eth_driver* structure that holds:
1302 * - An *rte_pci_driver* structure (which must be the first field).
1304 * - The *eth_dev_init* function invoked for each matching PCI device.
1306 * - The size of the private data to allocate for each matching device.
1309 struct rte_pci_driver pci_drv; /**< The PMD is also a PCI driver. */
1310 eth_dev_init_t eth_dev_init; /**< Device init function. */
1311 unsigned int dev_private_size; /**< Size of device private data. */
1316 * A function invoked by the initialization function of an Ethernet driver
1317 * to simultaneously register itself as a PCI driver and as an Ethernet
1318 * Poll Mode Driver (PMD).
1321 * The pointer to the *eth_driver* structure associated with
1322 * the Ethernet driver.
1324 extern void rte_eth_driver_register(struct eth_driver *eth_drv);
1327 * Configure an Ethernet device.
1328 * This function must be invoked first before any other function in the
1329 * Ethernet API. This function can also be re-invoked when a device is in the
1333 * The port identifier of the Ethernet device to configure.
1334 * @param nb_rx_queue
1335 * The number of receive queues to set up for the Ethernet device.
1336 * @param nb_tx_queue
1337 * The number of transmit queues to set up for the Ethernet device.
1339 * The pointer to the configuration data to be used for the Ethernet device.
1340 * The *rte_eth_conf* structure includes:
1341 * - the hardware offload features to activate, with dedicated fields for
1342 * each statically configurable offload hardware feature provided by
1343 * Ethernet devices, such as IP checksum or VLAN tag stripping for
1345 * - the Receive Side Scaling (RSS) configuration when using multiple RX
1348 * Embedding all configuration information in a single data structure
1349 * is the more flexible method that allows the addition of new features
1350 * without changing the syntax of the API.
1352 * - 0: Success, device configured.
1353 * - <0: Error code returned by the driver configuration function.
1355 extern int rte_eth_dev_configure(uint8_t port_id,
1356 uint16_t nb_rx_queue,
1357 uint16_t nb_tx_queue,
1358 const struct rte_eth_conf *eth_conf);
1361 * Allocate and set up a receive queue for an Ethernet device.
1363 * The function allocates a contiguous block of memory for *nb_rx_desc*
1364 * receive descriptors from a memory zone associated with *socket_id*
1365 * and initializes each receive descriptor with a network buffer allocated
1366 * from the memory pool *mb_pool*.
1369 * The port identifier of the Ethernet device.
1370 * @param rx_queue_id
1371 * The index of the receive queue to set up.
1372 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1373 * to rte_eth_dev_configure().
1375 * The number of receive descriptors to allocate for the receive ring.
1377 * The *socket_id* argument is the socket identifier in case of NUMA.
1378 * The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1379 * the DMA memory allocated for the receive descriptors of the ring.
1381 * The pointer to the configuration data to be used for the receive queue.
1382 * The *rx_conf* structure contains an *rx_thresh* structure with the values
1383 * of the Prefetch, Host, and Write-Back threshold registers of the receive
1386 * The pointer to the memory pool from which to allocate *rte_mbuf* network
1387 * memory buffers to populate each descriptor of the receive ring.
1389 * - 0: Success, receive queue correctly set up.
1390 * - -EINVAL: The size of network buffers which can be allocated from the
1391 * memory pool does not fit the various buffer sizes allowed by the
1392 * device controller.
1393 * - -ENOMEM: Unable to allocate the receive ring descriptors or to
1394 * allocate network memory buffers from the memory pool when
1395 * initializing receive descriptors.
1397 extern int rte_eth_rx_queue_setup(uint8_t port_id, uint16_t rx_queue_id,
1398 uint16_t nb_rx_desc, unsigned int socket_id,
1399 const struct rte_eth_rxconf *rx_conf,
1400 struct rte_mempool *mb_pool);
1403 * Allocate and set up a transmit queue for an Ethernet device.
1406 * The port identifier of the Ethernet device.
1407 * @param tx_queue_id
1408 * The index of the transmit queue to set up.
1409 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1410 * to rte_eth_dev_configure().
1412 * The number of transmit descriptors to allocate for the transmit ring.
1414 * The *socket_id* argument is the socket identifier in case of NUMA.
1415 * Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1416 * the DMA memory allocated for the transmit descriptors of the ring.
1418 * The pointer to the configuration data to be used for the transmit queue.
1419 * The *tx_conf* structure contains the following data:
1420 * - The *tx_thresh* structure with the values of the Prefetch, Host, and
1421 * Write-Back threshold registers of the transmit ring.
1422 * When setting Write-Back threshold to the value greater then zero,
1423 * *tx_rs_thresh* value should be explicitly set to one.
1424 * - The *tx_free_thresh* value indicates the [minimum] number of network
1425 * buffers that must be pending in the transmit ring to trigger their
1426 * [implicit] freeing by the driver transmit function.
1427 * - The *tx_rs_thresh* value indicates the [minimum] number of transmit
1428 * descriptors that must be pending in the transmit ring before setting the
1429 * RS bit on a descriptor by the driver transmit function.
1430 * The *tx_rs_thresh* value should be less or equal then
1431 * *tx_free_thresh* value, and both of them should be less then
1433 * - The *txq_flags* member contains flags to pass to the TX queue setup
1434 * function to configure the behavior of the TX queue. This should be set
1435 * to 0 if no special configuration is required.
1437 * Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces
1438 * the transmit function to use default values.
1440 * - 0: Success, the transmit queue is correctly set up.
1441 * - -ENOMEM: Unable to allocate the transmit ring descriptors.
1443 extern int rte_eth_tx_queue_setup(uint8_t port_id, uint16_t tx_queue_id,
1444 uint16_t nb_tx_desc, unsigned int socket_id,
1445 const struct rte_eth_txconf *tx_conf);
1448 * Return the NUMA socket to which an Ethernet device is connected
1451 * The port identifier of the Ethernet device
1453 * The NUMA socket id to which the Ethernet device is connected or
1454 * a default of zero if the socket could not be determined.
1455 * -1 is returned is the port_id value is out of range.
1457 extern int rte_eth_dev_socket_id(uint8_t port_id);
1461 * Start an Ethernet device.
1463 * The device start step is the last one and consists of setting the configured
1464 * offload features and in starting the transmit and the receive units of the
1466 * On success, all basic functions exported by the Ethernet API (link status,
1467 * receive/transmit, and so on) can be invoked.
1470 * The port identifier of the Ethernet device.
1472 * - 0: Success, Ethernet device started.
1473 * - <0: Error code of the driver device start function.
1475 extern int rte_eth_dev_start(uint8_t port_id);
1478 * Stop an Ethernet device. The device can be restarted with a call to
1479 * rte_eth_dev_start()
1482 * The port identifier of the Ethernet device.
1484 extern void rte_eth_dev_stop(uint8_t port_id);
1487 * Close an Ethernet device. The device cannot be restarted!
1490 * The port identifier of the Ethernet device.
1492 extern void rte_eth_dev_close(uint8_t port_id);
1495 * Enable receipt in promiscuous mode for an Ethernet device.
1498 * The port identifier of the Ethernet device.
1500 extern void rte_eth_promiscuous_enable(uint8_t port_id);
1503 * Disable receipt in promiscuous mode for an Ethernet device.
1506 * The port identifier of the Ethernet device.
1508 extern void rte_eth_promiscuous_disable(uint8_t port_id);
1511 * Return the value of promiscuous mode for an Ethernet device.
1514 * The port identifier of the Ethernet device.
1516 * - (1) if promiscuous is enabled
1517 * - (0) if promiscuous is disabled.
1520 extern int rte_eth_promiscuous_get(uint8_t port_id);
1523 * Enable the receipt of any multicast frame by an Ethernet device.
1526 * The port identifier of the Ethernet device.
1528 extern void rte_eth_allmulticast_enable(uint8_t port_id);
1531 * Disable the receipt of all multicast frames by an Ethernet device.
1534 * The port identifier of the Ethernet device.
1536 extern void rte_eth_allmulticast_disable(uint8_t port_id);
1539 * Return the value of allmulticast mode for an Ethernet device.
1542 * The port identifier of the Ethernet device.
1544 * - (1) if allmulticast is enabled
1545 * - (0) if allmulticast is disabled.
1548 extern int rte_eth_allmulticast_get(uint8_t port_id);
1551 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
1552 * or FULL-DUPLEX) of the physical link of an Ethernet device. It might need
1553 * to wait up to 9 seconds in it.
1556 * The port identifier of the Ethernet device.
1558 * A pointer to an *rte_eth_link* structure to be filled with
1559 * the status, the speed and the mode of the Ethernet device link.
1561 extern void rte_eth_link_get(uint8_t port_id, struct rte_eth_link *link);
1564 * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
1565 * or FULL-DUPLEX) of the physical link of an Ethernet device. It is a no-wait
1566 * version of rte_eth_link_get().
1569 * The port identifier of the Ethernet device.
1571 * A pointer to an *rte_eth_link* structure to be filled with
1572 * the status, the speed and the mode of the Ethernet device link.
1574 extern void rte_eth_link_get_nowait(uint8_t port_id,
1575 struct rte_eth_link *link);
1578 * Retrieve the general I/O statistics of an Ethernet device.
1581 * The port identifier of the Ethernet device.
1583 * A pointer to a structure of type *rte_eth_stats* to be filled with
1584 * the values of device counters for the following set of statistics:
1585 * - *ipackets* with the total of successfully received packets.
1586 * - *opackets* with the total of successfully transmitted packets.
1587 * - *ibytes* with the total of successfully received bytes.
1588 * - *obytes* with the total of successfully transmitted bytes.
1589 * - *ierrors* with the total of erroneous received packets.
1590 * - *oerrors* with the total of failed transmitted packets.
1592 extern void rte_eth_stats_get(uint8_t port_id, struct rte_eth_stats *stats);
1595 * Reset the general I/O statistics of an Ethernet device.
1598 * The port identifier of the Ethernet device.
1600 extern void rte_eth_stats_reset(uint8_t port_id);
1603 * Set a mapping for the specified transmit queue to the specified per-queue
1604 * statistics counter.
1607 * The port identifier of the Ethernet device.
1608 * @param tx_queue_id
1609 * The index of the transmit queue for which a queue stats mapping is required.
1610 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1611 * to rte_eth_dev_configure().
1613 * The per-queue packet statistics functionality number that the transmit
1614 * queue is to be assigned.
1615 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
1617 * Zero if successful. Non-zero otherwise.
1619 extern int rte_eth_dev_set_tx_queue_stats_mapping(uint8_t port_id,
1620 uint16_t tx_queue_id,
1624 * Set a mapping for the specified receive queue to the specified per-queue
1625 * statistics counter.
1628 * The port identifier of the Ethernet device.
1629 * @param rx_queue_id
1630 * The index of the receive queue for which a queue stats mapping is required.
1631 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1632 * to rte_eth_dev_configure().
1634 * The per-queue packet statistics functionality number that the receive
1635 * queue is to be assigned.
1636 * The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
1638 * Zero if successful. Non-zero otherwise.
1640 extern int rte_eth_dev_set_rx_queue_stats_mapping(uint8_t port_id,
1641 uint16_t rx_queue_id,
1645 * Retrieve the Ethernet address of an Ethernet device.
1648 * The port identifier of the Ethernet device.
1650 * A pointer to a structure of type *ether_addr* to be filled with
1651 * the Ethernet address of the Ethernet device.
1653 extern void rte_eth_macaddr_get(uint8_t port_id, struct ether_addr *mac_addr);
1656 * Retrieve the contextual information of an Ethernet device.
1659 * The port identifier of the Ethernet device.
1661 * A pointer to a structure of type *rte_eth_dev_info* to be filled with
1662 * the contextual information of the Ethernet device.
1664 extern void rte_eth_dev_info_get(uint8_t port_id,
1665 struct rte_eth_dev_info *dev_info);
1668 * Enable/Disable hardware filtering by an Ethernet device of received
1669 * VLAN packets tagged with a given VLAN Tag Identifier.
1672 * The port identifier of the Ethernet device.
1674 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
1676 * If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*.
1677 * Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*.
1679 * - (0) if successful.
1680 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
1681 * - (-ENODEV) if *port_id* invalid.
1682 * - (-ENOSYS) if VLAN filtering on *port_id* disabled.
1683 * - (-EINVAL) if *vlan_id* > 4095.
1685 extern int rte_eth_dev_vlan_filter(uint8_t port_id, uint16_t vlan_id , int on);
1688 * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
1689 * 82599/X540 can support VLAN stripping at the rx queue level
1692 * The port identifier of the Ethernet device.
1693 * @param rx_queue_id
1694 * The index of the receive queue for which a queue stats mapping is required.
1695 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1696 * to rte_eth_dev_configure().
1698 * If 1, Enable VLAN Stripping of the receive queue of the Ethernet port.
1699 * If 0, Disable VLAN Stripping of the receive queue of the Ethernet port.
1701 * - (0) if successful.
1702 * - (-ENOSUP) if hardware-assisted VLAN stripping not configured.
1703 * - (-ENODEV) if *port_id* invalid.
1704 * - (-EINVAL) if *rx_queue_id* invalid.
1706 extern int rte_eth_dev_set_vlan_strip_on_queue(uint8_t port_id,
1707 uint16_t rx_queue_id, int on);
1710 * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
1711 * the VLAN Header. This is a register setup available on some Intel NIC, not
1712 * but all, please check the data sheet for availability.
1715 * The port identifier of the Ethernet device.
1717 * The Tag Protocol ID
1719 * - (0) if successful.
1720 * - (-ENOSUP) if hardware-assisted VLAN TPID setup is not supported.
1721 * - (-ENODEV) if *port_id* invalid.
1723 extern int rte_eth_dev_set_vlan_ether_type(uint8_t port_id, uint16_t tag_type);
1726 * Set VLAN offload configuration on an Ethernet device
1727 * Enable/Disable Extended VLAN by an Ethernet device, This is a register setup
1728 * available on some Intel NIC, not but all, please check the data sheet for
1730 * Enable/Disable VLAN Strip can be done on rx queue for certain NIC, but here
1731 * the configuration is applied on the port level.
1734 * The port identifier of the Ethernet device.
1735 * @param offload_mask
1736 * The VLAN Offload bit mask can be mixed use with "OR"
1737 * ETH_VLAN_STRIP_OFFLOAD
1738 * ETH_VLAN_FILTER_OFFLOAD
1739 * ETH_VLAN_EXTEND_OFFLOAD
1741 * - (0) if successful.
1742 * - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
1743 * - (-ENODEV) if *port_id* invalid.
1745 extern int rte_eth_dev_set_vlan_offload(uint8_t port_id, int offload_mask);
1748 * Read VLAN Offload configuration from an Ethernet device
1751 * The port identifier of the Ethernet device.
1753 * - (>0) if successful. Bit mask to indicate
1754 * ETH_VLAN_STRIP_OFFLOAD
1755 * ETH_VLAN_FILTER_OFFLOAD
1756 * ETH_VLAN_EXTEND_OFFLOAD
1757 * - (-ENODEV) if *port_id* invalid.
1759 extern int rte_eth_dev_get_vlan_offload(uint8_t port_id);
1763 * Retrieve a burst of input packets from a receive queue of an Ethernet
1764 * device. The retrieved packets are stored in *rte_mbuf* structures whose
1765 * pointers are supplied in the *rx_pkts* array.
1767 * The rte_eth_rx_burst() function loops, parsing the RX ring of the
1768 * receive queue, up to *nb_pkts* packets, and for each completed RX
1769 * descriptor in the ring, it performs the following operations:
1771 * - Initialize the *rte_mbuf* data structure associated with the
1772 * RX descriptor according to the information provided by the NIC into
1773 * that RX descriptor.
1775 * - Store the *rte_mbuf* data structure into the next entry of the
1778 * - Replenish the RX descriptor with a new *rte_mbuf* buffer
1779 * allocated from the memory pool associated with the receive queue at
1780 * initialization time.
1782 * When retrieving an input packet that was scattered by the controller
1783 * into multiple receive descriptors, the rte_eth_rx_burst() function
1784 * appends the associated *rte_mbuf* buffers to the first buffer of the
1787 * The rte_eth_rx_burst() function returns the number of packets
1788 * actually retrieved, which is the number of *rte_mbuf* data structures
1789 * effectively supplied into the *rx_pkts* array.
1790 * A return value equal to *nb_pkts* indicates that the RX queue contained
1791 * at least *rx_pkts* packets, and this is likely to signify that other
1792 * received packets remain in the input queue. Applications implementing
1793 * a "retrieve as much received packets as possible" policy can check this
1794 * specific case and keep invoking the rte_eth_rx_burst() function until
1795 * a value less than *nb_pkts* is returned.
1797 * This receive method has the following advantages:
1799 * - It allows a run-to-completion network stack engine to retrieve and
1800 * to immediately process received packets in a fast burst-oriented
1801 * approach, avoiding the overhead of unnecessary intermediate packet
1802 * queue/dequeue operations.
1804 * - Conversely, it also allows an asynchronous-oriented processing
1805 * method to retrieve bursts of received packets and to immediately
1806 * queue them for further parallel processing by another logical core,
1807 * for instance. However, instead of having received packets being
1808 * individually queued by the driver, this approach allows the invoker
1809 * of the rte_eth_rx_burst() function to queue a burst of retrieved
1810 * packets at a time and therefore dramatically reduce the cost of
1811 * enqueue/dequeue operations per packet.
1813 * - It allows the rte_eth_rx_burst() function of the driver to take
1814 * advantage of burst-oriented hardware features (CPU cache,
1815 * prefetch instructions, and so on) to minimize the number of CPU
1816 * cycles per packet.
1818 * To summarize, the proposed receive API enables many
1819 * burst-oriented optimizations in both synchronous and asynchronous
1820 * packet processing environments with no overhead in both cases.
1822 * The rte_eth_rx_burst() function does not provide any error
1823 * notification to avoid the corresponding overhead. As a hint, the
1824 * upper-level application might check the status of the device link once
1825 * being systematically returned a 0 value for a given number of tries.
1828 * The port identifier of the Ethernet device.
1830 * The index of the receive queue from which to retrieve input packets.
1831 * The value must be in the range [0, nb_rx_queue - 1] previously supplied
1832 * to rte_eth_dev_configure().
1834 * The address of an array of pointers to *rte_mbuf* structures that
1835 * must be large enough to store *nb_pkts* pointers in it.
1837 * The maximum number of packets to retrieve.
1839 * The number of packets actually retrieved, which is the number
1840 * of pointers to *rte_mbuf* structures effectively supplied to the
1843 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
1844 extern uint16_t rte_eth_rx_burst(uint8_t port_id, uint16_t queue_id,
1845 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
1847 static inline uint16_t
1848 rte_eth_rx_burst(uint8_t port_id, uint16_t queue_id,
1849 struct rte_mbuf **rx_pkts, uint16_t nb_pkts)
1851 struct rte_eth_dev *dev;
1853 dev = &rte_eth_devices[port_id];
1854 return (*dev->rx_pkt_burst)(dev->data->rx_queues[queue_id], rx_pkts, nb_pkts);
1859 * Get the number of used descriptors in a specific queue
1862 * The port identifier of the Ethernet device.
1864 * The queue id on the specific port.
1866 * The number of used descriptors in the specific queue.
1868 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
1869 extern uint32_t rte_eth_rx_queue_count(uint8_t port_id, uint16_t queue_id);
1871 static inline uint32_t
1872 rte_eth_rx_queue_count(uint8_t port_id, uint16_t queue_id)
1874 struct rte_eth_dev *dev;
1876 dev = &rte_eth_devices[port_id];
1877 return (*dev->dev_ops->rx_queue_count)(dev, queue_id);
1882 * Check if the DD bit of the specific RX descriptor in the queue has been set
1885 * The port identifier of the Ethernet device.
1887 * The queue id on the specific port.
1889 * The offset of the descriptor ID from tail.
1891 * - (1) if the specific DD bit is set.
1892 * - (0) if the specific DD bit is not set.
1893 * - (-ENODEV) if *port_id* invalid.
1895 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
1896 extern int rte_eth_rx_descriptor_done(uint8_t port_id,
1901 rte_eth_rx_descriptor_done(uint8_t port_id, uint16_t queue_id, uint16_t offset)
1903 struct rte_eth_dev *dev;
1905 dev = &rte_eth_devices[port_id];
1906 return (*dev->dev_ops->rx_descriptor_done)( \
1907 dev->data->rx_queues[queue_id], offset);
1912 * Send a burst of output packets on a transmit queue of an Ethernet device.
1914 * The rte_eth_tx_burst() function is invoked to transmit output packets
1915 * on the output queue *queue_id* of the Ethernet device designated by its
1917 * The *nb_pkts* parameter is the number of packets to send which are
1918 * supplied in the *tx_pkts* array of *rte_mbuf* structures.
1919 * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
1920 * up to the number of transmit descriptors available in the TX ring of the
1922 * For each packet to send, the rte_eth_tx_burst() function performs
1923 * the following operations:
1925 * - Pick up the next available descriptor in the transmit ring.
1927 * - Free the network buffer previously sent with that descriptor, if any.
1929 * - Initialize the transmit descriptor with the information provided
1930 * in the *rte_mbuf data structure.
1932 * In the case of a segmented packet composed of a list of *rte_mbuf* buffers,
1933 * the rte_eth_tx_burst() function uses several transmit descriptors
1936 * The rte_eth_tx_burst() function returns the number of packets it
1937 * actually sent. A return value equal to *nb_pkts* means that all packets
1938 * have been sent, and this is likely to signify that other output packets
1939 * could be immediately transmitted again. Applications that implement a
1940 * "send as many packets to transmit as possible" policy can check this
1941 * specific case and keep invoking the rte_eth_tx_burst() function until
1942 * a value less than *nb_pkts* is returned.
1944 * It is the responsibility of the rte_eth_tx_burst() function to
1945 * transparently free the memory buffers of packets previously sent.
1946 * This feature is driven by the *tx_free_thresh* value supplied to the
1947 * rte_eth_dev_configure() function at device configuration time.
1948 * When the number of previously sent packets reached the "minimum transmit
1949 * packets to free" threshold, the rte_eth_tx_burst() function must
1950 * [attempt to] free the *rte_mbuf* buffers of those packets whose
1951 * transmission was effectively completed.
1954 * The port identifier of the Ethernet device.
1956 * The index of the transmit queue through which output packets must be
1958 * The value must be in the range [0, nb_tx_queue - 1] previously supplied
1959 * to rte_eth_dev_configure().
1961 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
1962 * which contain the output packets.
1964 * The maximum number of packets to transmit.
1966 * The number of output packets actually stored in transmit descriptors of
1967 * the transmit ring. The return value can be less than the value of the
1968 * *tx_pkts* parameter when the transmit ring is full or has been filled up.
1970 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
1971 extern uint16_t rte_eth_tx_burst(uint8_t port_id, uint16_t queue_id,
1972 struct rte_mbuf **tx_pkts, uint16_t nb_pkts);
1974 static inline uint16_t
1975 rte_eth_tx_burst(uint8_t port_id, uint16_t queue_id,
1976 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
1978 struct rte_eth_dev *dev;
1980 dev = &rte_eth_devices[port_id];
1981 return (*dev->tx_pkt_burst)(dev->data->tx_queues[queue_id], tx_pkts, nb_pkts);
1986 * Setup a new signature filter rule on an Ethernet device
1989 * The port identifier of the Ethernet device.
1990 * @param fdir_filter
1991 * The pointer to the fdir filter structure describing the signature filter
1993 * The *rte_fdir_filter* structure includes the values of the different fields
1994 * to match: source and destination IP addresses, vlan id, flexbytes, source
1995 * and destination ports, and so on.
1997 * The index of the RX queue where to store RX packets matching the added
1998 * signature filter defined in fdir_filter.
2000 * - (0) if successful.
2001 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2002 * - (-ENODEV) if *port_id* invalid.
2003 * - (-ENOSYS) if the FDIR mode is not configured in signature mode
2005 * - (-EINVAL) if the fdir_filter information is not correct.
2007 int rte_eth_dev_fdir_add_signature_filter(uint8_t port_id,
2008 struct rte_fdir_filter *fdir_filter,
2012 * Update a signature filter rule on an Ethernet device.
2013 * If the rule doesn't exits, it is created.
2016 * The port identifier of the Ethernet device.
2018 * The pointer to the structure describing the signature filter rule.
2019 * The *rte_fdir_filter* structure includes the values of the different fields
2020 * to match: source and destination IP addresses, vlan id, flexbytes, source
2021 * and destination ports, and so on.
2023 * The index of the RX queue where to store RX packets matching the added
2024 * signature filter defined in fdir_ftr.
2026 * - (0) if successful.
2027 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2028 * - (-ENODEV) if *port_id* invalid.
2029 * - (-ENOSYS) if the flow director mode is not configured in signature mode
2031 * - (-EINVAL) if the fdir_filter information is not correct.
2033 int rte_eth_dev_fdir_update_signature_filter(uint8_t port_id,
2034 struct rte_fdir_filter *fdir_ftr,
2038 * Remove a signature filter rule on an Ethernet device.
2041 * The port identifier of the Ethernet device.
2043 * The pointer to the structure describing the signature filter rule.
2044 * The *rte_fdir_filter* structure includes the values of the different fields
2045 * to match: source and destination IP addresses, vlan id, flexbytes, source
2046 * and destination ports, and so on.
2048 * - (0) if successful.
2049 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2050 * - (-ENODEV) if *port_id* invalid.
2051 * - (-ENOSYS) if the flow director mode is not configured in signature mode
2053 * - (-EINVAL) if the fdir_filter information is not correct.
2055 int rte_eth_dev_fdir_remove_signature_filter(uint8_t port_id,
2056 struct rte_fdir_filter *fdir_ftr);
2059 * Retrieve the flow director information of an Ethernet device.
2062 * The port identifier of the Ethernet device.
2064 * A pointer to a structure of type *rte_eth_dev_fdir* to be filled with
2065 * the flow director information of the Ethernet device.
2067 * - (0) if successful.
2068 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2069 * - (-ENODEV) if *port_id* invalid.
2070 * - (-ENOSYS) if the flow director mode is not configured on *port_id*.
2072 int rte_eth_dev_fdir_get_infos(uint8_t port_id, struct rte_eth_fdir *fdir);
2075 * Add a new perfect filter rule on an Ethernet device.
2078 * The port identifier of the Ethernet device.
2079 * @param fdir_filter
2080 * The pointer to the structure describing the perfect filter rule.
2081 * The *rte_fdir_filter* structure includes the values of the different fields
2082 * to match: source and destination IP addresses, vlan id, flexbytes, source
2083 * and destination ports, and so on.
2084 * IPv6 are not supported.
2086 * The 16-bit value supplied in the field hash.fdir.id of mbuf for RX
2087 * packets matching the perfect filter.
2089 * The index of the RX queue where to store RX packets matching the added
2090 * perfect filter defined in fdir_filter.
2092 * If drop is set to 1, matching RX packets are stored into the RX drop
2093 * queue defined in the rte_fdir_conf.
2095 * - (0) if successful.
2096 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2097 * - (-ENODEV) if *port_id* invalid.
2098 * - (-ENOSYS) if the flow director mode is not configured in perfect mode
2100 * - (-EINVAL) if the fdir_filter information is not correct.
2102 int rte_eth_dev_fdir_add_perfect_filter(uint8_t port_id,
2103 struct rte_fdir_filter *fdir_filter,
2104 uint16_t soft_id, uint8_t rx_queue,
2108 * Update a perfect filter rule on an Ethernet device.
2109 * If the rule doesn't exits, it is created.
2112 * The port identifier of the Ethernet device.
2113 * @param fdir_filter
2114 * The pointer to the structure describing the perfect filter rule.
2115 * The *rte_fdir_filter* structure includes the values of the different fields
2116 * to match: source and destination IP addresses, vlan id, flexbytes, source
2117 * and destination ports, and so on.
2118 * IPv6 are not supported.
2120 * The 16-bit value supplied in the field hash.fdir.id of mbuf for RX
2121 * packets matching the perfect filter.
2123 * The index of the RX queue where to store RX packets matching the added
2124 * perfect filter defined in fdir_filter.
2126 * If drop is set to 1, matching RX packets are stored into the RX drop
2127 * queue defined in the rte_fdir_conf.
2129 * - (0) if successful.
2130 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2131 * - (-ENODEV) if *port_id* invalid.
2132 * - (-ENOSYS) if the flow director mode is not configured in perfect mode
2134 * - (-EINVAL) if the fdir_filter information is not correct.
2136 int rte_eth_dev_fdir_update_perfect_filter(uint8_t port_id,
2137 struct rte_fdir_filter *fdir_filter,
2138 uint16_t soft_id, uint8_t rx_queue,
2142 * Remove a perfect filter rule on an Ethernet device.
2145 * The port identifier of the Ethernet device.
2146 * @param fdir_filter
2147 * The pointer to the structure describing the perfect filter rule.
2148 * The *rte_fdir_filter* structure includes the values of the different fields
2149 * to match: source and destination IP addresses, vlan id, flexbytes, source
2150 * and destination ports, and so on.
2151 * IPv6 are not supported.
2153 * The soft_id value provided when adding/updating the removed filter.
2155 * - (0) if successful.
2156 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2157 * - (-ENODEV) if *port_id* invalid.
2158 * - (-ENOSYS) if the flow director mode is not configured in perfect mode
2160 * - (-EINVAL) if the fdir_filter information is not correct.
2162 int rte_eth_dev_fdir_remove_perfect_filter(uint8_t port_id,
2163 struct rte_fdir_filter *fdir_filter,
2166 * Configure globally the masks for flow director mode for an Ethernet device.
2167 * For example, the device can match packets with only the first 24 bits of
2168 * the IPv4 source address.
2170 * The following fields can be masked: IPv4 addresses and L4 port numbers.
2171 * The following fields can be either enabled or disabled completely for the
2172 * matching functionality: VLAN ID tag; VLAN Priority + CFI bit; Flexible 2-byte
2174 * IPv6 masks are not supported.
2176 * All filters must comply with the masks previously configured.
2177 * For example, with a mask equal to 255.255.255.0 for the source IPv4 address,
2178 * all IPv4 filters must be created with a source IPv4 address that fits the
2181 * This function flushes all filters that have been previously added in
2185 * The port identifier of the Ethernet device.
2187 * The pointer to the fdir mask structure describing relevant headers fields
2188 * and relevant bits to use when matching packets addresses and ports.
2189 * IPv6 masks are not supported.
2191 * - (0) if successful.
2192 * - (-ENOTSUP) if hardware doesn't support flow director mode.
2193 * - (-ENODEV) if *port_id* invalid.
2194 * - (-ENOSYS) if the flow director mode is not configured in perfect
2195 * mode on *port_id*.
2196 * - (-EINVAL) if the fdir_filter information is not correct
2198 int rte_eth_dev_fdir_set_masks(uint8_t port_id,
2199 struct rte_fdir_masks *fdir_mask);
2202 * The eth device event type for interrupt, and maybe others in the future.
2204 enum rte_eth_event_type {
2205 RTE_ETH_EVENT_UNKNOWN, /**< unknown event type */
2206 RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
2207 RTE_ETH_EVENT_MAX /**< max value of this enum */
2210 typedef void (*rte_eth_dev_cb_fn)(uint8_t port_id, \
2211 enum rte_eth_event_type event, void *cb_arg);
2212 /**< user application callback to be registered for interrupts */
2217 * Register a callback function for specific port id.
2224 * User supplied callback function to be called.
2226 * Pointer to the parameters for the registered callback.
2229 * - On success, zero.
2230 * - On failure, a negative value.
2232 int rte_eth_dev_callback_register(uint8_t port_id,
2233 enum rte_eth_event_type event,
2234 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
2237 * Unregister a callback function for specific port id.
2244 * User supplied callback function to be called.
2246 * Pointer to the parameters for the registered callback. -1 means to
2247 * remove all for the same callback address and same event.
2250 * - On success, zero.
2251 * - On failure, a negative value.
2253 int rte_eth_dev_callback_unregister(uint8_t port_id,
2254 enum rte_eth_event_type event,
2255 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
2258 * @internal Executes all the user application registered callbacks for
2259 * the specific device. It is for DPDK internal user only. User
2260 * application should not call it directly.
2263 * Pointer to struct rte_eth_dev.
2265 * Eth device interrupt event type.
2270 void _rte_eth_dev_callback_process(struct rte_eth_dev *dev,
2271 enum rte_eth_event_type event);
2274 * Turn on the LED on the Ethernet device.
2275 * This function turns on the LED on the Ethernet device.
2278 * The port identifier of the Ethernet device.
2280 * - (0) if successful.
2281 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
2283 * - (-ENODEV) if *port_id* invalid.
2285 int rte_eth_led_on(uint8_t port_id);
2288 * Turn off the LED on the Ethernet device.
2289 * This function turns off the LED on the Ethernet device.
2292 * The port identifier of the Ethernet device.
2294 * - (0) if successful.
2295 * - (-ENOTSUP) if underlying hardware OR driver doesn't support
2297 * - (-ENODEV) if *port_id* invalid.
2299 int rte_eth_led_off(uint8_t port_id);
2302 * Configure the Ethernet link flow control for Ethernet device
2305 * The port identifier of the Ethernet device.
2307 * The pointer to the structure of the flow control parameters.
2309 * - (0) if successful.
2310 * - (-ENOTSUP) if hardware doesn't support flow control mode.
2311 * - (-ENODEV) if *port_id* invalid.
2312 * - (-EINVAL) if bad parameter
2313 * - (-EIO) if flow control setup failure
2315 int rte_eth_dev_flow_ctrl_set(uint8_t port_id,
2316 struct rte_eth_fc_conf *fc_conf);
2319 * Configure the Ethernet priority flow control under DCB environment
2320 * for Ethernet device.
2323 * The port identifier of the Ethernet device.
2325 * The pointer to the structure of the priority flow control parameters.
2327 * - (0) if successful.
2328 * - (-ENOTSUP) if hardware doesn't support priority flow control mode.
2329 * - (-ENODEV) if *port_id* invalid.
2330 * - (-EINVAL) if bad parameter
2331 * - (-EIO) if flow control setup failure
2333 int rte_eth_dev_priority_flow_ctrl_set(uint8_t port_id,
2334 struct rte_eth_pfc_conf *pfc_conf);
2337 * Add a MAC address to an internal array of addresses used to enable whitelist
2338 * filtering to accept packets only if the destination MAC address matches.
2341 * The port identifier of the Ethernet device.
2343 * The MAC address to add.
2345 * VMDq pool index to associate address with (if VMDq is enabled). If VMDq is
2346 * not enabled, this should be set to 0.
2348 * - (0) if successfully added or *mac_addr" was already added.
2349 * - (-ENOTSUP) if hardware doesn't support this feature.
2350 * - (-ENODEV) if *port* is invalid.
2351 * - (-ENOSPC) if no more MAC addresses can be added.
2352 * - (-EINVAL) if MAC address is invalid.
2354 int rte_eth_dev_mac_addr_add(uint8_t port, struct ether_addr *mac_addr,
2358 * Remove a MAC address from the internal array of addresses.
2361 * The port identifier of the Ethernet device.
2363 * MAC address to remove.
2365 * - (0) if successful, or *mac_addr* didn't exist.
2366 * - (-ENOTSUP) if hardware doesn't support.
2367 * - (-ENODEV) if *port* invalid.
2368 * - (-EADDRINUSE) if attempting to remove the default MAC address
2370 int rte_eth_dev_mac_addr_remove(uint8_t port, struct ether_addr *mac_addr);
2373 * Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
2376 * The port identifier of the Ethernet device.
2380 * - (0) if successful.
2381 * - (-ENOTSUP) if hardware doesn't support.
2382 * - (-EINVAL) if bad parameter.
2384 int rte_eth_dev_rss_reta_update(uint8_t port,
2385 struct rte_eth_rss_reta *reta_conf);
2388 * Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
2391 * The port identifier of the Ethernet device.
2395 * - (0) if successful.
2396 * - (-ENOTSUP) if hardware doesn't support.
2397 * - (-EINVAL) if bad parameter.
2399 int rte_eth_dev_rss_reta_query(uint8_t port,
2400 struct rte_eth_rss_reta *reta_conf);
2403 * Updates unicast hash table for receiving packet with the given destination
2404 * MAC address, and the packet is routed to all VFs for which the RX mode is
2405 * accept packets that match the unicast hash table.
2408 * The port identifier of the Ethernet device.
2410 * Unicast MAC address.
2412 * 1 - Set an unicast hash bit for receiving packets with the MAC address.
2413 * 0 - Clear an unicast hash bit.
2415 * - (0) if successful.
2416 * - (-ENOTSUP) if hardware doesn't support.
2417 * - (-ENODEV) if *port_id* invalid.
2418 * - (-EINVAL) if bad parameter.
2420 int rte_eth_dev_uc_hash_table_set(uint8_t port,struct ether_addr *addr,
2424 * Updates all unicast hash bitmaps for receiving packet with any Unicast
2425 * Ethernet MAC addresses,the packet is routed to all VFs for which the RX
2426 * mode is accept packets that match the unicast hash table.
2429 * The port identifier of the Ethernet device.
2431 * 1 - Set all unicast hash bitmaps for receiving all the Ethernet
2433 * 0 - Clear all unicast hash bitmaps
2435 * - (0) if successful.
2436 * - (-ENOTSUP) if hardware doesn't support.
2437 * - (-ENODEV) if *port_id* invalid.
2438 * - (-EINVAL) if bad parameter.
2440 int rte_eth_dev_uc_all_hash_table_set(uint8_t port,uint8_t on);
2443 * Set RX L2 Filtering mode of a VF of an Ethernet device.
2446 * The port identifier of the Ethernet device.
2450 * The RX mode mask, which is one or more of accepting Untagged Packets,
2451 * packets that match the PFUTA table, Broadcast and Multicast Promiscuous.
2452 * ETH_VMDQ_ACCEPT_UNTAG,ETH_VMDQ_ACCEPT_HASH_UC,
2453 * ETH_VMDQ_ACCEPT_BROADCAST and ETH_VMDQ_ACCEPT_MULTICAST will be used
2456 * 1 - Enable a VF RX mode.
2457 * 0 - Disable a VF RX mode.
2459 * - (0) if successful.
2460 * - (-ENOTSUP) if hardware doesn't support.
2461 * - (-ENOTSUP) if hardware doesn't support.
2462 * - (-EINVAL) if bad parameter.
2464 int rte_eth_dev_set_vf_rxmode(uint8_t port, uint16_t vf, uint16_t rx_mode,
2468 * Enable or disable a VF traffic transmit of the Ethernet device.
2471 * The port identifier of the Ethernet device.
2475 * 1 - Enable a VF traffic transmit.
2476 * 0 - Disable a VF traffic transmit.
2478 * - (0) if successful.
2479 * - (-ENODEV) if *port_id* invalid.
2480 * - (-ENOTSUP) if hardware doesn't support.
2481 * - (-EINVAL) if bad parameter.
2484 rte_eth_dev_set_vf_tx(uint8_t port,uint16_t vf, uint8_t on);
2487 * Enable or disable a VF traffic receive of an Ethernet device.
2490 * The port identifier of the Ethernet device.
2494 * 1 - Enable a VF traffic receive.
2495 * 0 - Disable a VF traffic receive.
2497 * - (0) if successful.
2498 * - (-ENOTSUP) if hardware doesn't support.
2499 * - (-ENODEV) if *port_id* invalid.
2500 * - (-EINVAL) if bad parameter.
2503 rte_eth_dev_set_vf_rx(uint8_t port,uint16_t vf, uint8_t on);
2506 * Enable/Disable hardware VF VLAN filtering by an Ethernet device of
2507 * received VLAN packets tagged with a given VLAN Tag Identifier.
2510 * The port identifier of the Ethernet device.
2512 * The VLAN Tag Identifier whose filtering must be enabled or disabled.
2514 * Bitmap listing which VFs participate in the VLAN filtering.
2516 * 1 - Enable VFs VLAN filtering.
2517 * 0 - Disable VFs VLAN filtering.
2519 * - (0) if successful.
2520 * - (-ENOTSUP) if hardware doesn't support.
2521 * - (-ENODEV) if *port_id* invalid.
2522 * - (-EINVAL) if bad parameter.
2525 rte_eth_dev_set_vf_vlan_filter(uint8_t port, uint16_t vlan_id,
2530 * Set a traffic mirroring rule on an Ethernet device
2533 * The port identifier of the Ethernet device.
2534 * @param mirror_conf
2535 * The pointer to the traffic mirroring structure describing the mirroring rule.
2536 * The *rte_eth_vm_mirror_conf* structure includes the type of mirroring rule,
2537 * destination pool and the value of rule if enable vlan or pool mirroring.
2540 * The index of traffic mirroring rule, we support four separated rules.
2542 * 1 - Enable a mirroring rule.
2543 * 0 - Disable a mirroring rule.
2545 * - (0) if successful.
2546 * - (-ENOTSUP) if hardware doesn't support this feature.
2547 * - (-ENODEV) if *port_id* invalid.
2548 * - (-EINVAL) if the mr_conf information is not correct.
2550 int rte_eth_mirror_rule_set(uint8_t port_id,
2551 struct rte_eth_vmdq_mirror_conf *mirror_conf,
2556 * Reset a traffic mirroring rule on an Ethernet device.
2559 * The port identifier of the Ethernet device.
2561 * The index of traffic mirroring rule, we support four separated rules.
2563 * - (0) if successful.
2564 * - (-ENOTSUP) if hardware doesn't support this feature.
2565 * - (-ENODEV) if *port_id* invalid.
2566 * - (-EINVAL) if bad parameter.
2568 int rte_eth_mirror_rule_reset(uint8_t port_id,
2572 * Initialize bypass logic. This function needs to be called before
2573 * executing any other bypass API.
2576 * The port identifier of the Ethernet device.
2578 * - (0) if successful.
2579 * - (-ENOTSUP) if hardware doesn't support.
2580 * - (-EINVAL) if bad parameter.
2582 int rte_eth_dev_bypass_init(uint8_t port);
2585 * Return bypass state.
2588 * The port identifier of the Ethernet device.
2590 * The return bypass state.
2593 * - (3) Isolate mode
2595 * - (0) if successful.
2596 * - (-ENOTSUP) if hardware doesn't support.
2597 * - (-EINVAL) if bad parameter.
2599 int rte_eth_dev_bypass_state_show(uint8_t port, uint32_t *state);
2605 * The port identifier of the Ethernet device.
2607 * The current bypass state.
2610 * - (3) Isolate mode
2612 * - (0) if successful.
2613 * - (-ENOTSUP) if hardware doesn't support.
2614 * - (-EINVAL) if bad parameter.
2616 int rte_eth_dev_bypass_state_set(uint8_t port, uint32_t *new_state);
2619 * Return bypass state when given event occurs.
2622 * The port identifier of the Ethernet device.
2625 * - (1) Main power on (power button is pushed)
2626 * - (2) Auxiliary power on (power supply is being plugged)
2627 * - (3) Main power off (system shutdown and power supply is left plugged in)
2628 * - (4) Auxiliary power off (power supply is being unplugged)
2629 * - (5) Display or set the watchdog timer
2631 * The bypass state when given event occurred.
2634 * - (3) Isolate mode
2636 * - (0) if successful.
2637 * - (-ENOTSUP) if hardware doesn't support.
2638 * - (-EINVAL) if bad parameter.
2640 int rte_eth_dev_bypass_event_show(uint8_t port, uint32_t event, uint32_t *state);
2643 * Set bypass state when given event occurs.
2646 * The port identifier of the Ethernet device.
2649 * - (1) Main power on (power button is pushed)
2650 * - (2) Auxiliary power on (power supply is being plugged)
2651 * - (3) Main power off (system shutdown and power supply is left plugged in)
2652 * - (4) Auxiliary power off (power supply is being unplugged)
2653 * - (5) Display or set the watchdog timer
2655 * The assigned state when given event occurs.
2658 * - (3) Isolate mode
2660 * - (0) if successful.
2661 * - (-ENOTSUP) if hardware doesn't support.
2662 * - (-EINVAL) if bad parameter.
2664 int rte_eth_dev_bypass_event_store(uint8_t port, uint32_t event, uint32_t state);
2667 * Set bypass watchdog timeout count.
2670 * The port identifier of the Ethernet device.
2672 * The timeout to be set.
2673 * - (0) 0 seconds (timer is off)
2682 * - (0) if successful.
2683 * - (-ENOTSUP) if hardware doesn't support.
2684 * - (-EINVAL) if bad parameter.
2686 int rte_eth_dev_wd_timeout_store(uint8_t port, uint32_t timeout);
2689 * Get bypass firmware version.
2692 * The port identifier of the Ethernet device.
2694 * The firmware version
2696 * - (0) if successful.
2697 * - (-ENOTSUP) if hardware doesn't support.
2698 * - (-EINVAL) if bad parameter.
2700 int rte_eth_dev_bypass_ver_show(uint8_t port, uint32_t *ver);
2703 * Return bypass watchdog timeout in seconds
2706 * The port identifier of the Ethernet device.
2708 * The return watchdog timeout. "0" represents timer expired
2709 * - (0) 0 seconds (timer is off)
2718 * - (0) if successful.
2719 * - (-ENOTSUP) if hardware doesn't support.
2720 * - (-EINVAL) if bad parameter.
2722 int rte_eth_dev_bypass_wd_timeout_show(uint8_t port, uint32_t *wd_timeout);
2725 * Reset bypass watchdog timer
2728 * The port identifier of the Ethernet device.
2730 * - (0) if successful.
2731 * - (-ENOTSUP) if hardware doesn't support.
2732 * - (-EINVAL) if bad parameter.
2734 int rte_eth_dev_bypass_wd_reset(uint8_t port);
2737 * Configuration of Receive Side Scaling hash computation of Ethernet device.
2740 * The port identifier of the Ethernet device.
2742 * The new configuration to use for RSS hash computation on the port.
2744 * - (0) if successful.
2745 * - (-ENODEV) if port identifier is invalid.
2746 * - (-ENOTSUP) if hardware doesn't support.
2747 * - (-EINVAL) if bad parameter.
2749 int rte_eth_dev_rss_hash_update(uint8_t port_id,
2750 struct rte_eth_rss_conf *rss_conf);
2756 #endif /* _RTE_ETHDEV_H_ */