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