a0d01d26675fba47e2098b3c9f7771ade70cdcf7
[dpdk.git] / lib / 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 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  *     - MTU
84  *     - flow control settings
85  *     - receive mode configuration (promiscuous mode, all-multicast mode,
86  *       hardware checksum mode, RSS/VMDQ settings etc.)
87  *     - VLAN filtering configuration
88  *     - default MAC address
89  *     - MAC addresses supplied to MAC address array
90  *     - flow director filtering mode (but not filtering rules)
91  *     - NIC queue statistics mappings
92  *
93  * Any other configuration will not be stored and will need to be re-entered
94  * before a call to rte_eth_dev_start().
95  *
96  * Finally, a network application can close an Ethernet device by invoking the
97  * rte_eth_dev_close() function.
98  *
99  * Each function of the application Ethernet API invokes a specific function
100  * of the PMD that controls the target device designated by its port
101  * identifier.
102  * For this purpose, all device-specific functions of an Ethernet driver are
103  * supplied through a set of pointers contained in a generic structure of type
104  * *eth_dev_ops*.
105  * The address of the *eth_dev_ops* structure is stored in the *rte_eth_dev*
106  * structure by the device init function of the Ethernet driver, which is
107  * invoked during the PCI probing phase, as explained earlier.
108  *
109  * In other words, each function of the Ethernet API simply retrieves the
110  * *rte_eth_dev* structure associated with the device port identifier and
111  * performs an indirect invocation of the corresponding driver function
112  * supplied in the *eth_dev_ops* structure of the *rte_eth_dev* structure.
113  *
114  * For performance reasons, the address of the burst-oriented RX and TX
115  * functions of the Ethernet driver are not contained in the *eth_dev_ops*
116  * structure. Instead, they are directly stored at the beginning of the
117  * *rte_eth_dev* structure to avoid an extra indirect memory access during
118  * their invocation.
119  *
120  * RTE ethernet device drivers do not use interrupts for transmitting or
121  * receiving. Instead, Ethernet drivers export Poll-Mode receive and transmit
122  * functions to applications.
123  * Both receive and transmit functions are packet-burst oriented to minimize
124  * their cost per packet through the following optimizations:
125  *
126  * - Sharing among multiple packets the incompressible cost of the
127  *   invocation of receive/transmit functions.
128  *
129  * - Enabling receive/transmit functions to take advantage of burst-oriented
130  *   hardware features (L1 cache, prefetch instructions, NIC head/tail
131  *   registers) to minimize the number of CPU cycles per packet, for instance,
132  *   by avoiding useless read memory accesses to ring descriptors, or by
133  *   systematically using arrays of pointers that exactly fit L1 cache line
134  *   boundaries and sizes.
135  *
136  * The burst-oriented receive function does not provide any error notification,
137  * to avoid the corresponding overhead. As a hint, the upper-level application
138  * might check the status of the device link once being systematically returned
139  * a 0 value by the receive function of the driver for a given number of tries.
140  */
141
142 #ifdef __cplusplus
143 extern "C" {
144 #endif
145
146 #include <stdint.h>
147
148 /* Use this macro to check if LRO API is supported */
149 #define RTE_ETHDEV_HAS_LRO_SUPPORT
150
151 /* Alias RTE_LIBRTE_ETHDEV_DEBUG for backward compatibility. */
152 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
153 #define RTE_ETHDEV_DEBUG_RX
154 #define RTE_ETHDEV_DEBUG_TX
155 #endif
156
157 #include <rte_compat.h>
158 #include <rte_log.h>
159 #include <rte_interrupts.h>
160 #include <rte_dev.h>
161 #include <rte_devargs.h>
162 #include <rte_errno.h>
163 #include <rte_common.h>
164 #include <rte_config.h>
165 #include <rte_ether.h>
166 #include <rte_power_intrinsics.h>
167
168 #include "rte_ethdev_trace_fp.h"
169 #include "rte_dev_info.h"
170
171 extern int rte_eth_dev_logtype;
172
173 #define RTE_ETHDEV_LOG(level, ...) \
174         rte_log(RTE_LOG_ ## level, rte_eth_dev_logtype, "" __VA_ARGS__)
175
176 struct rte_mbuf;
177
178 /**
179  * Initializes a device iterator.
180  *
181  * This iterator allows accessing a list of devices matching some devargs.
182  *
183  * @param iter
184  *   Device iterator handle initialized by the function.
185  *   The fields bus_str and cls_str might be dynamically allocated,
186  *   and could be freed by calling rte_eth_iterator_cleanup().
187  *
188  * @param devargs
189  *   Device description string.
190  *
191  * @return
192  *   0 on successful initialization, negative otherwise.
193  */
194 int rte_eth_iterator_init(struct rte_dev_iterator *iter, const char *devargs);
195
196 /**
197  * Iterates on devices with devargs filter.
198  * The ownership is not checked.
199  *
200  * The next port id is returned, and the iterator is updated.
201  *
202  * @param iter
203  *   Device iterator handle initialized by rte_eth_iterator_init().
204  *   Some fields bus_str and cls_str might be freed when no more port is found,
205  *   by calling rte_eth_iterator_cleanup().
206  *
207  * @return
208  *   A port id if found, RTE_MAX_ETHPORTS otherwise.
209  */
210 uint16_t rte_eth_iterator_next(struct rte_dev_iterator *iter);
211
212 /**
213  * Free some allocated fields of the iterator.
214  *
215  * This function is automatically called by rte_eth_iterator_next()
216  * on the last iteration (i.e. when no more matching port is found).
217  *
218  * It is safe to call this function twice; it will do nothing more.
219  *
220  * @param iter
221  *   Device iterator handle initialized by rte_eth_iterator_init().
222  *   The fields bus_str and cls_str are freed if needed.
223  */
224 void rte_eth_iterator_cleanup(struct rte_dev_iterator *iter);
225
226 /**
227  * Macro to iterate over all ethdev ports matching some devargs.
228  *
229  * If a break is done before the end of the loop,
230  * the function rte_eth_iterator_cleanup() must be called.
231  *
232  * @param id
233  *   Iterated port id of type uint16_t.
234  * @param devargs
235  *   Device parameters input as string of type char*.
236  * @param iter
237  *   Iterator handle of type struct rte_dev_iterator, used internally.
238  */
239 #define RTE_ETH_FOREACH_MATCHING_DEV(id, devargs, iter) \
240         for (rte_eth_iterator_init(iter, devargs), \
241              id = rte_eth_iterator_next(iter); \
242              id != RTE_MAX_ETHPORTS; \
243              id = rte_eth_iterator_next(iter))
244
245 /**
246  * A structure used to retrieve statistics for an Ethernet port.
247  * Not all statistics fields in struct rte_eth_stats are supported
248  * by any type of network interface card (NIC). If any statistics
249  * field is not supported, its value is 0.
250  * All byte-related statistics do not include Ethernet FCS regardless
251  * of whether these bytes have been delivered to the application
252  * (see DEV_RX_OFFLOAD_KEEP_CRC).
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         /* Queue stats are limited to max 256 queues */
267         uint64_t q_ipackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
268         /**< Total number of queue RX packets. */
269         uint64_t q_opackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
270         /**< Total number of queue TX packets. */
271         uint64_t q_ibytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
272         /**< Total number of successfully received queue bytes. */
273         uint64_t q_obytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
274         /**< Total number of successfully transmitted queue bytes. */
275         uint64_t q_errors[RTE_ETHDEV_QUEUE_STAT_CNTRS];
276         /**< Total number of queue packets received that are dropped. */
277 };
278
279 /**
280  * Device supported speeds bitmap flags
281  */
282 #define ETH_LINK_SPEED_AUTONEG  (0 <<  0)  /**< Autonegotiate (all speeds) */
283 #define ETH_LINK_SPEED_FIXED    (1 <<  0)  /**< Disable autoneg (fixed speed) */
284 #define ETH_LINK_SPEED_10M_HD   (1 <<  1)  /**<  10 Mbps half-duplex */
285 #define ETH_LINK_SPEED_10M      (1 <<  2)  /**<  10 Mbps full-duplex */
286 #define ETH_LINK_SPEED_100M_HD  (1 <<  3)  /**< 100 Mbps half-duplex */
287 #define ETH_LINK_SPEED_100M     (1 <<  4)  /**< 100 Mbps full-duplex */
288 #define ETH_LINK_SPEED_1G       (1 <<  5)  /**<   1 Gbps */
289 #define ETH_LINK_SPEED_2_5G     (1 <<  6)  /**< 2.5 Gbps */
290 #define ETH_LINK_SPEED_5G       (1 <<  7)  /**<   5 Gbps */
291 #define ETH_LINK_SPEED_10G      (1 <<  8)  /**<  10 Gbps */
292 #define ETH_LINK_SPEED_20G      (1 <<  9)  /**<  20 Gbps */
293 #define ETH_LINK_SPEED_25G      (1 << 10)  /**<  25 Gbps */
294 #define ETH_LINK_SPEED_40G      (1 << 11)  /**<  40 Gbps */
295 #define ETH_LINK_SPEED_50G      (1 << 12)  /**<  50 Gbps */
296 #define ETH_LINK_SPEED_56G      (1 << 13)  /**<  56 Gbps */
297 #define ETH_LINK_SPEED_100G     (1 << 14)  /**< 100 Gbps */
298 #define ETH_LINK_SPEED_200G     (1 << 15)  /**< 200 Gbps */
299
300 /**
301  * Ethernet numeric link speeds in Mbps
302  */
303 #define ETH_SPEED_NUM_NONE         0 /**< Not defined */
304 #define ETH_SPEED_NUM_10M         10 /**<  10 Mbps */
305 #define ETH_SPEED_NUM_100M       100 /**< 100 Mbps */
306 #define ETH_SPEED_NUM_1G        1000 /**<   1 Gbps */
307 #define ETH_SPEED_NUM_2_5G      2500 /**< 2.5 Gbps */
308 #define ETH_SPEED_NUM_5G        5000 /**<   5 Gbps */
309 #define ETH_SPEED_NUM_10G      10000 /**<  10 Gbps */
310 #define ETH_SPEED_NUM_20G      20000 /**<  20 Gbps */
311 #define ETH_SPEED_NUM_25G      25000 /**<  25 Gbps */
312 #define ETH_SPEED_NUM_40G      40000 /**<  40 Gbps */
313 #define ETH_SPEED_NUM_50G      50000 /**<  50 Gbps */
314 #define ETH_SPEED_NUM_56G      56000 /**<  56 Gbps */
315 #define ETH_SPEED_NUM_100G    100000 /**< 100 Gbps */
316 #define ETH_SPEED_NUM_200G    200000 /**< 200 Gbps */
317 #define ETH_SPEED_NUM_UNKNOWN UINT32_MAX /**< Unknown */
318
319 /**
320  * A structure used to retrieve link-level information of an Ethernet port.
321  */
322 __extension__
323 struct rte_eth_link {
324         uint32_t link_speed;        /**< ETH_SPEED_NUM_ */
325         uint16_t link_duplex  : 1;  /**< ETH_LINK_[HALF/FULL]_DUPLEX */
326         uint16_t link_autoneg : 1;  /**< ETH_LINK_[AUTONEG/FIXED] */
327         uint16_t link_status  : 1;  /**< ETH_LINK_[DOWN/UP] */
328 } __rte_aligned(8);      /**< aligned for atomic64 read/write */
329
330 /* Utility constants */
331 #define ETH_LINK_HALF_DUPLEX 0 /**< Half-duplex connection (see link_duplex). */
332 #define ETH_LINK_FULL_DUPLEX 1 /**< Full-duplex connection (see link_duplex). */
333 #define ETH_LINK_DOWN        0 /**< Link is down (see link_status). */
334 #define ETH_LINK_UP          1 /**< Link is up (see link_status). */
335 #define ETH_LINK_FIXED       0 /**< No autonegotiation (see link_autoneg). */
336 #define ETH_LINK_AUTONEG     1 /**< Autonegotiated (see link_autoneg). */
337 #define RTE_ETH_LINK_MAX_STR_LEN 40 /**< Max length of default link string. */
338
339 /**
340  * A structure used to configure the ring threshold registers of an RX/TX
341  * queue for an Ethernet port.
342  */
343 struct rte_eth_thresh {
344         uint8_t pthresh; /**< Ring prefetch threshold. */
345         uint8_t hthresh; /**< Ring host threshold. */
346         uint8_t wthresh; /**< Ring writeback threshold. */
347 };
348
349 /**
350  *  Simple flags are used for rte_eth_conf.rxmode.mq_mode.
351  */
352 #define ETH_MQ_RX_RSS_FLAG  0x1
353 #define ETH_MQ_RX_DCB_FLAG  0x2
354 #define ETH_MQ_RX_VMDQ_FLAG 0x4
355
356 /**
357  *  A set of values to identify what method is to be used to route
358  *  packets to multiple queues.
359  */
360 enum rte_eth_rx_mq_mode {
361         /** None of DCB,RSS or VMDQ mode */
362         ETH_MQ_RX_NONE = 0,
363
364         /** For RX side, only RSS is on */
365         ETH_MQ_RX_RSS = ETH_MQ_RX_RSS_FLAG,
366         /** For RX side,only DCB is on. */
367         ETH_MQ_RX_DCB = ETH_MQ_RX_DCB_FLAG,
368         /** Both DCB and RSS enable */
369         ETH_MQ_RX_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG,
370
371         /** Only VMDQ, no RSS nor DCB */
372         ETH_MQ_RX_VMDQ_ONLY = ETH_MQ_RX_VMDQ_FLAG,
373         /** RSS mode with VMDQ */
374         ETH_MQ_RX_VMDQ_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_VMDQ_FLAG,
375         /** Use VMDQ+DCB to route traffic to queues */
376         ETH_MQ_RX_VMDQ_DCB = ETH_MQ_RX_VMDQ_FLAG | ETH_MQ_RX_DCB_FLAG,
377         /** Enable both VMDQ and DCB in VMDq */
378         ETH_MQ_RX_VMDQ_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG |
379                                  ETH_MQ_RX_VMDQ_FLAG,
380 };
381
382 /**
383  * for rx mq mode backward compatible
384  */
385 #define ETH_RSS                       ETH_MQ_RX_RSS
386 #define VMDQ_DCB                      ETH_MQ_RX_VMDQ_DCB
387 #define ETH_DCB_RX                    ETH_MQ_RX_DCB
388
389 /**
390  * A set of values to identify what method is to be used to transmit
391  * packets using multi-TCs.
392  */
393 enum rte_eth_tx_mq_mode {
394         ETH_MQ_TX_NONE    = 0,  /**< It is in neither DCB nor VT mode. */
395         ETH_MQ_TX_DCB,          /**< For TX side,only DCB is on. */
396         ETH_MQ_TX_VMDQ_DCB,     /**< For TX side,both DCB and VT is on. */
397         ETH_MQ_TX_VMDQ_ONLY,    /**< Only VT on, no DCB */
398 };
399
400 /**
401  * for tx mq mode backward compatible
402  */
403 #define ETH_DCB_NONE                ETH_MQ_TX_NONE
404 #define ETH_VMDQ_DCB_TX             ETH_MQ_TX_VMDQ_DCB
405 #define ETH_DCB_TX                  ETH_MQ_TX_DCB
406
407 /**
408  * A structure used to configure the RX features of an Ethernet port.
409  */
410 struct rte_eth_rxmode {
411         /** The multi-queue packet distribution mode to be used, e.g. RSS. */
412         enum rte_eth_rx_mq_mode mq_mode;
413         uint32_t max_rx_pkt_len;  /**< Only used if JUMBO_FRAME enabled. */
414         /** Maximum allowed size of LRO aggregated packet. */
415         uint32_t max_lro_pkt_size;
416         uint16_t split_hdr_size;  /**< hdr buf size (header_split enabled).*/
417         /**
418          * Per-port Rx offloads to be set using DEV_RX_OFFLOAD_* flags.
419          * Only offloads set on rx_offload_capa field on rte_eth_dev_info
420          * structure are allowed to be set.
421          */
422         uint64_t offloads;
423
424         uint64_t reserved_64s[2]; /**< Reserved for future fields */
425         void *reserved_ptrs[2];   /**< Reserved for future fields */
426 };
427
428 /**
429  * VLAN types to indicate if it is for single VLAN, inner VLAN or outer VLAN.
430  * Note that single VLAN is treated the same as inner VLAN.
431  */
432 enum rte_vlan_type {
433         ETH_VLAN_TYPE_UNKNOWN = 0,
434         ETH_VLAN_TYPE_INNER, /**< Inner VLAN. */
435         ETH_VLAN_TYPE_OUTER, /**< Single VLAN, or outer VLAN. */
436         ETH_VLAN_TYPE_MAX,
437 };
438
439 /**
440  * A structure used to describe a vlan filter.
441  * If the bit corresponding to a VID is set, such VID is on.
442  */
443 struct rte_vlan_filter_conf {
444         uint64_t ids[64];
445 };
446
447 /**
448  * A structure used to configure the Receive Side Scaling (RSS) feature
449  * of an Ethernet port.
450  * If not NULL, the *rss_key* pointer of the *rss_conf* structure points
451  * to an array holding the RSS key to use for hashing specific header
452  * fields of received packets. The length of this array should be indicated
453  * by *rss_key_len* below. Otherwise, a default random hash key is used by
454  * the device driver.
455  *
456  * The *rss_key_len* field of the *rss_conf* structure indicates the length
457  * in bytes of the array pointed by *rss_key*. To be compatible, this length
458  * will be checked in i40e only. Others assume 40 bytes to be used as before.
459  *
460  * The *rss_hf* field of the *rss_conf* structure indicates the different
461  * types of IPv4/IPv6 packets to which the RSS hashing must be applied.
462  * Supplying an *rss_hf* equal to zero disables the RSS feature.
463  */
464 struct rte_eth_rss_conf {
465         uint8_t *rss_key;    /**< If not NULL, 40-byte hash key. */
466         uint8_t rss_key_len; /**< hash key length in bytes. */
467         uint64_t rss_hf;     /**< Hash functions to apply - see below. */
468 };
469
470 /*
471  * A packet can be identified by hardware as different flow types. Different
472  * NIC hardware may support different flow types.
473  * Basically, the NIC hardware identifies the flow type as deep protocol as
474  * possible, and exclusively. For example, if a packet is identified as
475  * 'RTE_ETH_FLOW_NONFRAG_IPV4_TCP', it will not be any of other flow types,
476  * though it is an actual IPV4 packet.
477  */
478 #define RTE_ETH_FLOW_UNKNOWN             0
479 #define RTE_ETH_FLOW_RAW                 1
480 #define RTE_ETH_FLOW_IPV4                2
481 #define RTE_ETH_FLOW_FRAG_IPV4           3
482 #define RTE_ETH_FLOW_NONFRAG_IPV4_TCP    4
483 #define RTE_ETH_FLOW_NONFRAG_IPV4_UDP    5
484 #define RTE_ETH_FLOW_NONFRAG_IPV4_SCTP   6
485 #define RTE_ETH_FLOW_NONFRAG_IPV4_OTHER  7
486 #define RTE_ETH_FLOW_IPV6                8
487 #define RTE_ETH_FLOW_FRAG_IPV6           9
488 #define RTE_ETH_FLOW_NONFRAG_IPV6_TCP   10
489 #define RTE_ETH_FLOW_NONFRAG_IPV6_UDP   11
490 #define RTE_ETH_FLOW_NONFRAG_IPV6_SCTP  12
491 #define RTE_ETH_FLOW_NONFRAG_IPV6_OTHER 13
492 #define RTE_ETH_FLOW_L2_PAYLOAD         14
493 #define RTE_ETH_FLOW_IPV6_EX            15
494 #define RTE_ETH_FLOW_IPV6_TCP_EX        16
495 #define RTE_ETH_FLOW_IPV6_UDP_EX        17
496 #define RTE_ETH_FLOW_PORT               18
497         /**< Consider device port number as a flow differentiator */
498 #define RTE_ETH_FLOW_VXLAN              19 /**< VXLAN protocol based flow */
499 #define RTE_ETH_FLOW_GENEVE             20 /**< GENEVE protocol based flow */
500 #define RTE_ETH_FLOW_NVGRE              21 /**< NVGRE protocol based flow */
501 #define RTE_ETH_FLOW_VXLAN_GPE          22 /**< VXLAN-GPE protocol based flow */
502 #define RTE_ETH_FLOW_GTPU               23 /**< GTPU protocol based flow */
503 #define RTE_ETH_FLOW_MAX                24
504
505 /*
506  * Below macros are defined for RSS offload types, they can be used to
507  * fill rte_eth_rss_conf.rss_hf or rte_flow_action_rss.types.
508  */
509 #define ETH_RSS_IPV4               (1ULL << 2)
510 #define ETH_RSS_FRAG_IPV4          (1ULL << 3)
511 #define ETH_RSS_NONFRAG_IPV4_TCP   (1ULL << 4)
512 #define ETH_RSS_NONFRAG_IPV4_UDP   (1ULL << 5)
513 #define ETH_RSS_NONFRAG_IPV4_SCTP  (1ULL << 6)
514 #define ETH_RSS_NONFRAG_IPV4_OTHER (1ULL << 7)
515 #define ETH_RSS_IPV6               (1ULL << 8)
516 #define ETH_RSS_FRAG_IPV6          (1ULL << 9)
517 #define ETH_RSS_NONFRAG_IPV6_TCP   (1ULL << 10)
518 #define ETH_RSS_NONFRAG_IPV6_UDP   (1ULL << 11)
519 #define ETH_RSS_NONFRAG_IPV6_SCTP  (1ULL << 12)
520 #define ETH_RSS_NONFRAG_IPV6_OTHER (1ULL << 13)
521 #define ETH_RSS_L2_PAYLOAD         (1ULL << 14)
522 #define ETH_RSS_IPV6_EX            (1ULL << 15)
523 #define ETH_RSS_IPV6_TCP_EX        (1ULL << 16)
524 #define ETH_RSS_IPV6_UDP_EX        (1ULL << 17)
525 #define ETH_RSS_PORT               (1ULL << 18)
526 #define ETH_RSS_VXLAN              (1ULL << 19)
527 #define ETH_RSS_GENEVE             (1ULL << 20)
528 #define ETH_RSS_NVGRE              (1ULL << 21)
529 #define ETH_RSS_GTPU               (1ULL << 23)
530 #define ETH_RSS_ETH                (1ULL << 24)
531 #define ETH_RSS_S_VLAN             (1ULL << 25)
532 #define ETH_RSS_C_VLAN             (1ULL << 26)
533 #define ETH_RSS_ESP                (1ULL << 27)
534 #define ETH_RSS_AH                 (1ULL << 28)
535 #define ETH_RSS_L2TPV3             (1ULL << 29)
536 #define ETH_RSS_PFCP               (1ULL << 30)
537 #define ETH_RSS_PPPOE              (1ULL << 31)
538 #define ETH_RSS_ECPRI              (1ULL << 32)
539 #define ETH_RSS_MPLS               (1ULL << 33)
540
541 /*
542  * We use the following macros to combine with above ETH_RSS_* for
543  * more specific input set selection. These bits are defined starting
544  * from the high end of the 64 bits.
545  * Note: If we use above ETH_RSS_* without SRC/DST_ONLY, it represents
546  * both SRC and DST are taken into account. If SRC_ONLY and DST_ONLY of
547  * the same level are used simultaneously, it is the same case as none of
548  * them are added.
549  */
550 #define ETH_RSS_L3_SRC_ONLY        (1ULL << 63)
551 #define ETH_RSS_L3_DST_ONLY        (1ULL << 62)
552 #define ETH_RSS_L4_SRC_ONLY        (1ULL << 61)
553 #define ETH_RSS_L4_DST_ONLY        (1ULL << 60)
554 #define ETH_RSS_L2_SRC_ONLY        (1ULL << 59)
555 #define ETH_RSS_L2_DST_ONLY        (1ULL << 58)
556
557 /*
558  * Only select IPV6 address prefix as RSS input set according to
559  * https://tools.ietf.org/html/rfc6052
560  * Must be combined with ETH_RSS_IPV6, ETH_RSS_NONFRAG_IPV6_UDP,
561  * ETH_RSS_NONFRAG_IPV6_TCP, ETH_RSS_NONFRAG_IPV6_SCTP.
562  */
563 #define RTE_ETH_RSS_L3_PRE32       (1ULL << 57)
564 #define RTE_ETH_RSS_L3_PRE40       (1ULL << 56)
565 #define RTE_ETH_RSS_L3_PRE48       (1ULL << 55)
566 #define RTE_ETH_RSS_L3_PRE56       (1ULL << 54)
567 #define RTE_ETH_RSS_L3_PRE64       (1ULL << 53)
568 #define RTE_ETH_RSS_L3_PRE96       (1ULL << 52)
569
570 /*
571  * Use the following macros to combine with the above layers
572  * to choose inner and outer layers or both for RSS computation.
573  * Bits 50 and 51 are reserved for this.
574  */
575
576 /**
577  * level 0, requests the default behavior.
578  * Depending on the packet type, it can mean outermost, innermost,
579  * anything in between or even no RSS.
580  * It basically stands for the innermost encapsulation level RSS
581  * can be performed on according to PMD and device capabilities.
582  */
583 #define ETH_RSS_LEVEL_PMD_DEFAULT       (0ULL << 50)
584
585 /**
586  * level 1, requests RSS to be performed on the outermost packet
587  * encapsulation level.
588  */
589 #define ETH_RSS_LEVEL_OUTERMOST         (1ULL << 50)
590
591 /**
592  * level 2, requests RSS to be performed on the specified inner packet
593  * encapsulation level, from outermost to innermost (lower to higher values).
594  */
595 #define ETH_RSS_LEVEL_INNERMOST         (2ULL << 50)
596 #define ETH_RSS_LEVEL_MASK              (3ULL << 50)
597
598 #define ETH_RSS_LEVEL(rss_hf) ((rss_hf & ETH_RSS_LEVEL_MASK) >> 50)
599
600 /**
601  * For input set change of hash filter, if SRC_ONLY and DST_ONLY of
602  * the same level are used simultaneously, it is the same case as
603  * none of them are added.
604  *
605  * @param rss_hf
606  *   RSS types with SRC/DST_ONLY.
607  * @return
608  *   RSS types.
609  */
610 static inline uint64_t
611 rte_eth_rss_hf_refine(uint64_t rss_hf)
612 {
613         if ((rss_hf & ETH_RSS_L3_SRC_ONLY) && (rss_hf & ETH_RSS_L3_DST_ONLY))
614                 rss_hf &= ~(ETH_RSS_L3_SRC_ONLY | ETH_RSS_L3_DST_ONLY);
615
616         if ((rss_hf & ETH_RSS_L4_SRC_ONLY) && (rss_hf & ETH_RSS_L4_DST_ONLY))
617                 rss_hf &= ~(ETH_RSS_L4_SRC_ONLY | ETH_RSS_L4_DST_ONLY);
618
619         return rss_hf;
620 }
621
622 #define ETH_RSS_IPV6_PRE32 ( \
623                 ETH_RSS_IPV6 | \
624                 RTE_ETH_RSS_L3_PRE32)
625
626 #define ETH_RSS_IPV6_PRE40 ( \
627                 ETH_RSS_IPV6 | \
628                 RTE_ETH_RSS_L3_PRE40)
629
630 #define ETH_RSS_IPV6_PRE48 ( \
631                 ETH_RSS_IPV6 | \
632                 RTE_ETH_RSS_L3_PRE48)
633
634 #define ETH_RSS_IPV6_PRE56 ( \
635                 ETH_RSS_IPV6 | \
636                 RTE_ETH_RSS_L3_PRE56)
637
638 #define ETH_RSS_IPV6_PRE64 ( \
639                 ETH_RSS_IPV6 | \
640                 RTE_ETH_RSS_L3_PRE64)
641
642 #define ETH_RSS_IPV6_PRE96 ( \
643                 ETH_RSS_IPV6 | \
644                 RTE_ETH_RSS_L3_PRE96)
645
646 #define ETH_RSS_IPV6_PRE32_UDP ( \
647                 ETH_RSS_NONFRAG_IPV6_UDP | \
648                 RTE_ETH_RSS_L3_PRE32)
649
650 #define ETH_RSS_IPV6_PRE40_UDP ( \
651                 ETH_RSS_NONFRAG_IPV6_UDP | \
652                 RTE_ETH_RSS_L3_PRE40)
653
654 #define ETH_RSS_IPV6_PRE48_UDP ( \
655                 ETH_RSS_NONFRAG_IPV6_UDP | \
656                 RTE_ETH_RSS_L3_PRE48)
657
658 #define ETH_RSS_IPV6_PRE56_UDP ( \
659                 ETH_RSS_NONFRAG_IPV6_UDP | \
660                 RTE_ETH_RSS_L3_PRE56)
661
662 #define ETH_RSS_IPV6_PRE64_UDP ( \
663                 ETH_RSS_NONFRAG_IPV6_UDP | \
664                 RTE_ETH_RSS_L3_PRE64)
665
666 #define ETH_RSS_IPV6_PRE96_UDP ( \
667                 ETH_RSS_NONFRAG_IPV6_UDP | \
668                 RTE_ETH_RSS_L3_PRE96)
669
670 #define ETH_RSS_IPV6_PRE32_TCP ( \
671                 ETH_RSS_NONFRAG_IPV6_TCP | \
672                 RTE_ETH_RSS_L3_PRE32)
673
674 #define ETH_RSS_IPV6_PRE40_TCP ( \
675                 ETH_RSS_NONFRAG_IPV6_TCP | \
676                 RTE_ETH_RSS_L3_PRE40)
677
678 #define ETH_RSS_IPV6_PRE48_TCP ( \
679                 ETH_RSS_NONFRAG_IPV6_TCP | \
680                 RTE_ETH_RSS_L3_PRE48)
681
682 #define ETH_RSS_IPV6_PRE56_TCP ( \
683                 ETH_RSS_NONFRAG_IPV6_TCP | \
684                 RTE_ETH_RSS_L3_PRE56)
685
686 #define ETH_RSS_IPV6_PRE64_TCP ( \
687                 ETH_RSS_NONFRAG_IPV6_TCP | \
688                 RTE_ETH_RSS_L3_PRE64)
689
690 #define ETH_RSS_IPV6_PRE96_TCP ( \
691                 ETH_RSS_NONFRAG_IPV6_TCP | \
692                 RTE_ETH_RSS_L3_PRE96)
693
694 #define ETH_RSS_IPV6_PRE32_SCTP ( \
695                 ETH_RSS_NONFRAG_IPV6_SCTP | \
696                 RTE_ETH_RSS_L3_PRE32)
697
698 #define ETH_RSS_IPV6_PRE40_SCTP ( \
699                 ETH_RSS_NONFRAG_IPV6_SCTP | \
700                 RTE_ETH_RSS_L3_PRE40)
701
702 #define ETH_RSS_IPV6_PRE48_SCTP ( \
703                 ETH_RSS_NONFRAG_IPV6_SCTP | \
704                 RTE_ETH_RSS_L3_PRE48)
705
706 #define ETH_RSS_IPV6_PRE56_SCTP ( \
707                 ETH_RSS_NONFRAG_IPV6_SCTP | \
708                 RTE_ETH_RSS_L3_PRE56)
709
710 #define ETH_RSS_IPV6_PRE64_SCTP ( \
711                 ETH_RSS_NONFRAG_IPV6_SCTP | \
712                 RTE_ETH_RSS_L3_PRE64)
713
714 #define ETH_RSS_IPV6_PRE96_SCTP ( \
715                 ETH_RSS_NONFRAG_IPV6_SCTP | \
716                 RTE_ETH_RSS_L3_PRE96)
717
718 #define ETH_RSS_IP ( \
719         ETH_RSS_IPV4 | \
720         ETH_RSS_FRAG_IPV4 | \
721         ETH_RSS_NONFRAG_IPV4_OTHER | \
722         ETH_RSS_IPV6 | \
723         ETH_RSS_FRAG_IPV6 | \
724         ETH_RSS_NONFRAG_IPV6_OTHER | \
725         ETH_RSS_IPV6_EX)
726
727 #define ETH_RSS_UDP ( \
728         ETH_RSS_NONFRAG_IPV4_UDP | \
729         ETH_RSS_NONFRAG_IPV6_UDP | \
730         ETH_RSS_IPV6_UDP_EX)
731
732 #define ETH_RSS_TCP ( \
733         ETH_RSS_NONFRAG_IPV4_TCP | \
734         ETH_RSS_NONFRAG_IPV6_TCP | \
735         ETH_RSS_IPV6_TCP_EX)
736
737 #define ETH_RSS_SCTP ( \
738         ETH_RSS_NONFRAG_IPV4_SCTP | \
739         ETH_RSS_NONFRAG_IPV6_SCTP)
740
741 #define ETH_RSS_TUNNEL ( \
742         ETH_RSS_VXLAN  | \
743         ETH_RSS_GENEVE | \
744         ETH_RSS_NVGRE)
745
746 #define ETH_RSS_VLAN ( \
747         ETH_RSS_S_VLAN  | \
748         ETH_RSS_C_VLAN)
749
750 /**< Mask of valid RSS hash protocols */
751 #define ETH_RSS_PROTO_MASK ( \
752         ETH_RSS_IPV4 | \
753         ETH_RSS_FRAG_IPV4 | \
754         ETH_RSS_NONFRAG_IPV4_TCP | \
755         ETH_RSS_NONFRAG_IPV4_UDP | \
756         ETH_RSS_NONFRAG_IPV4_SCTP | \
757         ETH_RSS_NONFRAG_IPV4_OTHER | \
758         ETH_RSS_IPV6 | \
759         ETH_RSS_FRAG_IPV6 | \
760         ETH_RSS_NONFRAG_IPV6_TCP | \
761         ETH_RSS_NONFRAG_IPV6_UDP | \
762         ETH_RSS_NONFRAG_IPV6_SCTP | \
763         ETH_RSS_NONFRAG_IPV6_OTHER | \
764         ETH_RSS_L2_PAYLOAD | \
765         ETH_RSS_IPV6_EX | \
766         ETH_RSS_IPV6_TCP_EX | \
767         ETH_RSS_IPV6_UDP_EX | \
768         ETH_RSS_PORT  | \
769         ETH_RSS_VXLAN | \
770         ETH_RSS_GENEVE | \
771         ETH_RSS_NVGRE | \
772         ETH_RSS_MPLS)
773
774 /*
775  * Definitions used for redirection table entry size.
776  * Some RSS RETA sizes may not be supported by some drivers, check the
777  * documentation or the description of relevant functions for more details.
778  */
779 #define ETH_RSS_RETA_SIZE_64  64
780 #define ETH_RSS_RETA_SIZE_128 128
781 #define ETH_RSS_RETA_SIZE_256 256
782 #define ETH_RSS_RETA_SIZE_512 512
783 #define RTE_RETA_GROUP_SIZE   64
784
785 /* Definitions used for VMDQ and DCB functionality */
786 #define ETH_VMDQ_MAX_VLAN_FILTERS   64 /**< Maximum nb. of VMDQ vlan filters. */
787 #define ETH_DCB_NUM_USER_PRIORITIES 8  /**< Maximum nb. of DCB priorities. */
788 #define ETH_VMDQ_DCB_NUM_QUEUES     128 /**< Maximum nb. of VMDQ DCB queues. */
789 #define ETH_DCB_NUM_QUEUES          128 /**< Maximum nb. of DCB queues. */
790
791 /* DCB capability defines */
792 #define ETH_DCB_PG_SUPPORT      0x00000001 /**< Priority Group(ETS) support. */
793 #define ETH_DCB_PFC_SUPPORT     0x00000002 /**< Priority Flow Control support. */
794
795 /* Definitions used for VLAN Offload functionality */
796 #define ETH_VLAN_STRIP_OFFLOAD   0x0001 /**< VLAN Strip  On/Off */
797 #define ETH_VLAN_FILTER_OFFLOAD  0x0002 /**< VLAN Filter On/Off */
798 #define ETH_VLAN_EXTEND_OFFLOAD  0x0004 /**< VLAN Extend On/Off */
799 #define ETH_QINQ_STRIP_OFFLOAD   0x0008 /**< QINQ Strip On/Off */
800
801 /* Definitions used for mask VLAN setting */
802 #define ETH_VLAN_STRIP_MASK   0x0001 /**< VLAN Strip  setting mask */
803 #define ETH_VLAN_FILTER_MASK  0x0002 /**< VLAN Filter  setting mask*/
804 #define ETH_VLAN_EXTEND_MASK  0x0004 /**< VLAN Extend  setting mask*/
805 #define ETH_QINQ_STRIP_MASK   0x0008 /**< QINQ Strip  setting mask */
806 #define ETH_VLAN_ID_MAX       0x0FFF /**< VLAN ID is in lower 12 bits*/
807
808 /* Definitions used for receive MAC address   */
809 #define ETH_NUM_RECEIVE_MAC_ADDR  128 /**< Maximum nb. of receive mac addr. */
810
811 /* Definitions used for unicast hash  */
812 #define ETH_VMDQ_NUM_UC_HASH_ARRAY  128 /**< Maximum nb. of UC hash array. */
813
814 /* Definitions used for VMDQ pool rx mode setting */
815 #define ETH_VMDQ_ACCEPT_UNTAG   0x0001 /**< accept untagged packets. */
816 #define ETH_VMDQ_ACCEPT_HASH_MC 0x0002 /**< accept packets in multicast table . */
817 #define ETH_VMDQ_ACCEPT_HASH_UC 0x0004 /**< accept packets in unicast table. */
818 #define ETH_VMDQ_ACCEPT_BROADCAST   0x0008 /**< accept broadcast packets. */
819 #define ETH_VMDQ_ACCEPT_MULTICAST   0x0010 /**< multicast promiscuous. */
820
821 /** Maximum nb. of vlan per mirror rule */
822 #define ETH_MIRROR_MAX_VLANS       64
823
824 #define ETH_MIRROR_VIRTUAL_POOL_UP     0x01  /**< Virtual Pool uplink Mirroring. */
825 #define ETH_MIRROR_UPLINK_PORT         0x02  /**< Uplink Port Mirroring. */
826 #define ETH_MIRROR_DOWNLINK_PORT       0x04  /**< Downlink Port Mirroring. */
827 #define ETH_MIRROR_VLAN                0x08  /**< VLAN Mirroring. */
828 #define ETH_MIRROR_VIRTUAL_POOL_DOWN   0x10  /**< Virtual Pool downlink Mirroring. */
829
830 /**
831  * A structure used to configure VLAN traffic mirror of an Ethernet port.
832  */
833 struct rte_eth_vlan_mirror {
834         uint64_t vlan_mask; /**< mask for valid VLAN ID. */
835         /** VLAN ID list for vlan mirroring. */
836         uint16_t vlan_id[ETH_MIRROR_MAX_VLANS];
837 };
838
839 /**
840  * A structure used to configure traffic mirror of an Ethernet port.
841  */
842 struct rte_eth_mirror_conf {
843         uint8_t rule_type; /**< Mirroring rule type */
844         uint8_t dst_pool;  /**< Destination pool for this mirror rule. */
845         uint64_t pool_mask; /**< Bitmap of pool for pool mirroring */
846         /** VLAN ID setting for VLAN mirroring. */
847         struct rte_eth_vlan_mirror vlan;
848 };
849
850 /**
851  * A structure used to configure 64 entries of Redirection Table of the
852  * Receive Side Scaling (RSS) feature of an Ethernet port. To configure
853  * more than 64 entries supported by hardware, an array of this structure
854  * is needed.
855  */
856 struct rte_eth_rss_reta_entry64 {
857         uint64_t mask;
858         /**< Mask bits indicate which entries need to be updated/queried. */
859         uint16_t reta[RTE_RETA_GROUP_SIZE];
860         /**< Group of 64 redirection table entries. */
861 };
862
863 /**
864  * This enum indicates the possible number of traffic classes
865  * in DCB configurations
866  */
867 enum rte_eth_nb_tcs {
868         ETH_4_TCS = 4, /**< 4 TCs with DCB. */
869         ETH_8_TCS = 8  /**< 8 TCs with DCB. */
870 };
871
872 /**
873  * This enum indicates the possible number of queue pools
874  * in VMDQ configurations.
875  */
876 enum rte_eth_nb_pools {
877         ETH_8_POOLS = 8,    /**< 8 VMDq pools. */
878         ETH_16_POOLS = 16,  /**< 16 VMDq pools. */
879         ETH_32_POOLS = 32,  /**< 32 VMDq pools. */
880         ETH_64_POOLS = 64   /**< 64 VMDq pools. */
881 };
882
883 /* This structure may be extended in future. */
884 struct rte_eth_dcb_rx_conf {
885         enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs */
886         /** Traffic class each UP mapped to. */
887         uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
888 };
889
890 struct rte_eth_vmdq_dcb_tx_conf {
891         enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools. */
892         /** Traffic class each UP mapped to. */
893         uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
894 };
895
896 struct rte_eth_dcb_tx_conf {
897         enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs. */
898         /** Traffic class each UP mapped to. */
899         uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
900 };
901
902 struct rte_eth_vmdq_tx_conf {
903         enum rte_eth_nb_pools nb_queue_pools; /**< VMDq mode, 64 pools. */
904 };
905
906 /**
907  * A structure used to configure the VMDQ+DCB feature
908  * of an Ethernet port.
909  *
910  * Using this feature, packets are routed to a pool of queues, based
911  * on the vlan id in the vlan tag, and then to a specific queue within
912  * that pool, using the user priority vlan tag field.
913  *
914  * A default pool may be used, if desired, to route all traffic which
915  * does not match the vlan filter rules.
916  */
917 struct rte_eth_vmdq_dcb_conf {
918         enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools */
919         uint8_t enable_default_pool; /**< If non-zero, use a default pool */
920         uint8_t default_pool; /**< The default pool, if applicable */
921         uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
922         struct {
923                 uint16_t vlan_id; /**< The vlan id of the received frame */
924                 uint64_t pools;   /**< Bitmask of pools for packet rx */
925         } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
926         uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
927         /**< Selects a queue in a pool */
928 };
929
930 /**
931  * A structure used to configure the VMDQ feature of an Ethernet port when
932  * not combined with the DCB feature.
933  *
934  * Using this feature, packets are routed to a pool of queues. By default,
935  * the pool selection is based on the MAC address, the vlan id in the
936  * vlan tag as specified in the pool_map array.
937  * Passing the ETH_VMDQ_ACCEPT_UNTAG in the rx_mode field allows pool
938  * selection using only the MAC address. MAC address to pool mapping is done
939  * using the rte_eth_dev_mac_addr_add function, with the pool parameter
940  * corresponding to the pool id.
941  *
942  * Queue selection within the selected pool will be done using RSS when
943  * it is enabled or revert to the first queue of the pool if not.
944  *
945  * A default pool may be used, if desired, to route all traffic which
946  * does not match the vlan filter rules or any pool MAC address.
947  */
948 struct rte_eth_vmdq_rx_conf {
949         enum rte_eth_nb_pools nb_queue_pools; /**< VMDq only mode, 8 or 64 pools */
950         uint8_t enable_default_pool; /**< If non-zero, use a default pool */
951         uint8_t default_pool; /**< The default pool, if applicable */
952         uint8_t enable_loop_back; /**< Enable VT loop back */
953         uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
954         uint32_t rx_mode; /**< Flags from ETH_VMDQ_ACCEPT_* */
955         struct {
956                 uint16_t vlan_id; /**< The vlan id of the received frame */
957                 uint64_t pools;   /**< Bitmask of pools for packet rx */
958         } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
959 };
960
961 /**
962  * A structure used to configure the TX features of an Ethernet port.
963  */
964 struct rte_eth_txmode {
965         enum rte_eth_tx_mq_mode mq_mode; /**< TX multi-queues mode. */
966         /**
967          * Per-port Tx offloads to be set using DEV_TX_OFFLOAD_* flags.
968          * Only offloads set on tx_offload_capa field on rte_eth_dev_info
969          * structure are allowed to be set.
970          */
971         uint64_t offloads;
972
973         uint16_t pvid;
974         __extension__
975         uint8_t hw_vlan_reject_tagged : 1,
976                 /**< If set, reject sending out tagged pkts */
977                 hw_vlan_reject_untagged : 1,
978                 /**< If set, reject sending out untagged pkts */
979                 hw_vlan_insert_pvid : 1;
980                 /**< If set, enable port based VLAN insertion */
981
982         uint64_t reserved_64s[2]; /**< Reserved for future fields */
983         void *reserved_ptrs[2];   /**< Reserved for future fields */
984 };
985
986 /**
987  * @warning
988  * @b EXPERIMENTAL: this structure may change without prior notice.
989  *
990  * A structure used to configure an Rx packet segment to split.
991  *
992  * If RTE_ETH_RX_OFFLOAD_BUFFER_SPLIT flag is set in offloads field,
993  * the PMD will split the received packets into multiple segments
994  * according to the specification in the description array:
995  *
996  * - The first network buffer will be allocated from the memory pool,
997  *   specified in the first array element, the second buffer, from the
998  *   pool in the second element, and so on.
999  *
1000  * - The offsets from the segment description elements specify
1001  *   the data offset from the buffer beginning except the first mbuf.
1002  *   The first segment offset is added with RTE_PKTMBUF_HEADROOM.
1003  *
1004  * - The lengths in the elements define the maximal data amount
1005  *   being received to each segment. The receiving starts with filling
1006  *   up the first mbuf data buffer up to specified length. If the
1007  *   there are data remaining (packet is longer than buffer in the first
1008  *   mbuf) the following data will be pushed to the next segment
1009  *   up to its own length, and so on.
1010  *
1011  * - If the length in the segment description element is zero
1012  *   the actual buffer size will be deduced from the appropriate
1013  *   memory pool properties.
1014  *
1015  * - If there is not enough elements to describe the buffer for entire
1016  *   packet of maximal length the following parameters will be used
1017  *   for the all remaining segments:
1018  *     - pool from the last valid element
1019  *     - the buffer size from this pool
1020  *     - zero offset
1021  */
1022 struct rte_eth_rxseg_split {
1023         struct rte_mempool *mp; /**< Memory pool to allocate segment from. */
1024         uint16_t length; /**< Segment data length, configures split point. */
1025         uint16_t offset; /**< Data offset from beginning of mbuf data buffer. */
1026         uint32_t reserved; /**< Reserved field. */
1027 };
1028
1029 /**
1030  * @warning
1031  * @b EXPERIMENTAL: this structure may change without prior notice.
1032  *
1033  * A common structure used to describe Rx packet segment properties.
1034  */
1035 union rte_eth_rxseg {
1036         /* The settings for buffer split offload. */
1037         struct rte_eth_rxseg_split split;
1038         /* The other features settings should be added here. */
1039 };
1040
1041 /**
1042  * A structure used to configure an RX ring of an Ethernet port.
1043  */
1044 struct rte_eth_rxconf {
1045         struct rte_eth_thresh rx_thresh; /**< RX ring threshold registers. */
1046         uint16_t rx_free_thresh; /**< Drives the freeing of RX descriptors. */
1047         uint8_t rx_drop_en; /**< Drop packets if no descriptors are available. */
1048         uint8_t rx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
1049         uint16_t rx_nseg; /**< Number of descriptions in rx_seg array. */
1050         /**
1051          * Per-queue Rx offloads to be set using DEV_RX_OFFLOAD_* flags.
1052          * Only offloads set on rx_queue_offload_capa or rx_offload_capa
1053          * fields on rte_eth_dev_info structure are allowed to be set.
1054          */
1055         uint64_t offloads;
1056         /**
1057          * Points to the array of segment descriptions for an entire packet.
1058          * Array elements are properties for consecutive Rx segments.
1059          *
1060          * The supported capabilities of receiving segmentation is reported
1061          * in rte_eth_dev_info.rx_seg_capa field.
1062          */
1063         union rte_eth_rxseg *rx_seg;
1064
1065         uint64_t reserved_64s[2]; /**< Reserved for future fields */
1066         void *reserved_ptrs[2];   /**< Reserved for future fields */
1067 };
1068
1069 /**
1070  * A structure used to configure a TX ring of an Ethernet port.
1071  */
1072 struct rte_eth_txconf {
1073         struct rte_eth_thresh tx_thresh; /**< TX ring threshold registers. */
1074         uint16_t tx_rs_thresh; /**< Drives the setting of RS bit on TXDs. */
1075         uint16_t tx_free_thresh; /**< Start freeing TX buffers if there are
1076                                       less free descriptors than this value. */
1077
1078         uint8_t tx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
1079         /**
1080          * Per-queue Tx offloads to be set  using DEV_TX_OFFLOAD_* flags.
1081          * Only offloads set on tx_queue_offload_capa or tx_offload_capa
1082          * fields on rte_eth_dev_info structure are allowed to be set.
1083          */
1084         uint64_t offloads;
1085
1086         uint64_t reserved_64s[2]; /**< Reserved for future fields */
1087         void *reserved_ptrs[2];   /**< Reserved for future fields */
1088 };
1089
1090 /**
1091  * @warning
1092  * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
1093  *
1094  * A structure used to return the hairpin capabilities that are supported.
1095  */
1096 struct rte_eth_hairpin_cap {
1097         /** The max number of hairpin queues (different bindings). */
1098         uint16_t max_nb_queues;
1099         /** Max number of Rx queues to be connected to one Tx queue. */
1100         uint16_t max_rx_2_tx;
1101         /** Max number of Tx queues to be connected to one Rx queue. */
1102         uint16_t max_tx_2_rx;
1103         uint16_t max_nb_desc; /**< The max num of descriptors. */
1104 };
1105
1106 #define RTE_ETH_MAX_HAIRPIN_PEERS 32
1107
1108 /**
1109  * @warning
1110  * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
1111  *
1112  * A structure used to hold hairpin peer data.
1113  */
1114 struct rte_eth_hairpin_peer {
1115         uint16_t port; /**< Peer port. */
1116         uint16_t queue; /**< Peer queue. */
1117 };
1118
1119 /**
1120  * @warning
1121  * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
1122  *
1123  * A structure used to configure hairpin binding.
1124  */
1125 struct rte_eth_hairpin_conf {
1126         uint32_t peer_count:16; /**< The number of peers. */
1127
1128         /**
1129          * Explicit Tx flow rule mode.
1130          * One hairpin pair of queues should have the same attribute.
1131          *
1132          * - When set, the user should be responsible for inserting the hairpin
1133          *   Tx part flows and removing them.
1134          * - When clear, the PMD will try to handle the Tx part of the flows,
1135          *   e.g., by splitting one flow into two parts.
1136          */
1137         uint32_t tx_explicit:1;
1138
1139         /**
1140          * Manually bind hairpin queues.
1141          * One hairpin pair of queues should have the same attribute.
1142          *
1143          * - When set, to enable hairpin, the user should call the hairpin bind
1144          *   function after all the queues are set up properly and the ports are
1145          *   started. Also, the hairpin unbind function should be called
1146          *   accordingly before stopping a port that with hairpin configured.
1147          * - When clear, the PMD will try to enable the hairpin with the queues
1148          *   configured automatically during port start.
1149          */
1150         uint32_t manual_bind:1;
1151         uint32_t reserved:14; /**< Reserved bits. */
1152         struct rte_eth_hairpin_peer peers[RTE_ETH_MAX_HAIRPIN_PEERS];
1153 };
1154
1155 /**
1156  * A structure contains information about HW descriptor ring limitations.
1157  */
1158 struct rte_eth_desc_lim {
1159         uint16_t nb_max;   /**< Max allowed number of descriptors. */
1160         uint16_t nb_min;   /**< Min allowed number of descriptors. */
1161         uint16_t nb_align; /**< Number of descriptors should be aligned to. */
1162
1163         /**
1164          * Max allowed number of segments per whole packet.
1165          *
1166          * - For TSO packet this is the total number of data descriptors allowed
1167          *   by device.
1168          *
1169          * @see nb_mtu_seg_max
1170          */
1171         uint16_t nb_seg_max;
1172
1173         /**
1174          * Max number of segments per one MTU.
1175          *
1176          * - For non-TSO packet, this is the maximum allowed number of segments
1177          *   in a single transmit packet.
1178          *
1179          * - For TSO packet each segment within the TSO may span up to this
1180          *   value.
1181          *
1182          * @see nb_seg_max
1183          */
1184         uint16_t nb_mtu_seg_max;
1185 };
1186
1187 /**
1188  * This enum indicates the flow control mode
1189  */
1190 enum rte_eth_fc_mode {
1191         RTE_FC_NONE = 0, /**< Disable flow control. */
1192         RTE_FC_RX_PAUSE, /**< RX pause frame, enable flowctrl on TX side. */
1193         RTE_FC_TX_PAUSE, /**< TX pause frame, enable flowctrl on RX side. */
1194         RTE_FC_FULL      /**< Enable flow control on both side. */
1195 };
1196
1197 /**
1198  * A structure used to configure Ethernet flow control parameter.
1199  * These parameters will be configured into the register of the NIC.
1200  * Please refer to the corresponding data sheet for proper value.
1201  */
1202 struct rte_eth_fc_conf {
1203         uint32_t high_water;  /**< High threshold value to trigger XOFF */
1204         uint32_t low_water;   /**< Low threshold value to trigger XON */
1205         uint16_t pause_time;  /**< Pause quota in the Pause frame */
1206         uint16_t send_xon;    /**< Is XON frame need be sent */
1207         enum rte_eth_fc_mode mode;  /**< Link flow control mode */
1208         uint8_t mac_ctrl_frame_fwd; /**< Forward MAC control frames */
1209         uint8_t autoneg;      /**< Use Pause autoneg */
1210 };
1211
1212 /**
1213  * A structure used to configure Ethernet priority flow control parameter.
1214  * These parameters will be configured into the register of the NIC.
1215  * Please refer to the corresponding data sheet for proper value.
1216  */
1217 struct rte_eth_pfc_conf {
1218         struct rte_eth_fc_conf fc; /**< General flow control parameter. */
1219         uint8_t priority;          /**< VLAN User Priority. */
1220 };
1221
1222 /**
1223  * Tunnel type for device-specific classifier configuration.
1224  * @see rte_eth_udp_tunnel
1225  */
1226 enum rte_eth_tunnel_type {
1227         RTE_TUNNEL_TYPE_NONE = 0,
1228         RTE_TUNNEL_TYPE_VXLAN,
1229         RTE_TUNNEL_TYPE_GENEVE,
1230         RTE_TUNNEL_TYPE_TEREDO,
1231         RTE_TUNNEL_TYPE_NVGRE,
1232         RTE_TUNNEL_TYPE_IP_IN_GRE,
1233         RTE_L2_TUNNEL_TYPE_E_TAG,
1234         RTE_TUNNEL_TYPE_VXLAN_GPE,
1235         RTE_TUNNEL_TYPE_ECPRI,
1236         RTE_TUNNEL_TYPE_MAX,
1237 };
1238
1239 /* Deprecated API file for rte_eth_dev_filter_* functions */
1240 #include "rte_eth_ctrl.h"
1241
1242 /**
1243  *  Memory space that can be configured to store Flow Director filters
1244  *  in the board memory.
1245  */
1246 enum rte_fdir_pballoc_type {
1247         RTE_FDIR_PBALLOC_64K = 0,  /**< 64k. */
1248         RTE_FDIR_PBALLOC_128K,     /**< 128k. */
1249         RTE_FDIR_PBALLOC_256K,     /**< 256k. */
1250 };
1251
1252 /**
1253  *  Select report mode of FDIR hash information in RX descriptors.
1254  */
1255 enum rte_fdir_status_mode {
1256         RTE_FDIR_NO_REPORT_STATUS = 0, /**< Never report FDIR hash. */
1257         RTE_FDIR_REPORT_STATUS, /**< Only report FDIR hash for matching pkts. */
1258         RTE_FDIR_REPORT_STATUS_ALWAYS, /**< Always report FDIR hash. */
1259 };
1260
1261 /**
1262  * A structure used to configure the Flow Director (FDIR) feature
1263  * of an Ethernet port.
1264  *
1265  * If mode is RTE_FDIR_MODE_NONE, the pballoc value is ignored.
1266  */
1267 struct rte_fdir_conf {
1268         enum rte_fdir_mode mode; /**< Flow Director mode. */
1269         enum rte_fdir_pballoc_type pballoc; /**< Space for FDIR filters. */
1270         enum rte_fdir_status_mode status;  /**< How to report FDIR hash. */
1271         /** RX queue of packets matching a "drop" filter in perfect mode. */
1272         uint8_t drop_queue;
1273         struct rte_eth_fdir_masks mask;
1274         struct rte_eth_fdir_flex_conf flex_conf;
1275         /**< Flex payload configuration. */
1276 };
1277
1278 /**
1279  * UDP tunneling configuration.
1280  *
1281  * Used to configure the classifier of a device,
1282  * associating an UDP port with a type of tunnel.
1283  *
1284  * Some NICs may need such configuration to properly parse a tunnel
1285  * with any standard or custom UDP port.
1286  */
1287 struct rte_eth_udp_tunnel {
1288         uint16_t udp_port; /**< UDP port used for the tunnel. */
1289         uint8_t prot_type; /**< Tunnel type. @see rte_eth_tunnel_type */
1290 };
1291
1292 /**
1293  * A structure used to enable/disable specific device interrupts.
1294  */
1295 struct rte_intr_conf {
1296         /** enable/disable lsc interrupt. 0 (default) - disable, 1 enable */
1297         uint32_t lsc:1;
1298         /** enable/disable rxq interrupt. 0 (default) - disable, 1 enable */
1299         uint32_t rxq:1;
1300         /** enable/disable rmv interrupt. 0 (default) - disable, 1 enable */
1301         uint32_t rmv:1;
1302 };
1303
1304 /**
1305  * A structure used to configure an Ethernet port.
1306  * Depending upon the RX multi-queue mode, extra advanced
1307  * configuration settings may be needed.
1308  */
1309 struct rte_eth_conf {
1310         uint32_t link_speeds; /**< bitmap of ETH_LINK_SPEED_XXX of speeds to be
1311                                 used. ETH_LINK_SPEED_FIXED disables link
1312                                 autonegotiation, and a unique speed shall be
1313                                 set. Otherwise, the bitmap defines the set of
1314                                 speeds to be advertised. If the special value
1315                                 ETH_LINK_SPEED_AUTONEG (0) is used, all speeds
1316                                 supported are advertised. */
1317         struct rte_eth_rxmode rxmode; /**< Port RX configuration. */
1318         struct rte_eth_txmode txmode; /**< Port TX configuration. */
1319         uint32_t lpbk_mode; /**< Loopback operation mode. By default the value
1320                                  is 0, meaning the loopback mode is disabled.
1321                                  Read the datasheet of given ethernet controller
1322                                  for details. The possible values of this field
1323                                  are defined in implementation of each driver. */
1324         struct {
1325                 struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
1326                 struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
1327                 /**< Port vmdq+dcb configuration. */
1328                 struct rte_eth_dcb_rx_conf dcb_rx_conf;
1329                 /**< Port dcb RX configuration. */
1330                 struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
1331                 /**< Port vmdq RX configuration. */
1332         } rx_adv_conf; /**< Port RX filtering configuration. */
1333         union {
1334                 struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
1335                 /**< Port vmdq+dcb TX configuration. */
1336                 struct rte_eth_dcb_tx_conf dcb_tx_conf;
1337                 /**< Port dcb TX configuration. */
1338                 struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
1339                 /**< Port vmdq TX configuration. */
1340         } tx_adv_conf; /**< Port TX DCB configuration (union). */
1341         /** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
1342             is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
1343         uint32_t dcb_capability_en;
1344         struct rte_fdir_conf fdir_conf; /**< FDIR configuration. DEPRECATED */
1345         struct rte_intr_conf intr_conf; /**< Interrupt mode configuration. */
1346 };
1347
1348 /**
1349  * RX offload capabilities of a device.
1350  */
1351 #define DEV_RX_OFFLOAD_VLAN_STRIP  0x00000001
1352 #define DEV_RX_OFFLOAD_IPV4_CKSUM  0x00000002
1353 #define DEV_RX_OFFLOAD_UDP_CKSUM   0x00000004
1354 #define DEV_RX_OFFLOAD_TCP_CKSUM   0x00000008
1355 #define DEV_RX_OFFLOAD_TCP_LRO     0x00000010
1356 #define DEV_RX_OFFLOAD_QINQ_STRIP  0x00000020
1357 #define DEV_RX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000040
1358 #define DEV_RX_OFFLOAD_MACSEC_STRIP     0x00000080
1359 #define DEV_RX_OFFLOAD_HEADER_SPLIT     0x00000100
1360 #define DEV_RX_OFFLOAD_VLAN_FILTER      0x00000200
1361 #define DEV_RX_OFFLOAD_VLAN_EXTEND      0x00000400
1362 #define DEV_RX_OFFLOAD_JUMBO_FRAME      0x00000800
1363 #define DEV_RX_OFFLOAD_SCATTER          0x00002000
1364 /**
1365  * Timestamp is set by the driver in RTE_MBUF_DYNFIELD_TIMESTAMP_NAME
1366  * and RTE_MBUF_DYNFLAG_RX_TIMESTAMP_NAME is set in ol_flags.
1367  * The mbuf field and flag are registered when the offload is configured.
1368  */
1369 #define DEV_RX_OFFLOAD_TIMESTAMP        0x00004000
1370 #define DEV_RX_OFFLOAD_SECURITY         0x00008000
1371 #define DEV_RX_OFFLOAD_KEEP_CRC         0x00010000
1372 #define DEV_RX_OFFLOAD_SCTP_CKSUM       0x00020000
1373 #define DEV_RX_OFFLOAD_OUTER_UDP_CKSUM  0x00040000
1374 #define DEV_RX_OFFLOAD_RSS_HASH         0x00080000
1375 #define RTE_ETH_RX_OFFLOAD_BUFFER_SPLIT 0x00100000
1376
1377 #define DEV_RX_OFFLOAD_CHECKSUM (DEV_RX_OFFLOAD_IPV4_CKSUM | \
1378                                  DEV_RX_OFFLOAD_UDP_CKSUM | \
1379                                  DEV_RX_OFFLOAD_TCP_CKSUM)
1380 #define DEV_RX_OFFLOAD_VLAN (DEV_RX_OFFLOAD_VLAN_STRIP | \
1381                              DEV_RX_OFFLOAD_VLAN_FILTER | \
1382                              DEV_RX_OFFLOAD_VLAN_EXTEND | \
1383                              DEV_RX_OFFLOAD_QINQ_STRIP)
1384
1385 /*
1386  * If new Rx offload capabilities are defined, they also must be
1387  * mentioned in rte_rx_offload_names in rte_ethdev.c file.
1388  */
1389
1390 /**
1391  * TX offload capabilities of a device.
1392  */
1393 #define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001
1394 #define DEV_TX_OFFLOAD_IPV4_CKSUM  0x00000002
1395 #define DEV_TX_OFFLOAD_UDP_CKSUM   0x00000004
1396 #define DEV_TX_OFFLOAD_TCP_CKSUM   0x00000008
1397 #define DEV_TX_OFFLOAD_SCTP_CKSUM  0x00000010
1398 #define DEV_TX_OFFLOAD_TCP_TSO     0x00000020
1399 #define DEV_TX_OFFLOAD_UDP_TSO     0x00000040
1400 #define DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000080 /**< Used for tunneling packet. */
1401 #define DEV_TX_OFFLOAD_QINQ_INSERT 0x00000100
1402 #define DEV_TX_OFFLOAD_VXLAN_TNL_TSO    0x00000200    /**< Used for tunneling packet. */
1403 #define DEV_TX_OFFLOAD_GRE_TNL_TSO      0x00000400    /**< Used for tunneling packet. */
1404 #define DEV_TX_OFFLOAD_IPIP_TNL_TSO     0x00000800    /**< Used for tunneling packet. */
1405 #define DEV_TX_OFFLOAD_GENEVE_TNL_TSO   0x00001000    /**< Used for tunneling packet. */
1406 #define DEV_TX_OFFLOAD_MACSEC_INSERT    0x00002000
1407 #define DEV_TX_OFFLOAD_MT_LOCKFREE      0x00004000
1408 /**< Multiple threads can invoke rte_eth_tx_burst() concurrently on the same
1409  * tx queue without SW lock.
1410  */
1411 #define DEV_TX_OFFLOAD_MULTI_SEGS       0x00008000
1412 /**< Device supports multi segment send. */
1413 #define DEV_TX_OFFLOAD_MBUF_FAST_FREE   0x00010000
1414 /**< Device supports optimization for fast release of mbufs.
1415  *   When set application must guarantee that per-queue all mbufs comes from
1416  *   the same mempool and has refcnt = 1.
1417  */
1418 #define DEV_TX_OFFLOAD_SECURITY         0x00020000
1419 /**
1420  * Device supports generic UDP tunneled packet TSO.
1421  * Application must set PKT_TX_TUNNEL_UDP and other mbuf fields required
1422  * for tunnel TSO.
1423  */
1424 #define DEV_TX_OFFLOAD_UDP_TNL_TSO      0x00040000
1425 /**
1426  * Device supports generic IP tunneled packet TSO.
1427  * Application must set PKT_TX_TUNNEL_IP and other mbuf fields required
1428  * for tunnel TSO.
1429  */
1430 #define DEV_TX_OFFLOAD_IP_TNL_TSO       0x00080000
1431 /** Device supports outer UDP checksum */
1432 #define DEV_TX_OFFLOAD_OUTER_UDP_CKSUM  0x00100000
1433 /**
1434  * Device sends on time read from RTE_MBUF_DYNFIELD_TIMESTAMP_NAME
1435  * if RTE_MBUF_DYNFLAG_TX_TIMESTAMP_NAME is set in ol_flags.
1436  * The mbuf field and flag are registered when the offload is configured.
1437  */
1438 #define DEV_TX_OFFLOAD_SEND_ON_TIMESTAMP 0x00200000
1439 /*
1440  * If new Tx offload capabilities are defined, they also must be
1441  * mentioned in rte_tx_offload_names in rte_ethdev.c file.
1442  */
1443
1444 /**@{@name Device capabilities
1445  * Non-offload capabilities reported in rte_eth_dev_info.dev_capa.
1446  */
1447 /** Device supports Rx queue setup after device started. */
1448 #define RTE_ETH_DEV_CAPA_RUNTIME_RX_QUEUE_SETUP 0x00000001
1449 /** Device supports Tx queue setup after device started. */
1450 #define RTE_ETH_DEV_CAPA_RUNTIME_TX_QUEUE_SETUP 0x00000002
1451 /**@}*/
1452
1453 /*
1454  * Fallback default preferred Rx/Tx port parameters.
1455  * These are used if an application requests default parameters
1456  * but the PMD does not provide preferred values.
1457  */
1458 #define RTE_ETH_DEV_FALLBACK_RX_RINGSIZE 512
1459 #define RTE_ETH_DEV_FALLBACK_TX_RINGSIZE 512
1460 #define RTE_ETH_DEV_FALLBACK_RX_NBQUEUES 1
1461 #define RTE_ETH_DEV_FALLBACK_TX_NBQUEUES 1
1462
1463 /**
1464  * Preferred Rx/Tx port parameters.
1465  * There are separate instances of this structure for transmission
1466  * and reception respectively.
1467  */
1468 struct rte_eth_dev_portconf {
1469         uint16_t burst_size; /**< Device-preferred burst size */
1470         uint16_t ring_size; /**< Device-preferred size of queue rings */
1471         uint16_t nb_queues; /**< Device-preferred number of queues */
1472 };
1473
1474 /**
1475  * Default values for switch domain id when ethdev does not support switch
1476  * domain definitions.
1477  */
1478 #define RTE_ETH_DEV_SWITCH_DOMAIN_ID_INVALID    (UINT16_MAX)
1479
1480 /**
1481  * Ethernet device associated switch information
1482  */
1483 struct rte_eth_switch_info {
1484         const char *name;       /**< switch name */
1485         uint16_t domain_id;     /**< switch domain id */
1486         uint16_t port_id;
1487         /**<
1488          * mapping to the devices physical switch port as enumerated from the
1489          * perspective of the embedded interconnect/switch. For SR-IOV enabled
1490          * device this may correspond to the VF_ID of each virtual function,
1491          * but each driver should explicitly define the mapping of switch
1492          * port identifier to that physical interconnect/switch
1493          */
1494 };
1495
1496 /**
1497  * @warning
1498  * @b EXPERIMENTAL: this structure may change without prior notice.
1499  *
1500  * Ethernet device Rx buffer segmentation capabilities.
1501  */
1502 struct rte_eth_rxseg_capa {
1503         __extension__
1504         uint32_t multi_pools:1; /**< Supports receiving to multiple pools.*/
1505         uint32_t offset_allowed:1; /**< Supports buffer offsets. */
1506         uint32_t offset_align_log2:4; /**< Required offset alignment. */
1507         uint16_t max_nseg; /**< Maximum amount of segments to split. */
1508         uint16_t reserved; /**< Reserved field. */
1509 };
1510
1511 /**
1512  * Ethernet device information
1513  */
1514
1515 /**
1516  * Ethernet device representor port type.
1517  */
1518 enum rte_eth_representor_type {
1519         RTE_ETH_REPRESENTOR_NONE, /**< not a representor. */
1520         RTE_ETH_REPRESENTOR_VF,   /**< representor of Virtual Function. */
1521         RTE_ETH_REPRESENTOR_SF,   /**< representor of Sub Function. */
1522         RTE_ETH_REPRESENTOR_PF,   /**< representor of Physical Function. */
1523 };
1524
1525 /**
1526  * A structure used to retrieve the contextual information of
1527  * an Ethernet device, such as the controlling driver of the
1528  * device, etc...
1529  */
1530 struct rte_eth_dev_info {
1531         struct rte_device *device; /** Generic device information */
1532         const char *driver_name; /**< Device Driver name. */
1533         unsigned int if_index; /**< Index to bound host interface, or 0 if none.
1534                 Use if_indextoname() to translate into an interface name. */
1535         uint16_t min_mtu;       /**< Minimum MTU allowed */
1536         uint16_t max_mtu;       /**< Maximum MTU allowed */
1537         const uint32_t *dev_flags; /**< Device flags */
1538         uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
1539         uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
1540         /** Maximum configurable size of LRO aggregated packet. */
1541         uint32_t max_lro_pkt_size;
1542         uint16_t max_rx_queues; /**< Maximum number of RX queues. */
1543         uint16_t max_tx_queues; /**< Maximum number of TX queues. */
1544         uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
1545         uint32_t max_hash_mac_addrs;
1546         /** Maximum number of hash MAC addresses for MTA and UTA. */
1547         uint16_t max_vfs; /**< Maximum number of VFs. */
1548         uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
1549         struct rte_eth_rxseg_capa rx_seg_capa; /**< Segmentation capability.*/
1550         uint64_t rx_offload_capa;
1551         /**< All RX offload capabilities including all per-queue ones */
1552         uint64_t tx_offload_capa;
1553         /**< All TX offload capabilities including all per-queue ones */
1554         uint64_t rx_queue_offload_capa;
1555         /**< Device per-queue RX offload capabilities. */
1556         uint64_t tx_queue_offload_capa;
1557         /**< Device per-queue TX offload capabilities. */
1558         uint16_t reta_size;
1559         /**< Device redirection table size, the total number of entries. */
1560         uint8_t hash_key_size; /**< Hash key size in bytes */
1561         /** Bit mask of RSS offloads, the bit offset also means flow type */
1562         uint64_t flow_type_rss_offloads;
1563         struct rte_eth_rxconf default_rxconf; /**< Default RX configuration */
1564         struct rte_eth_txconf default_txconf; /**< Default TX configuration */
1565         uint16_t vmdq_queue_base; /**< First queue ID for VMDQ pools. */
1566         uint16_t vmdq_queue_num;  /**< Queue number for VMDQ pools. */
1567         uint16_t vmdq_pool_base;  /**< First ID of VMDQ pools. */
1568         struct rte_eth_desc_lim rx_desc_lim;  /**< RX descriptors limits */
1569         struct rte_eth_desc_lim tx_desc_lim;  /**< TX descriptors limits */
1570         uint32_t speed_capa;  /**< Supported speeds bitmap (ETH_LINK_SPEED_). */
1571         /** Configured number of rx/tx queues */
1572         uint16_t nb_rx_queues; /**< Number of RX queues. */
1573         uint16_t nb_tx_queues; /**< Number of TX queues. */
1574         /** Rx parameter recommendations */
1575         struct rte_eth_dev_portconf default_rxportconf;
1576         /** Tx parameter recommendations */
1577         struct rte_eth_dev_portconf default_txportconf;
1578         /** Generic device capabilities (RTE_ETH_DEV_CAPA_). */
1579         uint64_t dev_capa;
1580         /**
1581          * Switching information for ports on a device with a
1582          * embedded managed interconnect/switch.
1583          */
1584         struct rte_eth_switch_info switch_info;
1585
1586         uint64_t reserved_64s[2]; /**< Reserved for future fields */
1587         void *reserved_ptrs[2];   /**< Reserved for future fields */
1588 };
1589
1590 /**
1591  * RX/TX queue states
1592  */
1593 #define RTE_ETH_QUEUE_STATE_STOPPED 0
1594 #define RTE_ETH_QUEUE_STATE_STARTED 1
1595 #define RTE_ETH_QUEUE_STATE_HAIRPIN 2
1596
1597 /**
1598  * Ethernet device RX queue information structure.
1599  * Used to retrieve information about configured queue.
1600  */
1601 struct rte_eth_rxq_info {
1602         struct rte_mempool *mp;     /**< mempool used by that queue. */
1603         struct rte_eth_rxconf conf; /**< queue config parameters. */
1604         uint8_t scattered_rx;       /**< scattered packets RX supported. */
1605         uint8_t queue_state;        /**< one of RTE_ETH_QUEUE_STATE_*. */
1606         uint16_t nb_desc;           /**< configured number of RXDs. */
1607         uint16_t rx_buf_size;       /**< hardware receive buffer size. */
1608 } __rte_cache_min_aligned;
1609
1610 /**
1611  * Ethernet device TX queue information structure.
1612  * Used to retrieve information about configured queue.
1613  */
1614 struct rte_eth_txq_info {
1615         struct rte_eth_txconf conf; /**< queue config parameters. */
1616         uint16_t nb_desc;           /**< configured number of TXDs. */
1617         uint8_t queue_state;        /**< one of RTE_ETH_QUEUE_STATE_*. */
1618 } __rte_cache_min_aligned;
1619
1620 /* Generic Burst mode flag definition, values can be ORed. */
1621
1622 /**
1623  * If the queues have different burst mode description, this bit will be set
1624  * by PMD, then the application can iterate to retrieve burst description for
1625  * all other queues.
1626  */
1627 #define RTE_ETH_BURST_FLAG_PER_QUEUE     (1ULL << 0)
1628
1629 /**
1630  * Ethernet device RX/TX queue packet burst mode information structure.
1631  * Used to retrieve information about packet burst mode setting.
1632  */
1633 struct rte_eth_burst_mode {
1634         uint64_t flags; /**< The ORed values of RTE_ETH_BURST_FLAG_xxx */
1635
1636 #define RTE_ETH_BURST_MODE_INFO_SIZE 1024 /**< Maximum size for information */
1637         char info[RTE_ETH_BURST_MODE_INFO_SIZE]; /**< burst mode information */
1638 };
1639
1640 /** Maximum name length for extended statistics counters */
1641 #define RTE_ETH_XSTATS_NAME_SIZE 64
1642
1643 /**
1644  * An Ethernet device extended statistic structure
1645  *
1646  * This structure is used by rte_eth_xstats_get() to provide
1647  * statistics that are not provided in the generic *rte_eth_stats*
1648  * structure.
1649  * It maps a name id, corresponding to an index in the array returned
1650  * by rte_eth_xstats_get_names(), to a statistic value.
1651  */
1652 struct rte_eth_xstat {
1653         uint64_t id;        /**< The index in xstats name array. */
1654         uint64_t value;     /**< The statistic counter value. */
1655 };
1656
1657 /**
1658  * A name element for extended statistics.
1659  *
1660  * An array of this structure is returned by rte_eth_xstats_get_names().
1661  * It lists the names of extended statistics for a PMD. The *rte_eth_xstat*
1662  * structure references these names by their array index.
1663  *
1664  * The xstats should follow a common naming scheme.
1665  * Some names are standardized in rte_stats_strings.
1666  * Examples:
1667  *     - rx_missed_errors
1668  *     - tx_q3_bytes
1669  *     - tx_size_128_to_255_packets
1670  */
1671 struct rte_eth_xstat_name {
1672         char name[RTE_ETH_XSTATS_NAME_SIZE]; /**< The statistic name. */
1673 };
1674
1675 #define ETH_DCB_NUM_TCS    8
1676 #define ETH_MAX_VMDQ_POOL  64
1677
1678 /**
1679  * A structure used to get the information of queue and
1680  * TC mapping on both TX and RX paths.
1681  */
1682 struct rte_eth_dcb_tc_queue_mapping {
1683         /** rx queues assigned to tc per Pool */
1684         struct {
1685                 uint16_t base;
1686                 uint16_t nb_queue;
1687         } tc_rxq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
1688         /** rx queues assigned to tc per Pool */
1689         struct {
1690                 uint16_t base;
1691                 uint16_t nb_queue;
1692         } tc_txq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
1693 };
1694
1695 /**
1696  * A structure used to get the information of DCB.
1697  * It includes TC UP mapping and queue TC mapping.
1698  */
1699 struct rte_eth_dcb_info {
1700         uint8_t nb_tcs;        /**< number of TCs */
1701         uint8_t prio_tc[ETH_DCB_NUM_USER_PRIORITIES]; /**< Priority to tc */
1702         uint8_t tc_bws[ETH_DCB_NUM_TCS]; /**< TX BW percentage for each TC */
1703         /** rx queues assigned to tc */
1704         struct rte_eth_dcb_tc_queue_mapping tc_queue;
1705 };
1706
1707 /**
1708  * This enum indicates the possible Forward Error Correction (FEC) modes
1709  * of an ethdev port.
1710  */
1711 enum rte_eth_fec_mode {
1712         RTE_ETH_FEC_NOFEC = 0,      /**< FEC is off */
1713         RTE_ETH_FEC_AUTO,           /**< FEC autonegotiation modes */
1714         RTE_ETH_FEC_BASER,          /**< FEC using common algorithm */
1715         RTE_ETH_FEC_RS,             /**< FEC using RS algorithm */
1716 };
1717
1718 /* Translate from FEC mode to FEC capa */
1719 #define RTE_ETH_FEC_MODE_TO_CAPA(x)     (1U << (x))
1720
1721 /* This macro indicates FEC capa mask */
1722 #define RTE_ETH_FEC_MODE_CAPA_MASK(x)   (1U << (RTE_ETH_FEC_ ## x))
1723
1724 /* A structure used to get capabilities per link speed */
1725 struct rte_eth_fec_capa {
1726         uint32_t speed; /**< Link speed (see ETH_SPEED_NUM_*) */
1727         uint32_t capa;  /**< FEC capabilities bitmask */
1728 };
1729
1730 #define RTE_ETH_ALL RTE_MAX_ETHPORTS
1731
1732 /* Macros to check for valid port */
1733 #define RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, retval) do { \
1734         if (!rte_eth_dev_is_valid_port(port_id)) { \
1735                 RTE_ETHDEV_LOG(ERR, "Invalid port_id=%u\n", port_id); \
1736                 return retval; \
1737         } \
1738 } while (0)
1739
1740 #define RTE_ETH_VALID_PORTID_OR_RET(port_id) do { \
1741         if (!rte_eth_dev_is_valid_port(port_id)) { \
1742                 RTE_ETHDEV_LOG(ERR, "Invalid port_id=%u\n", port_id); \
1743                 return; \
1744         } \
1745 } while (0)
1746
1747 /**
1748  * l2 tunnel configuration.
1749  */
1750
1751 /**< l2 tunnel enable mask */
1752 #define ETH_L2_TUNNEL_ENABLE_MASK       0x00000001
1753 /**< l2 tunnel insertion mask */
1754 #define ETH_L2_TUNNEL_INSERTION_MASK    0x00000002
1755 /**< l2 tunnel stripping mask */
1756 #define ETH_L2_TUNNEL_STRIPPING_MASK    0x00000004
1757 /**< l2 tunnel forwarding mask */
1758 #define ETH_L2_TUNNEL_FORWARDING_MASK   0x00000008
1759
1760 /**
1761  * Function type used for RX packet processing packet callbacks.
1762  *
1763  * The callback function is called on RX with a burst of packets that have
1764  * been received on the given port and queue.
1765  *
1766  * @param port_id
1767  *   The Ethernet port on which RX is being performed.
1768  * @param queue
1769  *   The queue on the Ethernet port which is being used to receive the packets.
1770  * @param pkts
1771  *   The burst of packets that have just been received.
1772  * @param nb_pkts
1773  *   The number of packets in the burst pointed to by "pkts".
1774  * @param max_pkts
1775  *   The max number of packets that can be stored in the "pkts" array.
1776  * @param user_param
1777  *   The arbitrary user parameter passed in by the application when the callback
1778  *   was originally configured.
1779  * @return
1780  *   The number of packets returned to the user.
1781  */
1782 typedef uint16_t (*rte_rx_callback_fn)(uint16_t port_id, uint16_t queue,
1783         struct rte_mbuf *pkts[], uint16_t nb_pkts, uint16_t max_pkts,
1784         void *user_param);
1785
1786 /**
1787  * Function type used for TX packet processing packet callbacks.
1788  *
1789  * The callback function is called on TX with a burst of packets immediately
1790  * before the packets are put onto the hardware queue for transmission.
1791  *
1792  * @param port_id
1793  *   The Ethernet port on which TX is being performed.
1794  * @param queue
1795  *   The queue on the Ethernet port which is being used to transmit the packets.
1796  * @param pkts
1797  *   The burst of packets that are about to be transmitted.
1798  * @param nb_pkts
1799  *   The number of packets in the burst pointed to by "pkts".
1800  * @param user_param
1801  *   The arbitrary user parameter passed in by the application when the callback
1802  *   was originally configured.
1803  * @return
1804  *   The number of packets to be written to the NIC.
1805  */
1806 typedef uint16_t (*rte_tx_callback_fn)(uint16_t port_id, uint16_t queue,
1807         struct rte_mbuf *pkts[], uint16_t nb_pkts, void *user_param);
1808
1809 /**
1810  * Possible states of an ethdev port.
1811  */
1812 enum rte_eth_dev_state {
1813         /** Device is unused before being probed. */
1814         RTE_ETH_DEV_UNUSED = 0,
1815         /** Device is attached when allocated in probing. */
1816         RTE_ETH_DEV_ATTACHED,
1817         /** Device is in removed state when plug-out is detected. */
1818         RTE_ETH_DEV_REMOVED,
1819 };
1820
1821 struct rte_eth_dev_sriov {
1822         uint8_t active;               /**< SRIOV is active with 16, 32 or 64 pools */
1823         uint8_t nb_q_per_pool;        /**< rx queue number per pool */
1824         uint16_t def_vmdq_idx;        /**< Default pool num used for PF */
1825         uint16_t def_pool_q_idx;      /**< Default pool queue start reg index */
1826 };
1827 #define RTE_ETH_DEV_SRIOV(dev)         ((dev)->data->sriov)
1828
1829 #define RTE_ETH_NAME_MAX_LEN RTE_DEV_NAME_MAX_LEN
1830
1831 #define RTE_ETH_DEV_NO_OWNER 0
1832
1833 #define RTE_ETH_MAX_OWNER_NAME_LEN 64
1834
1835 struct rte_eth_dev_owner {
1836         uint64_t id; /**< The owner unique identifier. */
1837         char name[RTE_ETH_MAX_OWNER_NAME_LEN]; /**< The owner name. */
1838 };
1839
1840 /** PMD supports thread-safe flow operations */
1841 #define RTE_ETH_DEV_FLOW_OPS_THREAD_SAFE  0x0001
1842 /** Device supports link state interrupt */
1843 #define RTE_ETH_DEV_INTR_LSC     0x0002
1844 /** Device is a bonded slave */
1845 #define RTE_ETH_DEV_BONDED_SLAVE 0x0004
1846 /** Device supports device removal interrupt */
1847 #define RTE_ETH_DEV_INTR_RMV     0x0008
1848 /** Device is port representor */
1849 #define RTE_ETH_DEV_REPRESENTOR  0x0010
1850 /** Device does not support MAC change after started */
1851 #define RTE_ETH_DEV_NOLIVE_MAC_ADDR  0x0020
1852 /**
1853  * Queue xstats filled automatically by ethdev layer.
1854  * PMDs filling the queue xstats themselves should not set this flag
1855  */
1856 #define RTE_ETH_DEV_AUTOFILL_QUEUE_XSTATS 0x0040
1857
1858 /**
1859  * Iterates over valid ethdev ports owned by a specific owner.
1860  *
1861  * @param port_id
1862  *   The id of the next possible valid owned port.
1863  * @param       owner_id
1864  *  The owner identifier.
1865  *  RTE_ETH_DEV_NO_OWNER means iterate over all valid ownerless ports.
1866  * @return
1867  *   Next valid port id owned by owner_id, RTE_MAX_ETHPORTS if there is none.
1868  */
1869 uint64_t rte_eth_find_next_owned_by(uint16_t port_id,
1870                 const uint64_t owner_id);
1871
1872 /**
1873  * Macro to iterate over all enabled ethdev ports owned by a specific owner.
1874  */
1875 #define RTE_ETH_FOREACH_DEV_OWNED_BY(p, o) \
1876         for (p = rte_eth_find_next_owned_by(0, o); \
1877              (unsigned int)p < (unsigned int)RTE_MAX_ETHPORTS; \
1878              p = rte_eth_find_next_owned_by(p + 1, o))
1879
1880 /**
1881  * Iterates over valid ethdev ports.
1882  *
1883  * @param port_id
1884  *   The id of the next possible valid port.
1885  * @return
1886  *   Next valid port id, RTE_MAX_ETHPORTS if there is none.
1887  */
1888 uint16_t rte_eth_find_next(uint16_t port_id);
1889
1890 /**
1891  * Macro to iterate over all enabled and ownerless ethdev ports.
1892  */
1893 #define RTE_ETH_FOREACH_DEV(p) \
1894         RTE_ETH_FOREACH_DEV_OWNED_BY(p, RTE_ETH_DEV_NO_OWNER)
1895
1896 /**
1897  * @warning
1898  * @b EXPERIMENTAL: this API may change without prior notice.
1899  *
1900  * Iterates over ethdev ports of a specified device.
1901  *
1902  * @param port_id_start
1903  *   The id of the next possible valid port.
1904  * @param parent
1905  *   The generic device behind the ports to iterate.
1906  * @return
1907  *   Next port id of the device, possibly port_id_start,
1908  *   RTE_MAX_ETHPORTS if there is none.
1909  */
1910 __rte_experimental
1911 uint16_t
1912 rte_eth_find_next_of(uint16_t port_id_start,
1913                 const struct rte_device *parent);
1914
1915 /**
1916  * Macro to iterate over all ethdev ports of a specified device.
1917  *
1918  * @param port_id
1919  *   The id of the matching port being iterated.
1920  * @param parent
1921  *   The rte_device pointer matching the iterated ports.
1922  */
1923 #define RTE_ETH_FOREACH_DEV_OF(port_id, parent) \
1924         for (port_id = rte_eth_find_next_of(0, parent); \
1925                 port_id < RTE_MAX_ETHPORTS; \
1926                 port_id = rte_eth_find_next_of(port_id + 1, parent))
1927
1928 /**
1929  * @warning
1930  * @b EXPERIMENTAL: this API may change without prior notice.
1931  *
1932  * Iterates over sibling ethdev ports (i.e. sharing the same rte_device).
1933  *
1934  * @param port_id_start
1935  *   The id of the next possible valid sibling port.
1936  * @param ref_port_id
1937  *   The id of a reference port to compare rte_device with.
1938  * @return
1939  *   Next sibling port id, possibly port_id_start or ref_port_id itself,
1940  *   RTE_MAX_ETHPORTS if there is none.
1941  */
1942 __rte_experimental
1943 uint16_t
1944 rte_eth_find_next_sibling(uint16_t port_id_start, uint16_t ref_port_id);
1945
1946 /**
1947  * Macro to iterate over all ethdev ports sharing the same rte_device
1948  * as the specified port.
1949  * Note: the specified reference port is part of the loop iterations.
1950  *
1951  * @param port_id
1952  *   The id of the matching port being iterated.
1953  * @param ref_port_id
1954  *   The id of the port being compared.
1955  */
1956 #define RTE_ETH_FOREACH_DEV_SIBLING(port_id, ref_port_id) \
1957         for (port_id = rte_eth_find_next_sibling(0, ref_port_id); \
1958                 port_id < RTE_MAX_ETHPORTS; \
1959                 port_id = rte_eth_find_next_sibling(port_id + 1, ref_port_id))
1960
1961 /**
1962  * @warning
1963  * @b EXPERIMENTAL: this API may change without prior notice.
1964  *
1965  * Get a new unique owner identifier.
1966  * An owner identifier is used to owns Ethernet devices by only one DPDK entity
1967  * to avoid multiple management of device by different entities.
1968  *
1969  * @param       owner_id
1970  *   Owner identifier pointer.
1971  * @return
1972  *   Negative errno value on error, 0 on success.
1973  */
1974 __rte_experimental
1975 int rte_eth_dev_owner_new(uint64_t *owner_id);
1976
1977 /**
1978  * @warning
1979  * @b EXPERIMENTAL: this API may change without prior notice.
1980  *
1981  * Set an Ethernet device owner.
1982  *
1983  * @param       port_id
1984  *  The identifier of the port to own.
1985  * @param       owner
1986  *  The owner pointer.
1987  * @return
1988  *  Negative errno value on error, 0 on success.
1989  */
1990 __rte_experimental
1991 int rte_eth_dev_owner_set(const uint16_t port_id,
1992                 const struct rte_eth_dev_owner *owner);
1993
1994 /**
1995  * @warning
1996  * @b EXPERIMENTAL: this API may change without prior notice.
1997  *
1998  * Unset Ethernet device owner to make the device ownerless.
1999  *
2000  * @param       port_id
2001  *  The identifier of port to make ownerless.
2002  * @param       owner_id
2003  *  The owner identifier.
2004  * @return
2005  *  0 on success, negative errno value on error.
2006  */
2007 __rte_experimental
2008 int rte_eth_dev_owner_unset(const uint16_t port_id,
2009                 const uint64_t owner_id);
2010
2011 /**
2012  * @warning
2013  * @b EXPERIMENTAL: this API may change without prior notice.
2014  *
2015  * Remove owner from all Ethernet devices owned by a specific owner.
2016  *
2017  * @param       owner_id
2018  *  The owner identifier.
2019  * @return
2020  *  0 on success, negative errno value on error.
2021  */
2022 __rte_experimental
2023 int rte_eth_dev_owner_delete(const uint64_t owner_id);
2024
2025 /**
2026  * @warning
2027  * @b EXPERIMENTAL: this API may change without prior notice.
2028  *
2029  * Get the owner of an Ethernet device.
2030  *
2031  * @param       port_id
2032  *  The port identifier.
2033  * @param       owner
2034  *  The owner structure pointer to fill.
2035  * @return
2036  *  0 on success, negative errno value on error..
2037  */
2038 __rte_experimental
2039 int rte_eth_dev_owner_get(const uint16_t port_id,
2040                 struct rte_eth_dev_owner *owner);
2041
2042 /**
2043  * Get the number of ports which are usable for the application.
2044  *
2045  * These devices must be iterated by using the macro
2046  * ``RTE_ETH_FOREACH_DEV`` or ``RTE_ETH_FOREACH_DEV_OWNED_BY``
2047  * to deal with non-contiguous ranges of devices.
2048  *
2049  * @return
2050  *   The count of available Ethernet devices.
2051  */
2052 uint16_t rte_eth_dev_count_avail(void);
2053
2054 /**
2055  * Get the total number of ports which are allocated.
2056  *
2057  * Some devices may not be available for the application.
2058  *
2059  * @return
2060  *   The total count of Ethernet devices.
2061  */
2062 uint16_t rte_eth_dev_count_total(void);
2063
2064 /**
2065  * Convert a numerical speed in Mbps to a bitmap flag that can be used in
2066  * the bitmap link_speeds of the struct rte_eth_conf
2067  *
2068  * @param speed
2069  *   Numerical speed value in Mbps
2070  * @param duplex
2071  *   ETH_LINK_[HALF/FULL]_DUPLEX (only for 10/100M speeds)
2072  * @return
2073  *   0 if the speed cannot be mapped
2074  */
2075 uint32_t rte_eth_speed_bitflag(uint32_t speed, int duplex);
2076
2077 /**
2078  * Get DEV_RX_OFFLOAD_* flag name.
2079  *
2080  * @param offload
2081  *   Offload flag.
2082  * @return
2083  *   Offload name or 'UNKNOWN' if the flag cannot be recognised.
2084  */
2085 const char *rte_eth_dev_rx_offload_name(uint64_t offload);
2086
2087 /**
2088  * Get DEV_TX_OFFLOAD_* flag name.
2089  *
2090  * @param offload
2091  *   Offload flag.
2092  * @return
2093  *   Offload name or 'UNKNOWN' if the flag cannot be recognised.
2094  */
2095 const char *rte_eth_dev_tx_offload_name(uint64_t offload);
2096
2097 /**
2098  * Configure an Ethernet device.
2099  * This function must be invoked first before any other function in the
2100  * Ethernet API. This function can also be re-invoked when a device is in the
2101  * stopped state.
2102  *
2103  * @param port_id
2104  *   The port identifier of the Ethernet device to configure.
2105  * @param nb_rx_queue
2106  *   The number of receive queues to set up for the Ethernet device.
2107  * @param nb_tx_queue
2108  *   The number of transmit queues to set up for the Ethernet device.
2109  * @param eth_conf
2110  *   The pointer to the configuration data to be used for the Ethernet device.
2111  *   The *rte_eth_conf* structure includes:
2112  *     -  the hardware offload features to activate, with dedicated fields for
2113  *        each statically configurable offload hardware feature provided by
2114  *        Ethernet devices, such as IP checksum or VLAN tag stripping for
2115  *        example.
2116  *        The Rx offload bitfield API is obsolete and will be deprecated.
2117  *        Applications should set the ignore_bitfield_offloads bit on *rxmode*
2118  *        structure and use offloads field to set per-port offloads instead.
2119  *     -  Any offloading set in eth_conf->[rt]xmode.offloads must be within
2120  *        the [rt]x_offload_capa returned from rte_eth_dev_info_get().
2121  *        Any type of device supported offloading set in the input argument
2122  *        eth_conf->[rt]xmode.offloads to rte_eth_dev_configure() is enabled
2123  *        on all queues and it can't be disabled in rte_eth_[rt]x_queue_setup()
2124  *     -  the Receive Side Scaling (RSS) configuration when using multiple RX
2125  *        queues per port. Any RSS hash function set in eth_conf->rss_conf.rss_hf
2126  *        must be within the flow_type_rss_offloads provided by drivers via
2127  *        rte_eth_dev_info_get() API.
2128  *
2129  *   Embedding all configuration information in a single data structure
2130  *   is the more flexible method that allows the addition of new features
2131  *   without changing the syntax of the API.
2132  * @return
2133  *   - 0: Success, device configured.
2134  *   - <0: Error code returned by the driver configuration function.
2135  */
2136 int rte_eth_dev_configure(uint16_t port_id, uint16_t nb_rx_queue,
2137                 uint16_t nb_tx_queue, const struct rte_eth_conf *eth_conf);
2138
2139 /**
2140  * @warning
2141  * @b EXPERIMENTAL: this API may change without prior notice.
2142  *
2143  * Check if an Ethernet device was physically removed.
2144  *
2145  * @param port_id
2146  *   The port identifier of the Ethernet device.
2147  * @return
2148  *   1 when the Ethernet device is removed, otherwise 0.
2149  */
2150 __rte_experimental
2151 int
2152 rte_eth_dev_is_removed(uint16_t port_id);
2153
2154 /**
2155  * Allocate and set up a receive queue for an Ethernet device.
2156  *
2157  * The function allocates a contiguous block of memory for *nb_rx_desc*
2158  * receive descriptors from a memory zone associated with *socket_id*
2159  * and initializes each receive descriptor with a network buffer allocated
2160  * from the memory pool *mb_pool*.
2161  *
2162  * @param port_id
2163  *   The port identifier of the Ethernet device.
2164  * @param rx_queue_id
2165  *   The index of the receive queue to set up.
2166  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
2167  *   to rte_eth_dev_configure().
2168  * @param nb_rx_desc
2169  *   The number of receive descriptors to allocate for the receive ring.
2170  * @param socket_id
2171  *   The *socket_id* argument is the socket identifier in case of NUMA.
2172  *   The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
2173  *   the DMA memory allocated for the receive descriptors of the ring.
2174  * @param rx_conf
2175  *   The pointer to the configuration data to be used for the receive queue.
2176  *   NULL value is allowed, in which case default RX configuration
2177  *   will be used.
2178  *   The *rx_conf* structure contains an *rx_thresh* structure with the values
2179  *   of the Prefetch, Host, and Write-Back threshold registers of the receive
2180  *   ring.
2181  *   In addition it contains the hardware offloads features to activate using
2182  *   the DEV_RX_OFFLOAD_* flags.
2183  *   If an offloading set in rx_conf->offloads
2184  *   hasn't been set in the input argument eth_conf->rxmode.offloads
2185  *   to rte_eth_dev_configure(), it is a new added offloading, it must be
2186  *   per-queue type and it is enabled for the queue.
2187  *   No need to repeat any bit in rx_conf->offloads which has already been
2188  *   enabled in rte_eth_dev_configure() at port level. An offloading enabled
2189  *   at port level can't be disabled at queue level.
2190  *   The configuration structure also contains the pointer to the array
2191  *   of the receiving buffer segment descriptions, see rx_seg and rx_nseg
2192  *   fields, this extended configuration might be used by split offloads like
2193  *   RTE_ETH_RX_OFFLOAD_BUFFER_SPLIT. If mp_pool is not NULL,
2194  *   the extended configuration fields must be set to NULL and zero.
2195  * @param mb_pool
2196  *   The pointer to the memory pool from which to allocate *rte_mbuf* network
2197  *   memory buffers to populate each descriptor of the receive ring. There are
2198  *   two options to provide Rx buffer configuration:
2199  *   - single pool:
2200  *     mb_pool is not NULL, rx_conf.rx_nseg is 0.
2201  *   - multiple segments description:
2202  *     mb_pool is NULL, rx_conf.rx_seg is not NULL, rx_conf.rx_nseg is not 0.
2203  *     Taken only if flag RTE_ETH_RX_OFFLOAD_BUFFER_SPLIT is set in offloads.
2204  *
2205  * @return
2206  *   - 0: Success, receive queue correctly set up.
2207  *   - -EIO: if device is removed.
2208  *   - -ENODEV: if *port_id* is invalid.
2209  *   - -EINVAL: The memory pool pointer is null or the size of network buffers
2210  *      which can be allocated from this memory pool does not fit the various
2211  *      buffer sizes allowed by the device controller.
2212  *   - -ENOMEM: Unable to allocate the receive ring descriptors or to
2213  *      allocate network memory buffers from the memory pool when
2214  *      initializing receive descriptors.
2215  */
2216 int rte_eth_rx_queue_setup(uint16_t port_id, uint16_t rx_queue_id,
2217                 uint16_t nb_rx_desc, unsigned int socket_id,
2218                 const struct rte_eth_rxconf *rx_conf,
2219                 struct rte_mempool *mb_pool);
2220
2221 /**
2222  * @warning
2223  * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
2224  *
2225  * Allocate and set up a hairpin receive queue for an Ethernet device.
2226  *
2227  * The function set up the selected queue to be used in hairpin.
2228  *
2229  * @param port_id
2230  *   The port identifier of the Ethernet device.
2231  * @param rx_queue_id
2232  *   The index of the receive queue to set up.
2233  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
2234  *   to rte_eth_dev_configure().
2235  * @param nb_rx_desc
2236  *   The number of receive descriptors to allocate for the receive ring.
2237  *   0 means the PMD will use default value.
2238  * @param conf
2239  *   The pointer to the hairpin configuration.
2240  *
2241  * @return
2242  *   - (0) if successful.
2243  *   - (-ENODEV) if *port_id* is invalid.
2244  *   - (-ENOTSUP) if hardware doesn't support.
2245  *   - (-EINVAL) if bad parameter.
2246  *   - (-ENOMEM) if unable to allocate the resources.
2247  */
2248 __rte_experimental
2249 int rte_eth_rx_hairpin_queue_setup
2250         (uint16_t port_id, uint16_t rx_queue_id, uint16_t nb_rx_desc,
2251          const struct rte_eth_hairpin_conf *conf);
2252
2253 /**
2254  * Allocate and set up a transmit queue for an Ethernet device.
2255  *
2256  * @param port_id
2257  *   The port identifier of the Ethernet device.
2258  * @param tx_queue_id
2259  *   The index of the transmit queue to set up.
2260  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
2261  *   to rte_eth_dev_configure().
2262  * @param nb_tx_desc
2263  *   The number of transmit descriptors to allocate for the transmit ring.
2264  * @param socket_id
2265  *   The *socket_id* argument is the socket identifier in case of NUMA.
2266  *   Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
2267  *   the DMA memory allocated for the transmit descriptors of the ring.
2268  * @param tx_conf
2269  *   The pointer to the configuration data to be used for the transmit queue.
2270  *   NULL value is allowed, in which case default TX configuration
2271  *   will be used.
2272  *   The *tx_conf* structure contains the following data:
2273  *   - The *tx_thresh* structure with the values of the Prefetch, Host, and
2274  *     Write-Back threshold registers of the transmit ring.
2275  *     When setting Write-Back threshold to the value greater then zero,
2276  *     *tx_rs_thresh* value should be explicitly set to one.
2277  *   - The *tx_free_thresh* value indicates the [minimum] number of network
2278  *     buffers that must be pending in the transmit ring to trigger their
2279  *     [implicit] freeing by the driver transmit function.
2280  *   - The *tx_rs_thresh* value indicates the [minimum] number of transmit
2281  *     descriptors that must be pending in the transmit ring before setting the
2282  *     RS bit on a descriptor by the driver transmit function.
2283  *     The *tx_rs_thresh* value should be less or equal then
2284  *     *tx_free_thresh* value, and both of them should be less then
2285  *     *nb_tx_desc* - 3.
2286  *   - The *offloads* member contains Tx offloads to be enabled.
2287  *     If an offloading set in tx_conf->offloads
2288  *     hasn't been set in the input argument eth_conf->txmode.offloads
2289  *     to rte_eth_dev_configure(), it is a new added offloading, it must be
2290  *     per-queue type and it is enabled for the queue.
2291  *     No need to repeat any bit in tx_conf->offloads which has already been
2292  *     enabled in rte_eth_dev_configure() at port level. An offloading enabled
2293  *     at port level can't be disabled at queue level.
2294  *
2295  *     Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces
2296  *     the transmit function to use default values.
2297  * @return
2298  *   - 0: Success, the transmit queue is correctly set up.
2299  *   - -ENOMEM: Unable to allocate the transmit ring descriptors.
2300  */
2301 int rte_eth_tx_queue_setup(uint16_t port_id, uint16_t tx_queue_id,
2302                 uint16_t nb_tx_desc, unsigned int socket_id,
2303                 const struct rte_eth_txconf *tx_conf);
2304
2305 /**
2306  * @warning
2307  * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
2308  *
2309  * Allocate and set up a transmit hairpin queue for an Ethernet device.
2310  *
2311  * @param port_id
2312  *   The port identifier of the Ethernet device.
2313  * @param tx_queue_id
2314  *   The index of the transmit queue to set up.
2315  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
2316  *   to rte_eth_dev_configure().
2317  * @param nb_tx_desc
2318  *   The number of transmit descriptors to allocate for the transmit ring.
2319  *   0 to set default PMD value.
2320  * @param conf
2321  *   The hairpin configuration.
2322  *
2323  * @return
2324  *   - (0) if successful.
2325  *   - (-ENODEV) if *port_id* is invalid.
2326  *   - (-ENOTSUP) if hardware doesn't support.
2327  *   - (-EINVAL) if bad parameter.
2328  *   - (-ENOMEM) if unable to allocate the resources.
2329  */
2330 __rte_experimental
2331 int rte_eth_tx_hairpin_queue_setup
2332         (uint16_t port_id, uint16_t tx_queue_id, uint16_t nb_tx_desc,
2333          const struct rte_eth_hairpin_conf *conf);
2334
2335 /**
2336  * @warning
2337  * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
2338  *
2339  * Get all the hairpin peer Rx / Tx ports of the current port.
2340  * The caller should ensure that the array is large enough to save the ports
2341  * list.
2342  *
2343  * @param port_id
2344  *   The port identifier of the Ethernet device.
2345  * @param peer_ports
2346  *   Pointer to the array to store the peer ports list.
2347  * @param len
2348  *   Length of the array to store the port identifiers.
2349  * @param direction
2350  *   Current port to peer port direction
2351  *   positive - current used as Tx to get all peer Rx ports.
2352  *   zero - current used as Rx to get all peer Tx ports.
2353  *
2354  * @return
2355  *   - (0 or positive) actual peer ports number.
2356  *   - (-EINVAL) if bad parameter.
2357  *   - (-ENODEV) if *port_id* invalid
2358  *   - (-ENOTSUP) if hardware doesn't support.
2359  *   - Others detailed errors from PMD drivers.
2360  */
2361 __rte_experimental
2362 int rte_eth_hairpin_get_peer_ports(uint16_t port_id, uint16_t *peer_ports,
2363                                    size_t len, uint32_t direction);
2364
2365 /**
2366  * @warning
2367  * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
2368  *
2369  * Bind all hairpin Tx queues of one port to the Rx queues of the peer port.
2370  * It is only allowed to call this function after all hairpin queues are
2371  * configured properly and the devices are in started state.
2372  *
2373  * @param tx_port
2374  *   The identifier of the Tx port.
2375  * @param rx_port
2376  *   The identifier of peer Rx port.
2377  *   RTE_MAX_ETHPORTS is allowed for the traversal of all devices.
2378  *   Rx port ID could have the same value as Tx port ID.
2379  *
2380  * @return
2381  *   - (0) if successful.
2382  *   - (-ENODEV) if Tx port ID is invalid.
2383  *   - (-EBUSY) if device is not in started state.
2384  *   - (-ENOTSUP) if hardware doesn't support.
2385  *   - Others detailed errors from PMD drivers.
2386  */
2387 __rte_experimental
2388 int rte_eth_hairpin_bind(uint16_t tx_port, uint16_t rx_port);
2389
2390 /**
2391  * @warning
2392  * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
2393  *
2394  * Unbind all hairpin Tx queues of one port from the Rx queues of the peer port.
2395  * This should be called before closing the Tx or Rx devices, if the bind
2396  * function is called before.
2397  * After unbinding the hairpin ports pair, it is allowed to bind them again.
2398  * Changing queues configuration should be after stopping the device(s).
2399  *
2400  * @param tx_port
2401  *   The identifier of the Tx port.
2402  * @param rx_port
2403  *   The identifier of peer Rx port.
2404  *   RTE_MAX_ETHPORTS is allowed for traversal of all devices.
2405  *   Rx port ID could have the same value as Tx port ID.
2406  *
2407  * @return
2408  *   - (0) if successful.
2409  *   - (-ENODEV) if Tx port ID is invalid.
2410  *   - (-EBUSY) if device is in stopped state.
2411  *   - (-ENOTSUP) if hardware doesn't support.
2412  *   - Others detailed errors from PMD drivers.
2413  */
2414 __rte_experimental
2415 int rte_eth_hairpin_unbind(uint16_t tx_port, uint16_t rx_port);
2416
2417 /**
2418  * Return the NUMA socket to which an Ethernet device is connected
2419  *
2420  * @param port_id
2421  *   The port identifier of the Ethernet device
2422  * @return
2423  *   The NUMA socket id to which the Ethernet device is connected or
2424  *   a default of zero if the socket could not be determined.
2425  *   -1 is returned is the port_id value is out of range.
2426  */
2427 int rte_eth_dev_socket_id(uint16_t port_id);
2428
2429 /**
2430  * Check if port_id of device is attached
2431  *
2432  * @param port_id
2433  *   The port identifier of the Ethernet device
2434  * @return
2435  *   - 0 if port is out of range or not attached
2436  *   - 1 if device is attached
2437  */
2438 int rte_eth_dev_is_valid_port(uint16_t port_id);
2439
2440 /**
2441  * Start specified RX queue of a port. It is used when rx_deferred_start
2442  * flag of the specified queue is true.
2443  *
2444  * @param port_id
2445  *   The port identifier of the Ethernet device
2446  * @param rx_queue_id
2447  *   The index of the rx queue to update the ring.
2448  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
2449  *   to rte_eth_dev_configure().
2450  * @return
2451  *   - 0: Success, the receive queue is started.
2452  *   - -ENODEV: if *port_id* is invalid.
2453  *   - -EINVAL: The queue_id out of range or belong to hairpin.
2454  *   - -EIO: if device is removed.
2455  *   - -ENOTSUP: The function not supported in PMD driver.
2456  */
2457 int rte_eth_dev_rx_queue_start(uint16_t port_id, uint16_t rx_queue_id);
2458
2459 /**
2460  * Stop specified RX queue of a port
2461  *
2462  * @param port_id
2463  *   The port identifier of the Ethernet device
2464  * @param rx_queue_id
2465  *   The index of the rx queue to update the ring.
2466  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
2467  *   to rte_eth_dev_configure().
2468  * @return
2469  *   - 0: Success, the receive queue is stopped.
2470  *   - -ENODEV: if *port_id* is invalid.
2471  *   - -EINVAL: The queue_id out of range or belong to hairpin.
2472  *   - -EIO: if device is removed.
2473  *   - -ENOTSUP: The function not supported in PMD driver.
2474  */
2475 int rte_eth_dev_rx_queue_stop(uint16_t port_id, uint16_t rx_queue_id);
2476
2477 /**
2478  * Start TX for specified queue of a port. It is used when tx_deferred_start
2479  * flag of the specified queue is true.
2480  *
2481  * @param port_id
2482  *   The port identifier of the Ethernet device
2483  * @param tx_queue_id
2484  *   The index of the tx queue to update the ring.
2485  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
2486  *   to rte_eth_dev_configure().
2487  * @return
2488  *   - 0: Success, the transmit queue is started.
2489  *   - -ENODEV: if *port_id* is invalid.
2490  *   - -EINVAL: The queue_id out of range or belong to hairpin.
2491  *   - -EIO: if device is removed.
2492  *   - -ENOTSUP: The function not supported in PMD driver.
2493  */
2494 int rte_eth_dev_tx_queue_start(uint16_t port_id, uint16_t tx_queue_id);
2495
2496 /**
2497  * Stop specified TX queue of a port
2498  *
2499  * @param port_id
2500  *   The port identifier of the Ethernet device
2501  * @param tx_queue_id
2502  *   The index of the tx queue to update the ring.
2503  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
2504  *   to rte_eth_dev_configure().
2505  * @return
2506  *   - 0: Success, the transmit queue is stopped.
2507  *   - -ENODEV: if *port_id* is invalid.
2508  *   - -EINVAL: The queue_id out of range or belong to hairpin.
2509  *   - -EIO: if device is removed.
2510  *   - -ENOTSUP: The function not supported in PMD driver.
2511  */
2512 int rte_eth_dev_tx_queue_stop(uint16_t port_id, uint16_t tx_queue_id);
2513
2514 /**
2515  * Start an Ethernet device.
2516  *
2517  * The device start step is the last one and consists of setting the configured
2518  * offload features and in starting the transmit and the receive units of the
2519  * device.
2520  *
2521  * Device RTE_ETH_DEV_NOLIVE_MAC_ADDR flag causes MAC address to be set before
2522  * PMD port start callback function is invoked.
2523  *
2524  * On success, all basic functions exported by the Ethernet API (link status,
2525  * receive/transmit, and so on) can be invoked.
2526  *
2527  * @param port_id
2528  *   The port identifier of the Ethernet device.
2529  * @return
2530  *   - 0: Success, Ethernet device started.
2531  *   - <0: Error code of the driver device start function.
2532  */
2533 int rte_eth_dev_start(uint16_t port_id);
2534
2535 /**
2536  * Stop an Ethernet device. The device can be restarted with a call to
2537  * rte_eth_dev_start()
2538  *
2539  * @param port_id
2540  *   The port identifier of the Ethernet device.
2541  * @return
2542  *   - 0: Success, Ethernet device stopped.
2543  *   - <0: Error code of the driver device stop function.
2544  */
2545 int rte_eth_dev_stop(uint16_t port_id);
2546
2547 /**
2548  * Link up an Ethernet device.
2549  *
2550  * Set device link up will re-enable the device rx/tx
2551  * functionality after it is previously set device linked down.
2552  *
2553  * @param port_id
2554  *   The port identifier of the Ethernet device.
2555  * @return
2556  *   - 0: Success, Ethernet device linked up.
2557  *   - <0: Error code of the driver device link up function.
2558  */
2559 int rte_eth_dev_set_link_up(uint16_t port_id);
2560
2561 /**
2562  * Link down an Ethernet device.
2563  * The device rx/tx functionality will be disabled if success,
2564  * and it can be re-enabled with a call to
2565  * rte_eth_dev_set_link_up()
2566  *
2567  * @param port_id
2568  *   The port identifier of the Ethernet device.
2569  */
2570 int rte_eth_dev_set_link_down(uint16_t port_id);
2571
2572 /**
2573  * Close a stopped Ethernet device. The device cannot be restarted!
2574  * The function frees all port resources.
2575  *
2576  * @param port_id
2577  *   The port identifier of the Ethernet device.
2578  * @return
2579  *   - Zero if the port is closed successfully.
2580  *   - Negative if something went wrong.
2581  */
2582 int rte_eth_dev_close(uint16_t port_id);
2583
2584 /**
2585  * Reset a Ethernet device and keep its port id.
2586  *
2587  * When a port has to be reset passively, the DPDK application can invoke
2588  * this function. For example when a PF is reset, all its VFs should also
2589  * be reset. Normally a DPDK application can invoke this function when
2590  * RTE_ETH_EVENT_INTR_RESET event is detected, but can also use it to start
2591  * a port reset in other circumstances.
2592  *
2593  * When this function is called, it first stops the port and then calls the
2594  * PMD specific dev_uninit( ) and dev_init( ) to return the port to initial
2595  * state, in which no Tx and Rx queues are setup, as if the port has been
2596  * reset and not started. The port keeps the port id it had before the
2597  * function call.
2598  *
2599  * After calling rte_eth_dev_reset( ), the application should use
2600  * rte_eth_dev_configure( ), rte_eth_rx_queue_setup( ),
2601  * rte_eth_tx_queue_setup( ), and rte_eth_dev_start( )
2602  * to reconfigure the device as appropriate.
2603  *
2604  * Note: To avoid unexpected behavior, the application should stop calling
2605  * Tx and Rx functions before calling rte_eth_dev_reset( ). For thread
2606  * safety, all these controlling functions should be called from the same
2607  * thread.
2608  *
2609  * @param port_id
2610  *   The port identifier of the Ethernet device.
2611  *
2612  * @return
2613  *   - (0) if successful.
2614  *   - (-ENODEV) if *port_id* is invalid.
2615  *   - (-ENOTSUP) if hardware doesn't support this function.
2616  *   - (-EPERM) if not ran from the primary process.
2617  *   - (-EIO) if re-initialisation failed or device is removed.
2618  *   - (-ENOMEM) if the reset failed due to OOM.
2619  *   - (-EAGAIN) if the reset temporarily failed and should be retried later.
2620  */
2621 int rte_eth_dev_reset(uint16_t port_id);
2622
2623 /**
2624  * Enable receipt in promiscuous mode for an Ethernet device.
2625  *
2626  * @param port_id
2627  *   The port identifier of the Ethernet device.
2628  * @return
2629  *   - (0) if successful.
2630  *   - (-ENOTSUP) if support for promiscuous_enable() does not exist
2631  *     for the device.
2632  *   - (-ENODEV) if *port_id* invalid.
2633  */
2634 int rte_eth_promiscuous_enable(uint16_t port_id);
2635
2636 /**
2637  * Disable receipt in promiscuous mode for an Ethernet device.
2638  *
2639  * @param port_id
2640  *   The port identifier of the Ethernet device.
2641  * @return
2642  *   - (0) if successful.
2643  *   - (-ENOTSUP) if support for promiscuous_disable() does not exist
2644  *     for the device.
2645  *   - (-ENODEV) if *port_id* invalid.
2646  */
2647 int rte_eth_promiscuous_disable(uint16_t port_id);
2648
2649 /**
2650  * Return the value of promiscuous mode for an Ethernet device.
2651  *
2652  * @param port_id
2653  *   The port identifier of the Ethernet device.
2654  * @return
2655  *   - (1) if promiscuous is enabled
2656  *   - (0) if promiscuous is disabled.
2657  *   - (-1) on error
2658  */
2659 int rte_eth_promiscuous_get(uint16_t port_id);
2660
2661 /**
2662  * Enable the receipt of any multicast frame by an Ethernet device.
2663  *
2664  * @param port_id
2665  *   The port identifier of the Ethernet device.
2666  * @return
2667  *   - (0) if successful.
2668  *   - (-ENOTSUP) if support for allmulticast_enable() does not exist
2669  *     for the device.
2670  *   - (-ENODEV) if *port_id* invalid.
2671  */
2672 int rte_eth_allmulticast_enable(uint16_t port_id);
2673
2674 /**
2675  * Disable the receipt of all multicast frames by an Ethernet device.
2676  *
2677  * @param port_id
2678  *   The port identifier of the Ethernet device.
2679  * @return
2680  *   - (0) if successful.
2681  *   - (-ENOTSUP) if support for allmulticast_disable() does not exist
2682  *     for the device.
2683  *   - (-ENODEV) if *port_id* invalid.
2684  */
2685 int rte_eth_allmulticast_disable(uint16_t port_id);
2686
2687 /**
2688  * Return the value of allmulticast mode for an Ethernet device.
2689  *
2690  * @param port_id
2691  *   The port identifier of the Ethernet device.
2692  * @return
2693  *   - (1) if allmulticast is enabled
2694  *   - (0) if allmulticast is disabled.
2695  *   - (-1) on error
2696  */
2697 int rte_eth_allmulticast_get(uint16_t port_id);
2698
2699 /**
2700  * Retrieve the link status (up/down), the duplex mode (half/full),
2701  * the negotiation (auto/fixed), and if available, the speed (Mbps).
2702  *
2703  * It might need to wait up to 9 seconds.
2704  * @see rte_eth_link_get_nowait.
2705  *
2706  * @param port_id
2707  *   The port identifier of the Ethernet device.
2708  * @param link
2709  *   Link information written back.
2710  * @return
2711  *   - (0) if successful.
2712  *   - (-ENOTSUP) if the function is not supported in PMD driver.
2713  *   - (-ENODEV) if *port_id* invalid.
2714  */
2715 int rte_eth_link_get(uint16_t port_id, struct rte_eth_link *link);
2716
2717 /**
2718  * Retrieve the link status (up/down), the duplex mode (half/full),
2719  * the negotiation (auto/fixed), and if available, the speed (Mbps).
2720  *
2721  * @param port_id
2722  *   The port identifier of the Ethernet device.
2723  * @param link
2724  *   Link information written back.
2725  * @return
2726  *   - (0) if successful.
2727  *   - (-ENOTSUP) if the function is not supported in PMD driver.
2728  *   - (-ENODEV) if *port_id* invalid.
2729  */
2730 int rte_eth_link_get_nowait(uint16_t port_id, struct rte_eth_link *link);
2731
2732 /**
2733  * @warning
2734  * @b EXPERIMENTAL: this API may change without prior notice.
2735  *
2736  * The function converts a link_speed to a string. It handles all special
2737  * values like unknown or none speed.
2738  *
2739  * @param link_speed
2740  *   link_speed of rte_eth_link struct
2741  * @return
2742  *   Link speed in textual format. It's pointer to immutable memory.
2743  *   No free is required.
2744  */
2745 __rte_experimental
2746 const char *rte_eth_link_speed_to_str(uint32_t link_speed);
2747
2748 /**
2749  * @warning
2750  * @b EXPERIMENTAL: this API may change without prior notice.
2751  *
2752  * The function converts a rte_eth_link struct representing a link status to
2753  * a string.
2754  *
2755  * @param str
2756  *   A pointer to a string to be filled with textual representation of
2757  *   device status. At least ETH_LINK_MAX_STR_LEN bytes should be allocated to
2758  *   store default link status text.
2759  * @param len
2760  *   Length of available memory at 'str' string.
2761  * @param eth_link
2762  *   Link status returned by rte_eth_link_get function
2763  * @return
2764  *   Number of bytes written to str array.
2765  */
2766 __rte_experimental
2767 int rte_eth_link_to_str(char *str, size_t len,
2768                         const struct rte_eth_link *eth_link);
2769
2770 /**
2771  * Retrieve the general I/O statistics of an Ethernet device.
2772  *
2773  * @param port_id
2774  *   The port identifier of the Ethernet device.
2775  * @param stats
2776  *   A pointer to a structure of type *rte_eth_stats* to be filled with
2777  *   the values of device counters for the following set of statistics:
2778  *   - *ipackets* with the total of successfully received packets.
2779  *   - *opackets* with the total of successfully transmitted packets.
2780  *   - *ibytes*   with the total of successfully received bytes.
2781  *   - *obytes*   with the total of successfully transmitted bytes.
2782  *   - *ierrors*  with the total of erroneous received packets.
2783  *   - *oerrors*  with the total of failed transmitted packets.
2784  * @return
2785  *   Zero if successful. Non-zero otherwise.
2786  */
2787 int rte_eth_stats_get(uint16_t port_id, struct rte_eth_stats *stats);
2788
2789 /**
2790  * Reset the general I/O statistics of an Ethernet device.
2791  *
2792  * @param port_id
2793  *   The port identifier of the Ethernet device.
2794  * @return
2795  *   - (0) if device notified to reset stats.
2796  *   - (-ENOTSUP) if hardware doesn't support.
2797  *   - (-ENODEV) if *port_id* invalid.
2798  *   - (<0): Error code of the driver stats reset function.
2799  */
2800 int rte_eth_stats_reset(uint16_t port_id);
2801
2802 /**
2803  * Retrieve names of extended statistics of an Ethernet device.
2804  *
2805  * There is an assumption that 'xstat_names' and 'xstats' arrays are matched
2806  * by array index:
2807  *  xstats_names[i].name => xstats[i].value
2808  *
2809  * And the array index is same with id field of 'struct rte_eth_xstat':
2810  *  xstats[i].id == i
2811  *
2812  * This assumption makes key-value pair matching less flexible but simpler.
2813  *
2814  * @param port_id
2815  *   The port identifier of the Ethernet device.
2816  * @param xstats_names
2817  *   An rte_eth_xstat_name array of at least *size* elements to
2818  *   be filled. If set to NULL, the function returns the required number
2819  *   of elements.
2820  * @param size
2821  *   The size of the xstats_names array (number of elements).
2822  * @return
2823  *   - A positive value lower or equal to size: success. The return value
2824  *     is the number of entries filled in the stats table.
2825  *   - A positive value higher than size: error, the given statistics table
2826  *     is too small. The return value corresponds to the size that should
2827  *     be given to succeed. The entries in the table are not valid and
2828  *     shall not be used by the caller.
2829  *   - A negative value on error (invalid port id).
2830  */
2831 int rte_eth_xstats_get_names(uint16_t port_id,
2832                 struct rte_eth_xstat_name *xstats_names,
2833                 unsigned int size);
2834
2835 /**
2836  * Retrieve extended statistics of an Ethernet device.
2837  *
2838  * There is an assumption that 'xstat_names' and 'xstats' arrays are matched
2839  * by array index:
2840  *  xstats_names[i].name => xstats[i].value
2841  *
2842  * And the array index is same with id field of 'struct rte_eth_xstat':
2843  *  xstats[i].id == i
2844  *
2845  * This assumption makes key-value pair matching less flexible but simpler.
2846  *
2847  * @param port_id
2848  *   The port identifier of the Ethernet device.
2849  * @param xstats
2850  *   A pointer to a table of structure of type *rte_eth_xstat*
2851  *   to be filled with device statistics ids and values.
2852  *   This parameter can be set to NULL if n is 0.
2853  * @param n
2854  *   The size of the xstats array (number of elements).
2855  * @return
2856  *   - A positive value lower or equal to n: success. The return value
2857  *     is the number of entries filled in the stats table.
2858  *   - A positive value higher than n: error, the given statistics table
2859  *     is too small. The return value corresponds to the size that should
2860  *     be given to succeed. The entries in the table are not valid and
2861  *     shall not be used by the caller.
2862  *   - A negative value on error (invalid port id).
2863  */
2864 int rte_eth_xstats_get(uint16_t port_id, struct rte_eth_xstat *xstats,
2865                 unsigned int n);
2866
2867 /**
2868  * Retrieve names of extended statistics of an Ethernet device.
2869  *
2870  * @param port_id
2871  *   The port identifier of the Ethernet device.
2872  * @param xstats_names
2873  *   An rte_eth_xstat_name array of at least *size* elements to
2874  *   be filled. If set to NULL, the function returns the required number
2875  *   of elements.
2876  * @param ids
2877  *   IDs array given by app to retrieve specific statistics
2878  * @param size
2879  *   The size of the xstats_names array (number of elements).
2880  * @return
2881  *   - A positive value lower or equal to size: success. The return value
2882  *     is the number of entries filled in the stats table.
2883  *   - A positive value higher than size: error, the given statistics table
2884  *     is too small. The return value corresponds to the size that should
2885  *     be given to succeed. The entries in the table are not valid and
2886  *     shall not be used by the caller.
2887  *   - A negative value on error (invalid port id).
2888  */
2889 int
2890 rte_eth_xstats_get_names_by_id(uint16_t port_id,
2891         struct rte_eth_xstat_name *xstats_names, unsigned int size,
2892         uint64_t *ids);
2893
2894 /**
2895  * Retrieve extended statistics of an Ethernet device.
2896  *
2897  * @param port_id
2898  *   The port identifier of the Ethernet device.
2899  * @param ids
2900  *   A pointer to an ids array passed by application. This tells which
2901  *   statistics values function should retrieve. This parameter
2902  *   can be set to NULL if size is 0. In this case function will retrieve
2903  *   all available statistics.
2904  * @param values
2905  *   A pointer to a table to be filled with device statistics values.
2906  * @param size
2907  *   The size of the ids array (number of elements).
2908  * @return
2909  *   - A positive value lower or equal to size: success. The return value
2910  *     is the number of entries filled in the stats table.
2911  *   - A positive value higher than size: error, the given statistics table
2912  *     is too small. The return value corresponds to the size that should
2913  *     be given to succeed. The entries in the table are not valid and
2914  *     shall not be used by the caller.
2915  *   - A negative value on error (invalid port id).
2916  */
2917 int rte_eth_xstats_get_by_id(uint16_t port_id, const uint64_t *ids,
2918                              uint64_t *values, unsigned int size);
2919
2920 /**
2921  * Gets the ID of a statistic from its name.
2922  *
2923  * This function searches for the statistics using string compares, and
2924  * as such should not be used on the fast-path. For fast-path retrieval of
2925  * specific statistics, store the ID as provided in *id* from this function,
2926  * and pass the ID to rte_eth_xstats_get()
2927  *
2928  * @param port_id The port to look up statistics from
2929  * @param xstat_name The name of the statistic to return
2930  * @param[out] id A pointer to an app-supplied uint64_t which should be
2931  *                set to the ID of the stat if the stat exists.
2932  * @return
2933  *    0 on success
2934  *    -ENODEV for invalid port_id,
2935  *    -EIO if device is removed,
2936  *    -EINVAL if the xstat_name doesn't exist in port_id
2937  */
2938 int rte_eth_xstats_get_id_by_name(uint16_t port_id, const char *xstat_name,
2939                 uint64_t *id);
2940
2941 /**
2942  * Reset extended statistics of an Ethernet device.
2943  *
2944  * @param port_id
2945  *   The port identifier of the Ethernet device.
2946  * @return
2947  *   - (0) if device notified to reset extended stats.
2948  *   - (-ENOTSUP) if pmd doesn't support both
2949  *     extended stats and basic stats reset.
2950  *   - (-ENODEV) if *port_id* invalid.
2951  *   - (<0): Error code of the driver xstats reset function.
2952  */
2953 int rte_eth_xstats_reset(uint16_t port_id);
2954
2955 /**
2956  *  Set a mapping for the specified transmit queue to the specified per-queue
2957  *  statistics counter.
2958  *
2959  * @param port_id
2960  *   The port identifier of the Ethernet device.
2961  * @param tx_queue_id
2962  *   The index of the transmit queue for which a queue stats mapping is required.
2963  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
2964  *   to rte_eth_dev_configure().
2965  * @param stat_idx
2966  *   The per-queue packet statistics functionality number that the transmit
2967  *   queue is to be assigned.
2968  *   The value must be in the range [0, RTE_ETHDEV_QUEUE_STAT_CNTRS - 1].
2969  *   Max RTE_ETHDEV_QUEUE_STAT_CNTRS being 256.
2970  * @return
2971  *   Zero if successful. Non-zero otherwise.
2972  */
2973 int rte_eth_dev_set_tx_queue_stats_mapping(uint16_t port_id,
2974                 uint16_t tx_queue_id, uint8_t stat_idx);
2975
2976 /**
2977  *  Set a mapping for the specified receive queue to the specified per-queue
2978  *  statistics counter.
2979  *
2980  * @param port_id
2981  *   The port identifier of the Ethernet device.
2982  * @param rx_queue_id
2983  *   The index of the receive queue for which a queue stats mapping is required.
2984  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
2985  *   to rte_eth_dev_configure().
2986  * @param stat_idx
2987  *   The per-queue packet statistics functionality number that the receive
2988  *   queue is to be assigned.
2989  *   The value must be in the range [0, RTE_ETHDEV_QUEUE_STAT_CNTRS - 1].
2990  *   Max RTE_ETHDEV_QUEUE_STAT_CNTRS being 256.
2991  * @return
2992  *   Zero if successful. Non-zero otherwise.
2993  */
2994 int rte_eth_dev_set_rx_queue_stats_mapping(uint16_t port_id,
2995                                            uint16_t rx_queue_id,
2996                                            uint8_t stat_idx);
2997
2998 /**
2999  * Retrieve the Ethernet address of an Ethernet device.
3000  *
3001  * @param port_id
3002  *   The port identifier of the Ethernet device.
3003  * @param mac_addr
3004  *   A pointer to a structure of type *ether_addr* to be filled with
3005  *   the Ethernet address of the Ethernet device.
3006  * @return
3007  *   - (0) if successful
3008  *   - (-ENODEV) if *port_id* invalid.
3009  */
3010 int rte_eth_macaddr_get(uint16_t port_id, struct rte_ether_addr *mac_addr);
3011
3012 /**
3013  * Retrieve the contextual information of an Ethernet device.
3014  *
3015  * As part of this function, a number of of fields in dev_info will be
3016  * initialized as follows:
3017  *
3018  * rx_desc_lim = lim
3019  * tx_desc_lim = lim
3020  *
3021  * Where lim is defined within the rte_eth_dev_info_get as
3022  *
3023  *  const struct rte_eth_desc_lim lim = {
3024  *      .nb_max = UINT16_MAX,
3025  *      .nb_min = 0,
3026  *      .nb_align = 1,
3027  *      .nb_seg_max = UINT16_MAX,
3028  *      .nb_mtu_seg_max = UINT16_MAX,
3029  *  };
3030  *
3031  * device = dev->device
3032  * min_mtu = RTE_ETHER_MIN_MTU
3033  * max_mtu = UINT16_MAX
3034  *
3035  * The following fields will be populated if support for dev_infos_get()
3036  * exists for the device and the rte_eth_dev 'dev' has been populated
3037  * successfully with a call to it:
3038  *
3039  * driver_name = dev->device->driver->name
3040  * nb_rx_queues = dev->data->nb_rx_queues
3041  * nb_tx_queues = dev->data->nb_tx_queues
3042  * dev_flags = &dev->data->dev_flags
3043  *
3044  * @param port_id
3045  *   The port identifier of the Ethernet device.
3046  * @param dev_info
3047  *   A pointer to a structure of type *rte_eth_dev_info* to be filled with
3048  *   the contextual information of the Ethernet device.
3049  * @return
3050  *   - (0) if successful.
3051  *   - (-ENOTSUP) if support for dev_infos_get() does not exist for the device.
3052  *   - (-ENODEV) if *port_id* invalid.
3053  */
3054 int rte_eth_dev_info_get(uint16_t port_id, struct rte_eth_dev_info *dev_info);
3055
3056 /**
3057  * Retrieve the firmware version of a device.
3058  *
3059  * @param port_id
3060  *   The port identifier of the device.
3061  * @param fw_version
3062  *   A pointer to a string array storing the firmware version of a device,
3063  *   the string includes terminating null. This pointer is allocated by caller.
3064  * @param fw_size
3065  *   The size of the string array pointed by fw_version, which should be
3066  *   large enough to store firmware version of the device.
3067  * @return
3068  *   - (0) if successful.
3069  *   - (-ENOTSUP) if operation is not supported.
3070  *   - (-ENODEV) if *port_id* invalid.
3071  *   - (-EIO) if device is removed.
3072  *   - (>0) if *fw_size* is not enough to store firmware version, return
3073  *          the size of the non truncated string.
3074  */
3075 int rte_eth_dev_fw_version_get(uint16_t port_id,
3076                                char *fw_version, size_t fw_size);
3077
3078 /**
3079  * Retrieve the supported packet types of an Ethernet device.
3080  *
3081  * When a packet type is announced as supported, it *must* be recognized by
3082  * the PMD. For instance, if RTE_PTYPE_L2_ETHER, RTE_PTYPE_L2_ETHER_VLAN
3083  * and RTE_PTYPE_L3_IPV4 are announced, the PMD must return the following
3084  * packet types for these packets:
3085  * - Ether/IPv4              -> RTE_PTYPE_L2_ETHER | RTE_PTYPE_L3_IPV4
3086  * - Ether/Vlan/IPv4         -> RTE_PTYPE_L2_ETHER_VLAN | RTE_PTYPE_L3_IPV4
3087  * - Ether/[anything else]   -> RTE_PTYPE_L2_ETHER
3088  * - Ether/Vlan/[anything else] -> RTE_PTYPE_L2_ETHER_VLAN
3089  *
3090  * When a packet is received by a PMD, the most precise type must be
3091  * returned among the ones supported. However a PMD is allowed to set
3092  * packet type that is not in the supported list, at the condition that it
3093  * is more precise. Therefore, a PMD announcing no supported packet types
3094  * can still set a matching packet type in a received packet.
3095  *
3096  * @note
3097  *   Better to invoke this API after the device is already started or rx burst
3098  *   function is decided, to obtain correct supported ptypes.
3099  * @note
3100  *   if a given PMD does not report what ptypes it supports, then the supported
3101  *   ptype count is reported as 0.
3102  * @param port_id
3103  *   The port identifier of the Ethernet device.
3104  * @param ptype_mask
3105  *   A hint of what kind of packet type which the caller is interested in.
3106  * @param ptypes
3107  *   An array pointer to store adequate packet types, allocated by caller.
3108  * @param num
3109  *  Size of the array pointed by param ptypes.
3110  * @return
3111  *   - (>=0) Number of supported ptypes. If the number of types exceeds num,
3112  *           only num entries will be filled into the ptypes array, but the full
3113  *           count of supported ptypes will be returned.
3114  *   - (-ENODEV) if *port_id* invalid.
3115  */
3116 int rte_eth_dev_get_supported_ptypes(uint16_t port_id, uint32_t ptype_mask,
3117                                      uint32_t *ptypes, int num);
3118 /**
3119  * @warning
3120  * @b EXPERIMENTAL: this API may change without prior notice.
3121  *
3122  * Inform Ethernet device about reduced range of packet types to handle.
3123  *
3124  * Application can use this function to set only specific ptypes that it's
3125  * interested. This information can be used by the PMD to optimize Rx path.
3126  *
3127  * The function accepts an array `set_ptypes` allocated by the caller to
3128  * store the packet types set by the driver, the last element of the array
3129  * is set to RTE_PTYPE_UNKNOWN. The size of the `set_ptype` array should be
3130  * `rte_eth_dev_get_supported_ptypes() + 1` else it might only be filled
3131  * partially.
3132  *
3133  * @param port_id
3134  *   The port identifier of the Ethernet device.
3135  * @param ptype_mask
3136  *   The ptype family that application is interested in should be bitwise OR of
3137  *   RTE_PTYPE_*_MASK or 0.
3138  * @param set_ptypes
3139  *   An array pointer to store set packet types, allocated by caller. The
3140  *   function marks the end of array with RTE_PTYPE_UNKNOWN.
3141  * @param num
3142  *   Size of the array pointed by param ptypes.
3143  *   Should be rte_eth_dev_get_supported_ptypes() + 1 to accommodate the
3144  *   set ptypes.
3145  * @return
3146  *   - (0) if Success.
3147  *   - (-ENODEV) if *port_id* invalid.
3148  *   - (-EINVAL) if *ptype_mask* is invalid (or) set_ptypes is NULL and
3149  *     num > 0.
3150  */
3151 __rte_experimental
3152 int rte_eth_dev_set_ptypes(uint16_t port_id, uint32_t ptype_mask,
3153                            uint32_t *set_ptypes, unsigned int num);
3154
3155 /**
3156  * Retrieve the MTU of an Ethernet device.
3157  *
3158  * @param port_id
3159  *   The port identifier of the Ethernet device.
3160  * @param mtu
3161  *   A pointer to a uint16_t where the retrieved MTU is to be stored.
3162  * @return
3163  *   - (0) if successful.
3164  *   - (-ENODEV) if *port_id* invalid.
3165  */
3166 int rte_eth_dev_get_mtu(uint16_t port_id, uint16_t *mtu);
3167
3168 /**
3169  * Change the MTU of an Ethernet device.
3170  *
3171  * @param port_id
3172  *   The port identifier of the Ethernet device.
3173  * @param mtu
3174  *   A uint16_t for the MTU to be applied.
3175  * @return
3176  *   - (0) if successful.
3177  *   - (-ENOTSUP) if operation is not supported.
3178  *   - (-ENODEV) if *port_id* invalid.
3179  *   - (-EIO) if device is removed.
3180  *   - (-EINVAL) if *mtu* invalid, validation of mtu can occur within
3181  *     rte_eth_dev_set_mtu if dev_infos_get is supported by the device or
3182  *     when the mtu is set using dev->dev_ops->mtu_set.
3183  *   - (-EBUSY) if operation is not allowed when the port is running
3184  */
3185 int rte_eth_dev_set_mtu(uint16_t port_id, uint16_t mtu);
3186
3187 /**
3188  * Enable/Disable hardware filtering by an Ethernet device of received
3189  * VLAN packets tagged with a given VLAN Tag Identifier.
3190  *
3191  * @param port_id
3192  *   The port identifier of the Ethernet device.
3193  * @param vlan_id
3194  *   The VLAN Tag Identifier whose filtering must be enabled or disabled.
3195  * @param on
3196  *   If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*.
3197  *   Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*.
3198  * @return
3199  *   - (0) if successful.
3200  *   - (-ENOTSUP) if hardware-assisted VLAN filtering not configured.
3201  *   - (-ENODEV) if *port_id* invalid.
3202  *   - (-EIO) if device is removed.
3203  *   - (-ENOSYS) if VLAN filtering on *port_id* disabled.
3204  *   - (-EINVAL) if *vlan_id* > 4095.
3205  */
3206 int rte_eth_dev_vlan_filter(uint16_t port_id, uint16_t vlan_id, int on);
3207
3208 /**
3209  * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
3210  *
3211  * @param port_id
3212  *   The port identifier of the Ethernet device.
3213  * @param rx_queue_id
3214  *   The index of the receive queue for which a queue stats mapping is required.
3215  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
3216  *   to rte_eth_dev_configure().
3217  * @param on
3218  *   If 1, Enable VLAN Stripping of the receive queue of the Ethernet port.
3219  *   If 0, Disable VLAN Stripping of the receive queue of the Ethernet port.
3220  * @return
3221  *   - (0) if successful.
3222  *   - (-ENOTSUP) if hardware-assisted VLAN stripping not configured.
3223  *   - (-ENODEV) if *port_id* invalid.
3224  *   - (-EINVAL) if *rx_queue_id* invalid.
3225  */
3226 int rte_eth_dev_set_vlan_strip_on_queue(uint16_t port_id, uint16_t rx_queue_id,
3227                 int on);
3228
3229 /**
3230  * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
3231  * the VLAN header.
3232  *
3233  * @param port_id
3234  *   The port identifier of the Ethernet device.
3235  * @param vlan_type
3236  *   The vlan type.
3237  * @param tag_type
3238  *   The Tag Protocol ID
3239  * @return
3240  *   - (0) if successful.
3241  *   - (-ENOTSUP) if hardware-assisted VLAN TPID setup is not supported.
3242  *   - (-ENODEV) if *port_id* invalid.
3243  *   - (-EIO) if device is removed.
3244  */
3245 int rte_eth_dev_set_vlan_ether_type(uint16_t port_id,
3246                                     enum rte_vlan_type vlan_type,
3247                                     uint16_t tag_type);
3248
3249 /**
3250  * Set VLAN offload configuration on an Ethernet device.
3251  *
3252  * @param port_id
3253  *   The port identifier of the Ethernet device.
3254  * @param offload_mask
3255  *   The VLAN Offload bit mask can be mixed use with "OR"
3256  *       ETH_VLAN_STRIP_OFFLOAD
3257  *       ETH_VLAN_FILTER_OFFLOAD
3258  *       ETH_VLAN_EXTEND_OFFLOAD
3259  *       ETH_QINQ_STRIP_OFFLOAD
3260  * @return
3261  *   - (0) if successful.
3262  *   - (-ENOTSUP) if hardware-assisted VLAN filtering not configured.
3263  *   - (-ENODEV) if *port_id* invalid.
3264  *   - (-EIO) if device is removed.
3265  */
3266 int rte_eth_dev_set_vlan_offload(uint16_t port_id, int offload_mask);
3267
3268 /**
3269  * Read VLAN Offload configuration from an Ethernet device
3270  *
3271  * @param port_id
3272  *   The port identifier of the Ethernet device.
3273  * @return
3274  *   - (>0) if successful. Bit mask to indicate
3275  *       ETH_VLAN_STRIP_OFFLOAD
3276  *       ETH_VLAN_FILTER_OFFLOAD
3277  *       ETH_VLAN_EXTEND_OFFLOAD
3278  *       ETH_QINQ_STRIP_OFFLOAD
3279  *   - (-ENODEV) if *port_id* invalid.
3280  */
3281 int rte_eth_dev_get_vlan_offload(uint16_t port_id);
3282
3283 /**
3284  * Set port based TX VLAN insertion on or off.
3285  *
3286  * @param port_id
3287  *  The port identifier of the Ethernet device.
3288  * @param pvid
3289  *  Port based TX VLAN identifier together with user priority.
3290  * @param on
3291  *  Turn on or off the port based TX VLAN insertion.
3292  *
3293  * @return
3294  *   - (0) if successful.
3295  *   - negative if failed.
3296  */
3297 int rte_eth_dev_set_vlan_pvid(uint16_t port_id, uint16_t pvid, int on);
3298
3299 typedef void (*buffer_tx_error_fn)(struct rte_mbuf **unsent, uint16_t count,
3300                 void *userdata);
3301
3302 /**
3303  * Structure used to buffer packets for future TX
3304  * Used by APIs rte_eth_tx_buffer and rte_eth_tx_buffer_flush
3305  */
3306 struct rte_eth_dev_tx_buffer {
3307         buffer_tx_error_fn error_callback;
3308         void *error_userdata;
3309         uint16_t size;           /**< Size of buffer for buffered tx */
3310         uint16_t length;         /**< Number of packets in the array */
3311         struct rte_mbuf *pkts[];
3312         /**< Pending packets to be sent on explicit flush or when full */
3313 };
3314
3315 /**
3316  * Calculate the size of the tx buffer.
3317  *
3318  * @param sz
3319  *   Number of stored packets.
3320  */
3321 #define RTE_ETH_TX_BUFFER_SIZE(sz) \
3322         (sizeof(struct rte_eth_dev_tx_buffer) + (sz) * sizeof(struct rte_mbuf *))
3323
3324 /**
3325  * Initialize default values for buffered transmitting
3326  *
3327  * @param buffer
3328  *   Tx buffer to be initialized.
3329  * @param size
3330  *   Buffer size
3331  * @return
3332  *   0 if no error
3333  */
3334 int
3335 rte_eth_tx_buffer_init(struct rte_eth_dev_tx_buffer *buffer, uint16_t size);
3336
3337 /**
3338  * Configure a callback for buffered packets which cannot be sent
3339  *
3340  * Register a specific callback to be called when an attempt is made to send
3341  * all packets buffered on an ethernet port, but not all packets can
3342  * successfully be sent. The callback registered here will be called only
3343  * from calls to rte_eth_tx_buffer() and rte_eth_tx_buffer_flush() APIs.
3344  * The default callback configured for each queue by default just frees the
3345  * packets back to the calling mempool. If additional behaviour is required,
3346  * for example, to count dropped packets, or to retry transmission of packets
3347  * which cannot be sent, this function should be used to register a suitable
3348  * callback function to implement the desired behaviour.
3349  * The example callback "rte_eth_count_unsent_packet_callback()" is also
3350  * provided as reference.
3351  *
3352  * @param buffer
3353  *   The port identifier of the Ethernet device.
3354  * @param callback
3355  *   The function to be used as the callback.
3356  * @param userdata
3357  *   Arbitrary parameter to be passed to the callback function
3358  * @return
3359  *   0 on success, or -1 on error with rte_errno set appropriately
3360  */
3361 int
3362 rte_eth_tx_buffer_set_err_callback(struct rte_eth_dev_tx_buffer *buffer,
3363                 buffer_tx_error_fn callback, void *userdata);
3364
3365 /**
3366  * Callback function for silently dropping unsent buffered packets.
3367  *
3368  * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
3369  * adjust the default behavior when buffered packets cannot be sent. This
3370  * function drops any unsent packets silently and is used by tx buffered
3371  * operations as default behavior.
3372  *
3373  * NOTE: this function should not be called directly, instead it should be used
3374  *       as a callback for packet buffering.
3375  *
3376  * NOTE: when configuring this function as a callback with
3377  *       rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
3378  *       should point to an uint64_t value.
3379  *
3380  * @param pkts
3381  *   The previously buffered packets which could not be sent
3382  * @param unsent
3383  *   The number of unsent packets in the pkts array
3384  * @param userdata
3385  *   Not used
3386  */
3387 void
3388 rte_eth_tx_buffer_drop_callback(struct rte_mbuf **pkts, uint16_t unsent,
3389                 void *userdata);
3390
3391 /**
3392  * Callback function for tracking unsent buffered packets.
3393  *
3394  * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
3395  * adjust the default behavior when buffered packets cannot be sent. This
3396  * function drops any unsent packets, but also updates a user-supplied counter
3397  * to track the overall number of packets dropped. The counter should be an
3398  * uint64_t variable.
3399  *
3400  * NOTE: this function should not be called directly, instead it should be used
3401  *       as a callback for packet buffering.
3402  *
3403  * NOTE: when configuring this function as a callback with
3404  *       rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
3405  *       should point to an uint64_t value.
3406  *
3407  * @param pkts
3408  *   The previously buffered packets which could not be sent
3409  * @param unsent
3410  *   The number of unsent packets in the pkts array
3411  * @param userdata
3412  *   Pointer to an uint64_t value, which will be incremented by unsent
3413  */
3414 void
3415 rte_eth_tx_buffer_count_callback(struct rte_mbuf **pkts, uint16_t unsent,
3416                 void *userdata);
3417
3418 /**
3419  * Request the driver to free mbufs currently cached by the driver. The
3420  * driver will only free the mbuf if it is no longer in use. It is the
3421  * application's responsibility to ensure rte_eth_tx_buffer_flush(..) is
3422  * called if needed.
3423  *
3424  * @param port_id
3425  *   The port identifier of the Ethernet device.
3426  * @param queue_id
3427  *   The index of the transmit queue through which output packets must be
3428  *   sent.
3429  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
3430  *   to rte_eth_dev_configure().
3431  * @param free_cnt
3432  *   Maximum number of packets to free. Use 0 to indicate all possible packets
3433  *   should be freed. Note that a packet may be using multiple mbufs.
3434  * @return
3435  *   Failure: < 0
3436  *     -ENODEV: Invalid interface
3437  *     -EIO: device is removed
3438  *     -ENOTSUP: Driver does not support function
3439  *   Success: >= 0
3440  *     0-n: Number of packets freed. More packets may still remain in ring that
3441  *     are in use.
3442  */
3443 int
3444 rte_eth_tx_done_cleanup(uint16_t port_id, uint16_t queue_id, uint32_t free_cnt);
3445
3446 /**
3447  * Subtypes for IPsec offload event(@ref RTE_ETH_EVENT_IPSEC) raised by
3448  * eth device.
3449  */
3450 enum rte_eth_event_ipsec_subtype {
3451         RTE_ETH_EVENT_IPSEC_UNKNOWN = 0,
3452                         /**< Unknown event type */
3453         RTE_ETH_EVENT_IPSEC_ESN_OVERFLOW,
3454                         /**< Sequence number overflow */
3455         RTE_ETH_EVENT_IPSEC_SA_TIME_EXPIRY,
3456                         /**< Soft time expiry of SA */
3457         RTE_ETH_EVENT_IPSEC_SA_BYTE_EXPIRY,
3458                         /**< Soft byte expiry of SA */
3459         RTE_ETH_EVENT_IPSEC_MAX
3460                         /**< Max value of this enum */
3461 };
3462
3463 /**
3464  * Descriptor for @ref RTE_ETH_EVENT_IPSEC event. Used by eth dev to send extra
3465  * information of the IPsec offload event.
3466  */
3467 struct rte_eth_event_ipsec_desc {
3468         enum rte_eth_event_ipsec_subtype subtype;
3469                         /**< Type of RTE_ETH_EVENT_IPSEC_* event */
3470         uint64_t metadata;
3471                         /**< Event specific metadata
3472                          *
3473                          * For the following events, *userdata* registered
3474                          * with the *rte_security_session* would be returned
3475                          * as metadata,
3476                          *
3477                          * - @ref RTE_ETH_EVENT_IPSEC_ESN_OVERFLOW
3478                          * - @ref RTE_ETH_EVENT_IPSEC_SA_TIME_EXPIRY
3479                          * - @ref RTE_ETH_EVENT_IPSEC_SA_BYTE_EXPIRY
3480                          *
3481                          * @see struct rte_security_session_conf
3482                          *
3483                          */
3484 };
3485
3486 /**
3487  * The eth device event type for interrupt, and maybe others in the future.
3488  */
3489 enum rte_eth_event_type {
3490         RTE_ETH_EVENT_UNKNOWN,  /**< unknown event type */
3491         RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
3492         RTE_ETH_EVENT_QUEUE_STATE,
3493                                 /**< queue state event (enabled/disabled) */
3494         RTE_ETH_EVENT_INTR_RESET,
3495                         /**< reset interrupt event, sent to VF on PF reset */
3496         RTE_ETH_EVENT_VF_MBOX,  /**< message from the VF received by PF */
3497         RTE_ETH_EVENT_MACSEC,   /**< MACsec offload related event */
3498         RTE_ETH_EVENT_INTR_RMV, /**< device removal event */
3499         RTE_ETH_EVENT_NEW,      /**< port is probed */
3500         RTE_ETH_EVENT_DESTROY,  /**< port is released */
3501         RTE_ETH_EVENT_IPSEC,    /**< IPsec offload related event */
3502         RTE_ETH_EVENT_FLOW_AGED,/**< New aged-out flows is detected */
3503         RTE_ETH_EVENT_MAX       /**< max value of this enum */
3504 };
3505
3506 typedef int (*rte_eth_dev_cb_fn)(uint16_t port_id,
3507                 enum rte_eth_event_type event, void *cb_arg, void *ret_param);
3508 /**< user application callback to be registered for interrupts */
3509
3510 /**
3511  * Register a callback function for port event.
3512  *
3513  * @param port_id
3514  *  Port id.
3515  *  RTE_ETH_ALL means register the event for all port ids.
3516  * @param event
3517  *  Event interested.
3518  * @param cb_fn
3519  *  User supplied callback function to be called.
3520  * @param cb_arg
3521  *  Pointer to the parameters for the registered callback.
3522  *
3523  * @return
3524  *  - On success, zero.
3525  *  - On failure, a negative value.
3526  */
3527 int rte_eth_dev_callback_register(uint16_t port_id,
3528                         enum rte_eth_event_type event,
3529                 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
3530
3531 /**
3532  * Unregister a callback function for port event.
3533  *
3534  * @param port_id
3535  *  Port id.
3536  *  RTE_ETH_ALL means unregister the event for all port ids.
3537  * @param event
3538  *  Event interested.
3539  * @param cb_fn
3540  *  User supplied callback function to be called.
3541  * @param cb_arg
3542  *  Pointer to the parameters for the registered callback. -1 means to
3543  *  remove all for the same callback address and same event.
3544  *
3545  * @return
3546  *  - On success, zero.
3547  *  - On failure, a negative value.
3548  */
3549 int rte_eth_dev_callback_unregister(uint16_t port_id,
3550                         enum rte_eth_event_type event,
3551                 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
3552
3553 /**
3554  * When there is no rx packet coming in Rx Queue for a long time, we can
3555  * sleep lcore related to RX Queue for power saving, and enable rx interrupt
3556  * to be triggered when Rx packet arrives.
3557  *
3558  * The rte_eth_dev_rx_intr_enable() function enables rx queue
3559  * interrupt on specific rx queue of a port.
3560  *
3561  * @param port_id
3562  *   The port identifier of the Ethernet device.
3563  * @param queue_id
3564  *   The index of the receive queue from which to retrieve input packets.
3565  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
3566  *   to rte_eth_dev_configure().
3567  * @return
3568  *   - (0) if successful.
3569  *   - (-ENOTSUP) if underlying hardware OR driver doesn't support
3570  *     that operation.
3571  *   - (-ENODEV) if *port_id* invalid.
3572  *   - (-EIO) if device is removed.
3573  */
3574 int rte_eth_dev_rx_intr_enable(uint16_t port_id, uint16_t queue_id);
3575
3576 /**
3577  * When lcore wakes up from rx interrupt indicating packet coming, disable rx
3578  * interrupt and returns to polling mode.
3579  *
3580  * The rte_eth_dev_rx_intr_disable() function disables rx queue
3581  * interrupt on specific rx queue of a port.
3582  *
3583  * @param port_id
3584  *   The port identifier of the Ethernet device.
3585  * @param queue_id
3586  *   The index of the receive queue from which to retrieve input packets.
3587  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
3588  *   to rte_eth_dev_configure().
3589  * @return
3590  *   - (0) if successful.
3591  *   - (-ENOTSUP) if underlying hardware OR driver doesn't support
3592  *     that operation.
3593  *   - (-ENODEV) if *port_id* invalid.
3594  *   - (-EIO) if device is removed.
3595  */
3596 int rte_eth_dev_rx_intr_disable(uint16_t port_id, uint16_t queue_id);
3597
3598 /**
3599  * RX Interrupt control per port.
3600  *
3601  * @param port_id
3602  *   The port identifier of the Ethernet device.
3603  * @param epfd
3604  *   Epoll instance fd which the intr vector associated to.
3605  *   Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
3606  * @param op
3607  *   The operation be performed for the vector.
3608  *   Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
3609  * @param data
3610  *   User raw data.
3611  * @return
3612  *   - On success, zero.
3613  *   - On failure, a negative value.
3614  */
3615 int rte_eth_dev_rx_intr_ctl(uint16_t port_id, int epfd, int op, void *data);
3616
3617 /**
3618  * RX Interrupt control per queue.
3619  *
3620  * @param port_id
3621  *   The port identifier of the Ethernet device.
3622  * @param queue_id
3623  *   The index of the receive queue from which to retrieve input packets.
3624  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
3625  *   to rte_eth_dev_configure().
3626  * @param epfd
3627  *   Epoll instance fd which the intr vector associated to.
3628  *   Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
3629  * @param op
3630  *   The operation be performed for the vector.
3631  *   Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
3632  * @param data
3633  *   User raw data.
3634  * @return
3635  *   - On success, zero.
3636  *   - On failure, a negative value.
3637  */
3638 int rte_eth_dev_rx_intr_ctl_q(uint16_t port_id, uint16_t queue_id,
3639                               int epfd, int op, void *data);
3640
3641 /**
3642  * @warning
3643  * @b EXPERIMENTAL: this API may change without prior notice.
3644  *
3645  * Get interrupt fd per Rx queue.
3646  *
3647  * @param port_id
3648  *   The port identifier of the Ethernet device.
3649  * @param queue_id
3650  *   The index of the receive queue from which to retrieve input packets.
3651  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
3652  *   to rte_eth_dev_configure().
3653  * @return
3654  *   - (>=0) the interrupt fd associated to the requested Rx queue if
3655  *           successful.
3656  *   - (-1) on error.
3657  */
3658 __rte_experimental
3659 int
3660 rte_eth_dev_rx_intr_ctl_q_get_fd(uint16_t port_id, uint16_t queue_id);
3661
3662 /**
3663  * Turn on the LED on the Ethernet device.
3664  * This function turns on the LED on the Ethernet device.
3665  *
3666  * @param port_id
3667  *   The port identifier of the Ethernet device.
3668  * @return
3669  *   - (0) if successful.
3670  *   - (-ENOTSUP) if underlying hardware OR driver doesn't support
3671  *     that operation.
3672  *   - (-ENODEV) if *port_id* invalid.
3673  *   - (-EIO) if device is removed.
3674  */
3675 int  rte_eth_led_on(uint16_t port_id);
3676
3677 /**
3678  * Turn off the LED on the Ethernet device.
3679  * This function turns off the LED on the Ethernet device.
3680  *
3681  * @param port_id
3682  *   The port identifier of the Ethernet device.
3683  * @return
3684  *   - (0) if successful.
3685  *   - (-ENOTSUP) if underlying hardware OR driver doesn't support
3686  *     that operation.
3687  *   - (-ENODEV) if *port_id* invalid.
3688  *   - (-EIO) if device is removed.
3689  */
3690 int  rte_eth_led_off(uint16_t port_id);
3691
3692 /**
3693  * @warning
3694  * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
3695  *
3696  * Get Forward Error Correction(FEC) capability.
3697  *
3698  * @param port_id
3699  *   The port identifier of the Ethernet device.
3700  * @param speed_fec_capa
3701  *   speed_fec_capa is out only with per-speed capabilities.
3702  *   If set to NULL, the function returns the required number
3703  *   of required array entries.
3704  * @param num
3705  *   a number of elements in an speed_fec_capa array.
3706  *
3707  * @return
3708  *   - A non-negative value lower or equal to num: success. The return value
3709  *     is the number of entries filled in the fec capa array.
3710  *   - A non-negative value higher than num: error, the given fec capa array
3711  *     is too small. The return value corresponds to the num that should
3712  *     be given to succeed. The entries in fec capa array are not valid and
3713  *     shall not be used by the caller.
3714  *   - (-ENOTSUP) if underlying hardware OR driver doesn't support.
3715  *     that operation.
3716  *   - (-EIO) if device is removed.
3717  *   - (-ENODEV)  if *port_id* invalid.
3718  *   - (-EINVAL)  if *num* or *speed_fec_capa* invalid
3719  */
3720 __rte_experimental
3721 int rte_eth_fec_get_capability(uint16_t port_id,
3722                                struct rte_eth_fec_capa *speed_fec_capa,
3723                                unsigned int num);
3724
3725 /**
3726  * @warning
3727  * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
3728  *
3729  * Get current Forward Error Correction(FEC) mode.
3730  * If link is down and AUTO is enabled, AUTO is returned, otherwise,
3731  * configured FEC mode is returned.
3732  * If link is up, current FEC mode is returned.
3733  *
3734  * @param port_id
3735  *   The port identifier of the Ethernet device.
3736  * @param fec_capa
3737  *   A bitmask of enabled FEC modes. If AUTO bit is set, other
3738  *   bits specify FEC modes which may be negotiated. If AUTO
3739  *   bit is clear, specify FEC modes to be used (only one valid
3740  *   mode per speed may be set).
3741  * @return
3742  *   - (0) if successful.
3743  *   - (-ENOTSUP) if underlying hardware OR driver doesn't support.
3744  *     that operation.
3745  *   - (-EIO) if device is removed.
3746  *   - (-ENODEV)  if *port_id* invalid.
3747  */
3748 __rte_experimental
3749 int rte_eth_fec_get(uint16_t port_id, uint32_t *fec_capa);
3750
3751 /**
3752  * @warning
3753  * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
3754  *
3755  * Set Forward Error Correction(FEC) mode.
3756  *
3757  * @param port_id
3758  *   The port identifier of the Ethernet device.
3759  * @param fec_capa
3760  *   A bitmask of allowed FEC modes. If AUTO bit is set, other
3761  *   bits specify FEC modes which may be negotiated. If AUTO
3762  *   bit is clear, specify FEC modes to be used (only one valid
3763  *   mode per speed may be set).
3764  * @return
3765  *   - (0) if successful.
3766  *   - (-EINVAL) if the FEC mode is not valid.
3767  *   - (-ENOTSUP) if underlying hardware OR driver doesn't support.
3768  *   - (-EIO) if device is removed.
3769  *   - (-ENODEV)  if *port_id* invalid.
3770  */
3771 __rte_experimental
3772 int rte_eth_fec_set(uint16_t port_id, uint32_t fec_capa);
3773
3774 /**
3775  * Get current status of the Ethernet link flow control for Ethernet device
3776  *
3777  * @param port_id
3778  *   The port identifier of the Ethernet device.
3779  * @param fc_conf
3780  *   The pointer to the structure where to store the flow control parameters.
3781  * @return
3782  *   - (0) if successful.
3783  *   - (-ENOTSUP) if hardware doesn't support flow control.
3784  *   - (-ENODEV)  if *port_id* invalid.
3785  *   - (-EIO)  if device is removed.
3786  */
3787 int rte_eth_dev_flow_ctrl_get(uint16_t port_id,
3788                               struct rte_eth_fc_conf *fc_conf);
3789
3790 /**
3791  * Configure the Ethernet link flow control for Ethernet device
3792  *
3793  * @param port_id
3794  *   The port identifier of the Ethernet device.
3795  * @param fc_conf
3796  *   The pointer to the structure of the flow control parameters.
3797  * @return
3798  *   - (0) if successful.
3799  *   - (-ENOTSUP) if hardware doesn't support flow control mode.
3800  *   - (-ENODEV)  if *port_id* invalid.
3801  *   - (-EINVAL)  if bad parameter
3802  *   - (-EIO)     if flow control setup failure or device is removed.
3803  */
3804 int rte_eth_dev_flow_ctrl_set(uint16_t port_id,
3805                               struct rte_eth_fc_conf *fc_conf);
3806
3807 /**
3808  * Configure the Ethernet priority flow control under DCB environment
3809  * for Ethernet device.
3810  *
3811  * @param port_id
3812  * The port identifier of the Ethernet device.
3813  * @param pfc_conf
3814  * The pointer to the structure of the priority flow control parameters.
3815  * @return
3816  *   - (0) if successful.
3817  *   - (-ENOTSUP) if hardware doesn't support priority flow control mode.
3818  *   - (-ENODEV)  if *port_id* invalid.
3819  *   - (-EINVAL)  if bad parameter
3820  *   - (-EIO)     if flow control setup failure or device is removed.
3821  */
3822 int rte_eth_dev_priority_flow_ctrl_set(uint16_t port_id,
3823                                 struct rte_eth_pfc_conf *pfc_conf);
3824
3825 /**
3826  * Add a MAC address to the set used for filtering incoming packets.
3827  *
3828  * @param port_id
3829  *   The port identifier of the Ethernet device.
3830  * @param mac_addr
3831  *   The MAC address to add.
3832  * @param pool
3833  *   VMDq pool index to associate address with (if VMDq is enabled). If VMDq is
3834  *   not enabled, this should be set to 0.
3835  * @return
3836  *   - (0) if successfully added or *mac_addr* was already added.
3837  *   - (-ENOTSUP) if hardware doesn't support this feature.
3838  *   - (-ENODEV) if *port* is invalid.
3839  *   - (-EIO) if device is removed.
3840  *   - (-ENOSPC) if no more MAC addresses can be added.
3841  *   - (-EINVAL) if MAC address is invalid.
3842  */
3843 int rte_eth_dev_mac_addr_add(uint16_t port_id, struct rte_ether_addr *mac_addr,
3844                                 uint32_t pool);
3845
3846 /**
3847  * Remove a MAC address from the internal array of addresses.
3848  *
3849  * @param port_id
3850  *   The port identifier of the Ethernet device.
3851  * @param mac_addr
3852  *   MAC address to remove.
3853  * @return
3854  *   - (0) if successful, or *mac_addr* didn't exist.
3855  *   - (-ENOTSUP) if hardware doesn't support.
3856  *   - (-ENODEV) if *port* invalid.
3857  *   - (-EADDRINUSE) if attempting to remove the default MAC address
3858  */
3859 int rte_eth_dev_mac_addr_remove(uint16_t port_id,
3860                                 struct rte_ether_addr *mac_addr);
3861
3862 /**
3863  * Set the default MAC address.
3864  *
3865  * @param port_id
3866  *   The port identifier of the Ethernet device.
3867  * @param mac_addr
3868  *   New default MAC address.
3869  * @return
3870  *   - (0) if successful, or *mac_addr* didn't exist.
3871  *   - (-ENOTSUP) if hardware doesn't support.
3872  *   - (-ENODEV) if *port* invalid.
3873  *   - (-EINVAL) if MAC address is invalid.
3874  */
3875 int rte_eth_dev_default_mac_addr_set(uint16_t port_id,
3876                 struct rte_ether_addr *mac_addr);
3877
3878 /**
3879  * Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3880  *
3881  * @param port_id
3882  *   The port identifier of the Ethernet device.
3883  * @param reta_conf
3884  *   RETA to update.
3885  * @param reta_size
3886  *   Redirection table size. The table size can be queried by
3887  *   rte_eth_dev_info_get().
3888  * @return
3889  *   - (0) if successful.
3890  *   - (-ENODEV) if *port_id* is invalid.
3891  *   - (-ENOTSUP) if hardware doesn't support.
3892  *   - (-EINVAL) if bad parameter.
3893  *   - (-EIO) if device is removed.
3894  */
3895 int rte_eth_dev_rss_reta_update(uint16_t port_id,
3896                                 struct rte_eth_rss_reta_entry64 *reta_conf,
3897                                 uint16_t reta_size);
3898
3899 /**
3900  * Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
3901  *
3902  * @param port_id
3903  *   The port identifier of the Ethernet device.
3904  * @param reta_conf
3905  *   RETA to query. For each requested reta entry, corresponding bit
3906  *   in mask must be set.
3907  * @param reta_size
3908  *   Redirection table size. The table size can be queried by
3909  *   rte_eth_dev_info_get().
3910  * @return
3911  *   - (0) if successful.
3912  *   - (-ENODEV) if *port_id* is invalid.
3913  *   - (-ENOTSUP) if hardware doesn't support.
3914  *   - (-EINVAL) if bad parameter.
3915  *   - (-EIO) if device is removed.
3916  */
3917 int rte_eth_dev_rss_reta_query(uint16_t port_id,
3918                                struct rte_eth_rss_reta_entry64 *reta_conf,
3919                                uint16_t reta_size);
3920
3921 /**
3922  * Updates unicast hash table for receiving packet with the given destination
3923  * MAC address, and the packet is routed to all VFs for which the RX mode is
3924  * accept packets that match the unicast hash table.
3925  *
3926  * @param port_id
3927  *   The port identifier of the Ethernet device.
3928  * @param addr
3929  *   Unicast MAC address.
3930  * @param on
3931  *    1 - Set an unicast hash bit for receiving packets with the MAC address.
3932  *    0 - Clear an unicast hash bit.
3933  * @return
3934  *   - (0) if successful.
3935  *   - (-ENOTSUP) if hardware doesn't support.
3936   *  - (-ENODEV) if *port_id* invalid.
3937  *   - (-EIO) if device is removed.
3938  *   - (-EINVAL) if bad parameter.
3939  */
3940 int rte_eth_dev_uc_hash_table_set(uint16_t port_id, struct rte_ether_addr *addr,
3941                                   uint8_t on);
3942
3943 /**
3944  * Updates all unicast hash bitmaps for receiving packet with any Unicast
3945  * Ethernet MAC addresses,the packet is routed to all VFs for which the RX
3946  * mode is accept packets that match the unicast hash table.
3947  *
3948  * @param port_id
3949  *   The port identifier of the Ethernet device.
3950  * @param on
3951  *    1 - Set all unicast hash bitmaps for receiving all the Ethernet
3952  *         MAC addresses
3953  *    0 - Clear all unicast hash bitmaps
3954  * @return
3955  *   - (0) if successful.
3956  *   - (-ENOTSUP) if hardware doesn't support.
3957   *  - (-ENODEV) if *port_id* invalid.
3958  *   - (-EIO) if device is removed.
3959  *   - (-EINVAL) if bad parameter.
3960  */
3961 int rte_eth_dev_uc_all_hash_table_set(uint16_t port_id, uint8_t on);
3962
3963 /**
3964  * Set a traffic mirroring rule on an Ethernet device
3965  *
3966  * @param port_id
3967  *   The port identifier of the Ethernet device.
3968  * @param mirror_conf
3969  *   The pointer to the traffic mirroring structure describing the mirroring rule.
3970  *   The *rte_eth_vm_mirror_conf* structure includes the type of mirroring rule,
3971  *   destination pool and the value of rule if enable vlan or pool mirroring.
3972  *
3973  * @param rule_id
3974  *   The index of traffic mirroring rule, we support four separated rules.
3975  * @param on
3976  *   1 - Enable a mirroring rule.
3977  *   0 - Disable a mirroring rule.
3978  * @return
3979  *   - (0) if successful.
3980  *   - (-ENOTSUP) if hardware doesn't support this feature.
3981  *   - (-ENODEV) if *port_id* invalid.
3982  *   - (-EIO) if device is removed.
3983  *   - (-EINVAL) if the mr_conf information is not correct.
3984  */
3985 int rte_eth_mirror_rule_set(uint16_t port_id,
3986                         struct rte_eth_mirror_conf *mirror_conf,
3987                         uint8_t rule_id,
3988                         uint8_t on);
3989
3990 /**
3991  * Reset a traffic mirroring rule on an Ethernet device.
3992  *
3993  * @param port_id
3994  *   The port identifier of the Ethernet device.
3995  * @param rule_id
3996  *   The index of traffic mirroring rule, we support four separated rules.
3997  * @return
3998  *   - (0) if successful.
3999  *   - (-ENOTSUP) if hardware doesn't support this feature.
4000  *   - (-ENODEV) if *port_id* invalid.
4001  *   - (-EIO) if device is removed.
4002  *   - (-EINVAL) if bad parameter.
4003  */
4004 int rte_eth_mirror_rule_reset(uint16_t port_id,
4005                                          uint8_t rule_id);
4006
4007 /**
4008  * Set the rate limitation for a queue on an Ethernet device.
4009  *
4010  * @param port_id
4011  *   The port identifier of the Ethernet device.
4012  * @param queue_idx
4013  *   The queue id.
4014  * @param tx_rate
4015  *   The tx rate in Mbps. Allocated from the total port link speed.
4016  * @return
4017  *   - (0) if successful.
4018  *   - (-ENOTSUP) if hardware doesn't support this feature.
4019  *   - (-ENODEV) if *port_id* invalid.
4020  *   - (-EIO) if device is removed.
4021  *   - (-EINVAL) if bad parameter.
4022  */
4023 int rte_eth_set_queue_rate_limit(uint16_t port_id, uint16_t queue_idx,
4024                         uint16_t tx_rate);
4025
4026 /**
4027  * Configuration of Receive Side Scaling hash computation of Ethernet device.
4028  *
4029  * @param port_id
4030  *   The port identifier of the Ethernet device.
4031  * @param rss_conf
4032  *   The new configuration to use for RSS hash computation on the port.
4033  * @return
4034  *   - (0) if successful.
4035  *   - (-ENODEV) if port identifier is invalid.
4036  *   - (-EIO) if device is removed.
4037  *   - (-ENOTSUP) if hardware doesn't support.
4038  *   - (-EINVAL) if bad parameter.
4039  */
4040 int rte_eth_dev_rss_hash_update(uint16_t port_id,
4041                                 struct rte_eth_rss_conf *rss_conf);
4042
4043 /**
4044  * Retrieve current configuration of Receive Side Scaling hash computation
4045  * of Ethernet device.
4046  *
4047  * @param port_id
4048  *   The port identifier of the Ethernet device.
4049  * @param rss_conf
4050  *   Where to store the current RSS hash configuration of the Ethernet device.
4051  * @return
4052  *   - (0) if successful.
4053  *   - (-ENODEV) if port identifier is invalid.
4054  *   - (-EIO) if device is removed.
4055  *   - (-ENOTSUP) if hardware doesn't support RSS.
4056  */
4057 int
4058 rte_eth_dev_rss_hash_conf_get(uint16_t port_id,
4059                               struct rte_eth_rss_conf *rss_conf);
4060
4061 /**
4062  * Add UDP tunneling port for a type of tunnel.
4063  *
4064  * Some NICs may require such configuration to properly parse a tunnel
4065  * with any standard or custom UDP port.
4066  * The packets with this UDP port will be parsed for this type of tunnel.
4067  * The device parser will also check the rest of the tunnel headers
4068  * before classifying the packet.
4069  *
4070  * With some devices, this API will affect packet classification, i.e.:
4071  *     - mbuf.packet_type reported on Rx
4072  *     - rte_flow rules with tunnel items
4073  *
4074  * @param port_id
4075  *   The port identifier of the Ethernet device.
4076  * @param tunnel_udp
4077  *   UDP tunneling configuration.
4078  *
4079  * @return
4080  *   - (0) if successful.
4081  *   - (-ENODEV) if port identifier is invalid.
4082  *   - (-EIO) if device is removed.
4083  *   - (-ENOTSUP) if hardware doesn't support tunnel type.
4084  */
4085 int
4086 rte_eth_dev_udp_tunnel_port_add(uint16_t port_id,
4087                                 struct rte_eth_udp_tunnel *tunnel_udp);
4088
4089 /**
4090  * Delete UDP tunneling port for a type of tunnel.
4091  *
4092  * The packets with this UDP port will not be classified as this type of tunnel
4093  * anymore if the device use such mapping for tunnel packet classification.
4094  *
4095  * @see rte_eth_dev_udp_tunnel_port_add
4096  *
4097  * @param port_id
4098  *   The port identifier of the Ethernet device.
4099  * @param tunnel_udp
4100  *   UDP tunneling configuration.
4101  *
4102  * @return
4103  *   - (0) if successful.
4104  *   - (-ENODEV) if port identifier is invalid.
4105  *   - (-EIO) if device is removed.
4106  *   - (-ENOTSUP) if hardware doesn't support tunnel type.
4107  */
4108 int
4109 rte_eth_dev_udp_tunnel_port_delete(uint16_t port_id,
4110                                    struct rte_eth_udp_tunnel *tunnel_udp);
4111
4112 /**
4113  * Get DCB information on an Ethernet device.
4114  *
4115  * @param port_id
4116  *   The port identifier of the Ethernet device.
4117  * @param dcb_info
4118  *   dcb information.
4119  * @return
4120  *   - (0) if successful.
4121  *   - (-ENODEV) if port identifier is invalid.
4122  *   - (-EIO) if device is removed.
4123  *   - (-ENOTSUP) if hardware doesn't support.
4124  */
4125 int rte_eth_dev_get_dcb_info(uint16_t port_id,
4126                              struct rte_eth_dcb_info *dcb_info);
4127
4128 struct rte_eth_rxtx_callback;
4129
4130 /**
4131  * Add a callback to be called on packet RX on a given port and queue.
4132  *
4133  * This API configures a function to be called for each burst of
4134  * packets received on a given NIC port queue. The return value is a pointer
4135  * that can be used to later remove the callback using
4136  * rte_eth_remove_rx_callback().
4137  *
4138  * Multiple functions are called in the order that they are added.
4139  *
4140  * @param port_id
4141  *   The port identifier of the Ethernet device.
4142  * @param queue_id
4143  *   The queue on the Ethernet device on which the callback is to be added.
4144  * @param fn
4145  *   The callback function
4146  * @param user_param
4147  *   A generic pointer parameter which will be passed to each invocation of the
4148  *   callback function on this port and queue. Inter-thread synchronization
4149  *   of any user data changes is the responsibility of the user.
4150  *
4151  * @return
4152  *   NULL on error.
4153  *   On success, a pointer value which can later be used to remove the callback.
4154  */
4155 const struct rte_eth_rxtx_callback *
4156 rte_eth_add_rx_callback(uint16_t port_id, uint16_t queue_id,
4157                 rte_rx_callback_fn fn, void *user_param);
4158
4159 /**
4160  * Add a callback that must be called first on packet RX on a given port
4161  * and queue.
4162  *
4163  * This API configures a first function to be called for each burst of
4164  * packets received on a given NIC port queue. The return value is a pointer
4165  * that can be used to later remove the callback using
4166  * rte_eth_remove_rx_callback().
4167  *
4168  * Multiple functions are called in the order that they are added.
4169  *
4170  * @param port_id
4171  *   The port identifier of the Ethernet device.
4172  * @param queue_id
4173  *   The queue on the Ethernet device on which the callback is to be added.
4174  * @param fn
4175  *   The callback function
4176  * @param user_param
4177  *   A generic pointer parameter which will be passed to each invocation of the
4178  *   callback function on this port and queue. Inter-thread synchronization
4179  *   of any user data changes is the responsibility of the user.
4180  *
4181  * @return
4182  *   NULL on error.
4183  *   On success, a pointer value which can later be used to remove the callback.
4184  */
4185 const struct rte_eth_rxtx_callback *
4186 rte_eth_add_first_rx_callback(uint16_t port_id, uint16_t queue_id,
4187                 rte_rx_callback_fn fn, void *user_param);
4188
4189 /**
4190  * Add a callback to be called on packet TX on a given port and queue.
4191  *
4192  * This API configures a function to be called for each burst of
4193  * packets sent on a given NIC port queue. The return value is a pointer
4194  * that can be used to later remove the callback using
4195  * rte_eth_remove_tx_callback().
4196  *
4197  * Multiple functions are called in the order that they are added.
4198  *
4199  * @param port_id
4200  *   The port identifier of the Ethernet device.
4201  * @param queue_id
4202  *   The queue on the Ethernet device on which the callback is to be added.
4203  * @param fn
4204  *   The callback function
4205  * @param user_param
4206  *   A generic pointer parameter which will be passed to each invocation of the
4207  *   callback function on this port and queue. Inter-thread synchronization
4208  *   of any user data changes is the responsibility of the user.
4209  *
4210  * @return
4211  *   NULL on error.
4212  *   On success, a pointer value which can later be used to remove the callback.
4213  */
4214 const struct rte_eth_rxtx_callback *
4215 rte_eth_add_tx_callback(uint16_t port_id, uint16_t queue_id,
4216                 rte_tx_callback_fn fn, void *user_param);
4217
4218 /**
4219  * Remove an RX packet callback from a given port and queue.
4220  *
4221  * This function is used to removed callbacks that were added to a NIC port
4222  * queue using rte_eth_add_rx_callback().
4223  *
4224  * Note: the callback is removed from the callback list but it isn't freed
4225  * since the it may still be in use. The memory for the callback can be
4226  * subsequently freed back by the application by calling rte_free():
4227  *
4228  * - Immediately - if the port is stopped, or the user knows that no
4229  *   callbacks are in flight e.g. if called from the thread doing RX/TX
4230  *   on that queue.
4231  *
4232  * - After a short delay - where the delay is sufficient to allow any
4233  *   in-flight callbacks to complete. Alternately, the RCU mechanism can be
4234  *   used to detect when data plane threads have ceased referencing the
4235  *   callback memory.
4236  *
4237  * @param port_id
4238  *   The port identifier of the Ethernet device.
4239  * @param queue_id
4240  *   The queue on the Ethernet device from which the callback is to be removed.
4241  * @param user_cb
4242  *   User supplied callback created via rte_eth_add_rx_callback().
4243  *
4244  * @return
4245  *   - 0: Success. Callback was removed.
4246  *   - -ENODEV:  If *port_id* is invalid.
4247  *   - -ENOTSUP: Callback support is not available.
4248  *   - -EINVAL:  The queue_id is out of range, or the callback
4249  *               is NULL or not found for the port/queue.
4250  */
4251 int rte_eth_remove_rx_callback(uint16_t port_id, uint16_t queue_id,
4252                 const struct rte_eth_rxtx_callback *user_cb);
4253
4254 /**
4255  * Remove a TX packet callback from a given port and queue.
4256  *
4257  * This function is used to removed callbacks that were added to a NIC port
4258  * queue using rte_eth_add_tx_callback().
4259  *
4260  * Note: the callback is removed from the callback list but it isn't freed
4261  * since the it may still be in use. The memory for the callback can be
4262  * subsequently freed back by the application by calling rte_free():
4263  *
4264  * - Immediately - if the port is stopped, or the user knows that no
4265  *   callbacks are in flight e.g. if called from the thread doing RX/TX
4266  *   on that queue.
4267  *
4268  * - After a short delay - where the delay is sufficient to allow any
4269  *   in-flight callbacks to complete. Alternately, the RCU mechanism can be
4270  *   used to detect when data plane threads have ceased referencing the
4271  *   callback memory.
4272  *
4273  * @param port_id
4274  *   The port identifier of the Ethernet device.
4275  * @param queue_id
4276  *   The queue on the Ethernet device from which the callback is to be removed.
4277  * @param user_cb
4278  *   User supplied callback created via rte_eth_add_tx_callback().
4279  *
4280  * @return
4281  *   - 0: Success. Callback was removed.
4282  *   - -ENODEV:  If *port_id* is invalid.
4283  *   - -ENOTSUP: Callback support is not available.
4284  *   - -EINVAL:  The queue_id is out of range, or the callback
4285  *               is NULL or not found for the port/queue.
4286  */
4287 int rte_eth_remove_tx_callback(uint16_t port_id, uint16_t queue_id,
4288                 const struct rte_eth_rxtx_callback *user_cb);
4289
4290 /**
4291  * Retrieve information about given port's RX queue.
4292  *
4293  * @param port_id
4294  *   The port identifier of the Ethernet device.
4295  * @param queue_id
4296  *   The RX queue on the Ethernet device for which information
4297  *   will be retrieved.
4298  * @param qinfo
4299  *   A pointer to a structure of type *rte_eth_rxq_info_info* to be filled with
4300  *   the information of the Ethernet device.
4301  *
4302  * @return
4303  *   - 0: Success
4304  *   - -ENODEV:  If *port_id* is invalid.
4305  *   - -ENOTSUP: routine is not supported by the device PMD.
4306  *   - -EINVAL:  The queue_id is out of range, or the queue
4307  *               is hairpin queue.
4308  */
4309 int rte_eth_rx_queue_info_get(uint16_t port_id, uint16_t queue_id,
4310         struct rte_eth_rxq_info *qinfo);
4311
4312 /**
4313  * Retrieve information about given port's TX queue.
4314  *
4315  * @param port_id
4316  *   The port identifier of the Ethernet device.
4317  * @param queue_id
4318  *   The TX queue on the Ethernet device for which information
4319  *   will be retrieved.
4320  * @param qinfo
4321  *   A pointer to a structure of type *rte_eth_txq_info_info* to be filled with
4322  *   the information of the Ethernet device.
4323  *
4324  * @return
4325  *   - 0: Success
4326  *   - -ENODEV:  If *port_id* is invalid.
4327  *   - -ENOTSUP: routine is not supported by the device PMD.
4328  *   - -EINVAL:  The queue_id is out of range, or the queue
4329  *               is hairpin queue.
4330  */
4331 int rte_eth_tx_queue_info_get(uint16_t port_id, uint16_t queue_id,
4332         struct rte_eth_txq_info *qinfo);
4333
4334 /**
4335  * Retrieve information about the Rx packet burst mode.
4336  *
4337  * @param port_id
4338  *   The port identifier of the Ethernet device.
4339  * @param queue_id
4340  *   The Rx queue on the Ethernet device for which information
4341  *   will be retrieved.
4342  * @param mode
4343  *   A pointer to a structure of type *rte_eth_burst_mode* to be filled
4344  *   with the information of the packet burst mode.
4345  *
4346  * @return
4347  *   - 0: Success
4348  *   - -ENODEV:  If *port_id* is invalid.
4349  *   - -ENOTSUP: routine is not supported by the device PMD.
4350  *   - -EINVAL:  The queue_id is out of range.
4351  */
4352 __rte_experimental
4353 int rte_eth_rx_burst_mode_get(uint16_t port_id, uint16_t queue_id,
4354         struct rte_eth_burst_mode *mode);
4355
4356 /**
4357  * Retrieve information about the Tx packet burst mode.
4358  *
4359  * @param port_id
4360  *   The port identifier of the Ethernet device.
4361  * @param queue_id
4362  *   The Tx queue on the Ethernet device for which information
4363  *   will be retrieved.
4364  * @param mode
4365  *   A pointer to a structure of type *rte_eth_burst_mode* to be filled
4366  *   with the information of the packet burst mode.
4367  *
4368  * @return
4369  *   - 0: Success
4370  *   - -ENODEV:  If *port_id* is invalid.
4371  *   - -ENOTSUP: routine is not supported by the device PMD.
4372  *   - -EINVAL:  The queue_id is out of range.
4373  */
4374 __rte_experimental
4375 int rte_eth_tx_burst_mode_get(uint16_t port_id, uint16_t queue_id,
4376         struct rte_eth_burst_mode *mode);
4377
4378 /**
4379  * @warning
4380  * @b EXPERIMENTAL: this API may change without prior notice.
4381  *
4382  * Retrieve the monitor condition for a given receive queue.
4383  *
4384  * @param port_id
4385  *   The port identifier of the Ethernet device.
4386  * @param queue_id
4387  *   The Rx queue on the Ethernet device for which information
4388  *   will be retrieved.
4389  * @param pmc
4390  *   The pointer to power-optimized monitoring condition structure.
4391  *
4392  * @return
4393  *   - 0: Success.
4394  *   -ENOTSUP: Operation not supported.
4395  *   -EINVAL: Invalid parameters.
4396  *   -ENODEV: Invalid port ID.
4397  */
4398 __rte_experimental
4399 int rte_eth_get_monitor_addr(uint16_t port_id, uint16_t queue_id,
4400                 struct rte_power_monitor_cond *pmc);
4401
4402 /**
4403  * Retrieve device registers and register attributes (number of registers and
4404  * register size)
4405  *
4406  * @param port_id
4407  *   The port identifier of the Ethernet device.
4408  * @param info
4409  *   Pointer to rte_dev_reg_info structure to fill in. If info->data is
4410  *   NULL the function fills in the width and length fields. If non-NULL
4411  *   the registers are put into the buffer pointed at by the data field.
4412  * @return
4413  *   - (0) if successful.
4414  *   - (-ENOTSUP) if hardware doesn't support.
4415  *   - (-EINVAL) if bad parameter.
4416  *   - (-ENODEV) if *port_id* invalid.
4417  *   - (-EIO) if device is removed.
4418  *   - others depends on the specific operations implementation.
4419  */
4420 int rte_eth_dev_get_reg_info(uint16_t port_id, struct rte_dev_reg_info *info);
4421
4422 /**
4423  * Retrieve size of device EEPROM
4424  *
4425  * @param port_id
4426  *   The port identifier of the Ethernet device.
4427  * @return
4428  *   - (>=0) EEPROM size if successful.
4429  *   - (-ENOTSUP) if hardware doesn't support.
4430  *   - (-ENODEV) if *port_id* invalid.
4431  *   - (-EIO) if device is removed.
4432  *   - others depends on the specific operations implementation.
4433  */
4434 int rte_eth_dev_get_eeprom_length(uint16_t port_id);
4435
4436 /**
4437  * Retrieve EEPROM and EEPROM attribute
4438  *
4439  * @param port_id
4440  *   The port identifier of the Ethernet device.
4441  * @param info
4442  *   The template includes buffer for return EEPROM data and
4443  *   EEPROM attributes to be filled.
4444  * @return
4445  *   - (0) if successful.
4446  *   - (-ENOTSUP) if hardware doesn't support.
4447  *   - (-EINVAL) if bad parameter.
4448  *   - (-ENODEV) if *port_id* invalid.
4449  *   - (-EIO) if device is removed.
4450  *   - others depends on the specific operations implementation.
4451  */
4452 int rte_eth_dev_get_eeprom(uint16_t port_id, struct rte_dev_eeprom_info *info);
4453
4454 /**
4455  * Program EEPROM with provided data
4456  *
4457  * @param port_id
4458  *   The port identifier of the Ethernet device.
4459  * @param info
4460  *   The template includes EEPROM data for programming and
4461  *   EEPROM attributes to be filled
4462  * @return
4463  *   - (0) if successful.
4464  *   - (-ENOTSUP) if hardware doesn't support.
4465  *   - (-ENODEV) if *port_id* invalid.
4466  *   - (-EINVAL) if bad parameter.
4467  *   - (-EIO) if device is removed.
4468  *   - others depends on the specific operations implementation.
4469  */
4470 int rte_eth_dev_set_eeprom(uint16_t port_id, struct rte_dev_eeprom_info *info);
4471
4472 /**
4473  * @warning
4474  * @b EXPERIMENTAL: this API may change without prior notice.
4475  *
4476  * Retrieve the type and size of plugin module EEPROM
4477  *
4478  * @param port_id
4479  *   The port identifier of the Ethernet device.
4480  * @param modinfo
4481  *   The type and size of plugin module EEPROM.
4482  * @return
4483  *   - (0) if successful.
4484  *   - (-ENOTSUP) if hardware doesn't support.
4485  *   - (-ENODEV) if *port_id* invalid.
4486  *   - (-EINVAL) if bad parameter.
4487  *   - (-EIO) if device is removed.
4488  *   - others depends on the specific operations implementation.
4489  */
4490 __rte_experimental
4491 int
4492 rte_eth_dev_get_module_info(uint16_t port_id,
4493                             struct rte_eth_dev_module_info *modinfo);
4494
4495 /**
4496  * @warning
4497  * @b EXPERIMENTAL: this API may change without prior notice.
4498  *
4499  * Retrieve the data of plugin module EEPROM
4500  *
4501  * @param port_id
4502  *   The port identifier of the Ethernet device.
4503  * @param info
4504  *   The template includes the plugin module EEPROM attributes, and the
4505  *   buffer for return plugin module EEPROM data.
4506  * @return
4507  *   - (0) if successful.
4508  *   - (-ENOTSUP) if hardware doesn't support.
4509  *   - (-EINVAL) if bad parameter.
4510  *   - (-ENODEV) if *port_id* invalid.
4511  *   - (-EIO) if device is removed.
4512  *   - others depends on the specific operations implementation.
4513  */
4514 __rte_experimental
4515 int
4516 rte_eth_dev_get_module_eeprom(uint16_t port_id,
4517                               struct rte_dev_eeprom_info *info);
4518
4519 /**
4520  * Set the list of multicast addresses to filter on an Ethernet device.
4521  *
4522  * @param port_id
4523  *   The port identifier of the Ethernet device.
4524  * @param mc_addr_set
4525  *   The array of multicast addresses to set. Equal to NULL when the function
4526  *   is invoked to flush the set of filtered addresses.
4527  * @param nb_mc_addr
4528  *   The number of multicast addresses in the *mc_addr_set* array. Equal to 0
4529  *   when the function is invoked to flush the set of filtered addresses.
4530  * @return
4531  *   - (0) if successful.
4532  *   - (-ENODEV) if *port_id* invalid.
4533  *   - (-EIO) if device is removed.
4534  *   - (-ENOTSUP) if PMD of *port_id* doesn't support multicast filtering.
4535  *   - (-ENOSPC) if *port_id* has not enough multicast filtering resources.
4536  */
4537 int rte_eth_dev_set_mc_addr_list(uint16_t port_id,
4538                                  struct rte_ether_addr *mc_addr_set,
4539                                  uint32_t nb_mc_addr);
4540
4541 /**
4542  * Enable IEEE1588/802.1AS timestamping for an Ethernet device.
4543  *
4544  * @param port_id
4545  *   The port identifier of the Ethernet device.
4546  *
4547  * @return
4548  *   - 0: Success.
4549  *   - -ENODEV: The port ID is invalid.
4550  *   - -EIO: if device is removed.
4551  *   - -ENOTSUP: The function is not supported by the Ethernet driver.
4552  */
4553 int rte_eth_timesync_enable(uint16_t port_id);
4554
4555 /**
4556  * Disable IEEE1588/802.1AS timestamping for an Ethernet device.
4557  *
4558  * @param port_id
4559  *   The port identifier of the Ethernet device.
4560  *
4561  * @return
4562  *   - 0: Success.
4563  *   - -ENODEV: The port ID is invalid.
4564  *   - -EIO: if device is removed.
4565  *   - -ENOTSUP: The function is not supported by the Ethernet driver.
4566  */
4567 int rte_eth_timesync_disable(uint16_t port_id);
4568
4569 /**
4570  * Read an IEEE1588/802.1AS RX timestamp from an Ethernet device.
4571  *
4572  * @param port_id
4573  *   The port identifier of the Ethernet device.
4574  * @param timestamp
4575  *   Pointer to the timestamp struct.
4576  * @param flags
4577  *   Device specific flags. Used to pass the RX timesync register index to
4578  *   i40e. Unused in igb/ixgbe, pass 0 instead.
4579  *
4580  * @return
4581  *   - 0: Success.
4582  *   - -EINVAL: No timestamp is available.
4583  *   - -ENODEV: The port ID is invalid.
4584  *   - -EIO: if device is removed.
4585  *   - -ENOTSUP: The function is not supported by the Ethernet driver.
4586  */
4587 int rte_eth_timesync_read_rx_timestamp(uint16_t port_id,
4588                 struct timespec *timestamp, uint32_t flags);
4589
4590 /**
4591  * Read an IEEE1588/802.1AS TX timestamp from an Ethernet device.
4592  *
4593  * @param port_id
4594  *   The port identifier of the Ethernet device.
4595  * @param timestamp
4596  *   Pointer to the timestamp struct.
4597  *
4598  * @return
4599  *   - 0: Success.
4600  *   - -EINVAL: No timestamp is available.
4601  *   - -ENODEV: The port ID is invalid.
4602  *   - -EIO: if device is removed.
4603  *   - -ENOTSUP: The function is not supported by the Ethernet driver.
4604  */
4605 int rte_eth_timesync_read_tx_timestamp(uint16_t port_id,
4606                 struct timespec *timestamp);
4607
4608 /**
4609  * Adjust the timesync clock on an Ethernet device.
4610  *
4611  * This is usually used in conjunction with other Ethdev timesync functions to
4612  * synchronize the device time using the IEEE1588/802.1AS protocol.
4613  *
4614  * @param port_id
4615  *   The port identifier of the Ethernet device.
4616  * @param delta
4617  *   The adjustment in nanoseconds.
4618  *
4619  * @return
4620  *   - 0: Success.
4621  *   - -ENODEV: The port ID is invalid.
4622  *   - -EIO: if device is removed.
4623  *   - -ENOTSUP: The function is not supported by the Ethernet driver.
4624  */
4625 int rte_eth_timesync_adjust_time(uint16_t port_id, int64_t delta);
4626
4627 /**
4628  * Read the time from the timesync clock on an Ethernet device.
4629  *
4630  * This is usually used in conjunction with other Ethdev timesync functions to
4631  * synchronize the device time using the IEEE1588/802.1AS protocol.
4632  *
4633  * @param port_id
4634  *   The port identifier of the Ethernet device.
4635  * @param time
4636  *   Pointer to the timespec struct that holds the time.
4637  *
4638  * @return
4639  *   - 0: Success.
4640  */
4641 int rte_eth_timesync_read_time(uint16_t port_id, struct timespec *time);
4642
4643 /**
4644  * Set the time of the timesync clock on an Ethernet device.
4645  *
4646  * This is usually used in conjunction with other Ethdev timesync functions to
4647  * synchronize the device time using the IEEE1588/802.1AS protocol.
4648  *
4649  * @param port_id
4650  *   The port identifier of the Ethernet device.
4651  * @param time
4652  *   Pointer to the timespec struct that holds the time.
4653  *
4654  * @return
4655  *   - 0: Success.
4656  *   - -EINVAL: No timestamp is available.
4657  *   - -ENODEV: The port ID is invalid.
4658  *   - -EIO: if device is removed.
4659  *   - -ENOTSUP: The function is not supported by the Ethernet driver.
4660  */
4661 int rte_eth_timesync_write_time(uint16_t port_id, const struct timespec *time);
4662
4663 /**
4664  * @warning
4665  * @b EXPERIMENTAL: this API may change without prior notice.
4666  *
4667  * Read the current clock counter of an Ethernet device
4668  *
4669  * This returns the current raw clock value of an Ethernet device. It is
4670  * a raw amount of ticks, with no given time reference.
4671  * The value returned here is from the same clock than the one
4672  * filling timestamp field of Rx packets when using hardware timestamp
4673  * offload. Therefore it can be used to compute a precise conversion of
4674  * the device clock to the real time.
4675  *
4676  * E.g, a simple heuristic to derivate the frequency would be:
4677  * uint64_t start, end;
4678  * rte_eth_read_clock(port, start);
4679  * rte_delay_ms(100);
4680  * rte_eth_read_clock(port, end);
4681  * double freq = (end - start) * 10;
4682  *
4683  * Compute a common reference with:
4684  * uint64_t base_time_sec = current_time();
4685  * uint64_t base_clock;
4686  * rte_eth_read_clock(port, base_clock);
4687  *
4688  * Then, convert the raw mbuf timestamp with:
4689  * base_time_sec + (double)(*timestamp_dynfield(mbuf) - base_clock) / freq;
4690  *
4691  * This simple example will not provide a very good accuracy. One must
4692  * at least measure multiple times the frequency and do a regression.
4693  * To avoid deviation from the system time, the common reference can
4694  * be repeated from time to time. The integer division can also be
4695  * converted by a multiplication and a shift for better performance.
4696  *
4697  * @param port_id
4698  *   The port identifier of the Ethernet device.
4699  * @param clock
4700  *   Pointer to the uint64_t that holds the raw clock value.
4701  *
4702  * @return
4703  *   - 0: Success.
4704  *   - -ENODEV: The port ID is invalid.
4705  *   - -ENOTSUP: The function is not supported by the Ethernet driver.
4706  */
4707 __rte_experimental
4708 int
4709 rte_eth_read_clock(uint16_t port_id, uint64_t *clock);
4710
4711 /**
4712 * Get the port id from device name. The device name should be specified
4713 * as below:
4714 * - PCIe address (Domain:Bus:Device.Function), for example- 0000:2:00.0
4715 * - SoC device name, for example- fsl-gmac0
4716 * - vdev dpdk name, for example- net_[pcap0|null0|tap0]
4717 *
4718 * @param name
4719 *  pci address or name of the device
4720 * @param port_id
4721 *   pointer to port identifier of the device
4722 * @return
4723 *   - (0) if successful and port_id is filled.
4724 *   - (-ENODEV or -EINVAL) on failure.
4725 */
4726 int
4727 rte_eth_dev_get_port_by_name(const char *name, uint16_t *port_id);
4728
4729 /**
4730 * Get the device name from port id. The device name is specified as below:
4731 * - PCIe address (Domain:Bus:Device.Function), for example- 0000:02:00.0
4732 * - SoC device name, for example- fsl-gmac0
4733 * - vdev dpdk name, for example- net_[pcap0|null0|tun0|tap0]
4734 *
4735 * @param port_id
4736 *   Port identifier of the device.
4737 * @param name
4738 *   Buffer of size RTE_ETH_NAME_MAX_LEN to store the name.
4739 * @return
4740 *   - (0) if successful.
4741 *   - (-ENODEV) if *port_id* is invalid.
4742 *   - (-EINVAL) on failure.
4743 */
4744 int
4745 rte_eth_dev_get_name_by_port(uint16_t port_id, char *name);
4746
4747 /**
4748  * Check that numbers of Rx and Tx descriptors satisfy descriptors limits from
4749  * the ethernet device information, otherwise adjust them to boundaries.
4750  *
4751  * @param port_id
4752  *   The port identifier of the Ethernet device.
4753  * @param nb_rx_desc
4754  *   A pointer to a uint16_t where the number of receive
4755  *   descriptors stored.
4756  * @param nb_tx_desc
4757  *   A pointer to a uint16_t where the number of transmit
4758  *   descriptors stored.
4759  * @return
4760  *   - (0) if successful.
4761  *   - (-ENOTSUP, -ENODEV or -EINVAL) on failure.
4762  */
4763 int rte_eth_dev_adjust_nb_rx_tx_desc(uint16_t port_id,
4764                                      uint16_t *nb_rx_desc,
4765                                      uint16_t *nb_tx_desc);
4766
4767 /**
4768  * Test if a port supports specific mempool ops.
4769  *
4770  * @param port_id
4771  *   Port identifier of the Ethernet device.
4772  * @param [in] pool
4773  *   The name of the pool operations to test.
4774  * @return
4775  *   - 0: best mempool ops choice for this port.
4776  *   - 1: mempool ops are supported for this port.
4777  *   - -ENOTSUP: mempool ops not supported for this port.
4778  *   - -ENODEV: Invalid port Identifier.
4779  *   - -EINVAL: Pool param is null.
4780  */
4781 int
4782 rte_eth_dev_pool_ops_supported(uint16_t port_id, const char *pool);
4783
4784 /**
4785  * Get the security context for the Ethernet device.
4786  *
4787  * @param port_id
4788  *   Port identifier of the Ethernet device
4789  * @return
4790  *   - NULL on error.
4791  *   - pointer to security context on success.
4792  */
4793 void *
4794 rte_eth_dev_get_sec_ctx(uint16_t port_id);
4795
4796 /**
4797  * @warning
4798  * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
4799  *
4800  * Query the device hairpin capabilities.
4801  *
4802  * @param port_id
4803  *   The port identifier of the Ethernet device.
4804  * @param cap
4805  *   Pointer to a structure that will hold the hairpin capabilities.
4806  * @return
4807  *   - (0) if successful.
4808  *   - (-ENOTSUP) if hardware doesn't support.
4809  */
4810 __rte_experimental
4811 int rte_eth_dev_hairpin_capability_get(uint16_t port_id,
4812                                        struct rte_eth_hairpin_cap *cap);
4813
4814 /**
4815  * @warning
4816  * @b EXPERIMENTAL: this structure may change without prior notice.
4817  *
4818  * ethernet device representor ID range entry
4819  */
4820 struct rte_eth_representor_range {
4821         enum rte_eth_representor_type type; /**< Representor type */
4822         int controller; /**< Controller index */
4823         int pf; /**< Physical function index */
4824         __extension__
4825         union {
4826                 int vf; /**< VF start index */
4827                 int sf; /**< SF start index */
4828         };
4829         uint32_t id_base; /**< Representor ID start index */
4830         uint32_t id_end;  /**< Representor ID end index */
4831         char name[RTE_DEV_NAME_MAX_LEN]; /**< Representor name */
4832 };
4833
4834 /**
4835  * @warning
4836  * @b EXPERIMENTAL: this structure may change without prior notice.
4837  *
4838  * Ethernet device representor information
4839  */
4840 struct rte_eth_representor_info {
4841         uint16_t controller; /**< Controller ID of caller device. */
4842         uint16_t pf; /**< Physical function ID of caller device. */
4843         struct rte_eth_representor_range ranges[];/**< Representor ID range. */
4844 };
4845
4846 /**
4847  * Retrieve the representor info of the device.
4848  *
4849  * Get device representor info to be able to calculate a unique
4850  * representor ID. @see rte_eth_representor_id_get helper.
4851  *
4852  * @param port_id
4853  *   The port identifier of the device.
4854  * @param info
4855  *   A pointer to a representor info structure.
4856  *   NULL to return number of range entries and allocate memory
4857  *   for next call to store detail.
4858  * @return
4859  *   - (-ENOTSUP) if operation is not supported.
4860  *   - (-ENODEV) if *port_id* invalid.
4861  *   - (-EIO) if device is removed.
4862  *   - (>=0) number of representor range entries supported by device.
4863  */
4864 __rte_experimental
4865 int rte_eth_representor_info_get(uint16_t port_id,
4866                                  struct rte_eth_representor_info *info);
4867
4868 #include <rte_ethdev_core.h>
4869
4870 /**
4871  *
4872  * Retrieve a burst of input packets from a receive queue of an Ethernet
4873  * device. The retrieved packets are stored in *rte_mbuf* structures whose
4874  * pointers are supplied in the *rx_pkts* array.
4875  *
4876  * The rte_eth_rx_burst() function loops, parsing the RX ring of the
4877  * receive queue, up to *nb_pkts* packets, and for each completed RX
4878  * descriptor in the ring, it performs the following operations:
4879  *
4880  * - Initialize the *rte_mbuf* data structure associated with the
4881  *   RX descriptor according to the information provided by the NIC into
4882  *   that RX descriptor.
4883  *
4884  * - Store the *rte_mbuf* data structure into the next entry of the
4885  *   *rx_pkts* array.
4886  *
4887  * - Replenish the RX descriptor with a new *rte_mbuf* buffer
4888  *   allocated from the memory pool associated with the receive queue at
4889  *   initialization time.
4890  *
4891  * When retrieving an input packet that was scattered by the controller
4892  * into multiple receive descriptors, the rte_eth_rx_burst() function
4893  * appends the associated *rte_mbuf* buffers to the first buffer of the
4894  * packet.
4895  *
4896  * The rte_eth_rx_burst() function returns the number of packets
4897  * actually retrieved, which is the number of *rte_mbuf* data structures
4898  * effectively supplied into the *rx_pkts* array.
4899  * A return value equal to *nb_pkts* indicates that the RX queue contained
4900  * at least *rx_pkts* packets, and this is likely to signify that other
4901  * received packets remain in the input queue. Applications implementing
4902  * a "retrieve as much received packets as possible" policy can check this
4903  * specific case and keep invoking the rte_eth_rx_burst() function until
4904  * a value less than *nb_pkts* is returned.
4905  *
4906  * This receive method has the following advantages:
4907  *
4908  * - It allows a run-to-completion network stack engine to retrieve and
4909  *   to immediately process received packets in a fast burst-oriented
4910  *   approach, avoiding the overhead of unnecessary intermediate packet
4911  *   queue/dequeue operations.
4912  *
4913  * - Conversely, it also allows an asynchronous-oriented processing
4914  *   method to retrieve bursts of received packets and to immediately
4915  *   queue them for further parallel processing by another logical core,
4916  *   for instance. However, instead of having received packets being
4917  *   individually queued by the driver, this approach allows the caller
4918  *   of the rte_eth_rx_burst() function to queue a burst of retrieved
4919  *   packets at a time and therefore dramatically reduce the cost of
4920  *   enqueue/dequeue operations per packet.
4921  *
4922  * - It allows the rte_eth_rx_burst() function of the driver to take
4923  *   advantage of burst-oriented hardware features (CPU cache,
4924  *   prefetch instructions, and so on) to minimize the number of CPU
4925  *   cycles per packet.
4926  *
4927  * To summarize, the proposed receive API enables many
4928  * burst-oriented optimizations in both synchronous and asynchronous
4929  * packet processing environments with no overhead in both cases.
4930  *
4931  * @note
4932  *   Some drivers using vector instructions require that *nb_pkts* is
4933  *   divisible by 4 or 8, depending on the driver implementation.
4934  *
4935  * The rte_eth_rx_burst() function does not provide any error
4936  * notification to avoid the corresponding overhead. As a hint, the
4937  * upper-level application might check the status of the device link once
4938  * being systematically returned a 0 value for a given number of tries.
4939  *
4940  * @param port_id
4941  *   The port identifier of the Ethernet device.
4942  * @param queue_id
4943  *   The index of the receive queue from which to retrieve input packets.
4944  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
4945  *   to rte_eth_dev_configure().
4946  * @param rx_pkts
4947  *   The address of an array of pointers to *rte_mbuf* structures that
4948  *   must be large enough to store *nb_pkts* pointers in it.
4949  * @param nb_pkts
4950  *   The maximum number of packets to retrieve.
4951  *   The value must be divisible by 8 in order to work with any driver.
4952  * @return
4953  *   The number of packets actually retrieved, which is the number
4954  *   of pointers to *rte_mbuf* structures effectively supplied to the
4955  *   *rx_pkts* array.
4956  */
4957 static inline uint16_t
4958 rte_eth_rx_burst(uint16_t port_id, uint16_t queue_id,
4959                  struct rte_mbuf **rx_pkts, const uint16_t nb_pkts)
4960 {
4961         struct rte_eth_dev *dev = &rte_eth_devices[port_id];
4962         uint16_t nb_rx;
4963
4964 #ifdef RTE_ETHDEV_DEBUG_RX
4965         RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
4966         RTE_FUNC_PTR_OR_ERR_RET(*dev->rx_pkt_burst, 0);
4967
4968         if (queue_id >= dev->data->nb_rx_queues) {
4969                 RTE_ETHDEV_LOG(ERR, "Invalid RX queue_id=%u\n", queue_id);
4970                 return 0;
4971         }
4972 #endif
4973         nb_rx = (*dev->rx_pkt_burst)(dev->data->rx_queues[queue_id],
4974                                      rx_pkts, nb_pkts);
4975
4976 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
4977         struct rte_eth_rxtx_callback *cb;
4978
4979         /* __ATOMIC_RELEASE memory order was used when the
4980          * call back was inserted into the list.
4981          * Since there is a clear dependency between loading
4982          * cb and cb->fn/cb->next, __ATOMIC_ACQUIRE memory order is
4983          * not required.
4984          */
4985         cb = __atomic_load_n(&dev->post_rx_burst_cbs[queue_id],
4986                                 __ATOMIC_RELAXED);
4987
4988         if (unlikely(cb != NULL)) {
4989                 do {
4990                         nb_rx = cb->fn.rx(port_id, queue_id, rx_pkts, nb_rx,
4991                                                 nb_pkts, cb->param);
4992                         cb = cb->next;
4993                 } while (cb != NULL);
4994         }
4995 #endif
4996
4997         rte_ethdev_trace_rx_burst(port_id, queue_id, (void **)rx_pkts, nb_rx);
4998         return nb_rx;
4999 }
5000
5001 /**
5002  * Get the number of used descriptors of a rx queue
5003  *
5004  * @param port_id
5005  *  The port identifier of the Ethernet device.
5006  * @param queue_id
5007  *  The queue id on the specific port.
5008  * @return
5009  *  The number of used descriptors in the specific queue, or:
5010  *   - (-ENODEV) if *port_id* is invalid.
5011  *     (-EINVAL) if *queue_id* is invalid
5012  *     (-ENOTSUP) if the device does not support this function
5013  */
5014 static inline int
5015 rte_eth_rx_queue_count(uint16_t port_id, uint16_t queue_id)
5016 {
5017         struct rte_eth_dev *dev;
5018
5019         RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
5020         dev = &rte_eth_devices[port_id];
5021         RTE_FUNC_PTR_OR_ERR_RET(*dev->rx_queue_count, -ENOTSUP);
5022         if (queue_id >= dev->data->nb_rx_queues ||
5023             dev->data->rx_queues[queue_id] == NULL)
5024                 return -EINVAL;
5025
5026         return (int)(*dev->rx_queue_count)(dev, queue_id);
5027 }
5028
5029 /**
5030  * Check if the DD bit of the specific RX descriptor in the queue has been set
5031  *
5032  * @param port_id
5033  *  The port identifier of the Ethernet device.
5034  * @param queue_id
5035  *  The queue id on the specific port.
5036  * @param offset
5037  *  The offset of the descriptor ID from tail.
5038  * @return
5039  *  - (1) if the specific DD bit is set.
5040  *  - (0) if the specific DD bit is not set.
5041  *  - (-ENODEV) if *port_id* invalid.
5042  *  - (-ENOTSUP) if the device does not support this function
5043  */
5044 __rte_deprecated
5045 static inline int
5046 rte_eth_rx_descriptor_done(uint16_t port_id, uint16_t queue_id, uint16_t offset)
5047 {
5048         struct rte_eth_dev *dev = &rte_eth_devices[port_id];
5049         RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
5050         RTE_FUNC_PTR_OR_ERR_RET(*dev->rx_descriptor_done, -ENOTSUP);
5051         return (*dev->rx_descriptor_done)(dev->data->rx_queues[queue_id], offset);
5052 }
5053
5054 #define RTE_ETH_RX_DESC_AVAIL    0 /**< Desc available for hw. */
5055 #define RTE_ETH_RX_DESC_DONE     1 /**< Desc done, filled by hw. */
5056 #define RTE_ETH_RX_DESC_UNAVAIL  2 /**< Desc used by driver or hw. */
5057
5058 /**
5059  * Check the status of a Rx descriptor in the queue
5060  *
5061  * It should be called in a similar context than the Rx function:
5062  * - on a dataplane core
5063  * - not concurrently on the same queue
5064  *
5065  * Since it's a dataplane function, no check is performed on port_id and
5066  * queue_id. The caller must therefore ensure that the port is enabled
5067  * and the queue is configured and running.
5068  *
5069  * Note: accessing to a random descriptor in the ring may trigger cache
5070  * misses and have a performance impact.
5071  *
5072  * @param port_id
5073  *  A valid port identifier of the Ethernet device which.
5074  * @param queue_id
5075  *  A valid Rx queue identifier on this port.
5076  * @param offset
5077  *  The offset of the descriptor starting from tail (0 is the next
5078  *  packet to be received by the driver).
5079  *
5080  * @return
5081  *  - (RTE_ETH_RX_DESC_AVAIL): Descriptor is available for the hardware to
5082  *    receive a packet.
5083  *  - (RTE_ETH_RX_DESC_DONE): Descriptor is done, it is filled by hw, but
5084  *    not yet processed by the driver (i.e. in the receive queue).
5085  *  - (RTE_ETH_RX_DESC_UNAVAIL): Descriptor is unavailable, either hold by
5086  *    the driver and not yet returned to hw, or reserved by the hw.
5087  *  - (-EINVAL) bad descriptor offset.
5088  *  - (-ENOTSUP) if the device does not support this function.
5089  *  - (-ENODEV) bad port or queue (only if compiled with debug).
5090  */
5091 static inline int
5092 rte_eth_rx_descriptor_status(uint16_t port_id, uint16_t queue_id,
5093         uint16_t offset)
5094 {
5095         struct rte_eth_dev *dev;
5096         void *rxq;
5097
5098 #ifdef RTE_ETHDEV_DEBUG_RX
5099         RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
5100 #endif
5101         dev = &rte_eth_devices[port_id];
5102 #ifdef RTE_ETHDEV_DEBUG_RX
5103         if (queue_id >= dev->data->nb_rx_queues)
5104                 return -ENODEV;
5105 #endif
5106         RTE_FUNC_PTR_OR_ERR_RET(*dev->rx_descriptor_status, -ENOTSUP);
5107         rxq = dev->data->rx_queues[queue_id];
5108
5109         return (*dev->rx_descriptor_status)(rxq, offset);
5110 }
5111
5112 #define RTE_ETH_TX_DESC_FULL    0 /**< Desc filled for hw, waiting xmit. */
5113 #define RTE_ETH_TX_DESC_DONE    1 /**< Desc done, packet is transmitted. */
5114 #define RTE_ETH_TX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */
5115
5116 /**
5117  * Check the status of a Tx descriptor in the queue.
5118  *
5119  * It should be called in a similar context than the Tx function:
5120  * - on a dataplane core
5121  * - not concurrently on the same queue
5122  *
5123  * Since it's a dataplane function, no check is performed on port_id and
5124  * queue_id. The caller must therefore ensure that the port is enabled
5125  * and the queue is configured and running.
5126  *
5127  * Note: accessing to a random descriptor in the ring may trigger cache
5128  * misses and have a performance impact.
5129  *
5130  * @param port_id
5131  *  A valid port identifier of the Ethernet device which.
5132  * @param queue_id
5133  *  A valid Tx queue identifier on this port.
5134  * @param offset
5135  *  The offset of the descriptor starting from tail (0 is the place where
5136  *  the next packet will be send).
5137  *
5138  * @return
5139  *  - (RTE_ETH_TX_DESC_FULL) Descriptor is being processed by the hw, i.e.
5140  *    in the transmit queue.
5141  *  - (RTE_ETH_TX_DESC_DONE) Hardware is done with this descriptor, it can
5142  *    be reused by the driver.
5143  *  - (RTE_ETH_TX_DESC_UNAVAIL): Descriptor is unavailable, reserved by the
5144  *    driver or the hardware.
5145  *  - (-EINVAL) bad descriptor offset.
5146  *  - (-ENOTSUP) if the device does not support this function.
5147  *  - (-ENODEV) bad port or queue (only if compiled with debug).
5148  */
5149 static inline int rte_eth_tx_descriptor_status(uint16_t port_id,
5150         uint16_t queue_id, uint16_t offset)
5151 {
5152         struct rte_eth_dev *dev;
5153         void *txq;
5154
5155 #ifdef RTE_ETHDEV_DEBUG_TX
5156         RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
5157 #endif
5158         dev = &rte_eth_devices[port_id];
5159 #ifdef RTE_ETHDEV_DEBUG_TX
5160         if (queue_id >= dev->data->nb_tx_queues)
5161                 return -ENODEV;
5162 #endif
5163         RTE_FUNC_PTR_OR_ERR_RET(*dev->tx_descriptor_status, -ENOTSUP);
5164         txq = dev->data->tx_queues[queue_id];
5165
5166         return (*dev->tx_descriptor_status)(txq, offset);
5167 }
5168
5169 /**
5170  * Send a burst of output packets on a transmit queue of an Ethernet device.
5171  *
5172  * The rte_eth_tx_burst() function is invoked to transmit output packets
5173  * on the output queue *queue_id* of the Ethernet device designated by its
5174  * *port_id*.
5175  * The *nb_pkts* parameter is the number of packets to send which are
5176  * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
5177  * allocated from a pool created with rte_pktmbuf_pool_create().
5178  * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
5179  * up to the number of transmit descriptors available in the TX ring of the
5180  * transmit queue.
5181  * For each packet to send, the rte_eth_tx_burst() function performs
5182  * the following operations:
5183  *
5184  * - Pick up the next available descriptor in the transmit ring.
5185  *
5186  * - Free the network buffer previously sent with that descriptor, if any.
5187  *
5188  * - Initialize the transmit descriptor with the information provided
5189  *   in the *rte_mbuf data structure.
5190  *
5191  * In the case of a segmented packet composed of a list of *rte_mbuf* buffers,
5192  * the rte_eth_tx_burst() function uses several transmit descriptors
5193  * of the ring.
5194  *
5195  * The rte_eth_tx_burst() function returns the number of packets it
5196  * actually sent. A return value equal to *nb_pkts* means that all packets
5197  * have been sent, and this is likely to signify that other output packets
5198  * could be immediately transmitted again. Applications that implement a
5199  * "send as many packets to transmit as possible" policy can check this
5200  * specific case and keep invoking the rte_eth_tx_burst() function until
5201  * a value less than *nb_pkts* is returned.
5202  *
5203  * It is the responsibility of the rte_eth_tx_burst() function to
5204  * transparently free the memory buffers of packets previously sent.
5205  * This feature is driven by the *tx_free_thresh* value supplied to the
5206  * rte_eth_dev_configure() function at device configuration time.
5207  * When the number of free TX descriptors drops below this threshold, the
5208  * rte_eth_tx_burst() function must [attempt to] free the *rte_mbuf*  buffers
5209  * of those packets whose transmission was effectively completed.
5210  *
5211  * If the PMD is DEV_TX_OFFLOAD_MT_LOCKFREE capable, multiple threads can
5212  * invoke this function concurrently on the same tx queue without SW lock.
5213  * @see rte_eth_dev_info_get, struct rte_eth_txconf::offloads
5214  *
5215  * @see rte_eth_tx_prepare to perform some prior checks or adjustments
5216  * for offloads.
5217  *
5218  * @param port_id
5219  *   The port identifier of the Ethernet device.
5220  * @param queue_id
5221  *   The index of the transmit queue through which output packets must be
5222  *   sent.
5223  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
5224  *   to rte_eth_dev_configure().
5225  * @param tx_pkts
5226  *   The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
5227  *   which contain the output packets.
5228  * @param nb_pkts
5229  *   The maximum number of packets to transmit.
5230  * @return
5231  *   The number of output packets actually stored in transmit descriptors of
5232  *   the transmit ring. The return value can be less than the value of the
5233  *   *tx_pkts* parameter when the transmit ring is full or has been filled up.
5234  */
5235 static inline uint16_t
5236 rte_eth_tx_burst(uint16_t port_id, uint16_t queue_id,
5237                  struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
5238 {
5239         struct rte_eth_dev *dev = &rte_eth_devices[port_id];
5240
5241 #ifdef RTE_ETHDEV_DEBUG_TX
5242         RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
5243         RTE_FUNC_PTR_OR_ERR_RET(*dev->tx_pkt_burst, 0);
5244
5245         if (queue_id >= dev->data->nb_tx_queues) {
5246                 RTE_ETHDEV_LOG(ERR, "Invalid TX queue_id=%u\n", queue_id);
5247                 return 0;
5248         }
5249 #endif
5250
5251 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
5252         struct rte_eth_rxtx_callback *cb;
5253
5254         /* __ATOMIC_RELEASE memory order was used when the
5255          * call back was inserted into the list.
5256          * Since there is a clear dependency between loading
5257          * cb and cb->fn/cb->next, __ATOMIC_ACQUIRE memory order is
5258          * not required.
5259          */
5260         cb = __atomic_load_n(&dev->pre_tx_burst_cbs[queue_id],
5261                                 __ATOMIC_RELAXED);
5262
5263         if (unlikely(cb != NULL)) {
5264                 do {
5265                         nb_pkts = cb->fn.tx(port_id, queue_id, tx_pkts, nb_pkts,
5266                                         cb->param);
5267                         cb = cb->next;
5268                 } while (cb != NULL);
5269         }
5270 #endif
5271
5272         rte_ethdev_trace_tx_burst(port_id, queue_id, (void **)tx_pkts,
5273                 nb_pkts);
5274         return (*dev->tx_pkt_burst)(dev->data->tx_queues[queue_id], tx_pkts, nb_pkts);
5275 }
5276
5277 /**
5278  * Process a burst of output packets on a transmit queue of an Ethernet device.
5279  *
5280  * The rte_eth_tx_prepare() function is invoked to prepare output packets to be
5281  * transmitted on the output queue *queue_id* of the Ethernet device designated
5282  * by its *port_id*.
5283  * The *nb_pkts* parameter is the number of packets to be prepared which are
5284  * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
5285  * allocated from a pool created with rte_pktmbuf_pool_create().
5286  * For each packet to send, the rte_eth_tx_prepare() function performs
5287  * the following operations:
5288  *
5289  * - Check if packet meets devices requirements for tx offloads.
5290  *
5291  * - Check limitations about number of segments.
5292  *
5293  * - Check additional requirements when debug is enabled.
5294  *
5295  * - Update and/or reset required checksums when tx offload is set for packet.
5296  *
5297  * Since this function can modify packet data, provided mbufs must be safely
5298  * writable (e.g. modified data cannot be in shared segment).
5299  *
5300  * The rte_eth_tx_prepare() function returns the number of packets ready to be
5301  * sent. A return value equal to *nb_pkts* means that all packets are valid and
5302  * ready to be sent, otherwise stops processing on the first invalid packet and
5303  * leaves the rest packets untouched.
5304  *
5305  * When this functionality is not implemented in the driver, all packets are
5306  * are returned untouched.
5307  *
5308  * @param port_id
5309  *   The port identifier of the Ethernet device.
5310  *   The value must be a valid port id.
5311  * @param queue_id
5312  *   The index of the transmit queue through which output packets must be
5313  *   sent.
5314  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
5315  *   to rte_eth_dev_configure().
5316  * @param tx_pkts
5317  *   The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
5318  *   which contain the output packets.
5319  * @param nb_pkts
5320  *   The maximum number of packets to process.
5321  * @return
5322  *   The number of packets correct and ready to be sent. The return value can be
5323  *   less than the value of the *tx_pkts* parameter when some packet doesn't
5324  *   meet devices requirements with rte_errno set appropriately:
5325  *   - EINVAL: offload flags are not correctly set
5326  *   - ENOTSUP: the offload feature is not supported by the hardware
5327  *   - ENODEV: if *port_id* is invalid (with debug enabled only)
5328  *
5329  */
5330
5331 #ifndef RTE_ETHDEV_TX_PREPARE_NOOP
5332
5333 static inline uint16_t
5334 rte_eth_tx_prepare(uint16_t port_id, uint16_t queue_id,
5335                 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
5336 {
5337         struct rte_eth_dev *dev;
5338
5339 #ifdef RTE_ETHDEV_DEBUG_TX
5340         if (!rte_eth_dev_is_valid_port(port_id)) {
5341                 RTE_ETHDEV_LOG(ERR, "Invalid TX port_id=%u\n", port_id);
5342                 rte_errno = ENODEV;
5343                 return 0;
5344         }
5345 #endif
5346
5347         dev = &rte_eth_devices[port_id];
5348
5349 #ifdef RTE_ETHDEV_DEBUG_TX
5350         if (queue_id >= dev->data->nb_tx_queues) {
5351                 RTE_ETHDEV_LOG(ERR, "Invalid TX queue_id=%u\n", queue_id);
5352                 rte_errno = EINVAL;
5353                 return 0;
5354         }
5355 #endif
5356
5357         if (!dev->tx_pkt_prepare)
5358                 return nb_pkts;
5359
5360         return (*dev->tx_pkt_prepare)(dev->data->tx_queues[queue_id],
5361                         tx_pkts, nb_pkts);
5362 }
5363
5364 #else
5365
5366 /*
5367  * Native NOOP operation for compilation targets which doesn't require any
5368  * preparations steps, and functional NOOP may introduce unnecessary performance
5369  * drop.
5370  *
5371  * Generally this is not a good idea to turn it on globally and didn't should
5372  * be used if behavior of tx_preparation can change.
5373  */
5374
5375 static inline uint16_t
5376 rte_eth_tx_prepare(__rte_unused uint16_t port_id,
5377                 __rte_unused uint16_t queue_id,
5378                 __rte_unused struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
5379 {
5380         return nb_pkts;
5381 }
5382
5383 #endif
5384
5385 /**
5386  * Send any packets queued up for transmission on a port and HW queue
5387  *
5388  * This causes an explicit flush of packets previously buffered via the
5389  * rte_eth_tx_buffer() function. It returns the number of packets successfully
5390  * sent to the NIC, and calls the error callback for any unsent packets. Unless
5391  * explicitly set up otherwise, the default callback simply frees the unsent
5392  * packets back to the owning mempool.
5393  *
5394  * @param port_id
5395  *   The port identifier of the Ethernet device.
5396  * @param queue_id
5397  *   The index of the transmit queue through which output packets must be
5398  *   sent.
5399  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
5400  *   to rte_eth_dev_configure().
5401  * @param buffer
5402  *   Buffer of packets to be transmit.
5403  * @return
5404  *   The number of packets successfully sent to the Ethernet device. The error
5405  *   callback is called for any packets which could not be sent.
5406  */
5407 static inline uint16_t
5408 rte_eth_tx_buffer_flush(uint16_t port_id, uint16_t queue_id,
5409                 struct rte_eth_dev_tx_buffer *buffer)
5410 {
5411         uint16_t sent;
5412         uint16_t to_send = buffer->length;
5413
5414         if (to_send == 0)
5415                 return 0;
5416
5417         sent = rte_eth_tx_burst(port_id, queue_id, buffer->pkts, to_send);
5418
5419         buffer->length = 0;
5420
5421         /* All packets sent, or to be dealt with by callback below */
5422         if (unlikely(sent != to_send))
5423                 buffer->error_callback(&buffer->pkts[sent],
5424                                        (uint16_t)(to_send - sent),
5425                                        buffer->error_userdata);
5426
5427         return sent;
5428 }
5429
5430 /**
5431  * Buffer a single packet for future transmission on a port and queue
5432  *
5433  * This function takes a single mbuf/packet and buffers it for later
5434  * transmission on the particular port and queue specified. Once the buffer is
5435  * full of packets, an attempt will be made to transmit all the buffered
5436  * packets. In case of error, where not all packets can be transmitted, a
5437  * callback is called with the unsent packets as a parameter. If no callback
5438  * is explicitly set up, the unsent packets are just freed back to the owning
5439  * mempool. The function returns the number of packets actually sent i.e.
5440  * 0 if no buffer flush occurred, otherwise the number of packets successfully
5441  * flushed
5442  *
5443  * @param port_id
5444  *   The port identifier of the Ethernet device.
5445  * @param queue_id
5446  *   The index of the transmit queue through which output packets must be
5447  *   sent.
5448  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
5449  *   to rte_eth_dev_configure().
5450  * @param buffer
5451  *   Buffer used to collect packets to be sent.
5452  * @param tx_pkt
5453  *   Pointer to the packet mbuf to be sent.
5454  * @return
5455  *   0 = packet has been buffered for later transmission
5456  *   N > 0 = packet has been buffered, and the buffer was subsequently flushed,
5457  *     causing N packets to be sent, and the error callback to be called for
5458  *     the rest.
5459  */
5460 static __rte_always_inline uint16_t
5461 rte_eth_tx_buffer(uint16_t port_id, uint16_t queue_id,
5462                 struct rte_eth_dev_tx_buffer *buffer, struct rte_mbuf *tx_pkt)
5463 {
5464         buffer->pkts[buffer->length++] = tx_pkt;
5465         if (buffer->length < buffer->size)
5466                 return 0;
5467
5468         return rte_eth_tx_buffer_flush(port_id, queue_id, buffer);
5469 }
5470
5471 #ifdef __cplusplus
5472 }
5473 #endif
5474
5475 #endif /* _RTE_ETHDEV_H_ */