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