925ef38ea2c9fde43088d724ea64c722ac21e204
[dpdk.git] / lib / librte_ethdev / rte_ethdev.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2010-2017 Intel Corporation
3  */
4
5 #ifndef _RTE_ETHDEV_H_
6 #define _RTE_ETHDEV_H_
7
8 /**
9  * @file
10  *
11  * RTE Ethernet Device API
12  *
13  * The Ethernet Device API is composed of two parts:
14  *
15  * - The application-oriented Ethernet API that includes functions to setup
16  *   an Ethernet device (configure it, setup its RX and TX queues and start it),
17  *   to get its MAC address, the speed and the status of its physical link,
18  *   to receive and to transmit packets, and so on.
19  *
20  * - The driver-oriented Ethernet API that exports functions allowing
21  *   an Ethernet Poll Mode Driver (PMD) to allocate an Ethernet device instance,
22  *   create memzone for HW rings and process registered callbacks, and so on.
23  *   PMDs should include rte_ethdev_driver.h instead of this header.
24  *
25  * By default, all the functions of the Ethernet Device API exported by a PMD
26  * are lock-free functions which assume to not be invoked in parallel on
27  * different logical cores to work on the same target object.  For instance,
28  * the receive function of a PMD cannot be invoked in parallel on two logical
29  * cores to poll the same RX queue [of the same port]. Of course, this function
30  * can be invoked in parallel by different logical cores on different RX queues.
31  * It is the responsibility of the upper level application to enforce this rule.
32  *
33  * If needed, parallel accesses by multiple logical cores to shared queues
34  * shall be explicitly protected by dedicated inline lock-aware functions
35  * built on top of their corresponding lock-free functions of the PMD API.
36  *
37  * In all functions of the Ethernet API, the Ethernet device is
38  * designated by an integer >= 0 named the device port identifier.
39  *
40  * At the Ethernet driver level, Ethernet devices are represented by a generic
41  * data structure of type *rte_eth_dev*.
42  *
43  * Ethernet devices are dynamically registered during the PCI probing phase
44  * performed at EAL initialization time.
45  * When an Ethernet device is being probed, an *rte_eth_dev* structure and
46  * a new port identifier are allocated for that device. Then, the eth_dev_init()
47  * function supplied by the Ethernet driver matching the probed PCI
48  * device is invoked to properly initialize the device.
49  *
50  * The role of the device init function consists of resetting the hardware,
51  * checking access to Non-volatile Memory (NVM), reading the MAC address
52  * from NVM etc.
53  *
54  * If the device init operation is successful, the correspondence between
55  * the port identifier assigned to the new device and its associated
56  * *rte_eth_dev* structure is effectively registered.
57  * Otherwise, both the *rte_eth_dev* structure and the port identifier are
58  * freed.
59  *
60  * The functions exported by the application Ethernet API to setup a device
61  * designated by its port identifier must be invoked in the following order:
62  *     - rte_eth_dev_configure()
63  *     - rte_eth_tx_queue_setup()
64  *     - rte_eth_rx_queue_setup()
65  *     - rte_eth_dev_start()
66  *
67  * Then, the network application can invoke, in any order, the functions
68  * exported by the Ethernet API to get the MAC address of a given device, to
69  * get the speed and the status of a device physical link, to receive/transmit
70  * [burst of] packets, and so on.
71  *
72  * If the application wants to change the configuration (i.e. call
73  * rte_eth_dev_configure(), rte_eth_tx_queue_setup(), or
74  * rte_eth_rx_queue_setup()), it must call rte_eth_dev_stop() first to stop the
75  * device and then do the reconfiguration before calling rte_eth_dev_start()
76  * again. The transmit and receive functions should not be invoked when the
77  * device is stopped.
78  *
79  * Please note that some configuration is not stored between calls to
80  * rte_eth_dev_stop()/rte_eth_dev_start(). The following configuration will
81  * be retained:
82  *
83  *     - flow control settings
84  *     - receive mode configuration (promiscuous mode, hardware checksum mode,
85  *       RSS/VMDQ settings etc.)
86  *     - VLAN filtering configuration
87  *     - MAC addresses supplied to MAC address array
88  *     - flow director filtering mode (but not filtering rules)
89  *     - NIC queue statistics mappings
90  *
91  * Any other configuration will not be stored and will need to be re-entered
92  * before a call to rte_eth_dev_start().
93  *
94  * Finally, a network application can close an Ethernet device by invoking the
95  * rte_eth_dev_close() function.
96  *
97  * Each function of the application Ethernet API invokes a specific function
98  * of the PMD that controls the target device designated by its port
99  * identifier.
100  * For this purpose, all device-specific functions of an Ethernet driver are
101  * supplied through a set of pointers contained in a generic structure of type
102  * *eth_dev_ops*.
103  * The address of the *eth_dev_ops* structure is stored in the *rte_eth_dev*
104  * structure by the device init function of the Ethernet driver, which is
105  * invoked during the PCI probing phase, as explained earlier.
106  *
107  * In other words, each function of the Ethernet API simply retrieves the
108  * *rte_eth_dev* structure associated with the device port identifier and
109  * performs an indirect invocation of the corresponding driver function
110  * supplied in the *eth_dev_ops* structure of the *rte_eth_dev* structure.
111  *
112  * For performance reasons, the address of the burst-oriented RX and TX
113  * functions of the Ethernet driver are not contained in the *eth_dev_ops*
114  * structure. Instead, they are directly stored at the beginning of the
115  * *rte_eth_dev* structure to avoid an extra indirect memory access during
116  * their invocation.
117  *
118  * RTE ethernet device drivers do not use interrupts for transmitting or
119  * receiving. Instead, Ethernet drivers export Poll-Mode receive and transmit
120  * functions to applications.
121  * Both receive and transmit functions are packet-burst oriented to minimize
122  * their cost per packet through the following optimizations:
123  *
124  * - Sharing among multiple packets the incompressible cost of the
125  *   invocation of receive/transmit functions.
126  *
127  * - Enabling receive/transmit functions to take advantage of burst-oriented
128  *   hardware features (L1 cache, prefetch instructions, NIC head/tail
129  *   registers) to minimize the number of CPU cycles per packet, for instance,
130  *   by avoiding useless read memory accesses to ring descriptors, or by
131  *   systematically using arrays of pointers that exactly fit L1 cache line
132  *   boundaries and sizes.
133  *
134  * The burst-oriented receive function does not provide any error notification,
135  * to avoid the corresponding overhead. As a hint, the upper-level application
136  * might check the status of the device link once being systematically returned
137  * a 0 value by the receive function of the driver for a given number of tries.
138  */
139
140 #ifdef __cplusplus
141 extern "C" {
142 #endif
143
144 #include <stdint.h>
145
146 /* Use this macro to check if LRO API is supported */
147 #define RTE_ETHDEV_HAS_LRO_SUPPORT
148
149 #include <rte_compat.h>
150 #include <rte_log.h>
151 #include <rte_interrupts.h>
152 #include <rte_dev.h>
153 #include <rte_devargs.h>
154 #include <rte_errno.h>
155 #include <rte_common.h>
156 #include <rte_config.h>
157
158 #include "rte_ether.h"
159 #include "rte_eth_ctrl.h"
160 #include "rte_dev_info.h"
161
162 extern int rte_eth_dev_logtype;
163
164 #define RTE_ETHDEV_LOG(level, ...) \
165         rte_log(RTE_LOG_ ## level, rte_eth_dev_logtype, "" __VA_ARGS__)
166
167 struct rte_mbuf;
168
169 /**
170  * @warning
171  * @b EXPERIMENTAL: this API may change without prior notice.
172  *
173  * Initializes a device iterator.
174  *
175  * This iterator allows accessing a list of devices matching some devargs.
176  *
177  * @param iter
178  *   Device iterator handle initialized by the function.
179  *   The fields bus_str and cls_str might be dynamically allocated,
180  *   and could be freed by calling rte_eth_iterator_cleanup().
181  *
182  * @param devargs
183  *   Device description string.
184  *
185  * @return
186  *   0 on successful initialization, negative otherwise.
187  */
188 __rte_experimental
189 int rte_eth_iterator_init(struct rte_dev_iterator *iter, const char *devargs);
190
191 /**
192  * @warning
193  * @b EXPERIMENTAL: this API may change without prior notice.
194  *
195  * Iterates on devices with devargs filter.
196  * The ownership is not checked.
197  *
198  * The next port id is returned, and the iterator is updated.
199  *
200  * @param iter
201  *   Device iterator handle initialized by rte_eth_iterator_init().
202  *   Some fields bus_str and cls_str might be freed when no more port is found,
203  *   by calling rte_eth_iterator_cleanup().
204  *
205  * @return
206  *   A port id if found, RTE_MAX_ETHPORTS otherwise.
207  */
208 __rte_experimental
209 uint16_t rte_eth_iterator_next(struct rte_dev_iterator *iter);
210
211 /**
212  * @warning
213  * @b EXPERIMENTAL: this API may change without prior notice.
214  *
215  * Free some allocated fields of the iterator.
216  *
217  * This function is automatically called by rte_eth_iterator_next()
218  * on the last iteration (i.e. when no more matching port is found).
219  *
220  * It is safe to call this function twice; it will do nothing more.
221  *
222  * @param iter
223  *   Device iterator handle initialized by rte_eth_iterator_init().
224  *   The fields bus_str and cls_str are freed if needed.
225  */
226 __rte_experimental
227 void rte_eth_iterator_cleanup(struct rte_dev_iterator *iter);
228
229 /**
230  * Macro to iterate over all ethdev ports matching some devargs.
231  *
232  * If a break is done before the end of the loop,
233  * the function rte_eth_iterator_cleanup() must be called.
234  *
235  * @param id
236  *   Iterated port id of type uint16_t.
237  * @param devargs
238  *   Device parameters input as string of type char*.
239  * @param iter
240  *   Iterator handle of type struct rte_dev_iterator, used internally.
241  */
242 #define RTE_ETH_FOREACH_MATCHING_DEV(id, devargs, iter) \
243         for (rte_eth_iterator_init(iter, devargs), \
244              id = rte_eth_iterator_next(iter); \
245              id != RTE_MAX_ETHPORTS; \
246              id = rte_eth_iterator_next(iter))
247
248 /**
249  * A structure used to retrieve statistics for an Ethernet port.
250  * Not all statistics fields in struct rte_eth_stats are supported
251  * by any type of network interface card (NIC). If any statistics
252  * field is not supported, its value is 0.
253  */
254 struct rte_eth_stats {
255         uint64_t ipackets;  /**< Total number of successfully received packets. */
256         uint64_t opackets;  /**< Total number of successfully transmitted packets.*/
257         uint64_t ibytes;    /**< Total number of successfully received bytes. */
258         uint64_t obytes;    /**< Total number of successfully transmitted bytes. */
259         uint64_t imissed;
260         /**< Total of RX packets dropped by the HW,
261          * because there are no available buffer (i.e. RX queues are full).
262          */
263         uint64_t ierrors;   /**< Total number of erroneous received packets. */
264         uint64_t oerrors;   /**< Total number of failed transmitted packets. */
265         uint64_t rx_nombuf; /**< Total number of RX mbuf allocation failures. */
266         uint64_t q_ipackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
267         /**< Total number of queue RX packets. */
268         uint64_t q_opackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
269         /**< Total number of queue TX packets. */
270         uint64_t q_ibytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
271         /**< Total number of successfully received queue bytes. */
272         uint64_t q_obytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
273         /**< Total number of successfully transmitted queue bytes. */
274         uint64_t q_errors[RTE_ETHDEV_QUEUE_STAT_CNTRS];
275         /**< Total number of queue packets received that are dropped. */
276 };
277
278 /**
279  * Device supported speeds bitmap flags
280  */
281 #define ETH_LINK_SPEED_AUTONEG  (0 <<  0)  /**< Autonegotiate (all speeds) */
282 #define ETH_LINK_SPEED_FIXED    (1 <<  0)  /**< Disable autoneg (fixed speed) */
283 #define ETH_LINK_SPEED_10M_HD   (1 <<  1)  /**<  10 Mbps half-duplex */
284 #define ETH_LINK_SPEED_10M      (1 <<  2)  /**<  10 Mbps full-duplex */
285 #define ETH_LINK_SPEED_100M_HD  (1 <<  3)  /**< 100 Mbps half-duplex */
286 #define ETH_LINK_SPEED_100M     (1 <<  4)  /**< 100 Mbps full-duplex */
287 #define ETH_LINK_SPEED_1G       (1 <<  5)  /**<   1 Gbps */
288 #define ETH_LINK_SPEED_2_5G     (1 <<  6)  /**< 2.5 Gbps */
289 #define ETH_LINK_SPEED_5G       (1 <<  7)  /**<   5 Gbps */
290 #define ETH_LINK_SPEED_10G      (1 <<  8)  /**<  10 Gbps */
291 #define ETH_LINK_SPEED_20G      (1 <<  9)  /**<  20 Gbps */
292 #define ETH_LINK_SPEED_25G      (1 << 10)  /**<  25 Gbps */
293 #define ETH_LINK_SPEED_40G      (1 << 11)  /**<  40 Gbps */
294 #define ETH_LINK_SPEED_50G      (1 << 12)  /**<  50 Gbps */
295 #define ETH_LINK_SPEED_56G      (1 << 13)  /**<  56 Gbps */
296 #define ETH_LINK_SPEED_100G     (1 << 14)  /**< 100 Gbps */
297
298 /**
299  * Ethernet numeric link speeds in Mbps
300  */
301 #define ETH_SPEED_NUM_NONE         0 /**< Not defined */
302 #define ETH_SPEED_NUM_10M         10 /**<  10 Mbps */
303 #define ETH_SPEED_NUM_100M       100 /**< 100 Mbps */
304 #define ETH_SPEED_NUM_1G        1000 /**<   1 Gbps */
305 #define ETH_SPEED_NUM_2_5G      2500 /**< 2.5 Gbps */
306 #define ETH_SPEED_NUM_5G        5000 /**<   5 Gbps */
307 #define ETH_SPEED_NUM_10G      10000 /**<  10 Gbps */
308 #define ETH_SPEED_NUM_20G      20000 /**<  20 Gbps */
309 #define ETH_SPEED_NUM_25G      25000 /**<  25 Gbps */
310 #define ETH_SPEED_NUM_40G      40000 /**<  40 Gbps */
311 #define ETH_SPEED_NUM_50G      50000 /**<  50 Gbps */
312 #define ETH_SPEED_NUM_56G      56000 /**<  56 Gbps */
313 #define ETH_SPEED_NUM_100G    100000 /**< 100 Gbps */
314
315 /**
316  * A structure used to retrieve link-level information of an Ethernet port.
317  */
318 __extension__
319 struct rte_eth_link {
320         uint32_t link_speed;        /**< ETH_SPEED_NUM_ */
321         uint16_t link_duplex  : 1;  /**< ETH_LINK_[HALF/FULL]_DUPLEX */
322         uint16_t link_autoneg : 1;  /**< ETH_LINK_[AUTONEG/FIXED] */
323         uint16_t link_status  : 1;  /**< ETH_LINK_[DOWN/UP] */
324 } __attribute__((aligned(8)));      /**< aligned for atomic64 read/write */
325
326 /* Utility constants */
327 #define ETH_LINK_HALF_DUPLEX 0 /**< Half-duplex connection (see link_duplex). */
328 #define ETH_LINK_FULL_DUPLEX 1 /**< Full-duplex connection (see link_duplex). */
329 #define ETH_LINK_DOWN        0 /**< Link is down (see link_status). */
330 #define ETH_LINK_UP          1 /**< Link is up (see link_status). */
331 #define ETH_LINK_FIXED       0 /**< No autonegotiation (see link_autoneg). */
332 #define ETH_LINK_AUTONEG     1 /**< Autonegotiated (see link_autoneg). */
333
334 /**
335  * A structure used to configure the ring threshold registers of an RX/TX
336  * queue for an Ethernet port.
337  */
338 struct rte_eth_thresh {
339         uint8_t pthresh; /**< Ring prefetch threshold. */
340         uint8_t hthresh; /**< Ring host threshold. */
341         uint8_t wthresh; /**< Ring writeback threshold. */
342 };
343
344 /**
345  *  Simple flags are used for rte_eth_conf.rxmode.mq_mode.
346  */
347 #define ETH_MQ_RX_RSS_FLAG  0x1
348 #define ETH_MQ_RX_DCB_FLAG  0x2
349 #define ETH_MQ_RX_VMDQ_FLAG 0x4
350
351 /**
352  *  A set of values to identify what method is to be used to route
353  *  packets to multiple queues.
354  */
355 enum rte_eth_rx_mq_mode {
356         /** None of DCB,RSS or VMDQ mode */
357         ETH_MQ_RX_NONE = 0,
358
359         /** For RX side, only RSS is on */
360         ETH_MQ_RX_RSS = ETH_MQ_RX_RSS_FLAG,
361         /** For RX side,only DCB is on. */
362         ETH_MQ_RX_DCB = ETH_MQ_RX_DCB_FLAG,
363         /** Both DCB and RSS enable */
364         ETH_MQ_RX_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG,
365
366         /** Only VMDQ, no RSS nor DCB */
367         ETH_MQ_RX_VMDQ_ONLY = ETH_MQ_RX_VMDQ_FLAG,
368         /** RSS mode with VMDQ */
369         ETH_MQ_RX_VMDQ_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_VMDQ_FLAG,
370         /** Use VMDQ+DCB to route traffic to queues */
371         ETH_MQ_RX_VMDQ_DCB = ETH_MQ_RX_VMDQ_FLAG | ETH_MQ_RX_DCB_FLAG,
372         /** Enable both VMDQ and DCB in VMDq */
373         ETH_MQ_RX_VMDQ_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG |
374                                  ETH_MQ_RX_VMDQ_FLAG,
375 };
376
377 /**
378  * for rx mq mode backward compatible
379  */
380 #define ETH_RSS                       ETH_MQ_RX_RSS
381 #define VMDQ_DCB                      ETH_MQ_RX_VMDQ_DCB
382 #define ETH_DCB_RX                    ETH_MQ_RX_DCB
383
384 /**
385  * A set of values to identify what method is to be used to transmit
386  * packets using multi-TCs.
387  */
388 enum rte_eth_tx_mq_mode {
389         ETH_MQ_TX_NONE    = 0,  /**< It is in neither DCB nor VT mode. */
390         ETH_MQ_TX_DCB,          /**< For TX side,only DCB is on. */
391         ETH_MQ_TX_VMDQ_DCB,     /**< For TX side,both DCB and VT is on. */
392         ETH_MQ_TX_VMDQ_ONLY,    /**< Only VT on, no DCB */
393 };
394
395 /**
396  * for tx mq mode backward compatible
397  */
398 #define ETH_DCB_NONE                ETH_MQ_TX_NONE
399 #define ETH_VMDQ_DCB_TX             ETH_MQ_TX_VMDQ_DCB
400 #define ETH_DCB_TX                  ETH_MQ_TX_DCB
401
402 /**
403  * A structure used to configure the RX features of an Ethernet port.
404  */
405 struct rte_eth_rxmode {
406         /** The multi-queue packet distribution mode to be used, e.g. RSS. */
407         enum rte_eth_rx_mq_mode mq_mode;
408         uint32_t max_rx_pkt_len;  /**< Only used if JUMBO_FRAME enabled. */
409         uint16_t split_hdr_size;  /**< hdr buf size (header_split enabled).*/
410         /**
411          * Per-port Rx offloads to be set using DEV_RX_OFFLOAD_* flags.
412          * Only offloads set on rx_offload_capa field on rte_eth_dev_info
413          * structure are allowed to be set.
414          */
415         uint64_t offloads;
416 };
417
418 /**
419  * VLAN types to indicate if it is for single VLAN, inner VLAN or outer VLAN.
420  * Note that single VLAN is treated the same as inner VLAN.
421  */
422 enum rte_vlan_type {
423         ETH_VLAN_TYPE_UNKNOWN = 0,
424         ETH_VLAN_TYPE_INNER, /**< Inner VLAN. */
425         ETH_VLAN_TYPE_OUTER, /**< Single VLAN, or outer VLAN. */
426         ETH_VLAN_TYPE_MAX,
427 };
428
429 /**
430  * A structure used to describe a vlan filter.
431  * If the bit corresponding to a VID is set, such VID is on.
432  */
433 struct rte_vlan_filter_conf {
434         uint64_t ids[64];
435 };
436
437 /**
438  * A structure used to configure the Receive Side Scaling (RSS) feature
439  * of an Ethernet port.
440  * If not NULL, the *rss_key* pointer of the *rss_conf* structure points
441  * to an array holding the RSS key to use for hashing specific header
442  * fields of received packets. The length of this array should be indicated
443  * by *rss_key_len* below. Otherwise, a default random hash key is used by
444  * the device driver.
445  *
446  * The *rss_key_len* field of the *rss_conf* structure indicates the length
447  * in bytes of the array pointed by *rss_key*. To be compatible, this length
448  * will be checked in i40e only. Others assume 40 bytes to be used as before.
449  *
450  * The *rss_hf* field of the *rss_conf* structure indicates the different
451  * types of IPv4/IPv6 packets to which the RSS hashing must be applied.
452  * Supplying an *rss_hf* equal to zero disables the RSS feature.
453  */
454 struct rte_eth_rss_conf {
455         uint8_t *rss_key;    /**< If not NULL, 40-byte hash key. */
456         uint8_t rss_key_len; /**< hash key length in bytes. */
457         uint64_t rss_hf;     /**< Hash functions to apply - see below. */
458 };
459
460 /*
461  * The RSS offload types are defined based on flow types which are defined
462  * in rte_eth_ctrl.h. Different NIC hardwares may support different RSS offload
463  * types. The supported flow types or RSS offload types can be queried by
464  * rte_eth_dev_info_get().
465  */
466 #define ETH_RSS_IPV4               (1ULL << RTE_ETH_FLOW_IPV4)
467 #define ETH_RSS_FRAG_IPV4          (1ULL << RTE_ETH_FLOW_FRAG_IPV4)
468 #define ETH_RSS_NONFRAG_IPV4_TCP   (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_TCP)
469 #define ETH_RSS_NONFRAG_IPV4_UDP   (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_UDP)
470 #define ETH_RSS_NONFRAG_IPV4_SCTP  (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_SCTP)
471 #define ETH_RSS_NONFRAG_IPV4_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV4_OTHER)
472 #define ETH_RSS_IPV6               (1ULL << RTE_ETH_FLOW_IPV6)
473 #define ETH_RSS_FRAG_IPV6          (1ULL << RTE_ETH_FLOW_FRAG_IPV6)
474 #define ETH_RSS_NONFRAG_IPV6_TCP   (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_TCP)
475 #define ETH_RSS_NONFRAG_IPV6_UDP   (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_UDP)
476 #define ETH_RSS_NONFRAG_IPV6_SCTP  (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_SCTP)
477 #define ETH_RSS_NONFRAG_IPV6_OTHER (1ULL << RTE_ETH_FLOW_NONFRAG_IPV6_OTHER)
478 #define ETH_RSS_L2_PAYLOAD         (1ULL << RTE_ETH_FLOW_L2_PAYLOAD)
479 #define ETH_RSS_IPV6_EX            (1ULL << RTE_ETH_FLOW_IPV6_EX)
480 #define ETH_RSS_IPV6_TCP_EX        (1ULL << RTE_ETH_FLOW_IPV6_TCP_EX)
481 #define ETH_RSS_IPV6_UDP_EX        (1ULL << RTE_ETH_FLOW_IPV6_UDP_EX)
482 #define ETH_RSS_PORT               (1ULL << RTE_ETH_FLOW_PORT)
483 #define ETH_RSS_VXLAN              (1ULL << RTE_ETH_FLOW_VXLAN)
484 #define ETH_RSS_GENEVE             (1ULL << RTE_ETH_FLOW_GENEVE)
485 #define ETH_RSS_NVGRE              (1ULL << RTE_ETH_FLOW_NVGRE)
486
487 #define ETH_RSS_IP ( \
488         ETH_RSS_IPV4 | \
489         ETH_RSS_FRAG_IPV4 | \
490         ETH_RSS_NONFRAG_IPV4_OTHER | \
491         ETH_RSS_IPV6 | \
492         ETH_RSS_FRAG_IPV6 | \
493         ETH_RSS_NONFRAG_IPV6_OTHER | \
494         ETH_RSS_IPV6_EX)
495
496 #define ETH_RSS_UDP ( \
497         ETH_RSS_NONFRAG_IPV4_UDP | \
498         ETH_RSS_NONFRAG_IPV6_UDP | \
499         ETH_RSS_IPV6_UDP_EX)
500
501 #define ETH_RSS_TCP ( \
502         ETH_RSS_NONFRAG_IPV4_TCP | \
503         ETH_RSS_NONFRAG_IPV6_TCP | \
504         ETH_RSS_IPV6_TCP_EX)
505
506 #define ETH_RSS_SCTP ( \
507         ETH_RSS_NONFRAG_IPV4_SCTP | \
508         ETH_RSS_NONFRAG_IPV6_SCTP)
509
510 #define ETH_RSS_TUNNEL ( \
511         ETH_RSS_VXLAN  | \
512         ETH_RSS_GENEVE | \
513         ETH_RSS_NVGRE)
514
515 /**< Mask of valid RSS hash protocols */
516 #define ETH_RSS_PROTO_MASK ( \
517         ETH_RSS_IPV4 | \
518         ETH_RSS_FRAG_IPV4 | \
519         ETH_RSS_NONFRAG_IPV4_TCP | \
520         ETH_RSS_NONFRAG_IPV4_UDP | \
521         ETH_RSS_NONFRAG_IPV4_SCTP | \
522         ETH_RSS_NONFRAG_IPV4_OTHER | \
523         ETH_RSS_IPV6 | \
524         ETH_RSS_FRAG_IPV6 | \
525         ETH_RSS_NONFRAG_IPV6_TCP | \
526         ETH_RSS_NONFRAG_IPV6_UDP | \
527         ETH_RSS_NONFRAG_IPV6_SCTP | \
528         ETH_RSS_NONFRAG_IPV6_OTHER | \
529         ETH_RSS_L2_PAYLOAD | \
530         ETH_RSS_IPV6_EX | \
531         ETH_RSS_IPV6_TCP_EX | \
532         ETH_RSS_IPV6_UDP_EX | \
533         ETH_RSS_PORT  | \
534         ETH_RSS_VXLAN | \
535         ETH_RSS_GENEVE | \
536         ETH_RSS_NVGRE)
537
538 /*
539  * Definitions used for redirection table entry size.
540  * Some RSS RETA sizes may not be supported by some drivers, check the
541  * documentation or the description of relevant functions for more details.
542  */
543 #define ETH_RSS_RETA_SIZE_64  64
544 #define ETH_RSS_RETA_SIZE_128 128
545 #define ETH_RSS_RETA_SIZE_256 256
546 #define ETH_RSS_RETA_SIZE_512 512
547 #define RTE_RETA_GROUP_SIZE   64
548
549 /* Definitions used for VMDQ and DCB functionality */
550 #define ETH_VMDQ_MAX_VLAN_FILTERS   64 /**< Maximum nb. of VMDQ vlan filters. */
551 #define ETH_DCB_NUM_USER_PRIORITIES 8  /**< Maximum nb. of DCB priorities. */
552 #define ETH_VMDQ_DCB_NUM_QUEUES     128 /**< Maximum nb. of VMDQ DCB queues. */
553 #define ETH_DCB_NUM_QUEUES          128 /**< Maximum nb. of DCB queues. */
554
555 /* DCB capability defines */
556 #define ETH_DCB_PG_SUPPORT      0x00000001 /**< Priority Group(ETS) support. */
557 #define ETH_DCB_PFC_SUPPORT     0x00000002 /**< Priority Flow Control support. */
558
559 /* Definitions used for VLAN Offload functionality */
560 #define ETH_VLAN_STRIP_OFFLOAD   0x0001 /**< VLAN Strip  On/Off */
561 #define ETH_VLAN_FILTER_OFFLOAD  0x0002 /**< VLAN Filter On/Off */
562 #define ETH_VLAN_EXTEND_OFFLOAD  0x0004 /**< VLAN Extend On/Off */
563
564 /* Definitions used for mask VLAN setting */
565 #define ETH_VLAN_STRIP_MASK   0x0001 /**< VLAN Strip  setting mask */
566 #define ETH_VLAN_FILTER_MASK  0x0002 /**< VLAN Filter  setting mask*/
567 #define ETH_VLAN_EXTEND_MASK  0x0004 /**< VLAN Extend  setting mask*/
568 #define ETH_VLAN_ID_MAX       0x0FFF /**< VLAN ID is in lower 12 bits*/
569
570 /* Definitions used for receive MAC address   */
571 #define ETH_NUM_RECEIVE_MAC_ADDR  128 /**< Maximum nb. of receive mac addr. */
572
573 /* Definitions used for unicast hash  */
574 #define ETH_VMDQ_NUM_UC_HASH_ARRAY  128 /**< Maximum nb. of UC hash array. */
575
576 /* Definitions used for VMDQ pool rx mode setting */
577 #define ETH_VMDQ_ACCEPT_UNTAG   0x0001 /**< accept untagged packets. */
578 #define ETH_VMDQ_ACCEPT_HASH_MC 0x0002 /**< accept packets in multicast table . */
579 #define ETH_VMDQ_ACCEPT_HASH_UC 0x0004 /**< accept packets in unicast table. */
580 #define ETH_VMDQ_ACCEPT_BROADCAST   0x0008 /**< accept broadcast packets. */
581 #define ETH_VMDQ_ACCEPT_MULTICAST   0x0010 /**< multicast promiscuous. */
582
583 /** Maximum nb. of vlan per mirror rule */
584 #define ETH_MIRROR_MAX_VLANS       64
585
586 #define ETH_MIRROR_VIRTUAL_POOL_UP     0x01  /**< Virtual Pool uplink Mirroring. */
587 #define ETH_MIRROR_UPLINK_PORT         0x02  /**< Uplink Port Mirroring. */
588 #define ETH_MIRROR_DOWNLINK_PORT       0x04  /**< Downlink Port Mirroring. */
589 #define ETH_MIRROR_VLAN                0x08  /**< VLAN Mirroring. */
590 #define ETH_MIRROR_VIRTUAL_POOL_DOWN   0x10  /**< Virtual Pool downlink Mirroring. */
591
592 /**
593  * A structure used to configure VLAN traffic mirror of an Ethernet port.
594  */
595 struct rte_eth_vlan_mirror {
596         uint64_t vlan_mask; /**< mask for valid VLAN ID. */
597         /** VLAN ID list for vlan mirroring. */
598         uint16_t vlan_id[ETH_MIRROR_MAX_VLANS];
599 };
600
601 /**
602  * A structure used to configure traffic mirror of an Ethernet port.
603  */
604 struct rte_eth_mirror_conf {
605         uint8_t rule_type; /**< Mirroring rule type */
606         uint8_t dst_pool;  /**< Destination pool for this mirror rule. */
607         uint64_t pool_mask; /**< Bitmap of pool for pool mirroring */
608         /** VLAN ID setting for VLAN mirroring. */
609         struct rte_eth_vlan_mirror vlan;
610 };
611
612 /**
613  * A structure used to configure 64 entries of Redirection Table of the
614  * Receive Side Scaling (RSS) feature of an Ethernet port. To configure
615  * more than 64 entries supported by hardware, an array of this structure
616  * is needed.
617  */
618 struct rte_eth_rss_reta_entry64 {
619         uint64_t mask;
620         /**< Mask bits indicate which entries need to be updated/queried. */
621         uint16_t reta[RTE_RETA_GROUP_SIZE];
622         /**< Group of 64 redirection table entries. */
623 };
624
625 /**
626  * This enum indicates the possible number of traffic classes
627  * in DCB configurations
628  */
629 enum rte_eth_nb_tcs {
630         ETH_4_TCS = 4, /**< 4 TCs with DCB. */
631         ETH_8_TCS = 8  /**< 8 TCs with DCB. */
632 };
633
634 /**
635  * This enum indicates the possible number of queue pools
636  * in VMDQ configurations.
637  */
638 enum rte_eth_nb_pools {
639         ETH_8_POOLS = 8,    /**< 8 VMDq pools. */
640         ETH_16_POOLS = 16,  /**< 16 VMDq pools. */
641         ETH_32_POOLS = 32,  /**< 32 VMDq pools. */
642         ETH_64_POOLS = 64   /**< 64 VMDq pools. */
643 };
644
645 /* This structure may be extended in future. */
646 struct rte_eth_dcb_rx_conf {
647         enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs */
648         /** Traffic class each UP mapped to. */
649         uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
650 };
651
652 struct rte_eth_vmdq_dcb_tx_conf {
653         enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools. */
654         /** Traffic class each UP mapped to. */
655         uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
656 };
657
658 struct rte_eth_dcb_tx_conf {
659         enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs. */
660         /** Traffic class each UP mapped to. */
661         uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
662 };
663
664 struct rte_eth_vmdq_tx_conf {
665         enum rte_eth_nb_pools nb_queue_pools; /**< VMDq mode, 64 pools. */
666 };
667
668 /**
669  * A structure used to configure the VMDQ+DCB feature
670  * of an Ethernet port.
671  *
672  * Using this feature, packets are routed to a pool of queues, based
673  * on the vlan id in the vlan tag, and then to a specific queue within
674  * that pool, using the user priority vlan tag field.
675  *
676  * A default pool may be used, if desired, to route all traffic which
677  * does not match the vlan filter rules.
678  */
679 struct rte_eth_vmdq_dcb_conf {
680         enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools */
681         uint8_t enable_default_pool; /**< If non-zero, use a default pool */
682         uint8_t default_pool; /**< The default pool, if applicable */
683         uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
684         struct {
685                 uint16_t vlan_id; /**< The vlan id of the received frame */
686                 uint64_t pools;   /**< Bitmask of pools for packet rx */
687         } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
688         uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
689         /**< Selects a queue in a pool */
690 };
691
692 /**
693  * A structure used to configure the VMDQ feature of an Ethernet port when
694  * not combined with the DCB feature.
695  *
696  * Using this feature, packets are routed to a pool of queues. By default,
697  * the pool selection is based on the MAC address, the vlan id in the
698  * vlan tag as specified in the pool_map array.
699  * Passing the ETH_VMDQ_ACCEPT_UNTAG in the rx_mode field allows pool
700  * selection using only the MAC address. MAC address to pool mapping is done
701  * using the rte_eth_dev_mac_addr_add function, with the pool parameter
702  * corresponding to the pool id.
703  *
704  * Queue selection within the selected pool will be done using RSS when
705  * it is enabled or revert to the first queue of the pool if not.
706  *
707  * A default pool may be used, if desired, to route all traffic which
708  * does not match the vlan filter rules or any pool MAC address.
709  */
710 struct rte_eth_vmdq_rx_conf {
711         enum rte_eth_nb_pools nb_queue_pools; /**< VMDq only mode, 8 or 64 pools */
712         uint8_t enable_default_pool; /**< If non-zero, use a default pool */
713         uint8_t default_pool; /**< The default pool, if applicable */
714         uint8_t enable_loop_back; /**< Enable VT loop back */
715         uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
716         uint32_t rx_mode; /**< Flags from ETH_VMDQ_ACCEPT_* */
717         struct {
718                 uint16_t vlan_id; /**< The vlan id of the received frame */
719                 uint64_t pools;   /**< Bitmask of pools for packet rx */
720         } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
721 };
722
723 /**
724  * A structure used to configure the TX features of an Ethernet port.
725  */
726 struct rte_eth_txmode {
727         enum rte_eth_tx_mq_mode mq_mode; /**< TX multi-queues mode. */
728         /**
729          * Per-port Tx offloads to be set using DEV_TX_OFFLOAD_* flags.
730          * Only offloads set on tx_offload_capa field on rte_eth_dev_info
731          * structure are allowed to be set.
732          */
733         uint64_t offloads;
734
735         /* For i40e specifically */
736         uint16_t pvid;
737         __extension__
738         uint8_t hw_vlan_reject_tagged : 1,
739                 /**< If set, reject sending out tagged pkts */
740                 hw_vlan_reject_untagged : 1,
741                 /**< If set, reject sending out untagged pkts */
742                 hw_vlan_insert_pvid : 1;
743                 /**< If set, enable port based VLAN insertion */
744 };
745
746 /**
747  * A structure used to configure an RX ring of an Ethernet port.
748  */
749 struct rte_eth_rxconf {
750         struct rte_eth_thresh rx_thresh; /**< RX ring threshold registers. */
751         uint16_t rx_free_thresh; /**< Drives the freeing of RX descriptors. */
752         uint8_t rx_drop_en; /**< Drop packets if no descriptors are available. */
753         uint8_t rx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
754         /**
755          * Per-queue Rx offloads to be set using DEV_RX_OFFLOAD_* flags.
756          * Only offloads set on rx_queue_offload_capa or rx_offload_capa
757          * fields on rte_eth_dev_info structure are allowed to be set.
758          */
759         uint64_t offloads;
760 };
761
762 /**
763  * A structure used to configure a TX ring of an Ethernet port.
764  */
765 struct rte_eth_txconf {
766         struct rte_eth_thresh tx_thresh; /**< TX ring threshold registers. */
767         uint16_t tx_rs_thresh; /**< Drives the setting of RS bit on TXDs. */
768         uint16_t tx_free_thresh; /**< Start freeing TX buffers if there are
769                                       less free descriptors than this value. */
770
771         uint8_t tx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
772         /**
773          * Per-queue Tx offloads to be set  using DEV_TX_OFFLOAD_* flags.
774          * Only offloads set on tx_queue_offload_capa or tx_offload_capa
775          * fields on rte_eth_dev_info structure are allowed to be set.
776          */
777         uint64_t offloads;
778 };
779
780 /**
781  * A structure contains information about HW descriptor ring limitations.
782  */
783 struct rte_eth_desc_lim {
784         uint16_t nb_max;   /**< Max allowed number of descriptors. */
785         uint16_t nb_min;   /**< Min allowed number of descriptors. */
786         uint16_t nb_align; /**< Number of descriptors should be aligned to. */
787
788         /**
789          * Max allowed number of segments per whole packet.
790          *
791          * - For TSO packet this is the total number of data descriptors allowed
792          *   by device.
793          *
794          * @see nb_mtu_seg_max
795          */
796         uint16_t nb_seg_max;
797
798         /**
799          * Max number of segments per one MTU.
800          *
801          * - For non-TSO packet, this is the maximum allowed number of segments
802          *   in a single transmit packet.
803          *
804          * - For TSO packet each segment within the TSO may span up to this
805          *   value.
806          *
807          * @see nb_seg_max
808          */
809         uint16_t nb_mtu_seg_max;
810 };
811
812 /**
813  * This enum indicates the flow control mode
814  */
815 enum rte_eth_fc_mode {
816         RTE_FC_NONE = 0, /**< Disable flow control. */
817         RTE_FC_RX_PAUSE, /**< RX pause frame, enable flowctrl on TX side. */
818         RTE_FC_TX_PAUSE, /**< TX pause frame, enable flowctrl on RX side. */
819         RTE_FC_FULL      /**< Enable flow control on both side. */
820 };
821
822 /**
823  * A structure used to configure Ethernet flow control parameter.
824  * These parameters will be configured into the register of the NIC.
825  * Please refer to the corresponding data sheet for proper value.
826  */
827 struct rte_eth_fc_conf {
828         uint32_t high_water;  /**< High threshold value to trigger XOFF */
829         uint32_t low_water;   /**< Low threshold value to trigger XON */
830         uint16_t pause_time;  /**< Pause quota in the Pause frame */
831         uint16_t send_xon;    /**< Is XON frame need be sent */
832         enum rte_eth_fc_mode mode;  /**< Link flow control mode */
833         uint8_t mac_ctrl_frame_fwd; /**< Forward MAC control frames */
834         uint8_t autoneg;      /**< Use Pause autoneg */
835 };
836
837 /**
838  * A structure used to configure Ethernet priority flow control parameter.
839  * These parameters will be configured into the register of the NIC.
840  * Please refer to the corresponding data sheet for proper value.
841  */
842 struct rte_eth_pfc_conf {
843         struct rte_eth_fc_conf fc; /**< General flow control parameter. */
844         uint8_t priority;          /**< VLAN User Priority. */
845 };
846
847 /**
848  *  Memory space that can be configured to store Flow Director filters
849  *  in the board memory.
850  */
851 enum rte_fdir_pballoc_type {
852         RTE_FDIR_PBALLOC_64K = 0,  /**< 64k. */
853         RTE_FDIR_PBALLOC_128K,     /**< 128k. */
854         RTE_FDIR_PBALLOC_256K,     /**< 256k. */
855 };
856
857 /**
858  *  Select report mode of FDIR hash information in RX descriptors.
859  */
860 enum rte_fdir_status_mode {
861         RTE_FDIR_NO_REPORT_STATUS = 0, /**< Never report FDIR hash. */
862         RTE_FDIR_REPORT_STATUS, /**< Only report FDIR hash for matching pkts. */
863         RTE_FDIR_REPORT_STATUS_ALWAYS, /**< Always report FDIR hash. */
864 };
865
866 /**
867  * A structure used to configure the Flow Director (FDIR) feature
868  * of an Ethernet port.
869  *
870  * If mode is RTE_FDIR_DISABLE, the pballoc value is ignored.
871  */
872 struct rte_fdir_conf {
873         enum rte_fdir_mode mode; /**< Flow Director mode. */
874         enum rte_fdir_pballoc_type pballoc; /**< Space for FDIR filters. */
875         enum rte_fdir_status_mode status;  /**< How to report FDIR hash. */
876         /** RX queue of packets matching a "drop" filter in perfect mode. */
877         uint8_t drop_queue;
878         struct rte_eth_fdir_masks mask;
879         struct rte_eth_fdir_flex_conf flex_conf;
880         /**< Flex payload configuration. */
881 };
882
883 /**
884  * UDP tunneling configuration.
885  * Used to config the UDP port for a type of tunnel.
886  * NICs need the UDP port to identify the tunnel type.
887  * Normally a type of tunnel has a default UDP port, this structure can be used
888  * in case if the users want to change or support more UDP port.
889  */
890 struct rte_eth_udp_tunnel {
891         uint16_t udp_port; /**< UDP port used for the tunnel. */
892         uint8_t prot_type; /**< Tunnel type. Defined in rte_eth_tunnel_type. */
893 };
894
895 /**
896  * A structure used to enable/disable specific device interrupts.
897  */
898 struct rte_intr_conf {
899         /** enable/disable lsc interrupt. 0 (default) - disable, 1 enable */
900         uint32_t lsc:1;
901         /** enable/disable rxq interrupt. 0 (default) - disable, 1 enable */
902         uint32_t rxq:1;
903         /** enable/disable rmv interrupt. 0 (default) - disable, 1 enable */
904         uint32_t rmv:1;
905 };
906
907 /**
908  * A structure used to configure an Ethernet port.
909  * Depending upon the RX multi-queue mode, extra advanced
910  * configuration settings may be needed.
911  */
912 struct rte_eth_conf {
913         uint32_t link_speeds; /**< bitmap of ETH_LINK_SPEED_XXX of speeds to be
914                                 used. ETH_LINK_SPEED_FIXED disables link
915                                 autonegotiation, and a unique speed shall be
916                                 set. Otherwise, the bitmap defines the set of
917                                 speeds to be advertised. If the special value
918                                 ETH_LINK_SPEED_AUTONEG (0) is used, all speeds
919                                 supported are advertised. */
920         struct rte_eth_rxmode rxmode; /**< Port RX configuration. */
921         struct rte_eth_txmode txmode; /**< Port TX configuration. */
922         uint32_t lpbk_mode; /**< Loopback operation mode. By default the value
923                                  is 0, meaning the loopback mode is disabled.
924                                  Read the datasheet of given ethernet controller
925                                  for details. The possible values of this field
926                                  are defined in implementation of each driver. */
927         struct {
928                 struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
929                 struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
930                 /**< Port vmdq+dcb configuration. */
931                 struct rte_eth_dcb_rx_conf dcb_rx_conf;
932                 /**< Port dcb RX configuration. */
933                 struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
934                 /**< Port vmdq RX configuration. */
935         } rx_adv_conf; /**< Port RX filtering configuration. */
936         union {
937                 struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
938                 /**< Port vmdq+dcb TX configuration. */
939                 struct rte_eth_dcb_tx_conf dcb_tx_conf;
940                 /**< Port dcb TX configuration. */
941                 struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
942                 /**< Port vmdq TX configuration. */
943         } tx_adv_conf; /**< Port TX DCB configuration (union). */
944         /** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
945             is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
946         uint32_t dcb_capability_en;
947         struct rte_fdir_conf fdir_conf; /**< FDIR configuration. */
948         struct rte_intr_conf intr_conf; /**< Interrupt mode configuration. */
949 };
950
951 /**
952  * RX offload capabilities of a device.
953  */
954 #define DEV_RX_OFFLOAD_VLAN_STRIP  0x00000001
955 #define DEV_RX_OFFLOAD_IPV4_CKSUM  0x00000002
956 #define DEV_RX_OFFLOAD_UDP_CKSUM   0x00000004
957 #define DEV_RX_OFFLOAD_TCP_CKSUM   0x00000008
958 #define DEV_RX_OFFLOAD_TCP_LRO     0x00000010
959 #define DEV_RX_OFFLOAD_QINQ_STRIP  0x00000020
960 #define DEV_RX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000040
961 #define DEV_RX_OFFLOAD_MACSEC_STRIP     0x00000080
962 #define DEV_RX_OFFLOAD_HEADER_SPLIT     0x00000100
963 #define DEV_RX_OFFLOAD_VLAN_FILTER      0x00000200
964 #define DEV_RX_OFFLOAD_VLAN_EXTEND      0x00000400
965 #define DEV_RX_OFFLOAD_JUMBO_FRAME      0x00000800
966 #define DEV_RX_OFFLOAD_SCATTER          0x00002000
967 #define DEV_RX_OFFLOAD_TIMESTAMP        0x00004000
968 #define DEV_RX_OFFLOAD_SECURITY         0x00008000
969 #define DEV_RX_OFFLOAD_KEEP_CRC         0x00010000
970 #define DEV_RX_OFFLOAD_SCTP_CKSUM       0x00020000
971 #define DEV_RX_OFFLOAD_OUTER_UDP_CKSUM  0x00040000
972
973 #define DEV_RX_OFFLOAD_CHECKSUM (DEV_RX_OFFLOAD_IPV4_CKSUM | \
974                                  DEV_RX_OFFLOAD_UDP_CKSUM | \
975                                  DEV_RX_OFFLOAD_TCP_CKSUM)
976 #define DEV_RX_OFFLOAD_VLAN (DEV_RX_OFFLOAD_VLAN_STRIP | \
977                              DEV_RX_OFFLOAD_VLAN_FILTER | \
978                              DEV_RX_OFFLOAD_VLAN_EXTEND)
979
980 /*
981  * If new Rx offload capabilities are defined, they also must be
982  * mentioned in rte_rx_offload_names in rte_ethdev.c file.
983  */
984
985 /**
986  * TX offload capabilities of a device.
987  */
988 #define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001
989 #define DEV_TX_OFFLOAD_IPV4_CKSUM  0x00000002
990 #define DEV_TX_OFFLOAD_UDP_CKSUM   0x00000004
991 #define DEV_TX_OFFLOAD_TCP_CKSUM   0x00000008
992 #define DEV_TX_OFFLOAD_SCTP_CKSUM  0x00000010
993 #define DEV_TX_OFFLOAD_TCP_TSO     0x00000020
994 #define DEV_TX_OFFLOAD_UDP_TSO     0x00000040
995 #define DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000080 /**< Used for tunneling packet. */
996 #define DEV_TX_OFFLOAD_QINQ_INSERT 0x00000100
997 #define DEV_TX_OFFLOAD_VXLAN_TNL_TSO    0x00000200    /**< Used for tunneling packet. */
998 #define DEV_TX_OFFLOAD_GRE_TNL_TSO      0x00000400    /**< Used for tunneling packet. */
999 #define DEV_TX_OFFLOAD_IPIP_TNL_TSO     0x00000800    /**< Used for tunneling packet. */
1000 #define DEV_TX_OFFLOAD_GENEVE_TNL_TSO   0x00001000    /**< Used for tunneling packet. */
1001 #define DEV_TX_OFFLOAD_MACSEC_INSERT    0x00002000
1002 #define DEV_TX_OFFLOAD_MT_LOCKFREE      0x00004000
1003 /**< Multiple threads can invoke rte_eth_tx_burst() concurrently on the same
1004  * tx queue without SW lock.
1005  */
1006 #define DEV_TX_OFFLOAD_MULTI_SEGS       0x00008000
1007 /**< Device supports multi segment send. */
1008 #define DEV_TX_OFFLOAD_MBUF_FAST_FREE   0x00010000
1009 /**< Device supports optimization for fast release of mbufs.
1010  *   When set application must guarantee that per-queue all mbufs comes from
1011  *   the same mempool and has refcnt = 1.
1012  */
1013 #define DEV_TX_OFFLOAD_SECURITY         0x00020000
1014 /**
1015  * Device supports generic UDP tunneled packet TSO.
1016  * Application must set PKT_TX_TUNNEL_UDP and other mbuf fields required
1017  * for tunnel TSO.
1018  */
1019 #define DEV_TX_OFFLOAD_UDP_TNL_TSO      0x00040000
1020 /**
1021  * Device supports generic IP tunneled packet TSO.
1022  * Application must set PKT_TX_TUNNEL_IP and other mbuf fields required
1023  * for tunnel TSO.
1024  */
1025 #define DEV_TX_OFFLOAD_IP_TNL_TSO       0x00080000
1026 /** Device supports outer UDP checksum */
1027 #define DEV_TX_OFFLOAD_OUTER_UDP_CKSUM  0x00100000
1028 /**
1029  * Device supports match on metadata Tx offload..
1030  * Application must set PKT_TX_METADATA and mbuf metadata field.
1031  */
1032 #define DEV_TX_OFFLOAD_MATCH_METADATA   0x00200000
1033
1034 #define RTE_ETH_DEV_CAPA_RUNTIME_RX_QUEUE_SETUP 0x00000001
1035 /**< Device supports Rx queue setup after device started*/
1036 #define RTE_ETH_DEV_CAPA_RUNTIME_TX_QUEUE_SETUP 0x00000002
1037 /**< Device supports Tx queue setup after device started*/
1038
1039 /*
1040  * If new Tx offload capabilities are defined, they also must be
1041  * mentioned in rte_tx_offload_names in rte_ethdev.c file.
1042  */
1043
1044 /*
1045  * Fallback default preferred Rx/Tx port parameters.
1046  * These are used if an application requests default parameters
1047  * but the PMD does not provide preferred values.
1048  */
1049 #define RTE_ETH_DEV_FALLBACK_RX_RINGSIZE 512
1050 #define RTE_ETH_DEV_FALLBACK_TX_RINGSIZE 512
1051 #define RTE_ETH_DEV_FALLBACK_RX_NBQUEUES 1
1052 #define RTE_ETH_DEV_FALLBACK_TX_NBQUEUES 1
1053
1054 /**
1055  * Preferred Rx/Tx port parameters.
1056  * There are separate instances of this structure for transmission
1057  * and reception respectively.
1058  */
1059 struct rte_eth_dev_portconf {
1060         uint16_t burst_size; /**< Device-preferred burst size */
1061         uint16_t ring_size; /**< Device-preferred size of queue rings */
1062         uint16_t nb_queues; /**< Device-preferred number of queues */
1063 };
1064
1065 /**
1066  * Default values for switch domain id when ethdev does not support switch
1067  * domain definitions.
1068  */
1069 #define RTE_ETH_DEV_SWITCH_DOMAIN_ID_INVALID    (0)
1070
1071 /**
1072  * Ethernet device associated switch information
1073  */
1074 struct rte_eth_switch_info {
1075         const char *name;       /**< switch name */
1076         uint16_t domain_id;     /**< switch domain id */
1077         uint16_t port_id;
1078         /**<
1079          * mapping to the devices physical switch port as enumerated from the
1080          * perspective of the embedded interconnect/switch. For SR-IOV enabled
1081          * device this may correspond to the VF_ID of each virtual function,
1082          * but each driver should explicitly define the mapping of switch
1083          * port identifier to that physical interconnect/switch
1084          */
1085 };
1086
1087 /**
1088  * Ethernet device information
1089  */
1090
1091 /**
1092  * A structure used to retrieve the contextual information of
1093  * an Ethernet device, such as the controlling driver of the
1094  * device, etc...
1095  */
1096 struct rte_eth_dev_info {
1097         struct rte_device *device; /** Generic device information */
1098         const char *driver_name; /**< Device Driver name. */
1099         unsigned int if_index; /**< Index to bound host interface, or 0 if none.
1100                 Use if_indextoname() to translate into an interface name. */
1101         const uint32_t *dev_flags; /**< Device flags */
1102         uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
1103         uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
1104         uint16_t max_rx_queues; /**< Maximum number of RX queues. */
1105         uint16_t max_tx_queues; /**< Maximum number of TX queues. */
1106         uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
1107         uint32_t max_hash_mac_addrs;
1108         /** Maximum number of hash MAC addresses for MTA and UTA. */
1109         uint16_t max_vfs; /**< Maximum number of VFs. */
1110         uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
1111         uint64_t rx_offload_capa;
1112         /**< All RX offload capabilities including all per-queue ones */
1113         uint64_t tx_offload_capa;
1114         /**< All TX offload capabilities including all per-queue ones */
1115         uint64_t rx_queue_offload_capa;
1116         /**< Device per-queue RX offload capabilities. */
1117         uint64_t tx_queue_offload_capa;
1118         /**< Device per-queue TX offload capabilities. */
1119         uint16_t reta_size;
1120         /**< Device redirection table size, the total number of entries. */
1121         uint8_t hash_key_size; /**< Hash key size in bytes */
1122         /** Bit mask of RSS offloads, the bit offset also means flow type */
1123         uint64_t flow_type_rss_offloads;
1124         struct rte_eth_rxconf default_rxconf; /**< Default RX configuration */
1125         struct rte_eth_txconf default_txconf; /**< Default TX configuration */
1126         uint16_t vmdq_queue_base; /**< First queue ID for VMDQ pools. */
1127         uint16_t vmdq_queue_num;  /**< Queue number for VMDQ pools. */
1128         uint16_t vmdq_pool_base;  /**< First ID of VMDQ pools. */
1129         struct rte_eth_desc_lim rx_desc_lim;  /**< RX descriptors limits */
1130         struct rte_eth_desc_lim tx_desc_lim;  /**< TX descriptors limits */
1131         uint32_t speed_capa;  /**< Supported speeds bitmap (ETH_LINK_SPEED_). */
1132         /** Configured number of rx/tx queues */
1133         uint16_t nb_rx_queues; /**< Number of RX queues. */
1134         uint16_t nb_tx_queues; /**< Number of TX queues. */
1135         /** Rx parameter recommendations */
1136         struct rte_eth_dev_portconf default_rxportconf;
1137         /** Tx parameter recommendations */
1138         struct rte_eth_dev_portconf default_txportconf;
1139         /** Generic device capabilities (RTE_ETH_DEV_CAPA_). */
1140         uint64_t dev_capa;
1141         /**
1142          * Switching information for ports on a device with a
1143          * embedded managed interconnect/switch.
1144          */
1145         struct rte_eth_switch_info switch_info;
1146 };
1147
1148 /**
1149  * Ethernet device RX queue information structure.
1150  * Used to retieve information about configured queue.
1151  */
1152 struct rte_eth_rxq_info {
1153         struct rte_mempool *mp;     /**< mempool used by that queue. */
1154         struct rte_eth_rxconf conf; /**< queue config parameters. */
1155         uint8_t scattered_rx;       /**< scattered packets RX supported. */
1156         uint16_t nb_desc;           /**< configured number of RXDs. */
1157 } __rte_cache_min_aligned;
1158
1159 /**
1160  * Ethernet device TX queue information structure.
1161  * Used to retrieve information about configured queue.
1162  */
1163 struct rte_eth_txq_info {
1164         struct rte_eth_txconf conf; /**< queue config parameters. */
1165         uint16_t nb_desc;           /**< configured number of TXDs. */
1166 } __rte_cache_min_aligned;
1167
1168 /** Maximum name length for extended statistics counters */
1169 #define RTE_ETH_XSTATS_NAME_SIZE 64
1170
1171 /**
1172  * An Ethernet device extended statistic structure
1173  *
1174  * This structure is used by rte_eth_xstats_get() to provide
1175  * statistics that are not provided in the generic *rte_eth_stats*
1176  * structure.
1177  * It maps a name id, corresponding to an index in the array returned
1178  * by rte_eth_xstats_get_names(), to a statistic value.
1179  */
1180 struct rte_eth_xstat {
1181         uint64_t id;        /**< The index in xstats name array. */
1182         uint64_t value;     /**< The statistic counter value. */
1183 };
1184
1185 /**
1186  * A name element for extended statistics.
1187  *
1188  * An array of this structure is returned by rte_eth_xstats_get_names().
1189  * It lists the names of extended statistics for a PMD. The *rte_eth_xstat*
1190  * structure references these names by their array index.
1191  */
1192 struct rte_eth_xstat_name {
1193         char name[RTE_ETH_XSTATS_NAME_SIZE]; /**< The statistic name. */
1194 };
1195
1196 #define ETH_DCB_NUM_TCS    8
1197 #define ETH_MAX_VMDQ_POOL  64
1198
1199 /**
1200  * A structure used to get the information of queue and
1201  * TC mapping on both TX and RX paths.
1202  */
1203 struct rte_eth_dcb_tc_queue_mapping {
1204         /** rx queues assigned to tc per Pool */
1205         struct {
1206                 uint8_t base;
1207                 uint8_t nb_queue;
1208         } tc_rxq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
1209         /** rx queues assigned to tc per Pool */
1210         struct {
1211                 uint8_t base;
1212                 uint8_t nb_queue;
1213         } tc_txq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
1214 };
1215
1216 /**
1217  * A structure used to get the information of DCB.
1218  * It includes TC UP mapping and queue TC mapping.
1219  */
1220 struct rte_eth_dcb_info {
1221         uint8_t nb_tcs;        /**< number of TCs */
1222         uint8_t prio_tc[ETH_DCB_NUM_USER_PRIORITIES]; /**< Priority to tc */
1223         uint8_t tc_bws[ETH_DCB_NUM_TCS]; /**< TX BW percentage for each TC */
1224         /** rx queues assigned to tc */
1225         struct rte_eth_dcb_tc_queue_mapping tc_queue;
1226 };
1227
1228 /**
1229  * RX/TX queue states
1230  */
1231 #define RTE_ETH_QUEUE_STATE_STOPPED 0
1232 #define RTE_ETH_QUEUE_STATE_STARTED 1
1233
1234 #define RTE_ETH_ALL RTE_MAX_ETHPORTS
1235
1236 /* Macros to check for valid port */
1237 #define RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, retval) do { \
1238         if (!rte_eth_dev_is_valid_port(port_id)) { \
1239                 RTE_ETHDEV_LOG(ERR, "Invalid port_id=%u\n", port_id); \
1240                 return retval; \
1241         } \
1242 } while (0)
1243
1244 #define RTE_ETH_VALID_PORTID_OR_RET(port_id) do { \
1245         if (!rte_eth_dev_is_valid_port(port_id)) { \
1246                 RTE_ETHDEV_LOG(ERR, "Invalid port_id=%u\n", port_id); \
1247                 return; \
1248         } \
1249 } while (0)
1250
1251 /**
1252  * l2 tunnel configuration.
1253  */
1254
1255 /**< l2 tunnel enable mask */
1256 #define ETH_L2_TUNNEL_ENABLE_MASK       0x00000001
1257 /**< l2 tunnel insertion mask */
1258 #define ETH_L2_TUNNEL_INSERTION_MASK    0x00000002
1259 /**< l2 tunnel stripping mask */
1260 #define ETH_L2_TUNNEL_STRIPPING_MASK    0x00000004
1261 /**< l2 tunnel forwarding mask */
1262 #define ETH_L2_TUNNEL_FORWARDING_MASK   0x00000008
1263
1264 /**
1265  * Function type used for RX packet processing packet callbacks.
1266  *
1267  * The callback function is called on RX with a burst of packets that have
1268  * been received on the given port and queue.
1269  *
1270  * @param port_id
1271  *   The Ethernet port on which RX is being performed.
1272  * @param queue
1273  *   The queue on the Ethernet port which is being used to receive the packets.
1274  * @param pkts
1275  *   The burst of packets that have just been received.
1276  * @param nb_pkts
1277  *   The number of packets in the burst pointed to by "pkts".
1278  * @param max_pkts
1279  *   The max number of packets that can be stored in the "pkts" array.
1280  * @param user_param
1281  *   The arbitrary user parameter passed in by the application when the callback
1282  *   was originally configured.
1283  * @return
1284  *   The number of packets returned to the user.
1285  */
1286 typedef uint16_t (*rte_rx_callback_fn)(uint16_t port_id, uint16_t queue,
1287         struct rte_mbuf *pkts[], uint16_t nb_pkts, uint16_t max_pkts,
1288         void *user_param);
1289
1290 /**
1291  * Function type used for TX packet processing packet callbacks.
1292  *
1293  * The callback function is called on TX with a burst of packets immediately
1294  * before the packets are put onto the hardware queue for transmission.
1295  *
1296  * @param port_id
1297  *   The Ethernet port on which TX is being performed.
1298  * @param queue
1299  *   The queue on the Ethernet port which is being used to transmit the packets.
1300  * @param pkts
1301  *   The burst of packets that are about to be transmitted.
1302  * @param nb_pkts
1303  *   The number of packets in the burst pointed to by "pkts".
1304  * @param user_param
1305  *   The arbitrary user parameter passed in by the application when the callback
1306  *   was originally configured.
1307  * @return
1308  *   The number of packets to be written to the NIC.
1309  */
1310 typedef uint16_t (*rte_tx_callback_fn)(uint16_t port_id, uint16_t queue,
1311         struct rte_mbuf *pkts[], uint16_t nb_pkts, void *user_param);
1312
1313 /**
1314  * Possible states of an ethdev port.
1315  */
1316 enum rte_eth_dev_state {
1317         /** Device is unused before being probed. */
1318         RTE_ETH_DEV_UNUSED = 0,
1319         /** Device is attached when allocated in probing. */
1320         RTE_ETH_DEV_ATTACHED,
1321         /** The deferred state is useless and replaced by ownership. */
1322         RTE_ETH_DEV_DEFERRED,
1323         /** Device is in removed state when plug-out is detected. */
1324         RTE_ETH_DEV_REMOVED,
1325 };
1326
1327 struct rte_eth_dev_sriov {
1328         uint8_t active;               /**< SRIOV is active with 16, 32 or 64 pools */
1329         uint8_t nb_q_per_pool;        /**< rx queue number per pool */
1330         uint16_t def_vmdq_idx;        /**< Default pool num used for PF */
1331         uint16_t def_pool_q_idx;      /**< Default pool queue start reg index */
1332 };
1333 #define RTE_ETH_DEV_SRIOV(dev)         ((dev)->data->sriov)
1334
1335 #define RTE_ETH_NAME_MAX_LEN RTE_DEV_NAME_MAX_LEN
1336
1337 #define RTE_ETH_DEV_NO_OWNER 0
1338
1339 #define RTE_ETH_MAX_OWNER_NAME_LEN 64
1340
1341 struct rte_eth_dev_owner {
1342         uint64_t id; /**< The owner unique identifier. */
1343         char name[RTE_ETH_MAX_OWNER_NAME_LEN]; /**< The owner name. */
1344 };
1345
1346 /**
1347  * Port is released (i.e. totally freed and data erased) on close.
1348  * Temporary flag for PMD migration to new rte_eth_dev_close() behaviour.
1349  */
1350 #define RTE_ETH_DEV_CLOSE_REMOVE 0x0001
1351 /** Device supports link state interrupt */
1352 #define RTE_ETH_DEV_INTR_LSC     0x0002
1353 /** Device is a bonded slave */
1354 #define RTE_ETH_DEV_BONDED_SLAVE 0x0004
1355 /** Device supports device removal interrupt */
1356 #define RTE_ETH_DEV_INTR_RMV     0x0008
1357 /** Device is port representor */
1358 #define RTE_ETH_DEV_REPRESENTOR  0x0010
1359 /** Device does not support MAC change after started */
1360 #define RTE_ETH_DEV_NOLIVE_MAC_ADDR  0x0020
1361
1362 /**
1363  * Iterates over valid ethdev ports owned by a specific owner.
1364  *
1365  * @param port_id
1366  *   The id of the next possible valid owned port.
1367  * @param       owner_id
1368  *  The owner identifier.
1369  *  RTE_ETH_DEV_NO_OWNER means iterate over all valid ownerless ports.
1370  * @return
1371  *   Next valid port id owned by owner_id, RTE_MAX_ETHPORTS if there is none.
1372  */
1373 uint64_t rte_eth_find_next_owned_by(uint16_t port_id,
1374                 const uint64_t owner_id);
1375
1376 /**
1377  * Macro to iterate over all enabled ethdev ports owned by a specific owner.
1378  */
1379 #define RTE_ETH_FOREACH_DEV_OWNED_BY(p, o) \
1380         for (p = rte_eth_find_next_owned_by(0, o); \
1381              (unsigned int)p < (unsigned int)RTE_MAX_ETHPORTS; \
1382              p = rte_eth_find_next_owned_by(p + 1, o))
1383
1384 /**
1385  * Iterates over valid ethdev ports.
1386  *
1387  * @param port_id
1388  *   The id of the next possible valid port.
1389  * @return
1390  *   Next valid port id, RTE_MAX_ETHPORTS if there is none.
1391  */
1392 uint16_t rte_eth_find_next(uint16_t port_id);
1393
1394 /**
1395  * Macro to iterate over all enabled and ownerless ethdev ports.
1396  */
1397 #define RTE_ETH_FOREACH_DEV(p) \
1398         RTE_ETH_FOREACH_DEV_OWNED_BY(p, RTE_ETH_DEV_NO_OWNER)
1399
1400
1401 /**
1402  * @warning
1403  * @b EXPERIMENTAL: this API may change without prior notice.
1404  *
1405  * Get a new unique owner identifier.
1406  * An owner identifier is used to owns Ethernet devices by only one DPDK entity
1407  * to avoid multiple management of device by different entities.
1408  *
1409  * @param       owner_id
1410  *   Owner identifier pointer.
1411  * @return
1412  *   Negative errno value on error, 0 on success.
1413  */
1414 int __rte_experimental rte_eth_dev_owner_new(uint64_t *owner_id);
1415
1416 /**
1417  * @warning
1418  * @b EXPERIMENTAL: this API may change without prior notice.
1419  *
1420  * Set an Ethernet device owner.
1421  *
1422  * @param       port_id
1423  *  The identifier of the port to own.
1424  * @param       owner
1425  *  The owner pointer.
1426  * @return
1427  *  Negative errno value on error, 0 on success.
1428  */
1429 int __rte_experimental rte_eth_dev_owner_set(const uint16_t port_id,
1430                 const struct rte_eth_dev_owner *owner);
1431
1432 /**
1433  * @warning
1434  * @b EXPERIMENTAL: this API may change without prior notice.
1435  *
1436  * Unset Ethernet device owner to make the device ownerless.
1437  *
1438  * @param       port_id
1439  *  The identifier of port to make ownerless.
1440  * @param       owner_id
1441  *  The owner identifier.
1442  * @return
1443  *  0 on success, negative errno value on error.
1444  */
1445 int __rte_experimental rte_eth_dev_owner_unset(const uint16_t port_id,
1446                 const uint64_t owner_id);
1447
1448 /**
1449  * @warning
1450  * @b EXPERIMENTAL: this API may change without prior notice.
1451  *
1452  * Remove owner from all Ethernet devices owned by a specific owner.
1453  *
1454  * @param       owner_id
1455  *  The owner identifier.
1456  */
1457 void __rte_experimental rte_eth_dev_owner_delete(const uint64_t owner_id);
1458
1459 /**
1460  * @warning
1461  * @b EXPERIMENTAL: this API may change without prior notice.
1462  *
1463  * Get the owner of an Ethernet device.
1464  *
1465  * @param       port_id
1466  *  The port identifier.
1467  * @param       owner
1468  *  The owner structure pointer to fill.
1469  * @return
1470  *  0 on success, negative errno value on error..
1471  */
1472 int __rte_experimental rte_eth_dev_owner_get(const uint16_t port_id,
1473                 struct rte_eth_dev_owner *owner);
1474
1475 /**
1476  * Get the total number of Ethernet devices that have been successfully
1477  * initialized by the matching Ethernet driver during the PCI probing phase
1478  * and that are available for applications to use. These devices must be
1479  * accessed by using the ``RTE_ETH_FOREACH_DEV()`` macro to deal with
1480  * non-contiguous ranges of devices.
1481  * These non-contiguous ranges can be created by calls to hotplug functions or
1482  * by some PMDs.
1483  *
1484  * @return
1485  *   - The total number of usable Ethernet devices.
1486  */
1487 __rte_deprecated
1488 uint16_t rte_eth_dev_count(void);
1489
1490 /**
1491  * Get the number of ports which are usable for the application.
1492  *
1493  * These devices must be iterated by using the macro
1494  * ``RTE_ETH_FOREACH_DEV`` or ``RTE_ETH_FOREACH_DEV_OWNED_BY``
1495  * to deal with non-contiguous ranges of devices.
1496  *
1497  * @return
1498  *   The count of available Ethernet devices.
1499  */
1500 uint16_t rte_eth_dev_count_avail(void);
1501
1502 /**
1503  * Get the total number of ports which are allocated.
1504  *
1505  * Some devices may not be available for the application.
1506  *
1507  * @return
1508  *   The total count of Ethernet devices.
1509  */
1510 uint16_t __rte_experimental rte_eth_dev_count_total(void);
1511
1512 /**
1513  * Attach a new Ethernet device specified by arguments.
1514  *
1515  * @param devargs
1516  *  A pointer to a strings array describing the new device
1517  *  to be attached. The strings should be a pci address like
1518  *  '0000:01:00.0' or virtual device name like 'net_pcap0'.
1519  * @param port_id
1520  *  A pointer to a port identifier actually attached.
1521  * @return
1522  *  0 on success and port_id is filled, negative on error
1523  */
1524 __rte_deprecated
1525 int rte_eth_dev_attach(const char *devargs, uint16_t *port_id);
1526
1527 /**
1528  * Detach a Ethernet device specified by port identifier.
1529  * This function must be called when the device is in the
1530  * closed state.
1531  *
1532  * @param port_id
1533  *   The port identifier of the device to detach.
1534  * @param devname
1535  *   A pointer to a buffer that will be filled with the device name.
1536  *   This buffer must be at least RTE_DEV_NAME_MAX_LEN long.
1537  * @return
1538  *  0 on success and devname is filled, negative on error
1539  */
1540 __rte_deprecated
1541 int rte_eth_dev_detach(uint16_t port_id, char *devname);
1542
1543 /**
1544  * Convert a numerical speed in Mbps to a bitmap flag that can be used in
1545  * the bitmap link_speeds of the struct rte_eth_conf
1546  *
1547  * @param speed
1548  *   Numerical speed value in Mbps
1549  * @param duplex
1550  *   ETH_LINK_[HALF/FULL]_DUPLEX (only for 10/100M speeds)
1551  * @return
1552  *   0 if the speed cannot be mapped
1553  */
1554 uint32_t rte_eth_speed_bitflag(uint32_t speed, int duplex);
1555
1556 /**
1557  * @warning
1558  * @b EXPERIMENTAL: this API may change without prior notice
1559  *
1560  * Get DEV_RX_OFFLOAD_* flag name.
1561  *
1562  * @param offload
1563  *   Offload flag.
1564  * @return
1565  *   Offload name or 'UNKNOWN' if the flag cannot be recognised.
1566  */
1567 const char * __rte_experimental rte_eth_dev_rx_offload_name(uint64_t offload);
1568
1569 /**
1570  * @warning
1571  * @b EXPERIMENTAL: this API may change without prior notice
1572  *
1573  * Get DEV_TX_OFFLOAD_* flag name.
1574  *
1575  * @param offload
1576  *   Offload flag.
1577  * @return
1578  *   Offload name or 'UNKNOWN' if the flag cannot be recognised.
1579  */
1580 const char * __rte_experimental rte_eth_dev_tx_offload_name(uint64_t offload);
1581
1582 /**
1583  * Configure an Ethernet device.
1584  * This function must be invoked first before any other function in the
1585  * Ethernet API. This function can also be re-invoked when a device is in the
1586  * stopped state.
1587  *
1588  * @param port_id
1589  *   The port identifier of the Ethernet device to configure.
1590  * @param nb_rx_queue
1591  *   The number of receive queues to set up for the Ethernet device.
1592  * @param nb_tx_queue
1593  *   The number of transmit queues to set up for the Ethernet device.
1594  * @param eth_conf
1595  *   The pointer to the configuration data to be used for the Ethernet device.
1596  *   The *rte_eth_conf* structure includes:
1597  *     -  the hardware offload features to activate, with dedicated fields for
1598  *        each statically configurable offload hardware feature provided by
1599  *        Ethernet devices, such as IP checksum or VLAN tag stripping for
1600  *        example.
1601  *        The Rx offload bitfield API is obsolete and will be deprecated.
1602  *        Applications should set the ignore_bitfield_offloads bit on *rxmode*
1603  *        structure and use offloads field to set per-port offloads instead.
1604  *     -  Any offloading set in eth_conf->[rt]xmode.offloads must be within
1605  *        the [rt]x_offload_capa returned from rte_eth_dev_infos_get().
1606  *        Any type of device supported offloading set in the input argument
1607  *        eth_conf->[rt]xmode.offloads to rte_eth_dev_configure() is enabled
1608  *        on all queues and it can't be disabled in rte_eth_[rt]x_queue_setup()
1609  *     -  the Receive Side Scaling (RSS) configuration when using multiple RX
1610  *        queues per port. Any RSS hash function set in eth_conf->rss_conf.rss_hf
1611  *        must be within the flow_type_rss_offloads provided by drivers via
1612  *        rte_eth_dev_infos_get() API.
1613  *
1614  *   Embedding all configuration information in a single data structure
1615  *   is the more flexible method that allows the addition of new features
1616  *   without changing the syntax of the API.
1617  * @return
1618  *   - 0: Success, device configured.
1619  *   - <0: Error code returned by the driver configuration function.
1620  */
1621 int rte_eth_dev_configure(uint16_t port_id, uint16_t nb_rx_queue,
1622                 uint16_t nb_tx_queue, const struct rte_eth_conf *eth_conf);
1623
1624 /**
1625  * @warning
1626  * @b EXPERIMENTAL: this API may change without prior notice.
1627  *
1628  * Check if an Ethernet device was physically removed.
1629  *
1630  * @param port_id
1631  *   The port identifier of the Ethernet device.
1632  * @return
1633  *   1 when the Ethernet device is removed, otherwise 0.
1634  */
1635 int __rte_experimental
1636 rte_eth_dev_is_removed(uint16_t port_id);
1637
1638 /**
1639  * Allocate and set up a receive queue for an Ethernet device.
1640  *
1641  * The function allocates a contiguous block of memory for *nb_rx_desc*
1642  * receive descriptors from a memory zone associated with *socket_id*
1643  * and initializes each receive descriptor with a network buffer allocated
1644  * from the memory pool *mb_pool*.
1645  *
1646  * @param port_id
1647  *   The port identifier of the Ethernet device.
1648  * @param rx_queue_id
1649  *   The index of the receive queue to set up.
1650  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
1651  *   to rte_eth_dev_configure().
1652  * @param nb_rx_desc
1653  *   The number of receive descriptors to allocate for the receive ring.
1654  * @param socket_id
1655  *   The *socket_id* argument is the socket identifier in case of NUMA.
1656  *   The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1657  *   the DMA memory allocated for the receive descriptors of the ring.
1658  * @param rx_conf
1659  *   The pointer to the configuration data to be used for the receive queue.
1660  *   NULL value is allowed, in which case default RX configuration
1661  *   will be used.
1662  *   The *rx_conf* structure contains an *rx_thresh* structure with the values
1663  *   of the Prefetch, Host, and Write-Back threshold registers of the receive
1664  *   ring.
1665  *   In addition it contains the hardware offloads features to activate using
1666  *   the DEV_RX_OFFLOAD_* flags.
1667  *   If an offloading set in rx_conf->offloads
1668  *   hasn't been set in the input argument eth_conf->rxmode.offloads
1669  *   to rte_eth_dev_configure(), it is a new added offloading, it must be
1670  *   per-queue type and it is enabled for the queue.
1671  *   No need to repeat any bit in rx_conf->offloads which has already been
1672  *   enabled in rte_eth_dev_configure() at port level. An offloading enabled
1673  *   at port level can't be disabled at queue level.
1674  * @param mb_pool
1675  *   The pointer to the memory pool from which to allocate *rte_mbuf* network
1676  *   memory buffers to populate each descriptor of the receive ring.
1677  * @return
1678  *   - 0: Success, receive queue correctly set up.
1679  *   - -EIO: if device is removed.
1680  *   - -EINVAL: The size of network buffers which can be allocated from the
1681  *      memory pool does not fit the various buffer sizes allowed by the
1682  *      device controller.
1683  *   - -ENOMEM: Unable to allocate the receive ring descriptors or to
1684  *      allocate network memory buffers from the memory pool when
1685  *      initializing receive descriptors.
1686  */
1687 int rte_eth_rx_queue_setup(uint16_t port_id, uint16_t rx_queue_id,
1688                 uint16_t nb_rx_desc, unsigned int socket_id,
1689                 const struct rte_eth_rxconf *rx_conf,
1690                 struct rte_mempool *mb_pool);
1691
1692 /**
1693  * Allocate and set up a transmit queue for an Ethernet device.
1694  *
1695  * @param port_id
1696  *   The port identifier of the Ethernet device.
1697  * @param tx_queue_id
1698  *   The index of the transmit queue to set up.
1699  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
1700  *   to rte_eth_dev_configure().
1701  * @param nb_tx_desc
1702  *   The number of transmit descriptors to allocate for the transmit ring.
1703  * @param socket_id
1704  *   The *socket_id* argument is the socket identifier in case of NUMA.
1705  *   Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1706  *   the DMA memory allocated for the transmit descriptors of the ring.
1707  * @param tx_conf
1708  *   The pointer to the configuration data to be used for the transmit queue.
1709  *   NULL value is allowed, in which case default TX configuration
1710  *   will be used.
1711  *   The *tx_conf* structure contains the following data:
1712  *   - The *tx_thresh* structure with the values of the Prefetch, Host, and
1713  *     Write-Back threshold registers of the transmit ring.
1714  *     When setting Write-Back threshold to the value greater then zero,
1715  *     *tx_rs_thresh* value should be explicitly set to one.
1716  *   - The *tx_free_thresh* value indicates the [minimum] number of network
1717  *     buffers that must be pending in the transmit ring to trigger their
1718  *     [implicit] freeing by the driver transmit function.
1719  *   - The *tx_rs_thresh* value indicates the [minimum] number of transmit
1720  *     descriptors that must be pending in the transmit ring before setting the
1721  *     RS bit on a descriptor by the driver transmit function.
1722  *     The *tx_rs_thresh* value should be less or equal then
1723  *     *tx_free_thresh* value, and both of them should be less then
1724  *     *nb_tx_desc* - 3.
1725  *   - The *offloads* member contains Tx offloads to be enabled.
1726  *     If an offloading set in tx_conf->offloads
1727  *     hasn't been set in the input argument eth_conf->txmode.offloads
1728  *     to rte_eth_dev_configure(), it is a new added offloading, it must be
1729  *     per-queue type and it is enabled for the queue.
1730  *     No need to repeat any bit in tx_conf->offloads which has already been
1731  *     enabled in rte_eth_dev_configure() at port level. An offloading enabled
1732  *     at port level can't be disabled at queue level.
1733  *
1734  *     Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces
1735  *     the transmit function to use default values.
1736  * @return
1737  *   - 0: Success, the transmit queue is correctly set up.
1738  *   - -ENOMEM: Unable to allocate the transmit ring descriptors.
1739  */
1740 int rte_eth_tx_queue_setup(uint16_t port_id, uint16_t tx_queue_id,
1741                 uint16_t nb_tx_desc, unsigned int socket_id,
1742                 const struct rte_eth_txconf *tx_conf);
1743
1744 /**
1745  * Return the NUMA socket to which an Ethernet device is connected
1746  *
1747  * @param port_id
1748  *   The port identifier of the Ethernet device
1749  * @return
1750  *   The NUMA socket id to which the Ethernet device is connected or
1751  *   a default of zero if the socket could not be determined.
1752  *   -1 is returned is the port_id value is out of range.
1753  */
1754 int rte_eth_dev_socket_id(uint16_t port_id);
1755
1756 /**
1757  * Check if port_id of device is attached
1758  *
1759  * @param port_id
1760  *   The port identifier of the Ethernet device
1761  * @return
1762  *   - 0 if port is out of range or not attached
1763  *   - 1 if device is attached
1764  */
1765 int rte_eth_dev_is_valid_port(uint16_t port_id);
1766
1767 /**
1768  * Start specified RX queue of a port. It is used when rx_deferred_start
1769  * flag of the specified queue is true.
1770  *
1771  * @param port_id
1772  *   The port identifier of the Ethernet device
1773  * @param rx_queue_id
1774  *   The index of the rx queue to update the ring.
1775  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
1776  *   to rte_eth_dev_configure().
1777  * @return
1778  *   - 0: Success, the receive queue is started.
1779  *   - -EINVAL: The port_id or the queue_id out of range.
1780  *   - -EIO: if device is removed.
1781  *   - -ENOTSUP: The function not supported in PMD driver.
1782  */
1783 int rte_eth_dev_rx_queue_start(uint16_t port_id, uint16_t rx_queue_id);
1784
1785 /**
1786  * Stop specified RX queue of a port
1787  *
1788  * @param port_id
1789  *   The port identifier of the Ethernet device
1790  * @param rx_queue_id
1791  *   The index of the rx queue to update the ring.
1792  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
1793  *   to rte_eth_dev_configure().
1794  * @return
1795  *   - 0: Success, the receive queue is stopped.
1796  *   - -EINVAL: The port_id or the queue_id out of range.
1797  *   - -EIO: if device is removed.
1798  *   - -ENOTSUP: The function not supported in PMD driver.
1799  */
1800 int rte_eth_dev_rx_queue_stop(uint16_t port_id, uint16_t rx_queue_id);
1801
1802 /**
1803  * Start TX for specified queue of a port. It is used when tx_deferred_start
1804  * flag of the specified queue is true.
1805  *
1806  * @param port_id
1807  *   The port identifier of the Ethernet device
1808  * @param tx_queue_id
1809  *   The index of the tx queue to update the ring.
1810  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
1811  *   to rte_eth_dev_configure().
1812  * @return
1813  *   - 0: Success, the transmit queue is started.
1814  *   - -EINVAL: The port_id or the queue_id out of range.
1815  *   - -EIO: if device is removed.
1816  *   - -ENOTSUP: The function not supported in PMD driver.
1817  */
1818 int rte_eth_dev_tx_queue_start(uint16_t port_id, uint16_t tx_queue_id);
1819
1820 /**
1821  * Stop specified TX queue of a port
1822  *
1823  * @param port_id
1824  *   The port identifier of the Ethernet device
1825  * @param tx_queue_id
1826  *   The index of the tx queue to update the ring.
1827  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
1828  *   to rte_eth_dev_configure().
1829  * @return
1830  *   - 0: Success, the transmit queue is stopped.
1831  *   - -EINVAL: The port_id or the queue_id out of range.
1832  *   - -EIO: if device is removed.
1833  *   - -ENOTSUP: The function not supported in PMD driver.
1834  */
1835 int rte_eth_dev_tx_queue_stop(uint16_t port_id, uint16_t tx_queue_id);
1836
1837 /**
1838  * Start an Ethernet device.
1839  *
1840  * The device start step is the last one and consists of setting the configured
1841  * offload features and in starting the transmit and the receive units of the
1842  * device.
1843  *
1844  * Device RTE_ETH_DEV_NOLIVE_MAC_ADDR flag causes MAC address to be set before
1845  * PMD port start callback function is invoked.
1846  *
1847  * On success, all basic functions exported by the Ethernet API (link status,
1848  * receive/transmit, and so on) can be invoked.
1849  *
1850  * @param port_id
1851  *   The port identifier of the Ethernet device.
1852  * @return
1853  *   - 0: Success, Ethernet device started.
1854  *   - <0: Error code of the driver device start function.
1855  */
1856 int rte_eth_dev_start(uint16_t port_id);
1857
1858 /**
1859  * Stop an Ethernet device. The device can be restarted with a call to
1860  * rte_eth_dev_start()
1861  *
1862  * @param port_id
1863  *   The port identifier of the Ethernet device.
1864  */
1865 void rte_eth_dev_stop(uint16_t port_id);
1866
1867 /**
1868  * Link up an Ethernet device.
1869  *
1870  * Set device link up will re-enable the device rx/tx
1871  * functionality after it is previously set device linked down.
1872  *
1873  * @param port_id
1874  *   The port identifier of the Ethernet device.
1875  * @return
1876  *   - 0: Success, Ethernet device linked up.
1877  *   - <0: Error code of the driver device link up function.
1878  */
1879 int rte_eth_dev_set_link_up(uint16_t port_id);
1880
1881 /**
1882  * Link down an Ethernet device.
1883  * The device rx/tx functionality will be disabled if success,
1884  * and it can be re-enabled with a call to
1885  * rte_eth_dev_set_link_up()
1886  *
1887  * @param port_id
1888  *   The port identifier of the Ethernet device.
1889  */
1890 int rte_eth_dev_set_link_down(uint16_t port_id);
1891
1892 /**
1893  * Close a stopped Ethernet device. The device cannot be restarted!
1894  * The function frees all port resources if the driver supports
1895  * the flag RTE_ETH_DEV_CLOSE_REMOVE.
1896  *
1897  * @param port_id
1898  *   The port identifier of the Ethernet device.
1899  */
1900 void rte_eth_dev_close(uint16_t port_id);
1901
1902 /**
1903  * Reset a Ethernet device and keep its port id.
1904  *
1905  * When a port has to be reset passively, the DPDK application can invoke
1906  * this function. For example when a PF is reset, all its VFs should also
1907  * be reset. Normally a DPDK application can invoke this function when
1908  * RTE_ETH_EVENT_INTR_RESET event is detected, but can also use it to start
1909  * a port reset in other circumstances.
1910  *
1911  * When this function is called, it first stops the port and then calls the
1912  * PMD specific dev_uninit( ) and dev_init( ) to return the port to initial
1913  * state, in which no Tx and Rx queues are setup, as if the port has been
1914  * reset and not started. The port keeps the port id it had before the
1915  * function call.
1916  *
1917  * After calling rte_eth_dev_reset( ), the application should use
1918  * rte_eth_dev_configure( ), rte_eth_rx_queue_setup( ),
1919  * rte_eth_tx_queue_setup( ), and rte_eth_dev_start( )
1920  * to reconfigure the device as appropriate.
1921  *
1922  * Note: To avoid unexpected behavior, the application should stop calling
1923  * Tx and Rx functions before calling rte_eth_dev_reset( ). For thread
1924  * safety, all these controlling functions should be called from the same
1925  * thread.
1926  *
1927  * @param port_id
1928  *   The port identifier of the Ethernet device.
1929  *
1930  * @return
1931  *   - (0) if successful.
1932  *   - (-EINVAL) if port identifier is invalid.
1933  *   - (-ENOTSUP) if hardware doesn't support this function.
1934  *   - (-EPERM) if not ran from the primary process.
1935  *   - (-EIO) if re-initialisation failed or device is removed.
1936  *   - (-ENOMEM) if the reset failed due to OOM.
1937  *   - (-EAGAIN) if the reset temporarily failed and should be retried later.
1938  */
1939 int rte_eth_dev_reset(uint16_t port_id);
1940
1941 /**
1942  * Enable receipt in promiscuous mode for an Ethernet device.
1943  *
1944  * @param port_id
1945  *   The port identifier of the Ethernet device.
1946  */
1947 void rte_eth_promiscuous_enable(uint16_t port_id);
1948
1949 /**
1950  * Disable receipt in promiscuous mode for an Ethernet device.
1951  *
1952  * @param port_id
1953  *   The port identifier of the Ethernet device.
1954  */
1955 void rte_eth_promiscuous_disable(uint16_t port_id);
1956
1957 /**
1958  * Return the value of promiscuous mode for an Ethernet device.
1959  *
1960  * @param port_id
1961  *   The port identifier of the Ethernet device.
1962  * @return
1963  *   - (1) if promiscuous is enabled
1964  *   - (0) if promiscuous is disabled.
1965  *   - (-1) on error
1966  */
1967 int rte_eth_promiscuous_get(uint16_t port_id);
1968
1969 /**
1970  * Enable the receipt of any multicast frame by an Ethernet device.
1971  *
1972  * @param port_id
1973  *   The port identifier of the Ethernet device.
1974  */
1975 void rte_eth_allmulticast_enable(uint16_t port_id);
1976
1977 /**
1978  * Disable the receipt of all multicast frames by an Ethernet device.
1979  *
1980  * @param port_id
1981  *   The port identifier of the Ethernet device.
1982  */
1983 void rte_eth_allmulticast_disable(uint16_t port_id);
1984
1985 /**
1986  * Return the value of allmulticast mode for an Ethernet device.
1987  *
1988  * @param port_id
1989  *   The port identifier of the Ethernet device.
1990  * @return
1991  *   - (1) if allmulticast is enabled
1992  *   - (0) if allmulticast is disabled.
1993  *   - (-1) on error
1994  */
1995 int rte_eth_allmulticast_get(uint16_t port_id);
1996
1997 /**
1998  * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
1999  * or FULL-DUPLEX) of the physical link of an Ethernet device. It might need
2000  * to wait up to 9 seconds in it.
2001  *
2002  * @param port_id
2003  *   The port identifier of the Ethernet device.
2004  * @param link
2005  *   A pointer to an *rte_eth_link* structure to be filled with
2006  *   the status, the speed and the mode of the Ethernet device link.
2007  */
2008 void rte_eth_link_get(uint16_t port_id, struct rte_eth_link *link);
2009
2010 /**
2011  * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
2012  * or FULL-DUPLEX) of the physical link of an Ethernet device. It is a no-wait
2013  * version of rte_eth_link_get().
2014  *
2015  * @param port_id
2016  *   The port identifier of the Ethernet device.
2017  * @param link
2018  *   A pointer to an *rte_eth_link* structure to be filled with
2019  *   the status, the speed and the mode of the Ethernet device link.
2020  */
2021 void rte_eth_link_get_nowait(uint16_t port_id, struct rte_eth_link *link);
2022
2023 /**
2024  * Retrieve the general I/O statistics of an Ethernet device.
2025  *
2026  * @param port_id
2027  *   The port identifier of the Ethernet device.
2028  * @param stats
2029  *   A pointer to a structure of type *rte_eth_stats* to be filled with
2030  *   the values of device counters for the following set of statistics:
2031  *   - *ipackets* with the total of successfully received packets.
2032  *   - *opackets* with the total of successfully transmitted packets.
2033  *   - *ibytes*   with the total of successfully received bytes.
2034  *   - *obytes*   with the total of successfully transmitted bytes.
2035  *   - *ierrors*  with the total of erroneous received packets.
2036  *   - *oerrors*  with the total of failed transmitted packets.
2037  * @return
2038  *   Zero if successful. Non-zero otherwise.
2039  */
2040 int rte_eth_stats_get(uint16_t port_id, struct rte_eth_stats *stats);
2041
2042 /**
2043  * Reset the general I/O statistics of an Ethernet device.
2044  *
2045  * @param port_id
2046  *   The port identifier of the Ethernet device.
2047  * @return
2048  *   - (0) if device notified to reset stats.
2049  *   - (-ENOTSUP) if hardware doesn't support.
2050  *   - (-ENODEV) if *port_id* invalid.
2051  */
2052 int rte_eth_stats_reset(uint16_t port_id);
2053
2054 /**
2055  * Retrieve names of extended statistics of an Ethernet device.
2056  *
2057  * There is an assumption that 'xstat_names' and 'xstats' arrays are matched
2058  * by array index:
2059  *  xstats_names[i].name => xstats[i].value
2060  *
2061  * And the array index is same with id field of 'struct rte_eth_xstat':
2062  *  xstats[i].id == i
2063  *
2064  * This assumption makes key-value pair matching less flexible but simpler.
2065  *
2066  * @param port_id
2067  *   The port identifier of the Ethernet device.
2068  * @param xstats_names
2069  *   An rte_eth_xstat_name array of at least *size* elements to
2070  *   be filled. If set to NULL, the function returns the required number
2071  *   of elements.
2072  * @param size
2073  *   The size of the xstats_names array (number of elements).
2074  * @return
2075  *   - A positive value lower or equal to size: success. The return value
2076  *     is the number of entries filled in the stats table.
2077  *   - A positive value higher than size: error, the given statistics table
2078  *     is too small. The return value corresponds to the size that should
2079  *     be given to succeed. The entries in the table are not valid and
2080  *     shall not be used by the caller.
2081  *   - A negative value on error (invalid port id).
2082  */
2083 int rte_eth_xstats_get_names(uint16_t port_id,
2084                 struct rte_eth_xstat_name *xstats_names,
2085                 unsigned int size);
2086
2087 /**
2088  * Retrieve extended statistics of an Ethernet device.
2089  *
2090  * There is an assumption that 'xstat_names' and 'xstats' arrays are matched
2091  * by array index:
2092  *  xstats_names[i].name => xstats[i].value
2093  *
2094  * And the array index is same with id field of 'struct rte_eth_xstat':
2095  *  xstats[i].id == i
2096  *
2097  * This assumption makes key-value pair matching less flexible but simpler.
2098  *
2099  * @param port_id
2100  *   The port identifier of the Ethernet device.
2101  * @param xstats
2102  *   A pointer to a table of structure of type *rte_eth_xstat*
2103  *   to be filled with device statistics ids and values.
2104  *   This parameter can be set to NULL if n is 0.
2105  * @param n
2106  *   The size of the xstats array (number of elements).
2107  * @return
2108  *   - A positive value lower or equal to n: success. The return value
2109  *     is the number of entries filled in the stats table.
2110  *   - A positive value higher than n: error, the given statistics table
2111  *     is too small. The return value corresponds to the size that should
2112  *     be given to succeed. The entries in the table are not valid and
2113  *     shall not be used by the caller.
2114  *   - A negative value on error (invalid port id).
2115  */
2116 int rte_eth_xstats_get(uint16_t port_id, struct rte_eth_xstat *xstats,
2117                 unsigned int n);
2118
2119 /**
2120  * Retrieve names of extended statistics of an Ethernet device.
2121  *
2122  * @param port_id
2123  *   The port identifier of the Ethernet device.
2124  * @param xstats_names
2125  *   An rte_eth_xstat_name array of at least *size* elements to
2126  *   be filled. If set to NULL, the function returns the required number
2127  *   of elements.
2128  * @param ids
2129  *   IDs array given by app to retrieve specific statistics
2130  * @param size
2131  *   The size of the xstats_names array (number of elements).
2132  * @return
2133  *   - A positive value lower or equal to size: success. The return value
2134  *     is the number of entries filled in the stats table.
2135  *   - A positive value higher than size: error, the given statistics table
2136  *     is too small. The return value corresponds to the size that should
2137  *     be given to succeed. The entries in the table are not valid and
2138  *     shall not be used by the caller.
2139  *   - A negative value on error (invalid port id).
2140  */
2141 int
2142 rte_eth_xstats_get_names_by_id(uint16_t port_id,
2143         struct rte_eth_xstat_name *xstats_names, unsigned int size,
2144         uint64_t *ids);
2145
2146 /**
2147  * Retrieve extended statistics of an Ethernet device.
2148  *
2149  * @param port_id
2150  *   The port identifier of the Ethernet device.
2151  * @param ids
2152  *   A pointer to an ids array passed by application. This tells which
2153  *   statistics values function should retrieve. This parameter
2154  *   can be set to NULL if size is 0. In this case function will retrieve
2155  *   all avalible statistics.
2156  * @param values
2157  *   A pointer to a table to be filled with device statistics values.
2158  * @param size
2159  *   The size of the ids array (number of elements).
2160  * @return
2161  *   - A positive value lower or equal to size: success. The return value
2162  *     is the number of entries filled in the stats table.
2163  *   - A positive value higher than size: error, the given statistics table
2164  *     is too small. The return value corresponds to the size that should
2165  *     be given to succeed. The entries in the table are not valid and
2166  *     shall not be used by the caller.
2167  *   - A negative value on error (invalid port id).
2168  */
2169 int rte_eth_xstats_get_by_id(uint16_t port_id, const uint64_t *ids,
2170                              uint64_t *values, unsigned int size);
2171
2172 /**
2173  * Gets the ID of a statistic from its name.
2174  *
2175  * This function searches for the statistics using string compares, and
2176  * as such should not be used on the fast-path. For fast-path retrieval of
2177  * specific statistics, store the ID as provided in *id* from this function,
2178  * and pass the ID to rte_eth_xstats_get()
2179  *
2180  * @param port_id The port to look up statistics from
2181  * @param xstat_name The name of the statistic to return
2182  * @param[out] id A pointer to an app-supplied uint64_t which should be
2183  *                set to the ID of the stat if the stat exists.
2184  * @return
2185  *    0 on success
2186  *    -ENODEV for invalid port_id,
2187  *    -EIO if device is removed,
2188  *    -EINVAL if the xstat_name doesn't exist in port_id
2189  */
2190 int rte_eth_xstats_get_id_by_name(uint16_t port_id, const char *xstat_name,
2191                 uint64_t *id);
2192
2193 /**
2194  * Reset extended statistics of an Ethernet device.
2195  *
2196  * @param port_id
2197  *   The port identifier of the Ethernet device.
2198  */
2199 void rte_eth_xstats_reset(uint16_t port_id);
2200
2201 /**
2202  *  Set a mapping for the specified transmit queue to the specified per-queue
2203  *  statistics counter.
2204  *
2205  * @param port_id
2206  *   The port identifier of the Ethernet device.
2207  * @param tx_queue_id
2208  *   The index of the transmit queue for which a queue stats mapping is required.
2209  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
2210  *   to rte_eth_dev_configure().
2211  * @param stat_idx
2212  *   The per-queue packet statistics functionality number that the transmit
2213  *   queue is to be assigned.
2214  *   The value must be in the range [0, RTE_ETHDEV_QUEUE_STAT_CNTRS - 1].
2215  * @return
2216  *   Zero if successful. Non-zero otherwise.
2217  */
2218 int rte_eth_dev_set_tx_queue_stats_mapping(uint16_t port_id,
2219                 uint16_t tx_queue_id, uint8_t stat_idx);
2220
2221 /**
2222  *  Set a mapping for the specified receive queue to the specified per-queue
2223  *  statistics counter.
2224  *
2225  * @param port_id
2226  *   The port identifier of the Ethernet device.
2227  * @param rx_queue_id
2228  *   The index of the receive queue for which a queue stats mapping is required.
2229  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
2230  *   to rte_eth_dev_configure().
2231  * @param stat_idx
2232  *   The per-queue packet statistics functionality number that the receive
2233  *   queue is to be assigned.
2234  *   The value must be in the range [0, RTE_ETHDEV_QUEUE_STAT_CNTRS - 1].
2235  * @return
2236  *   Zero if successful. Non-zero otherwise.
2237  */
2238 int rte_eth_dev_set_rx_queue_stats_mapping(uint16_t port_id,
2239                                            uint16_t rx_queue_id,
2240                                            uint8_t stat_idx);
2241
2242 /**
2243  * Retrieve the Ethernet address of an Ethernet device.
2244  *
2245  * @param port_id
2246  *   The port identifier of the Ethernet device.
2247  * @param mac_addr
2248  *   A pointer to a structure of type *ether_addr* to be filled with
2249  *   the Ethernet address of the Ethernet device.
2250  */
2251 void rte_eth_macaddr_get(uint16_t port_id, struct ether_addr *mac_addr);
2252
2253 /**
2254  * Retrieve the contextual information of an Ethernet device.
2255  *
2256  * @param port_id
2257  *   The port identifier of the Ethernet device.
2258  * @param dev_info
2259  *   A pointer to a structure of type *rte_eth_dev_info* to be filled with
2260  *   the contextual information of the Ethernet device.
2261  */
2262 void rte_eth_dev_info_get(uint16_t port_id, struct rte_eth_dev_info *dev_info);
2263
2264 /**
2265  * Retrieve the firmware version of a device.
2266  *
2267  * @param port_id
2268  *   The port identifier of the device.
2269  * @param fw_version
2270  *   A pointer to a string array storing the firmware version of a device,
2271  *   the string includes terminating null. This pointer is allocated by caller.
2272  * @param fw_size
2273  *   The size of the string array pointed by fw_version, which should be
2274  *   large enough to store firmware version of the device.
2275  * @return
2276  *   - (0) if successful.
2277  *   - (-ENOTSUP) if operation is not supported.
2278  *   - (-ENODEV) if *port_id* invalid.
2279  *   - (-EIO) if device is removed.
2280  *   - (>0) if *fw_size* is not enough to store firmware version, return
2281  *          the size of the non truncated string.
2282  */
2283 int rte_eth_dev_fw_version_get(uint16_t port_id,
2284                                char *fw_version, size_t fw_size);
2285
2286 /**
2287  * Retrieve the supported packet types of an Ethernet device.
2288  *
2289  * When a packet type is announced as supported, it *must* be recognized by
2290  * the PMD. For instance, if RTE_PTYPE_L2_ETHER, RTE_PTYPE_L2_ETHER_VLAN
2291  * and RTE_PTYPE_L3_IPV4 are announced, the PMD must return the following
2292  * packet types for these packets:
2293  * - Ether/IPv4              -> RTE_PTYPE_L2_ETHER | RTE_PTYPE_L3_IPV4
2294  * - Ether/Vlan/IPv4         -> RTE_PTYPE_L2_ETHER_VLAN | RTE_PTYPE_L3_IPV4
2295  * - Ether/[anything else]   -> RTE_PTYPE_L2_ETHER
2296  * - Ether/Vlan/[anything else] -> RTE_PTYPE_L2_ETHER_VLAN
2297  *
2298  * When a packet is received by a PMD, the most precise type must be
2299  * returned among the ones supported. However a PMD is allowed to set
2300  * packet type that is not in the supported list, at the condition that it
2301  * is more precise. Therefore, a PMD announcing no supported packet types
2302  * can still set a matching packet type in a received packet.
2303  *
2304  * @note
2305  *   Better to invoke this API after the device is already started or rx burst
2306  *   function is decided, to obtain correct supported ptypes.
2307  * @note
2308  *   if a given PMD does not report what ptypes it supports, then the supported
2309  *   ptype count is reported as 0.
2310  * @param port_id
2311  *   The port identifier of the Ethernet device.
2312  * @param ptype_mask
2313  *   A hint of what kind of packet type which the caller is interested in.
2314  * @param ptypes
2315  *   An array pointer to store adequate packet types, allocated by caller.
2316  * @param num
2317  *  Size of the array pointed by param ptypes.
2318  * @return
2319  *   - (>=0) Number of supported ptypes. If the number of types exceeds num,
2320  *           only num entries will be filled into the ptypes array, but the full
2321  *           count of supported ptypes will be returned.
2322  *   - (-ENODEV) if *port_id* invalid.
2323  */
2324 int rte_eth_dev_get_supported_ptypes(uint16_t port_id, uint32_t ptype_mask,
2325                                      uint32_t *ptypes, int num);
2326
2327 /**
2328  * Retrieve the MTU of an Ethernet device.
2329  *
2330  * @param port_id
2331  *   The port identifier of the Ethernet device.
2332  * @param mtu
2333  *   A pointer to a uint16_t where the retrieved MTU is to be stored.
2334  * @return
2335  *   - (0) if successful.
2336  *   - (-ENODEV) if *port_id* invalid.
2337  */
2338 int rte_eth_dev_get_mtu(uint16_t port_id, uint16_t *mtu);
2339
2340 /**
2341  * Change the MTU of an Ethernet device.
2342  *
2343  * @param port_id
2344  *   The port identifier of the Ethernet device.
2345  * @param mtu
2346  *   A uint16_t for the MTU to be applied.
2347  * @return
2348  *   - (0) if successful.
2349  *   - (-ENOTSUP) if operation is not supported.
2350  *   - (-ENODEV) if *port_id* invalid.
2351  *   - (-EIO) if device is removed.
2352  *   - (-EINVAL) if *mtu* invalid.
2353  *   - (-EBUSY) if operation is not allowed when the port is running
2354  */
2355 int rte_eth_dev_set_mtu(uint16_t port_id, uint16_t mtu);
2356
2357 /**
2358  * Enable/Disable hardware filtering by an Ethernet device of received
2359  * VLAN packets tagged with a given VLAN Tag Identifier.
2360  *
2361  * @param port_id
2362  *   The port identifier of the Ethernet device.
2363  * @param vlan_id
2364  *   The VLAN Tag Identifier whose filtering must be enabled or disabled.
2365  * @param on
2366  *   If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*.
2367  *   Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*.
2368  * @return
2369  *   - (0) if successful.
2370  *   - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2371  *   - (-ENODEV) if *port_id* invalid.
2372  *   - (-EIO) if device is removed.
2373  *   - (-ENOSYS) if VLAN filtering on *port_id* disabled.
2374  *   - (-EINVAL) if *vlan_id* > 4095.
2375  */
2376 int rte_eth_dev_vlan_filter(uint16_t port_id, uint16_t vlan_id, int on);
2377
2378 /**
2379  * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
2380  * 82599/X540/X550 can support VLAN stripping at the rx queue level
2381  *
2382  * @param port_id
2383  *   The port identifier of the Ethernet device.
2384  * @param rx_queue_id
2385  *   The index of the receive queue for which a queue stats mapping is required.
2386  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
2387  *   to rte_eth_dev_configure().
2388  * @param on
2389  *   If 1, Enable VLAN Stripping of the receive queue of the Ethernet port.
2390  *   If 0, Disable VLAN Stripping of the receive queue of the Ethernet port.
2391  * @return
2392  *   - (0) if successful.
2393  *   - (-ENOSUP) if hardware-assisted VLAN stripping not configured.
2394  *   - (-ENODEV) if *port_id* invalid.
2395  *   - (-EINVAL) if *rx_queue_id* invalid.
2396  */
2397 int rte_eth_dev_set_vlan_strip_on_queue(uint16_t port_id, uint16_t rx_queue_id,
2398                 int on);
2399
2400 /**
2401  * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
2402  * the VLAN Header. This is a register setup available on some Intel NIC, not
2403  * but all, please check the data sheet for availability.
2404  *
2405  * @param port_id
2406  *   The port identifier of the Ethernet device.
2407  * @param vlan_type
2408  *   The vlan type.
2409  * @param tag_type
2410  *   The Tag Protocol ID
2411  * @return
2412  *   - (0) if successful.
2413  *   - (-ENOSUP) if hardware-assisted VLAN TPID setup is not supported.
2414  *   - (-ENODEV) if *port_id* invalid.
2415  *   - (-EIO) if device is removed.
2416  */
2417 int rte_eth_dev_set_vlan_ether_type(uint16_t port_id,
2418                                     enum rte_vlan_type vlan_type,
2419                                     uint16_t tag_type);
2420
2421 /**
2422  * Set VLAN offload configuration on an Ethernet device
2423  * Enable/Disable Extended VLAN by an Ethernet device, This is a register setup
2424  * available on some Intel NIC, not but all, please check the data sheet for
2425  * availability.
2426  * Enable/Disable VLAN Strip can be done on rx queue for certain NIC, but here
2427  * the configuration is applied on the port level.
2428  *
2429  * @param port_id
2430  *   The port identifier of the Ethernet device.
2431  * @param offload_mask
2432  *   The VLAN Offload bit mask can be mixed use with "OR"
2433  *       ETH_VLAN_STRIP_OFFLOAD
2434  *       ETH_VLAN_FILTER_OFFLOAD
2435  *       ETH_VLAN_EXTEND_OFFLOAD
2436  * @return
2437  *   - (0) if successful.
2438  *   - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2439  *   - (-ENODEV) if *port_id* invalid.
2440  *   - (-EIO) if device is removed.
2441  */
2442 int rte_eth_dev_set_vlan_offload(uint16_t port_id, int offload_mask);
2443
2444 /**
2445  * Read VLAN Offload configuration from an Ethernet device
2446  *
2447  * @param port_id
2448  *   The port identifier of the Ethernet device.
2449  * @return
2450  *   - (>0) if successful. Bit mask to indicate
2451  *       ETH_VLAN_STRIP_OFFLOAD
2452  *       ETH_VLAN_FILTER_OFFLOAD
2453  *       ETH_VLAN_EXTEND_OFFLOAD
2454  *   - (-ENODEV) if *port_id* invalid.
2455  */
2456 int rte_eth_dev_get_vlan_offload(uint16_t port_id);
2457
2458 /**
2459  * Set port based TX VLAN insertion on or off.
2460  *
2461  * @param port_id
2462  *  The port identifier of the Ethernet device.
2463  * @param pvid
2464  *  Port based TX VLAN identifier together with user priority.
2465  * @param on
2466  *  Turn on or off the port based TX VLAN insertion.
2467  *
2468  * @return
2469  *   - (0) if successful.
2470  *   - negative if failed.
2471  */
2472 int rte_eth_dev_set_vlan_pvid(uint16_t port_id, uint16_t pvid, int on);
2473
2474 typedef void (*buffer_tx_error_fn)(struct rte_mbuf **unsent, uint16_t count,
2475                 void *userdata);
2476
2477 /**
2478  * Structure used to buffer packets for future TX
2479  * Used by APIs rte_eth_tx_buffer and rte_eth_tx_buffer_flush
2480  */
2481 struct rte_eth_dev_tx_buffer {
2482         buffer_tx_error_fn error_callback;
2483         void *error_userdata;
2484         uint16_t size;           /**< Size of buffer for buffered tx */
2485         uint16_t length;         /**< Number of packets in the array */
2486         struct rte_mbuf *pkts[];
2487         /**< Pending packets to be sent on explicit flush or when full */
2488 };
2489
2490 /**
2491  * Calculate the size of the tx buffer.
2492  *
2493  * @param sz
2494  *   Number of stored packets.
2495  */
2496 #define RTE_ETH_TX_BUFFER_SIZE(sz) \
2497         (sizeof(struct rte_eth_dev_tx_buffer) + (sz) * sizeof(struct rte_mbuf *))
2498
2499 /**
2500  * Initialize default values for buffered transmitting
2501  *
2502  * @param buffer
2503  *   Tx buffer to be initialized.
2504  * @param size
2505  *   Buffer size
2506  * @return
2507  *   0 if no error
2508  */
2509 int
2510 rte_eth_tx_buffer_init(struct rte_eth_dev_tx_buffer *buffer, uint16_t size);
2511
2512 /**
2513  * Configure a callback for buffered packets which cannot be sent
2514  *
2515  * Register a specific callback to be called when an attempt is made to send
2516  * all packets buffered on an ethernet port, but not all packets can
2517  * successfully be sent. The callback registered here will be called only
2518  * from calls to rte_eth_tx_buffer() and rte_eth_tx_buffer_flush() APIs.
2519  * The default callback configured for each queue by default just frees the
2520  * packets back to the calling mempool. If additional behaviour is required,
2521  * for example, to count dropped packets, or to retry transmission of packets
2522  * which cannot be sent, this function should be used to register a suitable
2523  * callback function to implement the desired behaviour.
2524  * The example callback "rte_eth_count_unsent_packet_callback()" is also
2525  * provided as reference.
2526  *
2527  * @param buffer
2528  *   The port identifier of the Ethernet device.
2529  * @param callback
2530  *   The function to be used as the callback.
2531  * @param userdata
2532  *   Arbitrary parameter to be passed to the callback function
2533  * @return
2534  *   0 on success, or -1 on error with rte_errno set appropriately
2535  */
2536 int
2537 rte_eth_tx_buffer_set_err_callback(struct rte_eth_dev_tx_buffer *buffer,
2538                 buffer_tx_error_fn callback, void *userdata);
2539
2540 /**
2541  * Callback function for silently dropping unsent buffered packets.
2542  *
2543  * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
2544  * adjust the default behavior when buffered packets cannot be sent. This
2545  * function drops any unsent packets silently and is used by tx buffered
2546  * operations as default behavior.
2547  *
2548  * NOTE: this function should not be called directly, instead it should be used
2549  *       as a callback for packet buffering.
2550  *
2551  * NOTE: when configuring this function as a callback with
2552  *       rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
2553  *       should point to an uint64_t value.
2554  *
2555  * @param pkts
2556  *   The previously buffered packets which could not be sent
2557  * @param unsent
2558  *   The number of unsent packets in the pkts array
2559  * @param userdata
2560  *   Not used
2561  */
2562 void
2563 rte_eth_tx_buffer_drop_callback(struct rte_mbuf **pkts, uint16_t unsent,
2564                 void *userdata);
2565
2566 /**
2567  * Callback function for tracking unsent buffered packets.
2568  *
2569  * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
2570  * adjust the default behavior when buffered packets cannot be sent. This
2571  * function drops any unsent packets, but also updates a user-supplied counter
2572  * to track the overall number of packets dropped. The counter should be an
2573  * uint64_t variable.
2574  *
2575  * NOTE: this function should not be called directly, instead it should be used
2576  *       as a callback for packet buffering.
2577  *
2578  * NOTE: when configuring this function as a callback with
2579  *       rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
2580  *       should point to an uint64_t value.
2581  *
2582  * @param pkts
2583  *   The previously buffered packets which could not be sent
2584  * @param unsent
2585  *   The number of unsent packets in the pkts array
2586  * @param userdata
2587  *   Pointer to an uint64_t value, which will be incremented by unsent
2588  */
2589 void
2590 rte_eth_tx_buffer_count_callback(struct rte_mbuf **pkts, uint16_t unsent,
2591                 void *userdata);
2592
2593 /**
2594  * Request the driver to free mbufs currently cached by the driver. The
2595  * driver will only free the mbuf if it is no longer in use. It is the
2596  * application's responsibity to ensure rte_eth_tx_buffer_flush(..) is
2597  * called if needed.
2598  *
2599  * @param port_id
2600  *   The port identifier of the Ethernet device.
2601  * @param queue_id
2602  *   The index of the transmit queue through which output packets must be
2603  *   sent.
2604  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
2605  *   to rte_eth_dev_configure().
2606  * @param free_cnt
2607  *   Maximum number of packets to free. Use 0 to indicate all possible packets
2608  *   should be freed. Note that a packet may be using multiple mbufs.
2609  * @return
2610  *   Failure: < 0
2611  *     -ENODEV: Invalid interface
2612  *     -EIO: device is removed
2613  *     -ENOTSUP: Driver does not support function
2614  *   Success: >= 0
2615  *     0-n: Number of packets freed. More packets may still remain in ring that
2616  *     are in use.
2617  */
2618 int
2619 rte_eth_tx_done_cleanup(uint16_t port_id, uint16_t queue_id, uint32_t free_cnt);
2620
2621 /**
2622  * Subtypes for IPsec offload event(@ref RTE_ETH_EVENT_IPSEC) raised by
2623  * eth device.
2624  */
2625 enum rte_eth_event_ipsec_subtype {
2626         RTE_ETH_EVENT_IPSEC_UNKNOWN = 0,
2627                         /**< Unknown event type */
2628         RTE_ETH_EVENT_IPSEC_ESN_OVERFLOW,
2629                         /**< Sequence number overflow */
2630         RTE_ETH_EVENT_IPSEC_SA_TIME_EXPIRY,
2631                         /**< Soft time expiry of SA */
2632         RTE_ETH_EVENT_IPSEC_SA_BYTE_EXPIRY,
2633                         /**< Soft byte expiry of SA */
2634         RTE_ETH_EVENT_IPSEC_MAX
2635                         /**< Max value of this enum */
2636 };
2637
2638 /**
2639  * Descriptor for @ref RTE_ETH_EVENT_IPSEC event. Used by eth dev to send extra
2640  * information of the IPsec offload event.
2641  */
2642 struct rte_eth_event_ipsec_desc {
2643         enum rte_eth_event_ipsec_subtype subtype;
2644                         /**< Type of RTE_ETH_EVENT_IPSEC_* event */
2645         uint64_t metadata;
2646                         /**< Event specific metadata
2647                          *
2648                          * For the following events, *userdata* registered
2649                          * with the *rte_security_session* would be returned
2650                          * as metadata,
2651                          *
2652                          * - @ref RTE_ETH_EVENT_IPSEC_ESN_OVERFLOW
2653                          * - @ref RTE_ETH_EVENT_IPSEC_SA_TIME_EXPIRY
2654                          * - @ref RTE_ETH_EVENT_IPSEC_SA_BYTE_EXPIRY
2655                          *
2656                          * @see struct rte_security_session_conf
2657                          *
2658                          */
2659 };
2660
2661 /**
2662  * The eth device event type for interrupt, and maybe others in the future.
2663  */
2664 enum rte_eth_event_type {
2665         RTE_ETH_EVENT_UNKNOWN,  /**< unknown event type */
2666         RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
2667         RTE_ETH_EVENT_QUEUE_STATE,
2668                                 /**< queue state event (enabled/disabled) */
2669         RTE_ETH_EVENT_INTR_RESET,
2670                         /**< reset interrupt event, sent to VF on PF reset */
2671         RTE_ETH_EVENT_VF_MBOX,  /**< message from the VF received by PF */
2672         RTE_ETH_EVENT_MACSEC,   /**< MACsec offload related event */
2673         RTE_ETH_EVENT_INTR_RMV, /**< device removal event */
2674         RTE_ETH_EVENT_NEW,      /**< port is probed */
2675         RTE_ETH_EVENT_DESTROY,  /**< port is released */
2676         RTE_ETH_EVENT_IPSEC,    /**< IPsec offload related event */
2677         RTE_ETH_EVENT_MAX       /**< max value of this enum */
2678 };
2679
2680 typedef int (*rte_eth_dev_cb_fn)(uint16_t port_id,
2681                 enum rte_eth_event_type event, void *cb_arg, void *ret_param);
2682 /**< user application callback to be registered for interrupts */
2683
2684 /**
2685  * Register a callback function for port event.
2686  *
2687  * @param port_id
2688  *  Port id.
2689  *  RTE_ETH_ALL means register the event for all port ids.
2690  * @param event
2691  *  Event interested.
2692  * @param cb_fn
2693  *  User supplied callback function to be called.
2694  * @param cb_arg
2695  *  Pointer to the parameters for the registered callback.
2696  *
2697  * @return
2698  *  - On success, zero.
2699  *  - On failure, a negative value.
2700  */
2701 int rte_eth_dev_callback_register(uint16_t port_id,
2702                         enum rte_eth_event_type event,
2703                 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
2704
2705 /**
2706  * Unregister a callback function for port event.
2707  *
2708  * @param port_id
2709  *  Port id.
2710  *  RTE_ETH_ALL means unregister the event for all port ids.
2711  * @param event
2712  *  Event interested.
2713  * @param cb_fn
2714  *  User supplied callback function to be called.
2715  * @param cb_arg
2716  *  Pointer to the parameters for the registered callback. -1 means to
2717  *  remove all for the same callback address and same event.
2718  *
2719  * @return
2720  *  - On success, zero.
2721  *  - On failure, a negative value.
2722  */
2723 int rte_eth_dev_callback_unregister(uint16_t port_id,
2724                         enum rte_eth_event_type event,
2725                 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
2726
2727 /**
2728  * When there is no rx packet coming in Rx Queue for a long time, we can
2729  * sleep lcore related to RX Queue for power saving, and enable rx interrupt
2730  * to be triggered when Rx packet arrives.
2731  *
2732  * The rte_eth_dev_rx_intr_enable() function enables rx queue
2733  * interrupt on specific rx queue of a port.
2734  *
2735  * @param port_id
2736  *   The port identifier of the Ethernet device.
2737  * @param queue_id
2738  *   The index of the receive queue from which to retrieve input packets.
2739  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
2740  *   to rte_eth_dev_configure().
2741  * @return
2742  *   - (0) if successful.
2743  *   - (-ENOTSUP) if underlying hardware OR driver doesn't support
2744  *     that operation.
2745  *   - (-ENODEV) if *port_id* invalid.
2746  *   - (-EIO) if device is removed.
2747  */
2748 int rte_eth_dev_rx_intr_enable(uint16_t port_id, uint16_t queue_id);
2749
2750 /**
2751  * When lcore wakes up from rx interrupt indicating packet coming, disable rx
2752  * interrupt and returns to polling mode.
2753  *
2754  * The rte_eth_dev_rx_intr_disable() function disables rx queue
2755  * interrupt on specific rx queue of a port.
2756  *
2757  * @param port_id
2758  *   The port identifier of the Ethernet device.
2759  * @param queue_id
2760  *   The index of the receive queue from which to retrieve input packets.
2761  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
2762  *   to rte_eth_dev_configure().
2763  * @return
2764  *   - (0) if successful.
2765  *   - (-ENOTSUP) if underlying hardware OR driver doesn't support
2766  *     that operation.
2767  *   - (-ENODEV) if *port_id* invalid.
2768  *   - (-EIO) if device is removed.
2769  */
2770 int rte_eth_dev_rx_intr_disable(uint16_t port_id, uint16_t queue_id);
2771
2772 /**
2773  * RX Interrupt control per port.
2774  *
2775  * @param port_id
2776  *   The port identifier of the Ethernet device.
2777  * @param epfd
2778  *   Epoll instance fd which the intr vector associated to.
2779  *   Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
2780  * @param op
2781  *   The operation be performed for the vector.
2782  *   Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
2783  * @param data
2784  *   User raw data.
2785  * @return
2786  *   - On success, zero.
2787  *   - On failure, a negative value.
2788  */
2789 int rte_eth_dev_rx_intr_ctl(uint16_t port_id, int epfd, int op, void *data);
2790
2791 /**
2792  * RX Interrupt control per queue.
2793  *
2794  * @param port_id
2795  *   The port identifier of the Ethernet device.
2796  * @param queue_id
2797  *   The index of the receive queue from which to retrieve input packets.
2798  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
2799  *   to rte_eth_dev_configure().
2800  * @param epfd
2801  *   Epoll instance fd which the intr vector associated to.
2802  *   Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
2803  * @param op
2804  *   The operation be performed for the vector.
2805  *   Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
2806  * @param data
2807  *   User raw data.
2808  * @return
2809  *   - On success, zero.
2810  *   - On failure, a negative value.
2811  */
2812 int rte_eth_dev_rx_intr_ctl_q(uint16_t port_id, uint16_t queue_id,
2813                               int epfd, int op, void *data);
2814
2815 /**
2816  * @warning
2817  * @b EXPERIMENTAL: this API may change without prior notice.
2818  *
2819  * Get interrupt fd per Rx queue.
2820  *
2821  * @param port_id
2822  *   The port identifier of the Ethernet device.
2823  * @param queue_id
2824  *   The index of the receive queue from which to retrieve input packets.
2825  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
2826  *   to rte_eth_dev_configure().
2827  * @return
2828  *   - (>=0) the interrupt fd associated to the requested Rx queue if
2829  *           successful.
2830  *   - (-1) on error.
2831  */
2832 int __rte_experimental
2833 rte_eth_dev_rx_intr_ctl_q_get_fd(uint16_t port_id, uint16_t queue_id);
2834
2835 /**
2836  * Turn on the LED on the Ethernet device.
2837  * This function turns on the LED on the Ethernet device.
2838  *
2839  * @param port_id
2840  *   The port identifier of the Ethernet device.
2841  * @return
2842  *   - (0) if successful.
2843  *   - (-ENOTSUP) if underlying hardware OR driver doesn't support
2844  *     that operation.
2845  *   - (-ENODEV) if *port_id* invalid.
2846  *   - (-EIO) if device is removed.
2847  */
2848 int  rte_eth_led_on(uint16_t port_id);
2849
2850 /**
2851  * Turn off the LED on the Ethernet device.
2852  * This function turns off the LED on the Ethernet device.
2853  *
2854  * @param port_id
2855  *   The port identifier of the Ethernet device.
2856  * @return
2857  *   - (0) if successful.
2858  *   - (-ENOTSUP) if underlying hardware OR driver doesn't support
2859  *     that operation.
2860  *   - (-ENODEV) if *port_id* invalid.
2861  *   - (-EIO) if device is removed.
2862  */
2863 int  rte_eth_led_off(uint16_t port_id);
2864
2865 /**
2866  * Get current status of the Ethernet link flow control for Ethernet device
2867  *
2868  * @param port_id
2869  *   The port identifier of the Ethernet device.
2870  * @param fc_conf
2871  *   The pointer to the structure where to store the flow control parameters.
2872  * @return
2873  *   - (0) if successful.
2874  *   - (-ENOTSUP) if hardware doesn't support flow control.
2875  *   - (-ENODEV)  if *port_id* invalid.
2876  *   - (-EIO)  if device is removed.
2877  */
2878 int rte_eth_dev_flow_ctrl_get(uint16_t port_id,
2879                               struct rte_eth_fc_conf *fc_conf);
2880
2881 /**
2882  * Configure the Ethernet link flow control for Ethernet device
2883  *
2884  * @param port_id
2885  *   The port identifier of the Ethernet device.
2886  * @param fc_conf
2887  *   The pointer to the structure of the flow control parameters.
2888  * @return
2889  *   - (0) if successful.
2890  *   - (-ENOTSUP) if hardware doesn't support flow control mode.
2891  *   - (-ENODEV)  if *port_id* invalid.
2892  *   - (-EINVAL)  if bad parameter
2893  *   - (-EIO)     if flow control setup failure or device is removed.
2894  */
2895 int rte_eth_dev_flow_ctrl_set(uint16_t port_id,
2896                               struct rte_eth_fc_conf *fc_conf);
2897
2898 /**
2899  * Configure the Ethernet priority flow control under DCB environment
2900  * for Ethernet device.
2901  *
2902  * @param port_id
2903  * The port identifier of the Ethernet device.
2904  * @param pfc_conf
2905  * The pointer to the structure of the priority flow control parameters.
2906  * @return
2907  *   - (0) if successful.
2908  *   - (-ENOTSUP) if hardware doesn't support priority flow control mode.
2909  *   - (-ENODEV)  if *port_id* invalid.
2910  *   - (-EINVAL)  if bad parameter
2911  *   - (-EIO)     if flow control setup failure or device is removed.
2912  */
2913 int rte_eth_dev_priority_flow_ctrl_set(uint16_t port_id,
2914                                 struct rte_eth_pfc_conf *pfc_conf);
2915
2916 /**
2917  * Add a MAC address to an internal array of addresses used to enable whitelist
2918  * filtering to accept packets only if the destination MAC address matches.
2919  *
2920  * @param port_id
2921  *   The port identifier of the Ethernet device.
2922  * @param mac_addr
2923  *   The MAC address to add.
2924  * @param pool
2925  *   VMDq pool index to associate address with (if VMDq is enabled). If VMDq is
2926  *   not enabled, this should be set to 0.
2927  * @return
2928  *   - (0) if successfully added or *mac_addr* was already added.
2929  *   - (-ENOTSUP) if hardware doesn't support this feature.
2930  *   - (-ENODEV) if *port* is invalid.
2931  *   - (-EIO) if device is removed.
2932  *   - (-ENOSPC) if no more MAC addresses can be added.
2933  *   - (-EINVAL) if MAC address is invalid.
2934  */
2935 int rte_eth_dev_mac_addr_add(uint16_t port_id, struct ether_addr *mac_addr,
2936                                 uint32_t pool);
2937
2938 /**
2939  * Remove a MAC address from the internal array of addresses.
2940  *
2941  * @param port_id
2942  *   The port identifier of the Ethernet device.
2943  * @param mac_addr
2944  *   MAC address to remove.
2945  * @return
2946  *   - (0) if successful, or *mac_addr* didn't exist.
2947  *   - (-ENOTSUP) if hardware doesn't support.
2948  *   - (-ENODEV) if *port* invalid.
2949  *   - (-EADDRINUSE) if attempting to remove the default MAC address
2950  */
2951 int rte_eth_dev_mac_addr_remove(uint16_t port_id, struct ether_addr *mac_addr);
2952
2953 /**
2954  * Set the default MAC address.
2955  *
2956  * @param port_id
2957  *   The port identifier of the Ethernet device.
2958  * @param mac_addr
2959  *   New default MAC address.
2960  * @return
2961  *   - (0) if successful, or *mac_addr* didn't exist.
2962  *   - (-ENOTSUP) if hardware doesn't support.
2963  *   - (-ENODEV) if *port* invalid.
2964  *   - (-EINVAL) if MAC address is invalid.
2965  */
2966 int rte_eth_dev_default_mac_addr_set(uint16_t port_id,
2967                 struct ether_addr *mac_addr);
2968
2969 /**
2970  * Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
2971  *
2972  * @param port_id
2973  *   The port identifier of the Ethernet device.
2974  * @param reta_conf
2975  *   RETA to update.
2976  * @param reta_size
2977  *   Redirection table size. The table size can be queried by
2978  *   rte_eth_dev_info_get().
2979  * @return
2980  *   - (0) if successful.
2981  *   - (-ENOTSUP) if hardware doesn't support.
2982  *   - (-EINVAL) if bad parameter.
2983  *   - (-EIO) if device is removed.
2984  */
2985 int rte_eth_dev_rss_reta_update(uint16_t port_id,
2986                                 struct rte_eth_rss_reta_entry64 *reta_conf,
2987                                 uint16_t reta_size);
2988
2989  /**
2990  * Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
2991  *
2992  * @param port_id
2993  *   The port identifier of the Ethernet device.
2994  * @param reta_conf
2995  *   RETA to query.
2996  * @param reta_size
2997  *   Redirection table size. The table size can be queried by
2998  *   rte_eth_dev_info_get().
2999  * @return
3000  *   - (0) if successful.
3001  *   - (-ENOTSUP) if hardware doesn't support.
3002  *   - (-EINVAL) if bad parameter.
3003  *   - (-EIO) if device is removed.
3004  */
3005 int rte_eth_dev_rss_reta_query(uint16_t port_id,
3006                                struct rte_eth_rss_reta_entry64 *reta_conf,
3007                                uint16_t reta_size);
3008
3009  /**
3010  * Updates unicast hash table for receiving packet with the given destination
3011  * MAC address, and the packet is routed to all VFs for which the RX mode is
3012  * accept packets that match the unicast hash table.
3013  *
3014  * @param port_id
3015  *   The port identifier of the Ethernet device.
3016  * @param addr
3017  *   Unicast MAC address.
3018  * @param on
3019  *    1 - Set an unicast hash bit for receiving packets with the MAC address.
3020  *    0 - Clear an unicast hash bit.
3021  * @return
3022  *   - (0) if successful.
3023  *   - (-ENOTSUP) if hardware doesn't support.
3024   *  - (-ENODEV) if *port_id* invalid.
3025  *   - (-EIO) if device is removed.
3026  *   - (-EINVAL) if bad parameter.
3027  */
3028 int rte_eth_dev_uc_hash_table_set(uint16_t port_id, struct ether_addr *addr,
3029                                   uint8_t on);
3030
3031  /**
3032  * Updates all unicast hash bitmaps for receiving packet with any Unicast
3033  * Ethernet MAC addresses,the packet is routed to all VFs for which the RX
3034  * mode is accept packets that match the unicast hash table.
3035  *
3036  * @param port_id
3037  *   The port identifier of the Ethernet device.
3038  * @param on
3039  *    1 - Set all unicast hash bitmaps for receiving all the Ethernet
3040  *         MAC addresses
3041  *    0 - Clear all unicast hash bitmaps
3042  * @return
3043  *   - (0) if successful.
3044  *   - (-ENOTSUP) if hardware doesn't support.
3045   *  - (-ENODEV) if *port_id* invalid.
3046  *   - (-EIO) if device is removed.
3047  *   - (-EINVAL) if bad parameter.
3048  */
3049 int rte_eth_dev_uc_all_hash_table_set(uint16_t port_id, uint8_t on);
3050
3051 /**
3052  * Set a traffic mirroring rule on an Ethernet device
3053  *
3054  * @param port_id
3055  *   The port identifier of the Ethernet device.
3056  * @param mirror_conf
3057  *   The pointer to the traffic mirroring structure describing the mirroring rule.
3058  *   The *rte_eth_vm_mirror_conf* structure includes the type of mirroring rule,
3059  *   destination pool and the value of rule if enable vlan or pool mirroring.
3060  *
3061  * @param rule_id
3062  *   The index of traffic mirroring rule, we support four separated rules.
3063  * @param on
3064  *   1 - Enable a mirroring rule.
3065  *   0 - Disable a mirroring rule.
3066  * @return
3067  *   - (0) if successful.
3068  *   - (-ENOTSUP) if hardware doesn't support this feature.
3069  *   - (-ENODEV) if *port_id* invalid.
3070  *   - (-EIO) if device is removed.
3071  *   - (-EINVAL) if the mr_conf information is not correct.
3072  */
3073 int rte_eth_mirror_rule_set(uint16_t port_id,
3074                         struct rte_eth_mirror_conf *mirror_conf,
3075                         uint8_t rule_id,
3076                         uint8_t on);
3077
3078 /**
3079  * Reset a traffic mirroring rule on an Ethernet device.
3080  *
3081  * @param port_id
3082  *   The port identifier of the Ethernet device.
3083  * @param rule_id
3084  *   The index of traffic mirroring rule, we support four separated rules.
3085  * @return
3086  *   - (0) if successful.
3087  *   - (-ENOTSUP) if hardware doesn't support this feature.
3088  *   - (-ENODEV) if *port_id* invalid.
3089  *   - (-EIO) if device is removed.
3090  *   - (-EINVAL) if bad parameter.
3091  */
3092 int rte_eth_mirror_rule_reset(uint16_t port_id,
3093                                          uint8_t rule_id);
3094
3095 /**
3096  * Set the rate limitation for a queue on an Ethernet device.
3097  *
3098  * @param port_id
3099  *   The port identifier of the Ethernet device.
3100  * @param queue_idx
3101  *   The queue id.
3102  * @param tx_rate
3103  *   The tx rate in Mbps. Allocated from the total port link speed.
3104  * @return
3105  *   - (0) if successful.
3106  *   - (-ENOTSUP) if hardware doesn't support this feature.
3107  *   - (-ENODEV) if *port_id* invalid.
3108  *   - (-EIO) if device is removed.
3109  *   - (-EINVAL) if bad parameter.
3110  */
3111 int rte_eth_set_queue_rate_limit(uint16_t port_id, uint16_t queue_idx,
3112                         uint16_t tx_rate);
3113
3114  /**
3115  * Configuration of Receive Side Scaling hash computation of Ethernet device.
3116  *
3117  * @param port_id
3118  *   The port identifier of the Ethernet device.
3119  * @param rss_conf
3120  *   The new configuration to use for RSS hash computation on the port.
3121  * @return
3122  *   - (0) if successful.
3123  *   - (-ENODEV) if port identifier is invalid.
3124  *   - (-EIO) if device is removed.
3125  *   - (-ENOTSUP) if hardware doesn't support.
3126  *   - (-EINVAL) if bad parameter.
3127  */
3128 int rte_eth_dev_rss_hash_update(uint16_t port_id,
3129                                 struct rte_eth_rss_conf *rss_conf);
3130
3131  /**
3132  * Retrieve current configuration of Receive Side Scaling hash computation
3133  * of Ethernet device.
3134  *
3135  * @param port_id
3136  *   The port identifier of the Ethernet device.
3137  * @param rss_conf
3138  *   Where to store the current RSS hash configuration of the Ethernet device.
3139  * @return
3140  *   - (0) if successful.
3141  *   - (-ENODEV) if port identifier is invalid.
3142  *   - (-EIO) if device is removed.
3143  *   - (-ENOTSUP) if hardware doesn't support RSS.
3144  */
3145 int
3146 rte_eth_dev_rss_hash_conf_get(uint16_t port_id,
3147                               struct rte_eth_rss_conf *rss_conf);
3148
3149  /**
3150  * Add UDP tunneling port for a specific type of tunnel.
3151  * The packets with this UDP port will be identified as this type of tunnel.
3152  * Before enabling any offloading function for a tunnel, users can call this API
3153  * to change or add more UDP port for the tunnel. So the offloading function
3154  * can take effect on the packets with the specific UDP port.
3155  *
3156  * @param port_id
3157  *   The port identifier of the Ethernet device.
3158  * @param tunnel_udp
3159  *   UDP tunneling configuration.
3160  *
3161  * @return
3162  *   - (0) if successful.
3163  *   - (-ENODEV) if port identifier is invalid.
3164  *   - (-EIO) if device is removed.
3165  *   - (-ENOTSUP) if hardware doesn't support tunnel type.
3166  */
3167 int
3168 rte_eth_dev_udp_tunnel_port_add(uint16_t port_id,
3169                                 struct rte_eth_udp_tunnel *tunnel_udp);
3170
3171  /**
3172  * Delete UDP tunneling port a specific type of tunnel.
3173  * The packets with this UDP port will not be identified as this type of tunnel
3174  * any more.
3175  * Before enabling any offloading function for a tunnel, users can call this API
3176  * to delete a UDP port for the tunnel. So the offloading function will not take
3177  * effect on the packets with the specific UDP port.
3178  *
3179  * @param port_id
3180  *   The port identifier of the Ethernet device.
3181  * @param tunnel_udp
3182  *   UDP tunneling configuration.
3183  *
3184  * @return
3185  *   - (0) if successful.
3186  *   - (-ENODEV) if port identifier is invalid.
3187  *   - (-EIO) if device is removed.
3188  *   - (-ENOTSUP) if hardware doesn't support tunnel type.
3189  */
3190 int
3191 rte_eth_dev_udp_tunnel_port_delete(uint16_t port_id,
3192                                    struct rte_eth_udp_tunnel *tunnel_udp);
3193
3194 /**
3195  * Check whether the filter type is supported on an Ethernet device.
3196  * All the supported filter types are defined in 'rte_eth_ctrl.h'.
3197  *
3198  * @param port_id
3199  *   The port identifier of the Ethernet device.
3200  * @param filter_type
3201  *   Filter type.
3202  * @return
3203  *   - (0) if successful.
3204  *   - (-ENOTSUP) if hardware doesn't support this filter type.
3205  *   - (-ENODEV) if *port_id* invalid.
3206  *   - (-EIO) if device is removed.
3207  */
3208 int rte_eth_dev_filter_supported(uint16_t port_id,
3209                 enum rte_filter_type filter_type);
3210
3211 /**
3212  * Take operations to assigned filter type on an Ethernet device.
3213  * All the supported operations and filter types are defined in 'rte_eth_ctrl.h'.
3214  *
3215  * @param port_id
3216  *   The port identifier of the Ethernet device.
3217  * @param filter_type
3218  *   Filter type.
3219  * @param filter_op
3220  *   Type of operation.
3221  * @param arg
3222  *   A pointer to arguments defined specifically for the operation.
3223  * @return
3224  *   - (0) if successful.
3225  *   - (-ENOTSUP) if hardware doesn't support.
3226  *   - (-ENODEV) if *port_id* invalid.
3227  *   - (-EIO) if device is removed.
3228  *   - others depends on the specific operations implementation.
3229  */
3230 int rte_eth_dev_filter_ctrl(uint16_t port_id, enum rte_filter_type filter_type,
3231                         enum rte_filter_op filter_op, void *arg);
3232
3233 /**
3234  * Get DCB information on an Ethernet device.
3235  *
3236  * @param port_id
3237  *   The port identifier of the Ethernet device.
3238  * @param dcb_info
3239  *   dcb information.
3240  * @return
3241  *   - (0) if successful.
3242  *   - (-ENODEV) if port identifier is invalid.
3243  *   - (-EIO) if device is removed.
3244  *   - (-ENOTSUP) if hardware doesn't support.
3245  */
3246 int rte_eth_dev_get_dcb_info(uint16_t port_id,
3247                              struct rte_eth_dcb_info *dcb_info);
3248
3249 struct rte_eth_rxtx_callback;
3250
3251 /**
3252  * Add a callback to be called on packet RX on a given port and queue.
3253  *
3254  * This API configures a function to be called for each burst of
3255  * packets received on a given NIC port queue. The return value is a pointer
3256  * that can be used to later remove the callback using
3257  * rte_eth_remove_rx_callback().
3258  *
3259  * Multiple functions are called in the order that they are added.
3260  *
3261  * @param port_id
3262  *   The port identifier of the Ethernet device.
3263  * @param queue_id
3264  *   The queue on the Ethernet device on which the callback is to be added.
3265  * @param fn
3266  *   The callback function
3267  * @param user_param
3268  *   A generic pointer parameter which will be passed to each invocation of the
3269  *   callback function on this port and queue.
3270  *
3271  * @return
3272  *   NULL on error.
3273  *   On success, a pointer value which can later be used to remove the callback.
3274  */
3275 const struct rte_eth_rxtx_callback *
3276 rte_eth_add_rx_callback(uint16_t port_id, uint16_t queue_id,
3277                 rte_rx_callback_fn fn, void *user_param);
3278
3279 /**
3280  * Add a callback that must be called first on packet RX on a given port
3281  * and queue.
3282  *
3283  * This API configures a first function to be called for each burst of
3284  * packets received on a given NIC port queue. The return value is a pointer
3285  * that can be used to later remove the callback using
3286  * rte_eth_remove_rx_callback().
3287  *
3288  * Multiple functions are called in the order that they are added.
3289  *
3290  * @param port_id
3291  *   The port identifier of the Ethernet device.
3292  * @param queue_id
3293  *   The queue on the Ethernet device on which the callback is to be added.
3294  * @param fn
3295  *   The callback function
3296  * @param user_param
3297  *   A generic pointer parameter which will be passed to each invocation of the
3298  *   callback function on this port and queue.
3299  *
3300  * @return
3301  *   NULL on error.
3302  *   On success, a pointer value which can later be used to remove the callback.
3303  */
3304 const struct rte_eth_rxtx_callback *
3305 rte_eth_add_first_rx_callback(uint16_t port_id, uint16_t queue_id,
3306                 rte_rx_callback_fn fn, void *user_param);
3307
3308 /**
3309  * Add a callback to be called on packet TX on a given port and queue.
3310  *
3311  * This API configures a function to be called for each burst of
3312  * packets sent on a given NIC port queue. The return value is a pointer
3313  * that can be used to later remove the callback using
3314  * rte_eth_remove_tx_callback().
3315  *
3316  * Multiple functions are called in the order that they are added.
3317  *
3318  * @param port_id
3319  *   The port identifier of the Ethernet device.
3320  * @param queue_id
3321  *   The queue on the Ethernet device on which the callback is to be added.
3322  * @param fn
3323  *   The callback function
3324  * @param user_param
3325  *   A generic pointer parameter which will be passed to each invocation of the
3326  *   callback function on this port and queue.
3327  *
3328  * @return
3329  *   NULL on error.
3330  *   On success, a pointer value which can later be used to remove the callback.
3331  */
3332 const struct rte_eth_rxtx_callback *
3333 rte_eth_add_tx_callback(uint16_t port_id, uint16_t queue_id,
3334                 rte_tx_callback_fn fn, void *user_param);
3335
3336 /**
3337  * Remove an RX packet callback from a given port and queue.
3338  *
3339  * This function is used to removed callbacks that were added to a NIC port
3340  * queue using rte_eth_add_rx_callback().
3341  *
3342  * Note: the callback is removed from the callback list but it isn't freed
3343  * since the it may still be in use. The memory for the callback can be
3344  * subsequently freed back by the application by calling rte_free():
3345  *
3346  * - Immediately - if the port is stopped, or the user knows that no
3347  *   callbacks are in flight e.g. if called from the thread doing RX/TX
3348  *   on that queue.
3349  *
3350  * - After a short delay - where the delay is sufficient to allow any
3351  *   in-flight callbacks to complete.
3352  *
3353  * @param port_id
3354  *   The port identifier of the Ethernet device.
3355  * @param queue_id
3356  *   The queue on the Ethernet device from which the callback is to be removed.
3357  * @param user_cb
3358  *   User supplied callback created via rte_eth_add_rx_callback().
3359  *
3360  * @return
3361  *   - 0: Success. Callback was removed.
3362  *   - -ENOTSUP: Callback support is not available.
3363  *   - -EINVAL:  The port_id or the queue_id is out of range, or the callback
3364  *               is NULL or not found for the port/queue.
3365  */
3366 int rte_eth_remove_rx_callback(uint16_t port_id, uint16_t queue_id,
3367                 const struct rte_eth_rxtx_callback *user_cb);
3368
3369 /**
3370  * Remove a TX packet callback from a given port and queue.
3371  *
3372  * This function is used to removed callbacks that were added to a NIC port
3373  * queue using rte_eth_add_tx_callback().
3374  *
3375  * Note: the callback is removed from the callback list but it isn't freed
3376  * since the it may still be in use. The memory for the callback can be
3377  * subsequently freed back by the application by calling rte_free():
3378  *
3379  * - Immediately - if the port is stopped, or the user knows that no
3380  *   callbacks are in flight e.g. if called from the thread doing RX/TX
3381  *   on that queue.
3382  *
3383  * - After a short delay - where the delay is sufficient to allow any
3384  *   in-flight callbacks to complete.
3385  *
3386  * @param port_id
3387  *   The port identifier of the Ethernet device.
3388  * @param queue_id
3389  *   The queue on the Ethernet device from which the callback is to be removed.
3390  * @param user_cb
3391  *   User supplied callback created via rte_eth_add_tx_callback().
3392  *
3393  * @return
3394  *   - 0: Success. Callback was removed.
3395  *   - -ENOTSUP: Callback support is not available.
3396  *   - -EINVAL:  The port_id or the queue_id is out of range, or the callback
3397  *               is NULL or not found for the port/queue.
3398  */
3399 int rte_eth_remove_tx_callback(uint16_t port_id, uint16_t queue_id,
3400                 const struct rte_eth_rxtx_callback *user_cb);
3401
3402 /**
3403  * Retrieve information about given port's RX queue.
3404  *
3405  * @param port_id
3406  *   The port identifier of the Ethernet device.
3407  * @param queue_id
3408  *   The RX queue on the Ethernet device for which information
3409  *   will be retrieved.
3410  * @param qinfo
3411  *   A pointer to a structure of type *rte_eth_rxq_info_info* to be filled with
3412  *   the information of the Ethernet device.
3413  *
3414  * @return
3415  *   - 0: Success
3416  *   - -ENOTSUP: routine is not supported by the device PMD.
3417  *   - -EINVAL:  The port_id or the queue_id is out of range.
3418  */
3419 int rte_eth_rx_queue_info_get(uint16_t port_id, uint16_t queue_id,
3420         struct rte_eth_rxq_info *qinfo);
3421
3422 /**
3423  * Retrieve information about given port's TX queue.
3424  *
3425  * @param port_id
3426  *   The port identifier of the Ethernet device.
3427  * @param queue_id
3428  *   The TX queue on the Ethernet device for which information
3429  *   will be retrieved.
3430  * @param qinfo
3431  *   A pointer to a structure of type *rte_eth_txq_info_info* to be filled with
3432  *   the information of the Ethernet device.
3433  *
3434  * @return
3435  *   - 0: Success
3436  *   - -ENOTSUP: routine is not supported by the device PMD.
3437  *   - -EINVAL:  The port_id or the queue_id is out of range.
3438  */
3439 int rte_eth_tx_queue_info_get(uint16_t port_id, uint16_t queue_id,
3440         struct rte_eth_txq_info *qinfo);
3441
3442 /**
3443  * Retrieve device registers and register attributes (number of registers and
3444  * register size)
3445  *
3446  * @param port_id
3447  *   The port identifier of the Ethernet device.
3448  * @param info
3449  *   Pointer to rte_dev_reg_info structure to fill in. If info->data is
3450  *   NULL the function fills in the width and length fields. If non-NULL
3451  *   the registers are put into the buffer pointed at by the data field.
3452  * @return
3453  *   - (0) if successful.
3454  *   - (-ENOTSUP) if hardware doesn't support.
3455  *   - (-ENODEV) if *port_id* invalid.
3456  *   - (-EIO) if device is removed.
3457  *   - others depends on the specific operations implementation.
3458  */
3459 int rte_eth_dev_get_reg_info(uint16_t port_id, struct rte_dev_reg_info *info);
3460
3461 /**
3462  * Retrieve size of device EEPROM
3463  *
3464  * @param port_id
3465  *   The port identifier of the Ethernet device.
3466  * @return
3467  *   - (>=0) EEPROM size if successful.
3468  *   - (-ENOTSUP) if hardware doesn't support.
3469  *   - (-ENODEV) if *port_id* invalid.
3470  *   - (-EIO) if device is removed.
3471  *   - others depends on the specific operations implementation.
3472  */
3473 int rte_eth_dev_get_eeprom_length(uint16_t port_id);
3474
3475 /**
3476  * Retrieve EEPROM and EEPROM attribute
3477  *
3478  * @param port_id
3479  *   The port identifier of the Ethernet device.
3480  * @param info
3481  *   The template includes buffer for return EEPROM data and
3482  *   EEPROM attributes to be filled.
3483  * @return
3484  *   - (0) if successful.
3485  *   - (-ENOTSUP) if hardware doesn't support.
3486  *   - (-ENODEV) if *port_id* invalid.
3487  *   - (-EIO) if device is removed.
3488  *   - others depends on the specific operations implementation.
3489  */
3490 int rte_eth_dev_get_eeprom(uint16_t port_id, struct rte_dev_eeprom_info *info);
3491
3492 /**
3493  * Program EEPROM with provided data
3494  *
3495  * @param port_id
3496  *   The port identifier of the Ethernet device.
3497  * @param info
3498  *   The template includes EEPROM data for programming and
3499  *   EEPROM attributes to be filled
3500  * @return
3501  *   - (0) if successful.
3502  *   - (-ENOTSUP) if hardware doesn't support.
3503  *   - (-ENODEV) if *port_id* invalid.
3504  *   - (-EIO) if device is removed.
3505  *   - others depends on the specific operations implementation.
3506  */
3507 int rte_eth_dev_set_eeprom(uint16_t port_id, struct rte_dev_eeprom_info *info);
3508
3509 /**
3510  * @warning
3511  * @b EXPERIMENTAL: this API may change without prior notice.
3512  *
3513  * Retrieve the type and size of plugin module EEPROM
3514  *
3515  * @param port_id
3516  *   The port identifier of the Ethernet device.
3517  * @param modinfo
3518  *   The type and size of plugin module EEPROM.
3519  * @return
3520  *   - (0) if successful.
3521  *   - (-ENOTSUP) if hardware doesn't support.
3522  *   - (-ENODEV) if *port_id* invalid.
3523  *   - (-EIO) if device is removed.
3524  *   - others depends on the specific operations implementation.
3525  */
3526 int __rte_experimental
3527 rte_eth_dev_get_module_info(uint16_t port_id,
3528                             struct rte_eth_dev_module_info *modinfo);
3529
3530 /**
3531  * @warning
3532  * @b EXPERIMENTAL: this API may change without prior notice.
3533  *
3534  * Retrieve the data of plugin module EEPROM
3535  *
3536  * @param port_id
3537  *   The port identifier of the Ethernet device.
3538  * @param info
3539  *   The template includes the plugin module EEPROM attributes, and the
3540  *   buffer for return plugin module EEPROM data.
3541  * @return
3542  *   - (0) if successful.
3543  *   - (-ENOTSUP) if hardware doesn't support.
3544  *   - (-ENODEV) if *port_id* invalid.
3545  *   - (-EIO) if device is removed.
3546  *   - others depends on the specific operations implementation.
3547  */
3548 int __rte_experimental
3549 rte_eth_dev_get_module_eeprom(uint16_t port_id,
3550                               struct rte_dev_eeprom_info *info);
3551
3552 /**
3553  * Set the list of multicast addresses to filter on an Ethernet device.
3554  *
3555  * @param port_id
3556  *   The port identifier of the Ethernet device.
3557  * @param mc_addr_set
3558  *   The array of multicast addresses to set. Equal to NULL when the function
3559  *   is invoked to flush the set of filtered addresses.
3560  * @param nb_mc_addr
3561  *   The number of multicast addresses in the *mc_addr_set* array. Equal to 0
3562  *   when the function is invoked to flush the set of filtered addresses.
3563  * @return
3564  *   - (0) if successful.
3565  *   - (-ENODEV) if *port_id* invalid.
3566  *   - (-EIO) if device is removed.
3567  *   - (-ENOTSUP) if PMD of *port_id* doesn't support multicast filtering.
3568  *   - (-ENOSPC) if *port_id* has not enough multicast filtering resources.
3569  */
3570 int rte_eth_dev_set_mc_addr_list(uint16_t port_id,
3571                                  struct ether_addr *mc_addr_set,
3572                                  uint32_t nb_mc_addr);
3573
3574 /**
3575  * Enable IEEE1588/802.1AS timestamping for an Ethernet device.
3576  *
3577  * @param port_id
3578  *   The port identifier of the Ethernet device.
3579  *
3580  * @return
3581  *   - 0: Success.
3582  *   - -ENODEV: The port ID is invalid.
3583  *   - -EIO: if device is removed.
3584  *   - -ENOTSUP: The function is not supported by the Ethernet driver.
3585  */
3586 int rte_eth_timesync_enable(uint16_t port_id);
3587
3588 /**
3589  * Disable IEEE1588/802.1AS timestamping for an Ethernet device.
3590  *
3591  * @param port_id
3592  *   The port identifier of the Ethernet device.
3593  *
3594  * @return
3595  *   - 0: Success.
3596  *   - -ENODEV: The port ID is invalid.
3597  *   - -EIO: if device is removed.
3598  *   - -ENOTSUP: The function is not supported by the Ethernet driver.
3599  */
3600 int rte_eth_timesync_disable(uint16_t port_id);
3601
3602 /**
3603  * Read an IEEE1588/802.1AS RX timestamp from an Ethernet device.
3604  *
3605  * @param port_id
3606  *   The port identifier of the Ethernet device.
3607  * @param timestamp
3608  *   Pointer to the timestamp struct.
3609  * @param flags
3610  *   Device specific flags. Used to pass the RX timesync register index to
3611  *   i40e. Unused in igb/ixgbe, pass 0 instead.
3612  *
3613  * @return
3614  *   - 0: Success.
3615  *   - -EINVAL: No timestamp is available.
3616  *   - -ENODEV: The port ID is invalid.
3617  *   - -EIO: if device is removed.
3618  *   - -ENOTSUP: The function is not supported by the Ethernet driver.
3619  */
3620 int rte_eth_timesync_read_rx_timestamp(uint16_t port_id,
3621                 struct timespec *timestamp, uint32_t flags);
3622
3623 /**
3624  * Read an IEEE1588/802.1AS TX timestamp from an Ethernet device.
3625  *
3626  * @param port_id
3627  *   The port identifier of the Ethernet device.
3628  * @param timestamp
3629  *   Pointer to the timestamp struct.
3630  *
3631  * @return
3632  *   - 0: Success.
3633  *   - -EINVAL: No timestamp is available.
3634  *   - -ENODEV: The port ID is invalid.
3635  *   - -EIO: if device is removed.
3636  *   - -ENOTSUP: The function is not supported by the Ethernet driver.
3637  */
3638 int rte_eth_timesync_read_tx_timestamp(uint16_t port_id,
3639                 struct timespec *timestamp);
3640
3641 /**
3642  * Adjust the timesync clock on an Ethernet device.
3643  *
3644  * This is usually used in conjunction with other Ethdev timesync functions to
3645  * synchronize the device time using the IEEE1588/802.1AS protocol.
3646  *
3647  * @param port_id
3648  *   The port identifier of the Ethernet device.
3649  * @param delta
3650  *   The adjustment in nanoseconds.
3651  *
3652  * @return
3653  *   - 0: Success.
3654  *   - -ENODEV: The port ID is invalid.
3655  *   - -EIO: if device is removed.
3656  *   - -ENOTSUP: The function is not supported by the Ethernet driver.
3657  */
3658 int rte_eth_timesync_adjust_time(uint16_t port_id, int64_t delta);
3659
3660 /**
3661  * Read the time from the timesync clock on an Ethernet device.
3662  *
3663  * This is usually used in conjunction with other Ethdev timesync functions to
3664  * synchronize the device time using the IEEE1588/802.1AS protocol.
3665  *
3666  * @param port_id
3667  *   The port identifier of the Ethernet device.
3668  * @param time
3669  *   Pointer to the timespec struct that holds the time.
3670  *
3671  * @return
3672  *   - 0: Success.
3673  */
3674 int rte_eth_timesync_read_time(uint16_t port_id, struct timespec *time);
3675
3676 /**
3677  * Set the time of the timesync clock on an Ethernet device.
3678  *
3679  * This is usually used in conjunction with other Ethdev timesync functions to
3680  * synchronize the device time using the IEEE1588/802.1AS protocol.
3681  *
3682  * @param port_id
3683  *   The port identifier of the Ethernet device.
3684  * @param time
3685  *   Pointer to the timespec struct that holds the time.
3686  *
3687  * @return
3688  *   - 0: Success.
3689  *   - -EINVAL: No timestamp is available.
3690  *   - -ENODEV: The port ID is invalid.
3691  *   - -EIO: if device is removed.
3692  *   - -ENOTSUP: The function is not supported by the Ethernet driver.
3693  */
3694 int rte_eth_timesync_write_time(uint16_t port_id, const struct timespec *time);
3695
3696 /**
3697  * Config l2 tunnel ether type of an Ethernet device for filtering specific
3698  * tunnel packets by ether type.
3699  *
3700  * @param port_id
3701  *   The port identifier of the Ethernet device.
3702  * @param l2_tunnel
3703  *   l2 tunnel configuration.
3704  *
3705  * @return
3706  *   - (0) if successful.
3707  *   - (-ENODEV) if port identifier is invalid.
3708  *   - (-EIO) if device is removed.
3709  *   - (-ENOTSUP) if hardware doesn't support tunnel type.
3710  */
3711 int
3712 rte_eth_dev_l2_tunnel_eth_type_conf(uint16_t port_id,
3713                                     struct rte_eth_l2_tunnel_conf *l2_tunnel);
3714
3715 /**
3716  * Enable/disable l2 tunnel offload functions. Include,
3717  * 1, The ability of parsing a type of l2 tunnel of an Ethernet device.
3718  *    Filtering, forwarding and offloading this type of tunnel packets depend on
3719  *    this ability.
3720  * 2, Stripping the l2 tunnel tag.
3721  * 3, Insertion of the l2 tunnel tag.
3722  * 4, Forwarding the packets based on the l2 tunnel tag.
3723  *
3724  * @param port_id
3725  *   The port identifier of the Ethernet device.
3726  * @param l2_tunnel
3727  *   l2 tunnel parameters.
3728  * @param mask
3729  *   Indicate the offload function.
3730  * @param en
3731  *   Enable or disable this function.
3732  *
3733  * @return
3734  *   - (0) if successful.
3735  *   - (-ENODEV) if port identifier is invalid.
3736  *   - (-EIO) if device is removed.
3737  *   - (-ENOTSUP) if hardware doesn't support tunnel type.
3738  */
3739 int
3740 rte_eth_dev_l2_tunnel_offload_set(uint16_t port_id,
3741                                   struct rte_eth_l2_tunnel_conf *l2_tunnel,
3742                                   uint32_t mask,
3743                                   uint8_t en);
3744
3745 /**
3746 * Get the port id from device name. The device name should be specified
3747 * as below:
3748 * - PCIe address (Domain:Bus:Device.Function), for example- 0000:2:00.0
3749 * - SoC device name, for example- fsl-gmac0
3750 * - vdev dpdk name, for example- net_[pcap0|null0|tap0]
3751 *
3752 * @param name
3753 *  pci address or name of the device
3754 * @param port_id
3755 *   pointer to port identifier of the device
3756 * @return
3757 *   - (0) if successful and port_id is filled.
3758 *   - (-ENODEV or -EINVAL) on failure.
3759 */
3760 int
3761 rte_eth_dev_get_port_by_name(const char *name, uint16_t *port_id);
3762
3763 /**
3764 * Get the device name from port id. The device name is specified as below:
3765 * - PCIe address (Domain:Bus:Device.Function), for example- 0000:02:00.0
3766 * - SoC device name, for example- fsl-gmac0
3767 * - vdev dpdk name, for example- net_[pcap0|null0|tun0|tap0]
3768 *
3769 * @param port_id
3770 *   Port identifier of the device.
3771 * @param name
3772 *   Buffer of size RTE_ETH_NAME_MAX_LEN to store the name.
3773 * @return
3774 *   - (0) if successful.
3775 *   - (-EINVAL) on failure.
3776 */
3777 int
3778 rte_eth_dev_get_name_by_port(uint16_t port_id, char *name);
3779
3780 /**
3781  * Check that numbers of Rx and Tx descriptors satisfy descriptors limits from
3782  * the ethernet device information, otherwise adjust them to boundaries.
3783  *
3784  * @param port_id
3785  *   The port identifier of the Ethernet device.
3786  * @param nb_rx_desc
3787  *   A pointer to a uint16_t where the number of receive
3788  *   descriptors stored.
3789  * @param nb_tx_desc
3790  *   A pointer to a uint16_t where the number of transmit
3791  *   descriptors stored.
3792  * @return
3793  *   - (0) if successful.
3794  *   - (-ENOTSUP, -ENODEV or -EINVAL) on failure.
3795  */
3796 int rte_eth_dev_adjust_nb_rx_tx_desc(uint16_t port_id,
3797                                      uint16_t *nb_rx_desc,
3798                                      uint16_t *nb_tx_desc);
3799
3800 /**
3801  * Test if a port supports specific mempool ops.
3802  *
3803  * @param port_id
3804  *   Port identifier of the Ethernet device.
3805  * @param [in] pool
3806  *   The name of the pool operations to test.
3807  * @return
3808  *   - 0: best mempool ops choice for this port.
3809  *   - 1: mempool ops are supported for this port.
3810  *   - -ENOTSUP: mempool ops not supported for this port.
3811  *   - -ENODEV: Invalid port Identifier.
3812  *   - -EINVAL: Pool param is null.
3813  */
3814 int
3815 rte_eth_dev_pool_ops_supported(uint16_t port_id, const char *pool);
3816
3817 /**
3818  * Get the security context for the Ethernet device.
3819  *
3820  * @param port_id
3821  *   Port identifier of the Ethernet device
3822  * @return
3823  *   - NULL on error.
3824  *   - pointer to security context on success.
3825  */
3826 void *
3827 rte_eth_dev_get_sec_ctx(uint16_t port_id);
3828
3829
3830 #include <rte_ethdev_core.h>
3831
3832 /**
3833  *
3834  * Retrieve a burst of input packets from a receive queue of an Ethernet
3835  * device. The retrieved packets are stored in *rte_mbuf* structures whose
3836  * pointers are supplied in the *rx_pkts* array.
3837  *
3838  * The rte_eth_rx_burst() function loops, parsing the RX ring of the
3839  * receive queue, up to *nb_pkts* packets, and for each completed RX
3840  * descriptor in the ring, it performs the following operations:
3841  *
3842  * - Initialize the *rte_mbuf* data structure associated with the
3843  *   RX descriptor according to the information provided by the NIC into
3844  *   that RX descriptor.
3845  *
3846  * - Store the *rte_mbuf* data structure into the next entry of the
3847  *   *rx_pkts* array.
3848  *
3849  * - Replenish the RX descriptor with a new *rte_mbuf* buffer
3850  *   allocated from the memory pool associated with the receive queue at
3851  *   initialization time.
3852  *
3853  * When retrieving an input packet that was scattered by the controller
3854  * into multiple receive descriptors, the rte_eth_rx_burst() function
3855  * appends the associated *rte_mbuf* buffers to the first buffer of the
3856  * packet.
3857  *
3858  * The rte_eth_rx_burst() function returns the number of packets
3859  * actually retrieved, which is the number of *rte_mbuf* data structures
3860  * effectively supplied into the *rx_pkts* array.
3861  * A return value equal to *nb_pkts* indicates that the RX queue contained
3862  * at least *rx_pkts* packets, and this is likely to signify that other
3863  * received packets remain in the input queue. Applications implementing
3864  * a "retrieve as much received packets as possible" policy can check this
3865  * specific case and keep invoking the rte_eth_rx_burst() function until
3866  * a value less than *nb_pkts* is returned.
3867  *
3868  * This receive method has the following advantages:
3869  *
3870  * - It allows a run-to-completion network stack engine to retrieve and
3871  *   to immediately process received packets in a fast burst-oriented
3872  *   approach, avoiding the overhead of unnecessary intermediate packet
3873  *   queue/dequeue operations.
3874  *
3875  * - Conversely, it also allows an asynchronous-oriented processing
3876  *   method to retrieve bursts of received packets and to immediately
3877  *   queue them for further parallel processing by another logical core,
3878  *   for instance. However, instead of having received packets being
3879  *   individually queued by the driver, this approach allows the caller
3880  *   of the rte_eth_rx_burst() function to queue a burst of retrieved
3881  *   packets at a time and therefore dramatically reduce the cost of
3882  *   enqueue/dequeue operations per packet.
3883  *
3884  * - It allows the rte_eth_rx_burst() function of the driver to take
3885  *   advantage of burst-oriented hardware features (CPU cache,
3886  *   prefetch instructions, and so on) to minimize the number of CPU
3887  *   cycles per packet.
3888  *
3889  * To summarize, the proposed receive API enables many
3890  * burst-oriented optimizations in both synchronous and asynchronous
3891  * packet processing environments with no overhead in both cases.
3892  *
3893  * The rte_eth_rx_burst() function does not provide any error
3894  * notification to avoid the corresponding overhead. As a hint, the
3895  * upper-level application might check the status of the device link once
3896  * being systematically returned a 0 value for a given number of tries.
3897  *
3898  * @param port_id
3899  *   The port identifier of the Ethernet device.
3900  * @param queue_id
3901  *   The index of the receive queue from which to retrieve input packets.
3902  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
3903  *   to rte_eth_dev_configure().
3904  * @param rx_pkts
3905  *   The address of an array of pointers to *rte_mbuf* structures that
3906  *   must be large enough to store *nb_pkts* pointers in it.
3907  * @param nb_pkts
3908  *   The maximum number of packets to retrieve.
3909  * @return
3910  *   The number of packets actually retrieved, which is the number
3911  *   of pointers to *rte_mbuf* structures effectively supplied to the
3912  *   *rx_pkts* array.
3913  */
3914 static inline uint16_t
3915 rte_eth_rx_burst(uint16_t port_id, uint16_t queue_id,
3916                  struct rte_mbuf **rx_pkts, const uint16_t nb_pkts)
3917 {
3918         struct rte_eth_dev *dev = &rte_eth_devices[port_id];
3919         uint16_t nb_rx;
3920
3921 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3922         RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
3923         RTE_FUNC_PTR_OR_ERR_RET(*dev->rx_pkt_burst, 0);
3924
3925         if (queue_id >= dev->data->nb_rx_queues) {
3926                 RTE_ETHDEV_LOG(ERR, "Invalid RX queue_id=%u\n", queue_id);
3927                 return 0;
3928         }
3929 #endif
3930         nb_rx = (*dev->rx_pkt_burst)(dev->data->rx_queues[queue_id],
3931                                      rx_pkts, nb_pkts);
3932
3933 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
3934         if (unlikely(dev->post_rx_burst_cbs[queue_id] != NULL)) {
3935                 struct rte_eth_rxtx_callback *cb =
3936                                 dev->post_rx_burst_cbs[queue_id];
3937
3938                 do {
3939                         nb_rx = cb->fn.rx(port_id, queue_id, rx_pkts, nb_rx,
3940                                                 nb_pkts, cb->param);
3941                         cb = cb->next;
3942                 } while (cb != NULL);
3943         }
3944 #endif
3945
3946         return nb_rx;
3947 }
3948
3949 /**
3950  * Get the number of used descriptors of a rx queue
3951  *
3952  * @param port_id
3953  *  The port identifier of the Ethernet device.
3954  * @param queue_id
3955  *  The queue id on the specific port.
3956  * @return
3957  *  The number of used descriptors in the specific queue, or:
3958  *     (-EINVAL) if *port_id* or *queue_id* is invalid
3959  *     (-ENOTSUP) if the device does not support this function
3960  */
3961 static inline int
3962 rte_eth_rx_queue_count(uint16_t port_id, uint16_t queue_id)
3963 {
3964         struct rte_eth_dev *dev;
3965
3966         RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -EINVAL);
3967         dev = &rte_eth_devices[port_id];
3968         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_queue_count, -ENOTSUP);
3969         if (queue_id >= dev->data->nb_rx_queues)
3970                 return -EINVAL;
3971
3972         return (int)(*dev->dev_ops->rx_queue_count)(dev, queue_id);
3973 }
3974
3975 /**
3976  * Check if the DD bit of the specific RX descriptor in the queue has been set
3977  *
3978  * @param port_id
3979  *  The port identifier of the Ethernet device.
3980  * @param queue_id
3981  *  The queue id on the specific port.
3982  * @param offset
3983  *  The offset of the descriptor ID from tail.
3984  * @return
3985  *  - (1) if the specific DD bit is set.
3986  *  - (0) if the specific DD bit is not set.
3987  *  - (-ENODEV) if *port_id* invalid.
3988  *  - (-ENOTSUP) if the device does not support this function
3989  */
3990 static inline int
3991 rte_eth_rx_descriptor_done(uint16_t port_id, uint16_t queue_id, uint16_t offset)
3992 {
3993         struct rte_eth_dev *dev = &rte_eth_devices[port_id];
3994         RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
3995         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_descriptor_done, -ENOTSUP);
3996         return (*dev->dev_ops->rx_descriptor_done)( \
3997                 dev->data->rx_queues[queue_id], offset);
3998 }
3999
4000 #define RTE_ETH_RX_DESC_AVAIL    0 /**< Desc available for hw. */
4001 #define RTE_ETH_RX_DESC_DONE     1 /**< Desc done, filled by hw. */
4002 #define RTE_ETH_RX_DESC_UNAVAIL  2 /**< Desc used by driver or hw. */
4003
4004 /**
4005  * Check the status of a Rx descriptor in the queue
4006  *
4007  * It should be called in a similar context than the Rx function:
4008  * - on a dataplane core
4009  * - not concurrently on the same queue
4010  *
4011  * Since it's a dataplane function, no check is performed on port_id and
4012  * queue_id. The caller must therefore ensure that the port is enabled
4013  * and the queue is configured and running.
4014  *
4015  * Note: accessing to a random descriptor in the ring may trigger cache
4016  * misses and have a performance impact.
4017  *
4018  * @param port_id
4019  *  A valid port identifier of the Ethernet device which.
4020  * @param queue_id
4021  *  A valid Rx queue identifier on this port.
4022  * @param offset
4023  *  The offset of the descriptor starting from tail (0 is the next
4024  *  packet to be received by the driver).
4025  *
4026  * @return
4027  *  - (RTE_ETH_RX_DESC_AVAIL): Descriptor is available for the hardware to
4028  *    receive a packet.
4029  *  - (RTE_ETH_RX_DESC_DONE): Descriptor is done, it is filled by hw, but
4030  *    not yet processed by the driver (i.e. in the receive queue).
4031  *  - (RTE_ETH_RX_DESC_UNAVAIL): Descriptor is unavailable, either hold by
4032  *    the driver and not yet returned to hw, or reserved by the hw.
4033  *  - (-EINVAL) bad descriptor offset.
4034  *  - (-ENOTSUP) if the device does not support this function.
4035  *  - (-ENODEV) bad port or queue (only if compiled with debug).
4036  */
4037 static inline int
4038 rte_eth_rx_descriptor_status(uint16_t port_id, uint16_t queue_id,
4039         uint16_t offset)
4040 {
4041         struct rte_eth_dev *dev;
4042         void *rxq;
4043
4044 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4045         RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
4046 #endif
4047         dev = &rte_eth_devices[port_id];
4048 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4049         if (queue_id >= dev->data->nb_rx_queues)
4050                 return -ENODEV;
4051 #endif
4052         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_descriptor_status, -ENOTSUP);
4053         rxq = dev->data->rx_queues[queue_id];
4054
4055         return (*dev->dev_ops->rx_descriptor_status)(rxq, offset);
4056 }
4057
4058 #define RTE_ETH_TX_DESC_FULL    0 /**< Desc filled for hw, waiting xmit. */
4059 #define RTE_ETH_TX_DESC_DONE    1 /**< Desc done, packet is transmitted. */
4060 #define RTE_ETH_TX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */
4061
4062 /**
4063  * Check the status of a Tx descriptor in the queue.
4064  *
4065  * It should be called in a similar context than the Tx function:
4066  * - on a dataplane core
4067  * - not concurrently on the same queue
4068  *
4069  * Since it's a dataplane function, no check is performed on port_id and
4070  * queue_id. The caller must therefore ensure that the port is enabled
4071  * and the queue is configured and running.
4072  *
4073  * Note: accessing to a random descriptor in the ring may trigger cache
4074  * misses and have a performance impact.
4075  *
4076  * @param port_id
4077  *  A valid port identifier of the Ethernet device which.
4078  * @param queue_id
4079  *  A valid Tx queue identifier on this port.
4080  * @param offset
4081  *  The offset of the descriptor starting from tail (0 is the place where
4082  *  the next packet will be send).
4083  *
4084  * @return
4085  *  - (RTE_ETH_TX_DESC_FULL) Descriptor is being processed by the hw, i.e.
4086  *    in the transmit queue.
4087  *  - (RTE_ETH_TX_DESC_DONE) Hardware is done with this descriptor, it can
4088  *    be reused by the driver.
4089  *  - (RTE_ETH_TX_DESC_UNAVAIL): Descriptor is unavailable, reserved by the
4090  *    driver or the hardware.
4091  *  - (-EINVAL) bad descriptor offset.
4092  *  - (-ENOTSUP) if the device does not support this function.
4093  *  - (-ENODEV) bad port or queue (only if compiled with debug).
4094  */
4095 static inline int rte_eth_tx_descriptor_status(uint16_t port_id,
4096         uint16_t queue_id, uint16_t offset)
4097 {
4098         struct rte_eth_dev *dev;
4099         void *txq;
4100
4101 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4102         RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
4103 #endif
4104         dev = &rte_eth_devices[port_id];
4105 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4106         if (queue_id >= dev->data->nb_tx_queues)
4107                 return -ENODEV;
4108 #endif
4109         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->tx_descriptor_status, -ENOTSUP);
4110         txq = dev->data->tx_queues[queue_id];
4111
4112         return (*dev->dev_ops->tx_descriptor_status)(txq, offset);
4113 }
4114
4115 /**
4116  * Send a burst of output packets on a transmit queue of an Ethernet device.
4117  *
4118  * The rte_eth_tx_burst() function is invoked to transmit output packets
4119  * on the output queue *queue_id* of the Ethernet device designated by its
4120  * *port_id*.
4121  * The *nb_pkts* parameter is the number of packets to send which are
4122  * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
4123  * allocated from a pool created with rte_pktmbuf_pool_create().
4124  * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
4125  * up to the number of transmit descriptors available in the TX ring of the
4126  * transmit queue.
4127  * For each packet to send, the rte_eth_tx_burst() function performs
4128  * the following operations:
4129  *
4130  * - Pick up the next available descriptor in the transmit ring.
4131  *
4132  * - Free the network buffer previously sent with that descriptor, if any.
4133  *
4134  * - Initialize the transmit descriptor with the information provided
4135  *   in the *rte_mbuf data structure.
4136  *
4137  * In the case of a segmented packet composed of a list of *rte_mbuf* buffers,
4138  * the rte_eth_tx_burst() function uses several transmit descriptors
4139  * of the ring.
4140  *
4141  * The rte_eth_tx_burst() function returns the number of packets it
4142  * actually sent. A return value equal to *nb_pkts* means that all packets
4143  * have been sent, and this is likely to signify that other output packets
4144  * could be immediately transmitted again. Applications that implement a
4145  * "send as many packets to transmit as possible" policy can check this
4146  * specific case and keep invoking the rte_eth_tx_burst() function until
4147  * a value less than *nb_pkts* is returned.
4148  *
4149  * It is the responsibility of the rte_eth_tx_burst() function to
4150  * transparently free the memory buffers of packets previously sent.
4151  * This feature is driven by the *tx_free_thresh* value supplied to the
4152  * rte_eth_dev_configure() function at device configuration time.
4153  * When the number of free TX descriptors drops below this threshold, the
4154  * rte_eth_tx_burst() function must [attempt to] free the *rte_mbuf*  buffers
4155  * of those packets whose transmission was effectively completed.
4156  *
4157  * If the PMD is DEV_TX_OFFLOAD_MT_LOCKFREE capable, multiple threads can
4158  * invoke this function concurrently on the same tx queue without SW lock.
4159  * @see rte_eth_dev_info_get, struct rte_eth_txconf::offloads
4160  *
4161  * @see rte_eth_tx_prepare to perform some prior checks or adjustments
4162  * for offloads.
4163  *
4164  * @param port_id
4165  *   The port identifier of the Ethernet device.
4166  * @param queue_id
4167  *   The index of the transmit queue through which output packets must be
4168  *   sent.
4169  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
4170  *   to rte_eth_dev_configure().
4171  * @param tx_pkts
4172  *   The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
4173  *   which contain the output packets.
4174  * @param nb_pkts
4175  *   The maximum number of packets to transmit.
4176  * @return
4177  *   The number of output packets actually stored in transmit descriptors of
4178  *   the transmit ring. The return value can be less than the value of the
4179  *   *tx_pkts* parameter when the transmit ring is full or has been filled up.
4180  */
4181 static inline uint16_t
4182 rte_eth_tx_burst(uint16_t port_id, uint16_t queue_id,
4183                  struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
4184 {
4185         struct rte_eth_dev *dev = &rte_eth_devices[port_id];
4186
4187 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4188         RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
4189         RTE_FUNC_PTR_OR_ERR_RET(*dev->tx_pkt_burst, 0);
4190
4191         if (queue_id >= dev->data->nb_tx_queues) {
4192                 RTE_ETHDEV_LOG(ERR, "Invalid TX queue_id=%u\n", queue_id);
4193                 return 0;
4194         }
4195 #endif
4196
4197 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
4198         struct rte_eth_rxtx_callback *cb = dev->pre_tx_burst_cbs[queue_id];
4199
4200         if (unlikely(cb != NULL)) {
4201                 do {
4202                         nb_pkts = cb->fn.tx(port_id, queue_id, tx_pkts, nb_pkts,
4203                                         cb->param);
4204                         cb = cb->next;
4205                 } while (cb != NULL);
4206         }
4207 #endif
4208
4209         return (*dev->tx_pkt_burst)(dev->data->tx_queues[queue_id], tx_pkts, nb_pkts);
4210 }
4211
4212 /**
4213  * @warning
4214  * @b EXPERIMENTAL: this API may change without prior notice
4215  *
4216  * Process a burst of output packets on a transmit queue of an Ethernet device.
4217  *
4218  * The rte_eth_tx_prepare() function is invoked to prepare output packets to be
4219  * transmitted on the output queue *queue_id* of the Ethernet device designated
4220  * by its *port_id*.
4221  * The *nb_pkts* parameter is the number of packets to be prepared which are
4222  * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
4223  * allocated from a pool created with rte_pktmbuf_pool_create().
4224  * For each packet to send, the rte_eth_tx_prepare() function performs
4225  * the following operations:
4226  *
4227  * - Check if packet meets devices requirements for tx offloads.
4228  *
4229  * - Check limitations about number of segments.
4230  *
4231  * - Check additional requirements when debug is enabled.
4232  *
4233  * - Update and/or reset required checksums when tx offload is set for packet.
4234  *
4235  * Since this function can modify packet data, provided mbufs must be safely
4236  * writable (e.g. modified data cannot be in shared segment).
4237  *
4238  * The rte_eth_tx_prepare() function returns the number of packets ready to be
4239  * sent. A return value equal to *nb_pkts* means that all packets are valid and
4240  * ready to be sent, otherwise stops processing on the first invalid packet and
4241  * leaves the rest packets untouched.
4242  *
4243  * When this functionality is not implemented in the driver, all packets are
4244  * are returned untouched.
4245  *
4246  * @param port_id
4247  *   The port identifier of the Ethernet device.
4248  *   The value must be a valid port id.
4249  * @param queue_id
4250  *   The index of the transmit queue through which output packets must be
4251  *   sent.
4252  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
4253  *   to rte_eth_dev_configure().
4254  * @param tx_pkts
4255  *   The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
4256  *   which contain the output packets.
4257  * @param nb_pkts
4258  *   The maximum number of packets to process.
4259  * @return
4260  *   The number of packets correct and ready to be sent. The return value can be
4261  *   less than the value of the *tx_pkts* parameter when some packet doesn't
4262  *   meet devices requirements with rte_errno set appropriately:
4263  *   - -EINVAL: offload flags are not correctly set
4264  *   - -ENOTSUP: the offload feature is not supported by the hardware
4265  *
4266  */
4267
4268 #ifndef RTE_ETHDEV_TX_PREPARE_NOOP
4269
4270 static inline uint16_t
4271 rte_eth_tx_prepare(uint16_t port_id, uint16_t queue_id,
4272                 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
4273 {
4274         struct rte_eth_dev *dev;
4275
4276 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4277         if (!rte_eth_dev_is_valid_port(port_id)) {
4278                 RTE_ETHDEV_LOG(ERR, "Invalid TX port_id=%u\n", port_id);
4279                 rte_errno = -EINVAL;
4280                 return 0;
4281         }
4282 #endif
4283
4284         dev = &rte_eth_devices[port_id];
4285
4286 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4287         if (queue_id >= dev->data->nb_tx_queues) {
4288                 RTE_ETHDEV_LOG(ERR, "Invalid TX queue_id=%u\n", queue_id);
4289                 rte_errno = -EINVAL;
4290                 return 0;
4291         }
4292 #endif
4293
4294         if (!dev->tx_pkt_prepare)
4295                 return nb_pkts;
4296
4297         return (*dev->tx_pkt_prepare)(dev->data->tx_queues[queue_id],
4298                         tx_pkts, nb_pkts);
4299 }
4300
4301 #else
4302
4303 /*
4304  * Native NOOP operation for compilation targets which doesn't require any
4305  * preparations steps, and functional NOOP may introduce unnecessary performance
4306  * drop.
4307  *
4308  * Generally this is not a good idea to turn it on globally and didn't should
4309  * be used if behavior of tx_preparation can change.
4310  */
4311
4312 static inline uint16_t
4313 rte_eth_tx_prepare(__rte_unused uint16_t port_id,
4314                 __rte_unused uint16_t queue_id,
4315                 __rte_unused struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
4316 {
4317         return nb_pkts;
4318 }
4319
4320 #endif
4321
4322 /**
4323  * Send any packets queued up for transmission on a port and HW queue
4324  *
4325  * This causes an explicit flush of packets previously buffered via the
4326  * rte_eth_tx_buffer() function. It returns the number of packets successfully
4327  * sent to the NIC, and calls the error callback for any unsent packets. Unless
4328  * explicitly set up otherwise, the default callback simply frees the unsent
4329  * packets back to the owning mempool.
4330  *
4331  * @param port_id
4332  *   The port identifier of the Ethernet device.
4333  * @param queue_id
4334  *   The index of the transmit queue through which output packets must be
4335  *   sent.
4336  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
4337  *   to rte_eth_dev_configure().
4338  * @param buffer
4339  *   Buffer of packets to be transmit.
4340  * @return
4341  *   The number of packets successfully sent to the Ethernet device. The error
4342  *   callback is called for any packets which could not be sent.
4343  */
4344 static inline uint16_t
4345 rte_eth_tx_buffer_flush(uint16_t port_id, uint16_t queue_id,
4346                 struct rte_eth_dev_tx_buffer *buffer)
4347 {
4348         uint16_t sent;
4349         uint16_t to_send = buffer->length;
4350
4351         if (to_send == 0)
4352                 return 0;
4353
4354         sent = rte_eth_tx_burst(port_id, queue_id, buffer->pkts, to_send);
4355
4356         buffer->length = 0;
4357
4358         /* All packets sent, or to be dealt with by callback below */
4359         if (unlikely(sent != to_send))
4360                 buffer->error_callback(&buffer->pkts[sent],
4361                                        (uint16_t)(to_send - sent),
4362                                        buffer->error_userdata);
4363
4364         return sent;
4365 }
4366
4367 /**
4368  * Buffer a single packet for future transmission on a port and queue
4369  *
4370  * This function takes a single mbuf/packet and buffers it for later
4371  * transmission on the particular port and queue specified. Once the buffer is
4372  * full of packets, an attempt will be made to transmit all the buffered
4373  * packets. In case of error, where not all packets can be transmitted, a
4374  * callback is called with the unsent packets as a parameter. If no callback
4375  * is explicitly set up, the unsent packets are just freed back to the owning
4376  * mempool. The function returns the number of packets actually sent i.e.
4377  * 0 if no buffer flush occurred, otherwise the number of packets successfully
4378  * flushed
4379  *
4380  * @param port_id
4381  *   The port identifier of the Ethernet device.
4382  * @param queue_id
4383  *   The index of the transmit queue through which output packets must be
4384  *   sent.
4385  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
4386  *   to rte_eth_dev_configure().
4387  * @param buffer
4388  *   Buffer used to collect packets to be sent.
4389  * @param tx_pkt
4390  *   Pointer to the packet mbuf to be sent.
4391  * @return
4392  *   0 = packet has been buffered for later transmission
4393  *   N > 0 = packet has been buffered, and the buffer was subsequently flushed,
4394  *     causing N packets to be sent, and the error callback to be called for
4395  *     the rest.
4396  */
4397 static __rte_always_inline uint16_t
4398 rte_eth_tx_buffer(uint16_t port_id, uint16_t queue_id,
4399                 struct rte_eth_dev_tx_buffer *buffer, struct rte_mbuf *tx_pkt)
4400 {
4401         buffer->pkts[buffer->length++] = tx_pkt;
4402         if (buffer->length < buffer->size)
4403                 return 0;
4404
4405         return rte_eth_tx_buffer_flush(port_id, queue_id, buffer);
4406 }
4407
4408 #ifdef __cplusplus
4409 }
4410 #endif
4411
4412 #endif /* _RTE_ETHDEV_H_ */