lib/librte_ethdev/rte_ethdev.h

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