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