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