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  * A structure used to retrieve the contextual information of
 874  * an Ethernet device, such as the controlling driver of the device,
 875  * its PCI context, etc...
 876  */
 877
 878 /**
 879  * RX offload capabilities of a device.
 880  */
 881 #define DEV_RX_OFFLOAD_VLAN_STRIP  0x00000001
 882 #define DEV_RX_OFFLOAD_IPV4_CKSUM  0x00000002
 883 #define DEV_RX_OFFLOAD_UDP_CKSUM   0x00000004
 884 #define DEV_RX_OFFLOAD_TCP_CKSUM   0x00000008
 885 #define DEV_RX_OFFLOAD_TCP_LRO     0x00000010
 886 #define DEV_RX_OFFLOAD_QINQ_STRIP  0x00000020
 887 #define DEV_RX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000040
 888 #define DEV_RX_OFFLOAD_MACSEC_STRIP     0x00000080
 889 #define DEV_RX_OFFLOAD_HEADER_SPLIT     0x00000100
 890 #define DEV_RX_OFFLOAD_VLAN_FILTER      0x00000200
 891 #define DEV_RX_OFFLOAD_VLAN_EXTEND      0x00000400
 892 #define DEV_RX_OFFLOAD_JUMBO_FRAME      0x00000800
 893 #define DEV_RX_OFFLOAD_CRC_STRIP        0x00001000
 894 #define DEV_RX_OFFLOAD_SCATTER          0x00002000
 895 #define DEV_RX_OFFLOAD_TIMESTAMP        0x00004000
 896 #define DEV_RX_OFFLOAD_SECURITY         0x00008000
 897
 898 /**
 899  * Invalid to set both DEV_RX_OFFLOAD_CRC_STRIP and DEV_RX_OFFLOAD_KEEP_CRC
 900  * No DEV_RX_OFFLOAD_CRC_STRIP flag means keep CRC
 901  */
 902 #define DEV_RX_OFFLOAD_KEEP_CRC         0x00010000
 903 #define DEV_RX_OFFLOAD_CHECKSUM (DEV_RX_OFFLOAD_IPV4_CKSUM | \
 904                                  DEV_RX_OFFLOAD_UDP_CKSUM | \
 905                                  DEV_RX_OFFLOAD_TCP_CKSUM)
 906 #define DEV_RX_OFFLOAD_VLAN (DEV_RX_OFFLOAD_VLAN_STRIP | \
 907                              DEV_RX_OFFLOAD_VLAN_FILTER | \
 908                              DEV_RX_OFFLOAD_VLAN_EXTEND)
 909
 910 /*
 911  * If new Rx offload capabilities are defined, they also must be
 912  * mentioned in rte_rx_offload_names in rte_ethdev.c file.
 913  */
 914
 915 /**
 916  * TX offload capabilities of a device.
 917  */
 918 #define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001
 919 #define DEV_TX_OFFLOAD_IPV4_CKSUM  0x00000002
 920 #define DEV_TX_OFFLOAD_UDP_CKSUM   0x00000004
 921 #define DEV_TX_OFFLOAD_TCP_CKSUM   0x00000008
 922 #define DEV_TX_OFFLOAD_SCTP_CKSUM  0x00000010
 923 #define DEV_TX_OFFLOAD_TCP_TSO     0x00000020
 924 #define DEV_TX_OFFLOAD_UDP_TSO     0x00000040
 925 #define DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000080 /**< Used for tunneling packet. */
 926 #define DEV_TX_OFFLOAD_QINQ_INSERT 0x00000100
 927 #define DEV_TX_OFFLOAD_VXLAN_TNL_TSO    0x00000200    /**< Used for tunneling packet. */
 928 #define DEV_TX_OFFLOAD_GRE_TNL_TSO      0x00000400    /**< Used for tunneling packet. */
 929 #define DEV_TX_OFFLOAD_IPIP_TNL_TSO     0x00000800    /**< Used for tunneling packet. */
 930 #define DEV_TX_OFFLOAD_GENEVE_TNL_TSO   0x00001000    /**< Used for tunneling packet. */
 931 #define DEV_TX_OFFLOAD_MACSEC_INSERT    0x00002000
 932 #define DEV_TX_OFFLOAD_MT_LOCKFREE      0x00004000
 933 /**< Multiple threads can invoke rte_eth_tx_burst() concurrently on the same
 934  * tx queue without SW lock.
 935  */
 936 #define DEV_TX_OFFLOAD_MULTI_SEGS       0x00008000
 937 /**< Device supports multi segment send. */
 938 #define DEV_TX_OFFLOAD_MBUF_FAST_FREE   0x00010000
 939 /**< Device supports optimization for fast release of mbufs.
 940  *   When set application must guarantee that per-queue all mbufs comes from
 941  *   the same mempool and has refcnt = 1.
 942  */
 943 #define DEV_TX_OFFLOAD_SECURITY         0x00020000
 944 /**
 945  * Device supports generic UDP tunneled packet TSO.
 946  * Application must set PKT_TX_TUNNEL_UDP and other mbuf fields required
 947  * for tunnel TSO.
 948  */
 949 #define DEV_TX_OFFLOAD_UDP_TNL_TSO      0x00040000
 950 /**
 951  * Device supports generic IP tunneled packet TSO.
 952  * Application must set PKT_TX_TUNNEL_IP and other mbuf fields required
 953  * for tunnel TSO.
 954  */
 955 #define DEV_TX_OFFLOAD_IP_TNL_TSO       0x00080000
 956
 957 #define RTE_ETH_DEV_CAPA_RUNTIME_RX_QUEUE_SETUP 0x00000001
 958 /**< Device supports Rx queue setup after device started*/
 959 #define RTE_ETH_DEV_CAPA_RUNTIME_TX_QUEUE_SETUP 0x00000002
 960 /**< Device supports Tx queue setup after device started*/
 961
 962 /*
 963  * If new Tx offload capabilities are defined, they also must be
 964  * mentioned in rte_tx_offload_names in rte_ethdev.c file.
 965  */
 966
 967 struct rte_pci_device;
 968
 969 /*
 970  * Fallback default preferred Rx/Tx port parameters.
 971  * These are used if an application requests default parameters
 972  * but the PMD does not provide preferred values.
 973  */
 974 #define RTE_ETH_DEV_FALLBACK_RX_RINGSIZE 512
 975 #define RTE_ETH_DEV_FALLBACK_TX_RINGSIZE 512
 976 #define RTE_ETH_DEV_FALLBACK_RX_NBQUEUES 1
 977 #define RTE_ETH_DEV_FALLBACK_TX_NBQUEUES 1
 978
 979 /**
 980  * Preferred Rx/Tx port parameters.
 981  * There are separate instances of this structure for transmission
 982  * and reception respectively.
 983  */
 984 struct rte_eth_dev_portconf {
 985         uint16_t burst_size; /**< Device-preferred burst size */
 986         uint16_t ring_size; /**< Device-preferred size of queue rings */
 987         uint16_t nb_queues; /**< Device-preferred number of queues */
 988 };
 989
 990 /**
 991  * Default values for switch domain id when ethdev does not support switch
 992  * domain definitions.
 993  */
 994 #define RTE_ETH_DEV_SWITCH_DOMAIN_ID_INVALID    (0)
 995
 996 /**
 997  * Ethernet device associated switch information
 998  */
 999 struct rte_eth_switch_info {
1000         const char *name;       /**< switch name */
1001         uint16_t domain_id;     /**< switch domain id */
1002         uint16_t port_id;
1003         /**<
1004          * mapping to the devices physical switch port as enumerated from the
1005          * perspective of the embedded interconnect/switch. For SR-IOV enabled
1006          * device this may correspond to the VF_ID of each virtual function,
1007          * but each driver should explicitly define the mapping of switch
1008          * port identifier to that physical interconnect/switch
1009          */
1010 };
1011
1012 /**
1013  * Ethernet device information
1014  */
1015 struct rte_eth_dev_info {
1016         struct rte_device *device; /** Generic device information */
1017         const char *driver_name; /**< Device Driver name. */
1018         unsigned int if_index; /**< Index to bound host interface, or 0 if none.
1019                 Use if_indextoname() to translate into an interface name. */
1020         const uint32_t *dev_flags; /**< Device flags */
1021         uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
1022         uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
1023         uint16_t max_rx_queues; /**< Maximum number of RX queues. */
1024         uint16_t max_tx_queues; /**< Maximum number of TX queues. */
1025         uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
1026         uint32_t max_hash_mac_addrs;
1027         /** Maximum number of hash MAC addresses for MTA and UTA. */
1028         uint16_t max_vfs; /**< Maximum number of VFs. */
1029         uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
1030         uint64_t rx_offload_capa;
1031         /**< All RX offload capabilities including all per-queue ones */
1032         uint64_t tx_offload_capa;
1033         /**< All TX offload capabilities including all per-queue ones */
1034         uint64_t rx_queue_offload_capa;
1035         /**< Device per-queue RX offload capabilities. */
1036         uint64_t tx_queue_offload_capa;
1037         /**< Device per-queue TX offload capabilities. */
1038         uint16_t reta_size;
1039         /**< Device redirection table size, the total number of entries. */
1040         uint8_t hash_key_size; /**< Hash key size in bytes */
1041         /** Bit mask of RSS offloads, the bit offset also means flow type */
1042         uint64_t flow_type_rss_offloads;
1043         struct rte_eth_rxconf default_rxconf; /**< Default RX configuration */
1044         struct rte_eth_txconf default_txconf; /**< Default TX configuration */
1045         uint16_t vmdq_queue_base; /**< First queue ID for VMDQ pools. */
1046         uint16_t vmdq_queue_num;  /**< Queue number for VMDQ pools. */
1047         uint16_t vmdq_pool_base;  /**< First ID of VMDQ pools. */
1048         struct rte_eth_desc_lim rx_desc_lim;  /**< RX descriptors limits */
1049         struct rte_eth_desc_lim tx_desc_lim;  /**< TX descriptors limits */
1050         uint32_t speed_capa;  /**< Supported speeds bitmap (ETH_LINK_SPEED_). */
1051         /** Configured number of rx/tx queues */
1052         uint16_t nb_rx_queues; /**< Number of RX queues. */
1053         uint16_t nb_tx_queues; /**< Number of TX queues. */
1054         /** Rx parameter recommendations */
1055         struct rte_eth_dev_portconf default_rxportconf;
1056         /** Tx parameter recommendations */
1057         struct rte_eth_dev_portconf default_txportconf;
1058         /** Generic device capabilities (RTE_ETH_DEV_CAPA_). */
1059         uint64_t dev_capa;
1060         /**
1061          * Switching information for ports on a device with a
1062          * embedded managed interconnect/switch.
1063          */
1064         struct rte_eth_switch_info switch_info;
1065 };
1066
1067 /**
1068  * Ethernet device RX queue information structure.
1069  * Used to retieve information about configured queue.
1070  */
1071 struct rte_eth_rxq_info {
1072         struct rte_mempool *mp;     /**< mempool used by that queue. */
1073         struct rte_eth_rxconf conf; /**< queue config parameters. */
1074         uint8_t scattered_rx;       /**< scattered packets RX supported. */
1075         uint16_t nb_desc;           /**< configured number of RXDs. */
1076 } __rte_cache_min_aligned;
1077
1078 /**
1079  * Ethernet device TX queue information structure.
1080  * Used to retrieve information about configured queue.
1081  */
1082 struct rte_eth_txq_info {
1083         struct rte_eth_txconf conf; /**< queue config parameters. */
1084         uint16_t nb_desc;           /**< configured number of TXDs. */
1085 } __rte_cache_min_aligned;
1086
1087 /** Maximum name length for extended statistics counters */
1088 #define RTE_ETH_XSTATS_NAME_SIZE 64
1089
1090 /**
1091  * An Ethernet device extended statistic structure
1092  *
1093  * This structure is used by rte_eth_xstats_get() to provide
1094  * statistics that are not provided in the generic *rte_eth_stats*
1095  * structure.
1096  * It maps a name id, corresponding to an index in the array returned
1097  * by rte_eth_xstats_get_names(), to a statistic value.
1098  */
1099 struct rte_eth_xstat {
1100         uint64_t id;        /**< The index in xstats name array. */
1101         uint64_t value;     /**< The statistic counter value. */
1102 };
1103
1104 /**
1105  * A name element for extended statistics.
1106  *
1107  * An array of this structure is returned by rte_eth_xstats_get_names().
1108  * It lists the names of extended statistics for a PMD. The *rte_eth_xstat*
1109  * structure references these names by their array index.
1110  */
1111 struct rte_eth_xstat_name {
1112         char name[RTE_ETH_XSTATS_NAME_SIZE]; /**< The statistic name. */
1113 };
1114
1115 #define ETH_DCB_NUM_TCS    8
1116 #define ETH_MAX_VMDQ_POOL  64
1117
1118 /**
1119  * A structure used to get the information of queue and
1120  * TC mapping on both TX and RX paths.
1121  */
1122 struct rte_eth_dcb_tc_queue_mapping {
1123         /** rx queues assigned to tc per Pool */
1124         struct {
1125                 uint8_t base;
1126                 uint8_t nb_queue;
1127         } tc_rxq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
1128         /** rx queues assigned to tc per Pool */
1129         struct {
1130                 uint8_t base;
1131                 uint8_t nb_queue;
1132         } tc_txq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
1133 };
1134
1135 /**
1136  * A structure used to get the information of DCB.
1137  * It includes TC UP mapping and queue TC mapping.
1138  */
1139 struct rte_eth_dcb_info {
1140         uint8_t nb_tcs;        /**< number of TCs */
1141         uint8_t prio_tc[ETH_DCB_NUM_USER_PRIORITIES]; /**< Priority to tc */
1142         uint8_t tc_bws[ETH_DCB_NUM_TCS]; /**< TX BW percentage for each TC */
1143         /** rx queues assigned to tc */
1144         struct rte_eth_dcb_tc_queue_mapping tc_queue;
1145 };
1146
1147 /**
1148  * RX/TX queue states
1149  */
1150 #define RTE_ETH_QUEUE_STATE_STOPPED 0
1151 #define RTE_ETH_QUEUE_STATE_STARTED 1
1152
1153 #define RTE_ETH_ALL RTE_MAX_ETHPORTS
1154
1155 /* Macros to check for valid port */
1156 #define RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, retval) 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 retval; \
1160         } \
1161 } while (0)
1162
1163 #define RTE_ETH_VALID_PORTID_OR_RET(port_id) do { \
1164         if (!rte_eth_dev_is_valid_port(port_id)) { \
1165                 RTE_ETHDEV_LOG(ERR, "Invalid port_id=%u\n", port_id); \
1166                 return; \
1167         } \
1168 } while (0)
1169
1170 /**
1171  * l2 tunnel configuration.
1172  */
1173
1174 /**< l2 tunnel enable mask */
1175 #define ETH_L2_TUNNEL_ENABLE_MASK       0x00000001
1176 /**< l2 tunnel insertion mask */
1177 #define ETH_L2_TUNNEL_INSERTION_MASK    0x00000002
1178 /**< l2 tunnel stripping mask */
1179 #define ETH_L2_TUNNEL_STRIPPING_MASK    0x00000004
1180 /**< l2 tunnel forwarding mask */
1181 #define ETH_L2_TUNNEL_FORWARDING_MASK   0x00000008
1182
1183 /**
1184  * Function type used for RX packet processing packet callbacks.
1185  *
1186  * The callback function is called on RX with a burst of packets that have
1187  * been received on the given port and queue.
1188  *
1189  * @param port_id
1190  *   The Ethernet port on which RX is being performed.
1191  * @param queue
1192  *   The queue on the Ethernet port which is being used to receive the packets.
1193  * @param pkts
1194  *   The burst of packets that have just been received.
1195  * @param nb_pkts
1196  *   The number of packets in the burst pointed to by "pkts".
1197  * @param max_pkts
1198  *   The max number of packets that can be stored in the "pkts" array.
1199  * @param user_param
1200  *   The arbitrary user parameter passed in by the application when the callback
1201  *   was originally configured.
1202  * @return
1203  *   The number of packets returned to the user.
1204  */
1205 typedef uint16_t (*rte_rx_callback_fn)(uint16_t port_id, uint16_t queue,
1206         struct rte_mbuf *pkts[], uint16_t nb_pkts, uint16_t max_pkts,
1207         void *user_param);
1208
1209 /**
1210  * Function type used for TX packet processing packet callbacks.
1211  *
1212  * The callback function is called on TX with a burst of packets immediately
1213  * before the packets are put onto the hardware queue for transmission.
1214  *
1215  * @param port_id
1216  *   The Ethernet port on which TX is being performed.
1217  * @param queue
1218  *   The queue on the Ethernet port which is being used to transmit the packets.
1219  * @param pkts
1220  *   The burst of packets that are about to be transmitted.
1221  * @param nb_pkts
1222  *   The number of packets in the burst pointed to by "pkts".
1223  * @param user_param
1224  *   The arbitrary user parameter passed in by the application when the callback
1225  *   was originally configured.
1226  * @return
1227  *   The number of packets to be written to the NIC.
1228  */
1229 typedef uint16_t (*rte_tx_callback_fn)(uint16_t port_id, uint16_t queue,
1230         struct rte_mbuf *pkts[], uint16_t nb_pkts, void *user_param);
1231
1232 /**
1233  * Possible states of an ethdev port.
1234  */
1235 enum rte_eth_dev_state {
1236         /** Device is unused before being probed. */
1237         RTE_ETH_DEV_UNUSED = 0,
1238         /** Device is attached when allocated in probing. */
1239         RTE_ETH_DEV_ATTACHED,
1240         /** The deferred state is useless and replaced by ownership. */
1241         RTE_ETH_DEV_DEFERRED,
1242         /** Device is in removed state when plug-out is detected. */
1243         RTE_ETH_DEV_REMOVED,
1244 };
1245
1246 struct rte_eth_dev_sriov {
1247         uint8_t active;               /**< SRIOV is active with 16, 32 or 64 pools */
1248         uint8_t nb_q_per_pool;        /**< rx queue number per pool */
1249         uint16_t def_vmdq_idx;        /**< Default pool num used for PF */
1250         uint16_t def_pool_q_idx;      /**< Default pool queue start reg index */
1251 };
1252 #define RTE_ETH_DEV_SRIOV(dev)         ((dev)->data->sriov)
1253
1254 #define RTE_ETH_NAME_MAX_LEN RTE_DEV_NAME_MAX_LEN
1255
1256 #define RTE_ETH_DEV_NO_OWNER 0
1257
1258 #define RTE_ETH_MAX_OWNER_NAME_LEN 64
1259
1260 struct rte_eth_dev_owner {
1261         uint64_t id; /**< The owner unique identifier. */
1262         char name[RTE_ETH_MAX_OWNER_NAME_LEN]; /**< The owner name. */
1263 };
1264
1265 /** Device supports link state interrupt */
1266 #define RTE_ETH_DEV_INTR_LSC     0x0002
1267 /** Device is a bonded slave */
1268 #define RTE_ETH_DEV_BONDED_SLAVE 0x0004
1269 /** Device supports device removal interrupt */
1270 #define RTE_ETH_DEV_INTR_RMV     0x0008
1271 /** Device is port representor */
1272 #define RTE_ETH_DEV_REPRESENTOR  0x0010
1273
1274 /**
1275  * Iterates over valid ethdev ports owned by a specific owner.
1276  *
1277  * @param port_id
1278  *   The id of the next possible valid owned port.
1279  * @param       owner_id
1280  *  The owner identifier.
1281  *  RTE_ETH_DEV_NO_OWNER means iterate over all valid ownerless ports.
1282  * @return
1283  *   Next valid port id owned by owner_id, RTE_MAX_ETHPORTS if there is none.
1284  */
1285 uint64_t rte_eth_find_next_owned_by(uint16_t port_id,
1286                 const uint64_t owner_id);
1287
1288 /**
1289  * Macro to iterate over all enabled ethdev ports owned by a specific owner.
1290  */
1291 #define RTE_ETH_FOREACH_DEV_OWNED_BY(p, o) \
1292         for (p = rte_eth_find_next_owned_by(0, o); \
1293              (unsigned int)p < (unsigned int)RTE_MAX_ETHPORTS; \
1294              p = rte_eth_find_next_owned_by(p + 1, o))
1295
1296 /**
1297  * Iterates over valid ethdev ports.
1298  *
1299  * @param port_id
1300  *   The id of the next possible valid port.
1301  * @return
1302  *   Next valid port id, RTE_MAX_ETHPORTS if there is none.
1303  */
1304 uint16_t rte_eth_find_next(uint16_t port_id);
1305
1306 /**
1307  * Macro to iterate over all enabled and ownerless ethdev ports.
1308  */
1309 #define RTE_ETH_FOREACH_DEV(p) \
1310         RTE_ETH_FOREACH_DEV_OWNED_BY(p, RTE_ETH_DEV_NO_OWNER)
1311
1312
1313 /**
1314  * @warning
1315  * @b EXPERIMENTAL: this API may change without prior notice.
1316  *
1317  * Get a new unique owner identifier.
1318  * An owner identifier is used to owns Ethernet devices by only one DPDK entity
1319  * to avoid multiple management of device by different entities.
1320  *
1321  * @param       owner_id
1322  *   Owner identifier pointer.
1323  * @return
1324  *   Negative errno value on error, 0 on success.
1325  */
1326 int __rte_experimental rte_eth_dev_owner_new(uint64_t *owner_id);
1327
1328 /**
1329  * @warning
1330  * @b EXPERIMENTAL: this API may change without prior notice.
1331  *
1332  * Set an Ethernet device owner.
1333  *
1334  * @param       port_id
1335  *  The identifier of the port to own.
1336  * @param       owner
1337  *  The owner pointer.
1338  * @return
1339  *  Negative errno value on error, 0 on success.
1340  */
1341 int __rte_experimental rte_eth_dev_owner_set(const uint16_t port_id,
1342                 const struct rte_eth_dev_owner *owner);
1343
1344 /**
1345  * @warning
1346  * @b EXPERIMENTAL: this API may change without prior notice.
1347  *
1348  * Unset Ethernet device owner to make the device ownerless.
1349  *
1350  * @param       port_id
1351  *  The identifier of port to make ownerless.
1352  * @param       owner_id
1353  *  The owner identifier.
1354  * @return
1355  *  0 on success, negative errno value on error.
1356  */
1357 int __rte_experimental rte_eth_dev_owner_unset(const uint16_t port_id,
1358                 const uint64_t owner_id);
1359
1360 /**
1361  * @warning
1362  * @b EXPERIMENTAL: this API may change without prior notice.
1363  *
1364  * Remove owner from all Ethernet devices owned by a specific owner.
1365  *
1366  * @param       owner_id
1367  *  The owner identifier.
1368  */
1369 void __rte_experimental rte_eth_dev_owner_delete(const uint64_t owner_id);
1370
1371 /**
1372  * @warning
1373  * @b EXPERIMENTAL: this API may change without prior notice.
1374  *
1375  * Get the owner of an Ethernet device.
1376  *
1377  * @param       port_id
1378  *  The port identifier.
1379  * @param       owner
1380  *  The owner structure pointer to fill.
1381  * @return
1382  *  0 on success, negative errno value on error..
1383  */
1384 int __rte_experimental rte_eth_dev_owner_get(const uint16_t port_id,
1385                 struct rte_eth_dev_owner *owner);
1386
1387 /**
1388  * Get the total number of Ethernet devices that have been successfully
1389  * initialized by the matching Ethernet driver during the PCI probing phase
1390  * and that are available for applications to use. These devices must be
1391  * accessed by using the ``RTE_ETH_FOREACH_DEV()`` macro to deal with
1392  * non-contiguous ranges of devices.
1393  * These non-contiguous ranges can be created by calls to hotplug functions or
1394  * by some PMDs.
1395  *
1396  * @return
1397  *   - The total number of usable Ethernet devices.
1398  */
1399 __rte_deprecated
1400 uint16_t rte_eth_dev_count(void);
1401
1402 /**
1403  * Get the number of ports which are usable for the application.
1404  *
1405  * These devices must be iterated by using the macro
1406  * ``RTE_ETH_FOREACH_DEV`` or ``RTE_ETH_FOREACH_DEV_OWNED_BY``
1407  * to deal with non-contiguous ranges of devices.
1408  *
1409  * @return
1410  *   The count of available Ethernet devices.
1411  */
1412 uint16_t rte_eth_dev_count_avail(void);
1413
1414 /**
1415  * Get the total number of ports which are allocated.
1416  *
1417  * Some devices may not be available for the application.
1418  *
1419  * @return
1420  *   The total count of Ethernet devices.
1421  */
1422 uint16_t __rte_experimental rte_eth_dev_count_total(void);
1423
1424 /**
1425  * Attach a new Ethernet device specified by arguments.
1426  *
1427  * @param devargs
1428  *  A pointer to a strings array describing the new device
1429  *  to be attached. The strings should be a pci address like
1430  *  '0000:01:00.0' or virtual device name like 'net_pcap0'.
1431  * @param port_id
1432  *  A pointer to a port identifier actually attached.
1433  * @return
1434  *  0 on success and port_id is filled, negative on error
1435  */
1436 int rte_eth_dev_attach(const char *devargs, uint16_t *port_id);
1437
1438 /**
1439  * Detach a Ethernet device specified by port identifier.
1440  * This function must be called when the device is in the
1441  * closed state.
1442  *
1443  * @param port_id
1444  *   The port identifier of the device to detach.
1445  * @param devname
1446  *   A pointer to a buffer that will be filled with the device name.
1447  *   This buffer must be at least RTE_DEV_NAME_MAX_LEN long.
1448  * @return
1449  *  0 on success and devname is filled, negative on error
1450  */
1451 int rte_eth_dev_detach(uint16_t port_id, char *devname);
1452
1453 /**
1454  * Convert a numerical speed in Mbps to a bitmap flag that can be used in
1455  * the bitmap link_speeds of the struct rte_eth_conf
1456  *
1457  * @param speed
1458  *   Numerical speed value in Mbps
1459  * @param duplex
1460  *   ETH_LINK_[HALF/FULL]_DUPLEX (only for 10/100M speeds)
1461  * @return
1462  *   0 if the speed cannot be mapped
1463  */
1464 uint32_t rte_eth_speed_bitflag(uint32_t speed, int duplex);
1465
1466 /**
1467  * @warning
1468  * @b EXPERIMENTAL: this API may change without prior notice
1469  *
1470  * Get DEV_RX_OFFLOAD_* flag name.
1471  *
1472  * @param offload
1473  *   Offload flag.
1474  * @return
1475  *   Offload name or 'UNKNOWN' if the flag cannot be recognised.
1476  */
1477 const char * __rte_experimental rte_eth_dev_rx_offload_name(uint64_t offload);
1478
1479 /**
1480  * @warning
1481  * @b EXPERIMENTAL: this API may change without prior notice
1482  *
1483  * Get DEV_TX_OFFLOAD_* flag name.
1484  *
1485  * @param offload
1486  *   Offload flag.
1487  * @return
1488  *   Offload name or 'UNKNOWN' if the flag cannot be recognised.
1489  */
1490 const char * __rte_experimental rte_eth_dev_tx_offload_name(uint64_t offload);
1491
1492 /**
1493  * Configure an Ethernet device.
1494  * This function must be invoked first before any other function in the
1495  * Ethernet API. This function can also be re-invoked when a device is in the
1496  * stopped state.
1497  *
1498  * @param port_id
1499  *   The port identifier of the Ethernet device to configure.
1500  * @param nb_rx_queue
1501  *   The number of receive queues to set up for the Ethernet device.
1502  * @param nb_tx_queue
1503  *   The number of transmit queues to set up for the Ethernet device.
1504  * @param eth_conf
1505  *   The pointer to the configuration data to be used for the Ethernet device.
1506  *   The *rte_eth_conf* structure includes:
1507  *     -  the hardware offload features to activate, with dedicated fields for
1508  *        each statically configurable offload hardware feature provided by
1509  *        Ethernet devices, such as IP checksum or VLAN tag stripping for
1510  *        example.
1511  *        The Rx offload bitfield API is obsolete and will be deprecated.
1512  *        Applications should set the ignore_bitfield_offloads bit on *rxmode*
1513  *        structure and use offloads field to set per-port offloads instead.
1514  *     -  Any offloading set in eth_conf->[rt]xmode.offloads must be within
1515  *        the [rt]x_offload_capa returned from rte_eth_dev_infos_get().
1516  *        Any type of device supported offloading set in the input argument
1517  *        eth_conf->[rt]xmode.offloads to rte_eth_dev_configure() is enabled
1518  *        on all queues and it can't be disabled in rte_eth_[rt]x_queue_setup().
1519  *     - the Receive Side Scaling (RSS) configuration when using multiple RX
1520  *         queues per port.
1521  *
1522  *   Embedding all configuration information in a single data structure
1523  *   is the more flexible method that allows the addition of new features
1524  *   without changing the syntax of the API.
1525  * @return
1526  *   - 0: Success, device configured.
1527  *   - <0: Error code returned by the driver configuration function.
1528  */
1529 int rte_eth_dev_configure(uint16_t port_id, uint16_t nb_rx_queue,
1530                 uint16_t nb_tx_queue, const struct rte_eth_conf *eth_conf);
1531
1532 /**
1533  * @warning
1534  * @b EXPERIMENTAL: this API may change without prior notice.
1535  *
1536  * Check if an Ethernet device was physically removed.
1537  *
1538  * @param port_id
1539  *   The port identifier of the Ethernet device.
1540  * @return
1541  *   1 when the Ethernet device is removed, otherwise 0.
1542  */
1543 int __rte_experimental
1544 rte_eth_dev_is_removed(uint16_t port_id);
1545
1546 /**
1547  * Allocate and set up a receive queue for an Ethernet device.
1548  *
1549  * The function allocates a contiguous block of memory for *nb_rx_desc*
1550  * receive descriptors from a memory zone associated with *socket_id*
1551  * and initializes each receive descriptor with a network buffer allocated
1552  * from the memory pool *mb_pool*.
1553  *
1554  * @param port_id
1555  *   The port identifier of the Ethernet device.
1556  * @param rx_queue_id
1557  *   The index of the receive queue to set up.
1558  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
1559  *   to rte_eth_dev_configure().
1560  * @param nb_rx_desc
1561  *   The number of receive descriptors to allocate for the receive ring.
1562  * @param socket_id
1563  *   The *socket_id* argument is the socket identifier in case of NUMA.
1564  *   The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1565  *   the DMA memory allocated for the receive descriptors of the ring.
1566  * @param rx_conf
1567  *   The pointer to the configuration data to be used for the receive queue.
1568  *   NULL value is allowed, in which case default RX configuration
1569  *   will be used.
1570  *   The *rx_conf* structure contains an *rx_thresh* structure with the values
1571  *   of the Prefetch, Host, and Write-Back threshold registers of the receive
1572  *   ring.
1573  *   In addition it contains the hardware offloads features to activate using
1574  *   the DEV_RX_OFFLOAD_* flags.
1575  *   If an offloading set in rx_conf->offloads
1576  *   hasn't been set in the input argument eth_conf->rxmode.offloads
1577  *   to rte_eth_dev_configure(), it is a new added offloading, it must be
1578  *   per-queue type and it is enabled for the queue.
1579  *   No need to repeat any bit in rx_conf->offloads which has already been
1580  *   enabled in rte_eth_dev_configure() at port level. An offloading enabled
1581  *   at port level can't be disabled at queue level.
1582  * @param mb_pool
1583  *   The pointer to the memory pool from which to allocate *rte_mbuf* network
1584  *   memory buffers to populate each descriptor of the receive ring.
1585  * @return
1586  *   - 0: Success, receive queue correctly set up.
1587  *   - -EIO: if device is removed.
1588  *   - -EINVAL: The size of network buffers which can be allocated from the
1589  *      memory pool does not fit the various buffer sizes allowed by the
1590  *      device controller.
1591  *   - -ENOMEM: Unable to allocate the receive ring descriptors or to
1592  *      allocate network memory buffers from the memory pool when
1593  *      initializing receive descriptors.
1594  */
1595 int rte_eth_rx_queue_setup(uint16_t port_id, uint16_t rx_queue_id,
1596                 uint16_t nb_rx_desc, unsigned int socket_id,
1597                 const struct rte_eth_rxconf *rx_conf,
1598                 struct rte_mempool *mb_pool);
1599
1600 /**
1601  * Allocate and set up a transmit queue for an Ethernet device.
1602  *
1603  * @param port_id
1604  *   The port identifier of the Ethernet device.
1605  * @param tx_queue_id
1606  *   The index of the transmit queue to set up.
1607  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
1608  *   to rte_eth_dev_configure().
1609  * @param nb_tx_desc
1610  *   The number of transmit descriptors to allocate for the transmit ring.
1611  * @param socket_id
1612  *   The *socket_id* argument is the socket identifier in case of NUMA.
1613  *   Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1614  *   the DMA memory allocated for the transmit descriptors of the ring.
1615  * @param tx_conf
1616  *   The pointer to the configuration data to be used for the transmit queue.
1617  *   NULL value is allowed, in which case default TX configuration
1618  *   will be used.
1619  *   The *tx_conf* structure contains the following data:
1620  *   - The *tx_thresh* structure with the values of the Prefetch, Host, and
1621  *     Write-Back threshold registers of the transmit ring.
1622  *     When setting Write-Back threshold to the value greater then zero,
1623  *     *tx_rs_thresh* value should be explicitly set to one.
1624  *   - The *tx_free_thresh* value indicates the [minimum] number of network
1625  *     buffers that must be pending in the transmit ring to trigger their
1626  *     [implicit] freeing by the driver transmit function.
1627  *   - The *tx_rs_thresh* value indicates the [minimum] number of transmit
1628  *     descriptors that must be pending in the transmit ring before setting the
1629  *     RS bit on a descriptor by the driver transmit function.
1630  *     The *tx_rs_thresh* value should be less or equal then
1631  *     *tx_free_thresh* value, and both of them should be less then
1632  *     *nb_tx_desc* - 3.
1633  *   - The *offloads* member contains Tx offloads to be enabled.
1634  *     If an offloading set in tx_conf->offloads
1635  *     hasn't been set in the input argument eth_conf->txmode.offloads
1636  *     to rte_eth_dev_configure(), it is a new added offloading, it must be
1637  *     per-queue type and it is enabled for the queue.
1638  *     No need to repeat any bit in tx_conf->offloads which has already been
1639  *     enabled in rte_eth_dev_configure() at port level. An offloading enabled
1640  *     at port level can't be disabled at queue level.
1641  *
1642  *     Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces
1643  *     the transmit function to use default values.
1644  * @return
1645  *   - 0: Success, the transmit queue is correctly set up.
1646  *   - -ENOMEM: Unable to allocate the transmit ring descriptors.
1647  */
1648 int rte_eth_tx_queue_setup(uint16_t port_id, uint16_t tx_queue_id,
1649                 uint16_t nb_tx_desc, unsigned int socket_id,
1650                 const struct rte_eth_txconf *tx_conf);
1651
1652 /**
1653  * Return the NUMA socket to which an Ethernet device is connected
1654  *
1655  * @param port_id
1656  *   The port identifier of the Ethernet device
1657  * @return
1658  *   The NUMA socket id to which the Ethernet device is connected or
1659  *   a default of zero if the socket could not be determined.
1660  *   -1 is returned is the port_id value is out of range.
1661  */
1662 int rte_eth_dev_socket_id(uint16_t port_id);
1663
1664 /**
1665  * Check if port_id of device is attached
1666  *
1667  * @param port_id
1668  *   The port identifier of the Ethernet device
1669  * @return
1670  *   - 0 if port is out of range or not attached
1671  *   - 1 if device is attached
1672  */
1673 int rte_eth_dev_is_valid_port(uint16_t port_id);
1674
1675 /**
1676  * Start specified RX queue of a port. It is used when rx_deferred_start
1677  * flag of the specified queue is true.
1678  *
1679  * @param port_id
1680  *   The port identifier of the Ethernet device
1681  * @param rx_queue_id
1682  *   The index of the rx queue to update the ring.
1683  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
1684  *   to rte_eth_dev_configure().
1685  * @return
1686  *   - 0: Success, the receive queue is started.
1687  *   - -EINVAL: The port_id or the queue_id out of range.
1688  *   - -EIO: if device is removed.
1689  *   - -ENOTSUP: The function not supported in PMD driver.
1690  */
1691 int rte_eth_dev_rx_queue_start(uint16_t port_id, uint16_t rx_queue_id);
1692
1693 /**
1694  * Stop specified RX queue of a port
1695  *
1696  * @param port_id
1697  *   The port identifier of the Ethernet device
1698  * @param rx_queue_id
1699  *   The index of the rx queue to update the ring.
1700  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
1701  *   to rte_eth_dev_configure().
1702  * @return
1703  *   - 0: Success, the receive queue is stopped.
1704  *   - -EINVAL: The port_id or the queue_id out of range.
1705  *   - -EIO: if device is removed.
1706  *   - -ENOTSUP: The function not supported in PMD driver.
1707  */
1708 int rte_eth_dev_rx_queue_stop(uint16_t port_id, uint16_t rx_queue_id);
1709
1710 /**
1711  * Start TX for specified queue of a port. It is used when tx_deferred_start
1712  * flag of the specified queue is true.
1713  *
1714  * @param port_id
1715  *   The port identifier of the Ethernet device
1716  * @param tx_queue_id
1717  *   The index of the tx queue to update the ring.
1718  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
1719  *   to rte_eth_dev_configure().
1720  * @return
1721  *   - 0: Success, the transmit queue is started.
1722  *   - -EINVAL: The port_id or the queue_id out of range.
1723  *   - -EIO: if device is removed.
1724  *   - -ENOTSUP: The function not supported in PMD driver.
1725  */
1726 int rte_eth_dev_tx_queue_start(uint16_t port_id, uint16_t tx_queue_id);
1727
1728 /**
1729  * Stop specified TX queue of a port
1730  *
1731  * @param port_id
1732  *   The port identifier of the Ethernet device
1733  * @param tx_queue_id
1734  *   The index of the tx queue to update the ring.
1735  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
1736  *   to rte_eth_dev_configure().
1737  * @return
1738  *   - 0: Success, the transmit queue is stopped.
1739  *   - -EINVAL: The port_id or the queue_id out of range.
1740  *   - -EIO: if device is removed.
1741  *   - -ENOTSUP: The function not supported in PMD driver.
1742  */
1743 int rte_eth_dev_tx_queue_stop(uint16_t port_id, uint16_t tx_queue_id);
1744
1745 /**
1746  * Start an Ethernet device.
1747  *
1748  * The device start step is the last one and consists of setting the configured
1749  * offload features and in starting the transmit and the receive units of the
1750  * device.
1751  * On success, all basic functions exported by the Ethernet API (link status,
1752  * receive/transmit, and so on) can be invoked.
1753  *
1754  * @param port_id
1755  *   The port identifier of the Ethernet device.
1756  * @return
1757  *   - 0: Success, Ethernet device started.
1758  *   - <0: Error code of the driver device start function.
1759  */
1760 int rte_eth_dev_start(uint16_t port_id);
1761
1762 /**
1763  * Stop an Ethernet device. The device can be restarted with a call to
1764  * rte_eth_dev_start()
1765  *
1766  * @param port_id
1767  *   The port identifier of the Ethernet device.
1768  */
1769 void rte_eth_dev_stop(uint16_t port_id);
1770
1771 /**
1772  * Link up an Ethernet device.
1773  *
1774  * Set device link up will re-enable the device rx/tx
1775  * functionality after it is previously set device linked down.
1776  *
1777  * @param port_id
1778  *   The port identifier of the Ethernet device.
1779  * @return
1780  *   - 0: Success, Ethernet device linked up.
1781  *   - <0: Error code of the driver device link up function.
1782  */
1783 int rte_eth_dev_set_link_up(uint16_t port_id);
1784
1785 /**
1786  * Link down an Ethernet device.
1787  * The device rx/tx functionality will be disabled if success,
1788  * and it can be re-enabled with a call to
1789  * rte_eth_dev_set_link_up()
1790  *
1791  * @param port_id
1792  *   The port identifier of the Ethernet device.
1793  */
1794 int rte_eth_dev_set_link_down(uint16_t port_id);
1795
1796 /**
1797  * Close a stopped Ethernet device. The device cannot be restarted!
1798  * The function frees all resources except for needed by the
1799  * closed state. To free these resources, call rte_eth_dev_detach().
1800  *
1801  * @param port_id
1802  *   The port identifier of the Ethernet device.
1803  */
1804 void rte_eth_dev_close(uint16_t port_id);
1805
1806 /**
1807  * Reset a Ethernet device and keep its port id.
1808  *
1809  * When a port has to be reset passively, the DPDK application can invoke
1810  * this function. For example when a PF is reset, all its VFs should also
1811  * be reset. Normally a DPDK application can invoke this function when
1812  * RTE_ETH_EVENT_INTR_RESET event is detected, but can also use it to start
1813  * a port reset in other circumstances.
1814  *
1815  * When this function is called, it first stops the port and then calls the
1816  * PMD specific dev_uninit( ) and dev_init( ) to return the port to initial
1817  * state, in which no Tx and Rx queues are setup, as if the port has been
1818  * reset and not started. The port keeps the port id it had before the
1819  * function call.
1820  *
1821  * After calling rte_eth_dev_reset( ), the application should use
1822  * rte_eth_dev_configure( ), rte_eth_rx_queue_setup( ),
1823  * rte_eth_tx_queue_setup( ), and rte_eth_dev_start( )
1824  * to reconfigure the device as appropriate.
1825  *
1826  * Note: To avoid unexpected behavior, the application should stop calling
1827  * Tx and Rx functions before calling rte_eth_dev_reset( ). For thread
1828  * safety, all these controlling functions should be called from the same
1829  * thread.
1830  *
1831  * @param port_id
1832  *   The port identifier of the Ethernet device.
1833  *
1834  * @return
1835  *   - (0) if successful.
1836  *   - (-EINVAL) if port identifier is invalid.
1837  *   - (-ENOTSUP) if hardware doesn't support this function.
1838  *   - (-EPERM) if not ran from the primary process.
1839  *   - (-EIO) if re-initialisation failed or device is removed.
1840  *   - (-ENOMEM) if the reset failed due to OOM.
1841  *   - (-EAGAIN) if the reset temporarily failed and should be retried later.
1842  */
1843 int rte_eth_dev_reset(uint16_t port_id);
1844
1845 /**
1846  * Enable receipt in promiscuous mode for an Ethernet device.
1847  *
1848  * @param port_id
1849  *   The port identifier of the Ethernet device.
1850  */
1851 void rte_eth_promiscuous_enable(uint16_t port_id);
1852
1853 /**
1854  * Disable receipt in promiscuous mode for an Ethernet device.
1855  *
1856  * @param port_id
1857  *   The port identifier of the Ethernet device.
1858  */
1859 void rte_eth_promiscuous_disable(uint16_t port_id);
1860
1861 /**
1862  * Return the value of promiscuous mode for an Ethernet device.
1863  *
1864  * @param port_id
1865  *   The port identifier of the Ethernet device.
1866  * @return
1867  *   - (1) if promiscuous is enabled
1868  *   - (0) if promiscuous is disabled.
1869  *   - (-1) on error
1870  */
1871 int rte_eth_promiscuous_get(uint16_t port_id);
1872
1873 /**
1874  * Enable the receipt of any multicast frame by an Ethernet device.
1875  *
1876  * @param port_id
1877  *   The port identifier of the Ethernet device.
1878  */
1879 void rte_eth_allmulticast_enable(uint16_t port_id);
1880
1881 /**
1882  * Disable the receipt of all multicast frames by an Ethernet device.
1883  *
1884  * @param port_id
1885  *   The port identifier of the Ethernet device.
1886  */
1887 void rte_eth_allmulticast_disable(uint16_t port_id);
1888
1889 /**
1890  * Return the value of allmulticast mode for an Ethernet device.
1891  *
1892  * @param port_id
1893  *   The port identifier of the Ethernet device.
1894  * @return
1895  *   - (1) if allmulticast is enabled
1896  *   - (0) if allmulticast is disabled.
1897  *   - (-1) on error
1898  */
1899 int rte_eth_allmulticast_get(uint16_t port_id);
1900
1901 /**
1902  * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
1903  * or FULL-DUPLEX) of the physical link of an Ethernet device. It might need
1904  * to wait up to 9 seconds in it.
1905  *
1906  * @param port_id
1907  *   The port identifier of the Ethernet device.
1908  * @param link
1909  *   A pointer to an *rte_eth_link* structure to be filled with
1910  *   the status, the speed and the mode of the Ethernet device link.
1911  */
1912 void rte_eth_link_get(uint16_t port_id, struct rte_eth_link *link);
1913
1914 /**
1915  * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
1916  * or FULL-DUPLEX) of the physical link of an Ethernet device. It is a no-wait
1917  * version of rte_eth_link_get().
1918  *
1919  * @param port_id
1920  *   The port identifier of the Ethernet device.
1921  * @param link
1922  *   A pointer to an *rte_eth_link* structure to be filled with
1923  *   the status, the speed and the mode of the Ethernet device link.
1924  */
1925 void rte_eth_link_get_nowait(uint16_t port_id, struct rte_eth_link *link);
1926
1927 /**
1928  * Retrieve the general I/O statistics of an Ethernet device.
1929  *
1930  * @param port_id
1931  *   The port identifier of the Ethernet device.
1932  * @param stats
1933  *   A pointer to a structure of type *rte_eth_stats* to be filled with
1934  *   the values of device counters for the following set of statistics:
1935  *   - *ipackets* with the total of successfully received packets.
1936  *   - *opackets* with the total of successfully transmitted packets.
1937  *   - *ibytes*   with the total of successfully received bytes.
1938  *   - *obytes*   with the total of successfully transmitted bytes.
1939  *   - *ierrors*  with the total of erroneous received packets.
1940  *   - *oerrors*  with the total of failed transmitted packets.
1941  * @return
1942  *   Zero if successful. Non-zero otherwise.
1943  */
1944 int rte_eth_stats_get(uint16_t port_id, struct rte_eth_stats *stats);
1945
1946 /**
1947  * Reset the general I/O statistics of an Ethernet device.
1948  *
1949  * @param port_id
1950  *   The port identifier of the Ethernet device.
1951  * @return
1952  *   - (0) if device notified to reset stats.
1953  *   - (-ENOTSUP) if hardware doesn't support.
1954  *   - (-ENODEV) if *port_id* invalid.
1955  */
1956 int rte_eth_stats_reset(uint16_t port_id);
1957
1958 /**
1959  * Retrieve names of extended statistics of an Ethernet device.
1960  *
1961  * There is an assumption that 'xstat_names' and 'xstats' arrays are matched
1962  * by array index:
1963  *  xstats_names[i].name => xstats[i].value
1964  *
1965  * And the array index is same with id field of 'struct rte_eth_xstat':
1966  *  xstats[i].id == i
1967  *
1968  * This assumption makes key-value pair matching less flexible but simpler.
1969  *
1970  * @param port_id
1971  *   The port identifier of the Ethernet device.
1972  * @param xstats_names
1973  *   An rte_eth_xstat_name array of at least *size* elements to
1974  *   be filled. If set to NULL, the function returns the required number
1975  *   of elements.
1976  * @param size
1977  *   The size of the xstats_names array (number of elements).
1978  * @return
1979  *   - A positive value lower or equal to size: success. The return value
1980  *     is the number of entries filled in the stats table.
1981  *   - A positive value higher than size: error, the given statistics table
1982  *     is too small. The return value corresponds to the size that should
1983  *     be given to succeed. The entries in the table are not valid and
1984  *     shall not be used by the caller.
1985  *   - A negative value on error (invalid port id).
1986  */
1987 int rte_eth_xstats_get_names(uint16_t port_id,
1988                 struct rte_eth_xstat_name *xstats_names,
1989                 unsigned int size);
1990
1991 /**
1992  * Retrieve extended statistics of an Ethernet device.
1993  *
1994  * There is an assumption that 'xstat_names' and 'xstats' arrays are matched
1995  * by array index:
1996  *  xstats_names[i].name => xstats[i].value
1997  *
1998  * And the array index is same with id field of 'struct rte_eth_xstat':
1999  *  xstats[i].id == i
2000  *
2001  * This assumption makes key-value pair matching less flexible but simpler.
2002  *
2003  * @param port_id
2004  *   The port identifier of the Ethernet device.
2005  * @param xstats
2006  *   A pointer to a table of structure of type *rte_eth_xstat*
2007  *   to be filled with device statistics ids and values.
2008  *   This parameter can be set to NULL if n is 0.
2009  * @param n
2010  *   The size of the xstats array (number of elements).
2011  * @return
2012  *   - A positive value lower or equal to n: success. The return value
2013  *     is the number of entries filled in the stats table.
2014  *   - A positive value higher than n: error, the given statistics table
2015  *     is too small. The return value corresponds to the size that should
2016  *     be given to succeed. The entries in the table are not valid and
2017  *     shall not be used by the caller.
2018  *   - A negative value on error (invalid port id).
2019  */
2020 int rte_eth_xstats_get(uint16_t port_id, struct rte_eth_xstat *xstats,
2021                 unsigned int n);
2022
2023 /**
2024  * Retrieve names of extended statistics of an Ethernet device.
2025  *
2026  * @param port_id
2027  *   The port identifier of the Ethernet device.
2028  * @param xstats_names
2029  *   An rte_eth_xstat_name array of at least *size* elements to
2030  *   be filled. If set to NULL, the function returns the required number
2031  *   of elements.
2032  * @param ids
2033  *   IDs array given by app to retrieve specific statistics
2034  * @param size
2035  *   The size of the xstats_names array (number of elements).
2036  * @return
2037  *   - A positive value lower or equal to size: success. The return value
2038  *     is the number of entries filled in the stats table.
2039  *   - A positive value higher than size: error, the given statistics table
2040  *     is too small. The return value corresponds to the size that should
2041  *     be given to succeed. The entries in the table are not valid and
2042  *     shall not be used by the caller.
2043  *   - A negative value on error (invalid port id).
2044  */
2045 int
2046 rte_eth_xstats_get_names_by_id(uint16_t port_id,
2047         struct rte_eth_xstat_name *xstats_names, unsigned int size,
2048         uint64_t *ids);
2049
2050 /**
2051  * Retrieve extended statistics of an Ethernet device.
2052  *
2053  * @param port_id
2054  *   The port identifier of the Ethernet device.
2055  * @param ids
2056  *   A pointer to an ids array passed by application. This tells which
2057  *   statistics values function should retrieve. This parameter
2058  *   can be set to NULL if size is 0. In this case function will retrieve
2059  *   all avalible statistics.
2060  * @param values
2061  *   A pointer to a table to be filled with device statistics values.
2062  * @param size
2063  *   The size of the ids array (number of elements).
2064  * @return
2065  *   - A positive value lower or equal to size: success. The return value
2066  *     is the number of entries filled in the stats table.
2067  *   - A positive value higher than size: error, the given statistics table
2068  *     is too small. The return value corresponds to the size that should
2069  *     be given to succeed. The entries in the table are not valid and
2070  *     shall not be used by the caller.
2071  *   - A negative value on error (invalid port id).
2072  */
2073 int rte_eth_xstats_get_by_id(uint16_t port_id, const uint64_t *ids,
2074                              uint64_t *values, unsigned int size);
2075
2076 /**
2077  * Gets the ID of a statistic from its name.
2078  *
2079  * This function searches for the statistics using string compares, and
2080  * as such should not be used on the fast-path. For fast-path retrieval of
2081  * specific statistics, store the ID as provided in *id* from this function,
2082  * and pass the ID to rte_eth_xstats_get()
2083  *
2084  * @param port_id The port to look up statistics from
2085  * @param xstat_name The name of the statistic to return
2086  * @param[out] id A pointer to an app-supplied uint64_t which should be
2087  *                set to the ID of the stat if the stat exists.
2088  * @return
2089  *    0 on success
2090  *    -ENODEV for invalid port_id,
2091  *    -EIO if device is removed,
2092  *    -EINVAL if the xstat_name doesn't exist in port_id
2093  */
2094 int rte_eth_xstats_get_id_by_name(uint16_t port_id, const char *xstat_name,
2095                 uint64_t *id);
2096
2097 /**
2098  * Reset extended statistics of an Ethernet device.
2099  *
2100  * @param port_id
2101  *   The port identifier of the Ethernet device.
2102  */
2103 void rte_eth_xstats_reset(uint16_t port_id);
2104
2105 /**
2106  *  Set a mapping for the specified transmit queue to the specified per-queue
2107  *  statistics counter.
2108  *
2109  * @param port_id
2110  *   The port identifier of the Ethernet device.
2111  * @param tx_queue_id
2112  *   The index of the transmit queue for which a queue stats mapping is required.
2113  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
2114  *   to rte_eth_dev_configure().
2115  * @param stat_idx
2116  *   The per-queue packet statistics functionality number that the transmit
2117  *   queue is to be assigned.
2118  *   The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2119  * @return
2120  *   Zero if successful. Non-zero otherwise.
2121  */
2122 int rte_eth_dev_set_tx_queue_stats_mapping(uint16_t port_id,
2123                 uint16_t tx_queue_id, uint8_t stat_idx);
2124
2125 /**
2126  *  Set a mapping for the specified receive queue to the specified per-queue
2127  *  statistics counter.
2128  *
2129  * @param port_id
2130  *   The port identifier of the Ethernet device.
2131  * @param rx_queue_id
2132  *   The index of the receive queue for which a queue stats mapping is required.
2133  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
2134  *   to rte_eth_dev_configure().
2135  * @param stat_idx
2136  *   The per-queue packet statistics functionality number that the receive
2137  *   queue is to be assigned.
2138  *   The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
2139  * @return
2140  *   Zero if successful. Non-zero otherwise.
2141  */
2142 int rte_eth_dev_set_rx_queue_stats_mapping(uint16_t port_id,
2143                                            uint16_t rx_queue_id,
2144                                            uint8_t stat_idx);
2145
2146 /**
2147  * Retrieve the Ethernet address of an Ethernet device.
2148  *
2149  * @param port_id
2150  *   The port identifier of the Ethernet device.
2151  * @param mac_addr
2152  *   A pointer to a structure of type *ether_addr* to be filled with
2153  *   the Ethernet address of the Ethernet device.
2154  */
2155 void rte_eth_macaddr_get(uint16_t port_id, struct ether_addr *mac_addr);
2156
2157 /**
2158  * Retrieve the contextual information of an Ethernet device.
2159  *
2160  * @param port_id
2161  *   The port identifier of the Ethernet device.
2162  * @param dev_info
2163  *   A pointer to a structure of type *rte_eth_dev_info* to be filled with
2164  *   the contextual information of the Ethernet device.
2165  */
2166 void rte_eth_dev_info_get(uint16_t port_id, struct rte_eth_dev_info *dev_info);
2167
2168 /**
2169  * Retrieve the firmware version of a device.
2170  *
2171  * @param port_id
2172  *   The port identifier of the device.
2173  * @param fw_version
2174  *   A pointer to a string array storing the firmware version of a device,
2175  *   the string includes terminating null. This pointer is allocated by caller.
2176  * @param fw_size
2177  *   The size of the string array pointed by fw_version, which should be
2178  *   large enough to store firmware version of the device.
2179  * @return
2180  *   - (0) if successful.
2181  *   - (-ENOTSUP) if operation is not supported.
2182  *   - (-ENODEV) if *port_id* invalid.
2183  *   - (-EIO) if device is removed.
2184  *   - (>0) if *fw_size* is not enough to store firmware version, return
2185  *          the size of the non truncated string.
2186  */
2187 int rte_eth_dev_fw_version_get(uint16_t port_id,
2188                                char *fw_version, size_t fw_size);
2189
2190 /**
2191  * Retrieve the supported packet types of an Ethernet device.
2192  *
2193  * When a packet type is announced as supported, it *must* be recognized by
2194  * the PMD. For instance, if RTE_PTYPE_L2_ETHER, RTE_PTYPE_L2_ETHER_VLAN
2195  * and RTE_PTYPE_L3_IPV4 are announced, the PMD must return the following
2196  * packet types for these packets:
2197  * - Ether/IPv4              -> RTE_PTYPE_L2_ETHER | RTE_PTYPE_L3_IPV4
2198  * - Ether/Vlan/IPv4         -> RTE_PTYPE_L2_ETHER_VLAN | RTE_PTYPE_L3_IPV4
2199  * - Ether/[anything else]   -> RTE_PTYPE_L2_ETHER
2200  * - Ether/Vlan/[anything else] -> RTE_PTYPE_L2_ETHER_VLAN
2201  *
2202  * When a packet is received by a PMD, the most precise type must be
2203  * returned among the ones supported. However a PMD is allowed to set
2204  * packet type that is not in the supported list, at the condition that it
2205  * is more precise. Therefore, a PMD announcing no supported packet types
2206  * can still set a matching packet type in a received packet.
2207  *
2208  * @note
2209  *   Better to invoke this API after the device is already started or rx burst
2210  *   function is decided, to obtain correct supported ptypes.
2211  * @note
2212  *   if a given PMD does not report what ptypes it supports, then the supported
2213  *   ptype count is reported as 0.
2214  * @param port_id
2215  *   The port identifier of the Ethernet device.
2216  * @param ptype_mask
2217  *   A hint of what kind of packet type which the caller is interested in.
2218  * @param ptypes
2219  *   An array pointer to store adequate packet types, allocated by caller.
2220  * @param num
2221  *  Size of the array pointed by param ptypes.
2222  * @return
2223  *   - (>=0) Number of supported ptypes. If the number of types exceeds num,
2224  *           only num entries will be filled into the ptypes array, but the full
2225  *           count of supported ptypes will be returned.
2226  *   - (-ENODEV) if *port_id* invalid.
2227  */
2228 int rte_eth_dev_get_supported_ptypes(uint16_t port_id, uint32_t ptype_mask,
2229                                      uint32_t *ptypes, int num);
2230
2231 /**
2232  * Retrieve the MTU of an Ethernet device.
2233  *
2234  * @param port_id
2235  *   The port identifier of the Ethernet device.
2236  * @param mtu
2237  *   A pointer to a uint16_t where the retrieved MTU is to be stored.
2238  * @return
2239  *   - (0) if successful.
2240  *   - (-ENODEV) if *port_id* invalid.
2241  */
2242 int rte_eth_dev_get_mtu(uint16_t port_id, uint16_t *mtu);
2243
2244 /**
2245  * Change the MTU of an Ethernet device.
2246  *
2247  * @param port_id
2248  *   The port identifier of the Ethernet device.
2249  * @param mtu
2250  *   A uint16_t for the MTU to be applied.
2251  * @return
2252  *   - (0) if successful.
2253  *   - (-ENOTSUP) if operation is not supported.
2254  *   - (-ENODEV) if *port_id* invalid.
2255  *   - (-EIO) if device is removed.
2256  *   - (-EINVAL) if *mtu* invalid.
2257  *   - (-EBUSY) if operation is not allowed when the port is running
2258  */
2259 int rte_eth_dev_set_mtu(uint16_t port_id, uint16_t mtu);
2260
2261 /**
2262  * Enable/Disable hardware filtering by an Ethernet device of received
2263  * VLAN packets tagged with a given VLAN Tag Identifier.
2264  *
2265  * @param port_id
2266  *   The port identifier of the Ethernet device.
2267  * @param vlan_id
2268  *   The VLAN Tag Identifier whose filtering must be enabled or disabled.
2269  * @param on
2270  *   If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*.
2271  *   Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*.
2272  * @return
2273  *   - (0) if successful.
2274  *   - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2275  *   - (-ENODEV) if *port_id* invalid.
2276  *   - (-EIO) if device is removed.
2277  *   - (-ENOSYS) if VLAN filtering on *port_id* disabled.
2278  *   - (-EINVAL) if *vlan_id* > 4095.
2279  */
2280 int rte_eth_dev_vlan_filter(uint16_t port_id, uint16_t vlan_id, int on);
2281
2282 /**
2283  * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
2284  * 82599/X540/X550 can support VLAN stripping at the rx queue level
2285  *
2286  * @param port_id
2287  *   The port identifier of the Ethernet device.
2288  * @param rx_queue_id
2289  *   The index of the receive queue for which a queue stats mapping is required.
2290  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
2291  *   to rte_eth_dev_configure().
2292  * @param on
2293  *   If 1, Enable VLAN Stripping of the receive queue of the Ethernet port.
2294  *   If 0, Disable VLAN Stripping of the receive queue of the Ethernet port.
2295  * @return
2296  *   - (0) if successful.
2297  *   - (-ENOSUP) if hardware-assisted VLAN stripping not configured.
2298  *   - (-ENODEV) if *port_id* invalid.
2299  *   - (-EINVAL) if *rx_queue_id* invalid.
2300  */
2301 int rte_eth_dev_set_vlan_strip_on_queue(uint16_t port_id, uint16_t rx_queue_id,
2302                 int on);
2303
2304 /**
2305  * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
2306  * the VLAN Header. This is a register setup available on some Intel NIC, not
2307  * but all, please check the data sheet for availability.
2308  *
2309  * @param port_id
2310  *   The port identifier of the Ethernet device.
2311  * @param vlan_type
2312  *   The vlan type.
2313  * @param tag_type
2314  *   The Tag Protocol ID
2315  * @return
2316  *   - (0) if successful.
2317  *   - (-ENOSUP) if hardware-assisted VLAN TPID setup is not supported.
2318  *   - (-ENODEV) if *port_id* invalid.
2319  *   - (-EIO) if device is removed.
2320  */
2321 int rte_eth_dev_set_vlan_ether_type(uint16_t port_id,
2322                                     enum rte_vlan_type vlan_type,
2323                                     uint16_t tag_type);
2324
2325 /**
2326  * Set VLAN offload configuration on an Ethernet device
2327  * Enable/Disable Extended VLAN by an Ethernet device, This is a register setup
2328  * available on some Intel NIC, not but all, please check the data sheet for
2329  * availability.
2330  * Enable/Disable VLAN Strip can be done on rx queue for certain NIC, but here
2331  * the configuration is applied on the port level.
2332  *
2333  * @param port_id
2334  *   The port identifier of the Ethernet device.
2335  * @param offload_mask
2336  *   The VLAN Offload bit mask can be mixed use with "OR"
2337  *       ETH_VLAN_STRIP_OFFLOAD
2338  *       ETH_VLAN_FILTER_OFFLOAD
2339  *       ETH_VLAN_EXTEND_OFFLOAD
2340  * @return
2341  *   - (0) if successful.
2342  *   - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
2343  *   - (-ENODEV) if *port_id* invalid.
2344  *   - (-EIO) if device is removed.
2345  */
2346 int rte_eth_dev_set_vlan_offload(uint16_t port_id, int offload_mask);
2347
2348 /**
2349  * Read VLAN Offload configuration from an Ethernet device
2350  *
2351  * @param port_id
2352  *   The port identifier of the Ethernet device.
2353  * @return
2354  *   - (>0) if successful. Bit mask to indicate
2355  *       ETH_VLAN_STRIP_OFFLOAD
2356  *       ETH_VLAN_FILTER_OFFLOAD
2357  *       ETH_VLAN_EXTEND_OFFLOAD
2358  *   - (-ENODEV) if *port_id* invalid.
2359  */
2360 int rte_eth_dev_get_vlan_offload(uint16_t port_id);
2361
2362 /**
2363  * Set port based TX VLAN insertion on or off.
2364  *
2365  * @param port_id
2366  *  The port identifier of the Ethernet device.
2367  * @param pvid
2368  *  Port based TX VLAN identifier together with user priority.
2369  * @param on
2370  *  Turn on or off the port based TX VLAN insertion.
2371  *
2372  * @return
2373  *   - (0) if successful.
2374  *   - negative if failed.
2375  */
2376 int rte_eth_dev_set_vlan_pvid(uint16_t port_id, uint16_t pvid, int on);
2377
2378 typedef void (*buffer_tx_error_fn)(struct rte_mbuf **unsent, uint16_t count,
2379                 void *userdata);
2380
2381 /**
2382  * Structure used to buffer packets for future TX
2383  * Used by APIs rte_eth_tx_buffer and rte_eth_tx_buffer_flush
2384  */
2385 struct rte_eth_dev_tx_buffer {
2386         buffer_tx_error_fn error_callback;
2387         void *error_userdata;
2388         uint16_t size;           /**< Size of buffer for buffered tx */
2389         uint16_t length;         /**< Number of packets in the array */
2390         struct rte_mbuf *pkts[];
2391         /**< Pending packets to be sent on explicit flush or when full */
2392 };
2393
2394 /**
2395  * Calculate the size of the tx buffer.
2396  *
2397  * @param sz
2398  *   Number of stored packets.
2399  */
2400 #define RTE_ETH_TX_BUFFER_SIZE(sz) \
2401         (sizeof(struct rte_eth_dev_tx_buffer) + (sz) * sizeof(struct rte_mbuf *))
2402
2403 /**
2404  * Initialize default values for buffered transmitting
2405  *
2406  * @param buffer
2407  *   Tx buffer to be initialized.
2408  * @param size
2409  *   Buffer size
2410  * @return
2411  *   0 if no error
2412  */
2413 int
2414 rte_eth_tx_buffer_init(struct rte_eth_dev_tx_buffer *buffer, uint16_t size);
2415
2416 /**
2417  * Configure a callback for buffered packets which cannot be sent
2418  *
2419  * Register a specific callback to be called when an attempt is made to send
2420  * all packets buffered on an ethernet port, but not all packets can
2421  * successfully be sent. The callback registered here will be called only
2422  * from calls to rte_eth_tx_buffer() and rte_eth_tx_buffer_flush() APIs.
2423  * The default callback configured for each queue by default just frees the
2424  * packets back to the calling mempool. If additional behaviour is required,
2425  * for example, to count dropped packets, or to retry transmission of packets
2426  * which cannot be sent, this function should be used to register a suitable
2427  * callback function to implement the desired behaviour.
2428  * The example callback "rte_eth_count_unsent_packet_callback()" is also
2429  * provided as reference.
2430  *
2431  * @param buffer
2432  *   The port identifier of the Ethernet device.
2433  * @param callback
2434  *   The function to be used as the callback.
2435  * @param userdata
2436  *   Arbitrary parameter to be passed to the callback function
2437  * @return
2438  *   0 on success, or -1 on error with rte_errno set appropriately
2439  */
2440 int
2441 rte_eth_tx_buffer_set_err_callback(struct rte_eth_dev_tx_buffer *buffer,
2442                 buffer_tx_error_fn callback, void *userdata);
2443
2444 /**
2445  * Callback function for silently dropping unsent buffered packets.
2446  *
2447  * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
2448  * adjust the default behavior when buffered packets cannot be sent. This
2449  * function drops any unsent packets silently and is used by tx buffered
2450  * operations as default behavior.
2451  *
2452  * NOTE: this function should not be called directly, instead it should be used
2453  *       as a callback for packet buffering.
2454  *
2455  * NOTE: when configuring this function as a callback with
2456  *       rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
2457  *       should point to an uint64_t value.
2458  *
2459  * @param pkts
2460  *   The previously buffered packets which could not be sent
2461  * @param unsent
2462  *   The number of unsent packets in the pkts array
2463  * @param userdata
2464  *   Not used
2465  */
2466 void
2467 rte_eth_tx_buffer_drop_callback(struct rte_mbuf **pkts, uint16_t unsent,
2468                 void *userdata);
2469
2470 /**
2471  * Callback function for tracking unsent buffered packets.
2472  *
2473  * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
2474  * adjust the default behavior when buffered packets cannot be sent. This
2475  * function drops any unsent packets, but also updates a user-supplied counter
2476  * to track the overall number of packets dropped. The counter should be an
2477  * uint64_t variable.
2478  *
2479  * NOTE: this function should not be called directly, instead it should be used
2480  *       as a callback for packet buffering.
2481  *
2482  * NOTE: when configuring this function as a callback with
2483  *       rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter
2484  *       should point to an uint64_t value.
2485  *
2486  * @param pkts
2487  *   The previously buffered packets which could not be sent
2488  * @param unsent
2489  *   The number of unsent packets in the pkts array
2490  * @param userdata
2491  *   Pointer to an uint64_t value, which will be incremented by unsent
2492  */
2493 void
2494 rte_eth_tx_buffer_count_callback(struct rte_mbuf **pkts, uint16_t unsent,
2495                 void *userdata);
2496
2497 /**
2498  * Request the driver to free mbufs currently cached by the driver. The
2499  * driver will only free the mbuf if it is no longer in use. It is the
2500  * application's responsibity to ensure rte_eth_tx_buffer_flush(..) is
2501  * called if needed.
2502  *
2503  * @param port_id
2504  *   The port identifier of the Ethernet device.
2505  * @param queue_id
2506  *   The index of the transmit queue through which output packets must be
2507  *   sent.
2508  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
2509  *   to rte_eth_dev_configure().
2510  * @param free_cnt
2511  *   Maximum number of packets to free. Use 0 to indicate all possible packets
2512  *   should be freed. Note that a packet may be using multiple mbufs.
2513  * @return
2514  *   Failure: < 0
2515  *     -ENODEV: Invalid interface
2516  *     -EIO: device is removed
2517  *     -ENOTSUP: Driver does not support function
2518  *   Success: >= 0
2519  *     0-n: Number of packets freed. More packets may still remain in ring that
2520  *     are in use.
2521  */
2522 int
2523 rte_eth_tx_done_cleanup(uint16_t port_id, uint16_t queue_id, uint32_t free_cnt);
2524
2525 /**
2526  * Subtypes for IPsec offload event(@ref RTE_ETH_EVENT_IPSEC) raised by
2527  * eth device.
2528  */
2529 enum rte_eth_event_ipsec_subtype {
2530         RTE_ETH_EVENT_IPSEC_UNKNOWN = 0,
2531                         /**< Unknown event type */
2532         RTE_ETH_EVENT_IPSEC_ESN_OVERFLOW,
2533                         /**< Sequence number overflow */
2534         RTE_ETH_EVENT_IPSEC_SA_TIME_EXPIRY,
2535                         /**< Soft time expiry of SA */
2536         RTE_ETH_EVENT_IPSEC_SA_BYTE_EXPIRY,
2537                         /**< Soft byte expiry of SA */
2538         RTE_ETH_EVENT_IPSEC_MAX
2539                         /**< Max value of this enum */
2540 };
2541
2542 /**
2543  * Descriptor for @ref RTE_ETH_EVENT_IPSEC event. Used by eth dev to send extra
2544  * information of the IPsec offload event.
2545  */
2546 struct rte_eth_event_ipsec_desc {
2547         enum rte_eth_event_ipsec_subtype subtype;
2548                         /**< Type of RTE_ETH_EVENT_IPSEC_* event */
2549         uint64_t metadata;
2550                         /**< Event specific metadata
2551                          *
2552                          * For the following events, *userdata* registered
2553                          * with the *rte_security_session* would be returned
2554                          * as metadata,
2555                          *
2556                          * - @ref RTE_ETH_EVENT_IPSEC_ESN_OVERFLOW
2557                          * - @ref RTE_ETH_EVENT_IPSEC_SA_TIME_EXPIRY
2558                          * - @ref RTE_ETH_EVENT_IPSEC_SA_BYTE_EXPIRY
2559                          *
2560                          * @see struct rte_security_session_conf
2561                          *
2562                          */
2563 };
2564
2565 /**
2566  * The eth device event type for interrupt, and maybe others in the future.
2567  */
2568 enum rte_eth_event_type {
2569         RTE_ETH_EVENT_UNKNOWN,  /**< unknown event type */
2570         RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
2571         RTE_ETH_EVENT_QUEUE_STATE,
2572                                 /**< queue state event (enabled/disabled) */
2573         RTE_ETH_EVENT_INTR_RESET,
2574                         /**< reset interrupt event, sent to VF on PF reset */
2575         RTE_ETH_EVENT_VF_MBOX,  /**< message from the VF received by PF */
2576         RTE_ETH_EVENT_MACSEC,   /**< MACsec offload related event */
2577         RTE_ETH_EVENT_INTR_RMV, /**< device removal event */
2578         RTE_ETH_EVENT_NEW,      /**< port is probed */
2579         RTE_ETH_EVENT_DESTROY,  /**< port is released */
2580         RTE_ETH_EVENT_IPSEC,    /**< IPsec offload related event */
2581         RTE_ETH_EVENT_MAX       /**< max value of this enum */
2582 };
2583
2584 typedef int (*rte_eth_dev_cb_fn)(uint16_t port_id,
2585                 enum rte_eth_event_type event, void *cb_arg, void *ret_param);
2586 /**< user application callback to be registered for interrupts */
2587
2588 /**
2589  * Register a callback function for port event.
2590  *
2591  * @param port_id
2592  *  Port id.
2593  *  RTE_ETH_ALL means register the event for all port ids.
2594  * @param event
2595  *  Event interested.
2596  * @param cb_fn
2597  *  User supplied callback function to be called.
2598  * @param cb_arg
2599  *  Pointer to the parameters for the registered callback.
2600  *
2601  * @return
2602  *  - On success, zero.
2603  *  - On failure, a negative value.
2604  */
2605 int rte_eth_dev_callback_register(uint16_t port_id,
2606                         enum rte_eth_event_type event,
2607                 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
2608
2609 /**
2610  * Unregister a callback function for port event.
2611  *
2612  * @param port_id
2613  *  Port id.
2614  *  RTE_ETH_ALL means unregister the event for all port ids.
2615  * @param event
2616  *  Event interested.
2617  * @param cb_fn
2618  *  User supplied callback function to be called.
2619  * @param cb_arg
2620  *  Pointer to the parameters for the registered callback. -1 means to
2621  *  remove all for the same callback address and same event.
2622  *
2623  * @return
2624  *  - On success, zero.
2625  *  - On failure, a negative value.
2626  */
2627 int rte_eth_dev_callback_unregister(uint16_t port_id,
2628                         enum rte_eth_event_type event,
2629                 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
2630
2631 /**
2632  * When there is no rx packet coming in Rx Queue for a long time, we can
2633  * sleep lcore related to RX Queue for power saving, and enable rx interrupt
2634  * to be triggered when Rx packet arrives.
2635  *
2636  * The rte_eth_dev_rx_intr_enable() function enables rx queue
2637  * interrupt on specific rx queue of a port.
2638  *
2639  * @param port_id
2640  *   The port identifier of the Ethernet device.
2641  * @param queue_id
2642  *   The index of the receive queue from which to retrieve input packets.
2643  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
2644  *   to rte_eth_dev_configure().
2645  * @return
2646  *   - (0) if successful.
2647  *   - (-ENOTSUP) if underlying hardware OR driver doesn't support
2648  *     that operation.
2649  *   - (-ENODEV) if *port_id* invalid.
2650  *   - (-EIO) if device is removed.
2651  */
2652 int rte_eth_dev_rx_intr_enable(uint16_t port_id, uint16_t queue_id);
2653
2654 /**
2655  * When lcore wakes up from rx interrupt indicating packet coming, disable rx
2656  * interrupt and returns to polling mode.
2657  *
2658  * The rte_eth_dev_rx_intr_disable() function disables rx queue
2659  * interrupt on specific rx queue of a port.
2660  *
2661  * @param port_id
2662  *   The port identifier of the Ethernet device.
2663  * @param queue_id
2664  *   The index of the receive queue from which to retrieve input packets.
2665  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
2666  *   to rte_eth_dev_configure().
2667  * @return
2668  *   - (0) if successful.
2669  *   - (-ENOTSUP) if underlying hardware OR driver doesn't support
2670  *     that operation.
2671  *   - (-ENODEV) if *port_id* invalid.
2672  *   - (-EIO) if device is removed.
2673  */
2674 int rte_eth_dev_rx_intr_disable(uint16_t port_id, uint16_t queue_id);
2675
2676 /**
2677  * RX Interrupt control per port.
2678  *
2679  * @param port_id
2680  *   The port identifier of the Ethernet device.
2681  * @param epfd
2682  *   Epoll instance fd which the intr vector associated to.
2683  *   Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
2684  * @param op
2685  *   The operation be performed for the vector.
2686  *   Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
2687  * @param data
2688  *   User raw data.
2689  * @return
2690  *   - On success, zero.
2691  *   - On failure, a negative value.
2692  */
2693 int rte_eth_dev_rx_intr_ctl(uint16_t port_id, int epfd, int op, void *data);
2694
2695 /**
2696  * RX Interrupt control per queue.
2697  *
2698  * @param port_id
2699  *   The port identifier of the Ethernet device.
2700  * @param queue_id
2701  *   The index of the receive queue from which to retrieve input packets.
2702  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
2703  *   to rte_eth_dev_configure().
2704  * @param epfd
2705  *   Epoll instance fd which the intr vector associated to.
2706  *   Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance.
2707  * @param op
2708  *   The operation be performed for the vector.
2709  *   Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}.
2710  * @param data
2711  *   User raw data.
2712  * @return
2713  *   - On success, zero.
2714  *   - On failure, a negative value.
2715  */
2716 int rte_eth_dev_rx_intr_ctl_q(uint16_t port_id, uint16_t queue_id,
2717                               int epfd, int op, void *data);
2718
2719 /**
2720  * Turn on the LED on the Ethernet device.
2721  * This function turns on the LED on the Ethernet device.
2722  *
2723  * @param port_id
2724  *   The port identifier of the Ethernet device.
2725  * @return
2726  *   - (0) if successful.
2727  *   - (-ENOTSUP) if underlying hardware OR driver doesn't support
2728  *     that operation.
2729  *   - (-ENODEV) if *port_id* invalid.
2730  *   - (-EIO) if device is removed.
2731  */
2732 int  rte_eth_led_on(uint16_t port_id);
2733
2734 /**
2735  * Turn off the LED on the Ethernet device.
2736  * This function turns off the LED on the Ethernet device.
2737  *
2738  * @param port_id
2739  *   The port identifier of the Ethernet device.
2740  * @return
2741  *   - (0) if successful.
2742  *   - (-ENOTSUP) if underlying hardware OR driver doesn't support
2743  *     that operation.
2744  *   - (-ENODEV) if *port_id* invalid.
2745  *   - (-EIO) if device is removed.
2746  */
2747 int  rte_eth_led_off(uint16_t port_id);
2748
2749 /**
2750  * Get current status of the Ethernet link flow control for Ethernet device
2751  *
2752  * @param port_id
2753  *   The port identifier of the Ethernet device.
2754  * @param fc_conf
2755  *   The pointer to the structure where to store the flow control parameters.
2756  * @return
2757  *   - (0) if successful.
2758  *   - (-ENOTSUP) if hardware doesn't support flow control.
2759  *   - (-ENODEV)  if *port_id* invalid.
2760  *   - (-EIO)  if device is removed.
2761  */
2762 int rte_eth_dev_flow_ctrl_get(uint16_t port_id,
2763                               struct rte_eth_fc_conf *fc_conf);
2764
2765 /**
2766  * Configure the Ethernet link flow control for Ethernet device
2767  *
2768  * @param port_id
2769  *   The port identifier of the Ethernet device.
2770  * @param fc_conf
2771  *   The pointer to the structure of the flow control parameters.
2772  * @return
2773  *   - (0) if successful.
2774  *   - (-ENOTSUP) if hardware doesn't support flow control mode.
2775  *   - (-ENODEV)  if *port_id* invalid.
2776  *   - (-EINVAL)  if bad parameter
2777  *   - (-EIO)     if flow control setup failure or device is removed.
2778  */
2779 int rte_eth_dev_flow_ctrl_set(uint16_t port_id,
2780                               struct rte_eth_fc_conf *fc_conf);
2781
2782 /**
2783  * Configure the Ethernet priority flow control under DCB environment
2784  * for Ethernet device.
2785  *
2786  * @param port_id
2787  * The port identifier of the Ethernet device.
2788  * @param pfc_conf
2789  * The pointer to the structure of the priority flow control parameters.
2790  * @return
2791  *   - (0) if successful.
2792  *   - (-ENOTSUP) if hardware doesn't support priority flow control mode.
2793  *   - (-ENODEV)  if *port_id* invalid.
2794  *   - (-EINVAL)  if bad parameter
2795  *   - (-EIO)     if flow control setup failure or device is removed.
2796  */
2797 int rte_eth_dev_priority_flow_ctrl_set(uint16_t port_id,
2798                                 struct rte_eth_pfc_conf *pfc_conf);
2799
2800 /**
2801  * Add a MAC address to an internal array of addresses used to enable whitelist
2802  * filtering to accept packets only if the destination MAC address matches.
2803  *
2804  * @param port_id
2805  *   The port identifier of the Ethernet device.
2806  * @param mac_addr
2807  *   The MAC address to add.
2808  * @param pool
2809  *   VMDq pool index to associate address with (if VMDq is enabled). If VMDq is
2810  *   not enabled, this should be set to 0.
2811  * @return
2812  *   - (0) if successfully added or *mac_addr* was already added.
2813  *   - (-ENOTSUP) if hardware doesn't support this feature.
2814  *   - (-ENODEV) if *port* is invalid.
2815  *   - (-EIO) if device is removed.
2816  *   - (-ENOSPC) if no more MAC addresses can be added.
2817  *   - (-EINVAL) if MAC address is invalid.
2818  */
2819 int rte_eth_dev_mac_addr_add(uint16_t port_id, struct ether_addr *mac_addr,
2820                                 uint32_t pool);
2821
2822 /**
2823  * Remove a MAC address from the internal array of addresses.
2824  *
2825  * @param port_id
2826  *   The port identifier of the Ethernet device.
2827  * @param mac_addr
2828  *   MAC address to remove.
2829  * @return
2830  *   - (0) if successful, or *mac_addr* didn't exist.
2831  *   - (-ENOTSUP) if hardware doesn't support.
2832  *   - (-ENODEV) if *port* invalid.
2833  *   - (-EADDRINUSE) if attempting to remove the default MAC address
2834  */
2835 int rte_eth_dev_mac_addr_remove(uint16_t port_id, struct ether_addr *mac_addr);
2836
2837 /**
2838  * Set the default MAC address.
2839  *
2840  * @param port_id
2841  *   The port identifier of the Ethernet device.
2842  * @param mac_addr
2843  *   New default MAC address.
2844  * @return
2845  *   - (0) if successful, or *mac_addr* didn't exist.
2846  *   - (-ENOTSUP) if hardware doesn't support.
2847  *   - (-ENODEV) if *port* invalid.
2848  *   - (-EINVAL) if MAC address is invalid.
2849  */
2850 int rte_eth_dev_default_mac_addr_set(uint16_t port_id,
2851                 struct ether_addr *mac_addr);
2852
2853 /**
2854  * Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
2855  *
2856  * @param port_id
2857  *   The port identifier of the Ethernet device.
2858  * @param reta_conf
2859  *   RETA to update.
2860  * @param reta_size
2861  *   Redirection table size. The table size can be queried by
2862  *   rte_eth_dev_info_get().
2863  * @return
2864  *   - (0) if successful.
2865  *   - (-ENOTSUP) if hardware doesn't support.
2866  *   - (-EINVAL) if bad parameter.
2867  *   - (-EIO) if device is removed.
2868  */
2869 int rte_eth_dev_rss_reta_update(uint16_t port_id,
2870                                 struct rte_eth_rss_reta_entry64 *reta_conf,
2871                                 uint16_t reta_size);
2872
2873  /**
2874  * Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
2875  *
2876  * @param port_id
2877  *   The port identifier of the Ethernet device.
2878  * @param reta_conf
2879  *   RETA to query.
2880  * @param reta_size
2881  *   Redirection table size. The table size can be queried by
2882  *   rte_eth_dev_info_get().
2883  * @return
2884  *   - (0) if successful.
2885  *   - (-ENOTSUP) if hardware doesn't support.
2886  *   - (-EINVAL) if bad parameter.
2887  *   - (-EIO) if device is removed.
2888  */
2889 int rte_eth_dev_rss_reta_query(uint16_t port_id,
2890                                struct rte_eth_rss_reta_entry64 *reta_conf,
2891                                uint16_t reta_size);
2892
2893  /**
2894  * Updates unicast hash table for receiving packet with the given destination
2895  * MAC address, and the packet is routed to all VFs for which the RX mode is
2896  * accept packets that match the unicast hash table.
2897  *
2898  * @param port_id
2899  *   The port identifier of the Ethernet device.
2900  * @param addr
2901  *   Unicast MAC address.
2902  * @param on
2903  *    1 - Set an unicast hash bit for receiving packets with the MAC address.
2904  *    0 - Clear an unicast hash bit.
2905  * @return
2906  *   - (0) if successful.
2907  *   - (-ENOTSUP) if hardware doesn't support.
2908   *  - (-ENODEV) if *port_id* invalid.
2909  *   - (-EIO) if device is removed.
2910  *   - (-EINVAL) if bad parameter.
2911  */
2912 int rte_eth_dev_uc_hash_table_set(uint16_t port_id, struct ether_addr *addr,
2913                                   uint8_t on);
2914
2915  /**
2916  * Updates all unicast hash bitmaps for receiving packet with any Unicast
2917  * Ethernet MAC addresses,the packet is routed to all VFs for which the RX
2918  * mode is accept packets that match the unicast hash table.
2919  *
2920  * @param port_id
2921  *   The port identifier of the Ethernet device.
2922  * @param on
2923  *    1 - Set all unicast hash bitmaps for receiving all the Ethernet
2924  *         MAC addresses
2925  *    0 - Clear all unicast hash bitmaps
2926  * @return
2927  *   - (0) if successful.
2928  *   - (-ENOTSUP) if hardware doesn't support.
2929   *  - (-ENODEV) if *port_id* invalid.
2930  *   - (-EIO) if device is removed.
2931  *   - (-EINVAL) if bad parameter.
2932  */
2933 int rte_eth_dev_uc_all_hash_table_set(uint16_t port_id, uint8_t on);
2934
2935 /**
2936  * Set a traffic mirroring rule on an Ethernet device
2937  *
2938  * @param port_id
2939  *   The port identifier of the Ethernet device.
2940  * @param mirror_conf
2941  *   The pointer to the traffic mirroring structure describing the mirroring rule.
2942  *   The *rte_eth_vm_mirror_conf* structure includes the type of mirroring rule,
2943  *   destination pool and the value of rule if enable vlan or pool mirroring.
2944  *
2945  * @param rule_id
2946  *   The index of traffic mirroring rule, we support four separated rules.
2947  * @param on
2948  *   1 - Enable a mirroring rule.
2949  *   0 - Disable a mirroring rule.
2950  * @return
2951  *   - (0) if successful.
2952  *   - (-ENOTSUP) if hardware doesn't support this feature.
2953  *   - (-ENODEV) if *port_id* invalid.
2954  *   - (-EIO) if device is removed.
2955  *   - (-EINVAL) if the mr_conf information is not correct.
2956  */
2957 int rte_eth_mirror_rule_set(uint16_t port_id,
2958                         struct rte_eth_mirror_conf *mirror_conf,
2959                         uint8_t rule_id,
2960                         uint8_t on);
2961
2962 /**
2963  * Reset a traffic mirroring rule on an Ethernet device.
2964  *
2965  * @param port_id
2966  *   The port identifier of the Ethernet device.
2967  * @param rule_id
2968  *   The index of traffic mirroring rule, we support four separated rules.
2969  * @return
2970  *   - (0) if successful.
2971  *   - (-ENOTSUP) if hardware doesn't support this feature.
2972  *   - (-ENODEV) if *port_id* invalid.
2973  *   - (-EIO) if device is removed.
2974  *   - (-EINVAL) if bad parameter.
2975  */
2976 int rte_eth_mirror_rule_reset(uint16_t port_id,
2977                                          uint8_t rule_id);
2978
2979 /**
2980  * Set the rate limitation for a queue on an Ethernet device.
2981  *
2982  * @param port_id
2983  *   The port identifier of the Ethernet device.
2984  * @param queue_idx
2985  *   The queue id.
2986  * @param tx_rate
2987  *   The tx rate in Mbps. Allocated from the total port link speed.
2988  * @return
2989  *   - (0) if successful.
2990  *   - (-ENOTSUP) if hardware doesn't support this feature.
2991  *   - (-ENODEV) if *port_id* invalid.
2992  *   - (-EIO) if device is removed.
2993  *   - (-EINVAL) if bad parameter.
2994  */
2995 int rte_eth_set_queue_rate_limit(uint16_t port_id, uint16_t queue_idx,
2996                         uint16_t tx_rate);
2997
2998  /**
2999  * Configuration of Receive Side Scaling hash computation of Ethernet device.
3000  *
3001  * @param port_id
3002  *   The port identifier of the Ethernet device.
3003  * @param rss_conf
3004  *   The new configuration to use for RSS hash computation on the port.
3005  * @return
3006  *   - (0) if successful.
3007  *   - (-ENODEV) if port identifier is invalid.
3008  *   - (-EIO) if device is removed.
3009  *   - (-ENOTSUP) if hardware doesn't support.
3010  *   - (-EINVAL) if bad parameter.
3011  */
3012 int rte_eth_dev_rss_hash_update(uint16_t port_id,
3013                                 struct rte_eth_rss_conf *rss_conf);
3014
3015  /**
3016  * Retrieve current configuration of Receive Side Scaling hash computation
3017  * of Ethernet device.
3018  *
3019  * @param port_id
3020  *   The port identifier of the Ethernet device.
3021  * @param rss_conf
3022  *   Where to store the current RSS hash configuration of the Ethernet device.
3023  * @return
3024  *   - (0) if successful.
3025  *   - (-ENODEV) if port identifier is invalid.
3026  *   - (-EIO) if device is removed.
3027  *   - (-ENOTSUP) if hardware doesn't support RSS.
3028  */
3029 int
3030 rte_eth_dev_rss_hash_conf_get(uint16_t port_id,
3031                               struct rte_eth_rss_conf *rss_conf);
3032
3033  /**
3034  * Add UDP tunneling port for a specific type of tunnel.
3035  * The packets with this UDP port will be identified as this type of tunnel.
3036  * Before enabling any offloading function for a tunnel, users can call this API
3037  * to change or add more UDP port for the tunnel. So the offloading function
3038  * can take effect on the packets with the specific UDP port.
3039  *
3040  * @param port_id
3041  *   The port identifier of the Ethernet device.
3042  * @param tunnel_udp
3043  *   UDP tunneling configuration.
3044  *
3045  * @return
3046  *   - (0) if successful.
3047  *   - (-ENODEV) if port identifier is invalid.
3048  *   - (-EIO) if device is removed.
3049  *   - (-ENOTSUP) if hardware doesn't support tunnel type.
3050  */
3051 int
3052 rte_eth_dev_udp_tunnel_port_add(uint16_t port_id,
3053                                 struct rte_eth_udp_tunnel *tunnel_udp);
3054
3055  /**
3056  * Delete UDP tunneling port a specific type of tunnel.
3057  * The packets with this UDP port will not be identified as this type of tunnel
3058  * any more.
3059  * Before enabling any offloading function for a tunnel, users can call this API
3060  * to delete a UDP port for the tunnel. So the offloading function will not take
3061  * 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_delete(uint16_t port_id,
3076                                    struct rte_eth_udp_tunnel *tunnel_udp);
3077
3078 /**
3079  * Check whether the filter type is supported on an Ethernet device.
3080  * All the supported filter types are defined in 'rte_eth_ctrl.h'.
3081  *
3082  * @param port_id
3083  *   The port identifier of the Ethernet device.
3084  * @param filter_type
3085  *   Filter type.
3086  * @return
3087  *   - (0) if successful.
3088  *   - (-ENOTSUP) if hardware doesn't support this filter type.
3089  *   - (-ENODEV) if *port_id* invalid.
3090  *   - (-EIO) if device is removed.
3091  */
3092 int rte_eth_dev_filter_supported(uint16_t port_id,
3093                 enum rte_filter_type filter_type);
3094
3095 /**
3096  * Take operations to assigned filter type on an Ethernet device.
3097  * All the supported operations and filter types are defined in 'rte_eth_ctrl.h'.
3098  *
3099  * @param port_id
3100  *   The port identifier of the Ethernet device.
3101  * @param filter_type
3102  *   Filter type.
3103  * @param filter_op
3104  *   Type of operation.
3105  * @param arg
3106  *   A pointer to arguments defined specifically for the operation.
3107  * @return
3108  *   - (0) if successful.
3109  *   - (-ENOTSUP) if hardware doesn't support.
3110  *   - (-ENODEV) if *port_id* invalid.
3111  *   - (-EIO) if device is removed.
3112  *   - others depends on the specific operations implementation.
3113  */
3114 int rte_eth_dev_filter_ctrl(uint16_t port_id, enum rte_filter_type filter_type,
3115                         enum rte_filter_op filter_op, void *arg);
3116
3117 /**
3118  * Get DCB information on an Ethernet device.
3119  *
3120  * @param port_id
3121  *   The port identifier of the Ethernet device.
3122  * @param dcb_info
3123  *   dcb information.
3124  * @return
3125  *   - (0) if successful.
3126  *   - (-ENODEV) if port identifier is invalid.
3127  *   - (-EIO) if device is removed.
3128  *   - (-ENOTSUP) if hardware doesn't support.
3129  */
3130 int rte_eth_dev_get_dcb_info(uint16_t port_id,
3131                              struct rte_eth_dcb_info *dcb_info);
3132
3133 struct rte_eth_rxtx_callback;
3134
3135 /**
3136  * Add a callback to be called on packet RX on a given port and queue.
3137  *
3138  * This API configures a function to be called for each burst of
3139  * packets received on a given NIC port queue. The return value is a pointer
3140  * that can be used to later remove the callback using
3141  * rte_eth_remove_rx_callback().
3142  *
3143  * Multiple functions are called in the order that they are added.
3144  *
3145  * @param port_id
3146  *   The port identifier of the Ethernet device.
3147  * @param queue_id
3148  *   The queue on the Ethernet device on which the callback is to be added.
3149  * @param fn
3150  *   The callback function
3151  * @param user_param
3152  *   A generic pointer parameter which will be passed to each invocation of the
3153  *   callback function on this port and queue.
3154  *
3155  * @return
3156  *   NULL on error.
3157  *   On success, a pointer value which can later be used to remove the callback.
3158  */
3159 const struct rte_eth_rxtx_callback *
3160 rte_eth_add_rx_callback(uint16_t port_id, uint16_t queue_id,
3161                 rte_rx_callback_fn fn, void *user_param);
3162
3163 /**
3164  * Add a callback that must be called first on packet RX on a given port
3165  * and queue.
3166  *
3167  * This API configures a first function to be called for each burst of
3168  * packets received on a given NIC port queue. The return value is a pointer
3169  * that can be used to later remove the callback using
3170  * rte_eth_remove_rx_callback().
3171  *
3172  * Multiple functions are called in the order that they are added.
3173  *
3174  * @param port_id
3175  *   The port identifier of the Ethernet device.
3176  * @param queue_id
3177  *   The queue on the Ethernet device on which the callback is to be added.
3178  * @param fn
3179  *   The callback function
3180  * @param user_param
3181  *   A generic pointer parameter which will be passed to each invocation of the
3182  *   callback function on this port and queue.
3183  *
3184  * @return
3185  *   NULL on error.
3186  *   On success, a pointer value which can later be used to remove the callback.
3187  */
3188 const struct rte_eth_rxtx_callback *
3189 rte_eth_add_first_rx_callback(uint16_t port_id, uint16_t queue_id,
3190                 rte_rx_callback_fn fn, void *user_param);
3191
3192 /**
3193  * Add a callback to be called on packet TX on a given port and queue.
3194  *
3195  * This API configures a function to be called for each burst of
3196  * packets sent on a given NIC port queue. The return value is a pointer
3197  * that can be used to later remove the callback using
3198  * rte_eth_remove_tx_callback().
3199  *
3200  * Multiple functions are called in the order that they are added.
3201  *
3202  * @param port_id
3203  *   The port identifier of the Ethernet device.
3204  * @param queue_id
3205  *   The queue on the Ethernet device on which the callback is to be added.
3206  * @param fn
3207  *   The callback function
3208  * @param user_param
3209  *   A generic pointer parameter which will be passed to each invocation of the
3210  *   callback function on this port and queue.
3211  *
3212  * @return
3213  *   NULL on error.
3214  *   On success, a pointer value which can later be used to remove the callback.
3215  */
3216 const struct rte_eth_rxtx_callback *
3217 rte_eth_add_tx_callback(uint16_t port_id, uint16_t queue_id,
3218                 rte_tx_callback_fn fn, void *user_param);
3219
3220 /**
3221  * Remove an RX packet callback from a given port and queue.
3222  *
3223  * This function is used to removed callbacks that were added to a NIC port
3224  * queue using rte_eth_add_rx_callback().
3225  *
3226  * Note: the callback is removed from the callback list but it isn't freed
3227  * since the it may still be in use. The memory for the callback can be
3228  * subsequently freed back by the application by calling rte_free():
3229  *
3230  * - Immediately - if the port is stopped, or the user knows that no
3231  *   callbacks are in flight e.g. if called from the thread doing RX/TX
3232  *   on that queue.
3233  *
3234  * - After a short delay - where the delay is sufficient to allow any
3235  *   in-flight callbacks to complete.
3236  *
3237  * @param port_id
3238  *   The port identifier of the Ethernet device.
3239  * @param queue_id
3240  *   The queue on the Ethernet device from which the callback is to be removed.
3241  * @param user_cb
3242  *   User supplied callback created via rte_eth_add_rx_callback().
3243  *
3244  * @return
3245  *   - 0: Success. Callback was removed.
3246  *   - -ENOTSUP: Callback support is not available.
3247  *   - -EINVAL:  The port_id or the queue_id is out of range, or the callback
3248  *               is NULL or not found for the port/queue.
3249  */
3250 int rte_eth_remove_rx_callback(uint16_t port_id, uint16_t queue_id,
3251                 const struct rte_eth_rxtx_callback *user_cb);
3252
3253 /**
3254  * Remove a TX packet callback from a given port and queue.
3255  *
3256  * This function is used to removed callbacks that were added to a NIC port
3257  * queue using rte_eth_add_tx_callback().
3258  *
3259  * Note: the callback is removed from the callback list but it isn't freed
3260  * since the it may still be in use. The memory for the callback can be
3261  * subsequently freed back by the application by calling rte_free():
3262  *
3263  * - Immediately - if the port is stopped, or the user knows that no
3264  *   callbacks are in flight e.g. if called from the thread doing RX/TX
3265  *   on that queue.
3266  *
3267  * - After a short delay - where the delay is sufficient to allow any
3268  *   in-flight callbacks to complete.
3269  *
3270  * @param port_id
3271  *   The port identifier of the Ethernet device.
3272  * @param queue_id
3273  *   The queue on the Ethernet device from which the callback is to be removed.
3274  * @param user_cb
3275  *   User supplied callback created via rte_eth_add_tx_callback().
3276  *
3277  * @return
3278  *   - 0: Success. Callback was removed.
3279  *   - -ENOTSUP: Callback support is not available.
3280  *   - -EINVAL:  The port_id or the queue_id is out of range, or the callback
3281  *               is NULL or not found for the port/queue.
3282  */
3283 int rte_eth_remove_tx_callback(uint16_t port_id, uint16_t queue_id,
3284                 const struct rte_eth_rxtx_callback *user_cb);
3285
3286 /**
3287  * Retrieve information about given port's RX queue.
3288  *
3289  * @param port_id
3290  *   The port identifier of the Ethernet device.
3291  * @param queue_id
3292  *   The RX queue on the Ethernet device for which information
3293  *   will be retrieved.
3294  * @param qinfo
3295  *   A pointer to a structure of type *rte_eth_rxq_info_info* to be filled with
3296  *   the information of the Ethernet device.
3297  *
3298  * @return
3299  *   - 0: Success
3300  *   - -ENOTSUP: routine is not supported by the device PMD.
3301  *   - -EINVAL:  The port_id or the queue_id is out of range.
3302  */
3303 int rte_eth_rx_queue_info_get(uint16_t port_id, uint16_t queue_id,
3304         struct rte_eth_rxq_info *qinfo);
3305
3306 /**
3307  * Retrieve information about given port's TX queue.
3308  *
3309  * @param port_id
3310  *   The port identifier of the Ethernet device.
3311  * @param queue_id
3312  *   The TX queue on the Ethernet device for which information
3313  *   will be retrieved.
3314  * @param qinfo
3315  *   A pointer to a structure of type *rte_eth_txq_info_info* to be filled with
3316  *   the information of the Ethernet device.
3317  *
3318  * @return
3319  *   - 0: Success
3320  *   - -ENOTSUP: routine is not supported by the device PMD.
3321  *   - -EINVAL:  The port_id or the queue_id is out of range.
3322  */
3323 int rte_eth_tx_queue_info_get(uint16_t port_id, uint16_t queue_id,
3324         struct rte_eth_txq_info *qinfo);
3325
3326 /**
3327  * Retrieve device registers and register attributes (number of registers and
3328  * register size)
3329  *
3330  * @param port_id
3331  *   The port identifier of the Ethernet device.
3332  * @param info
3333  *   Pointer to rte_dev_reg_info structure to fill in. If info->data is
3334  *   NULL the function fills in the width and length fields. If non-NULL
3335  *   the registers are put into the buffer pointed at by the data field.
3336  * @return
3337  *   - (0) if successful.
3338  *   - (-ENOTSUP) if hardware doesn't support.
3339  *   - (-ENODEV) if *port_id* invalid.
3340  *   - (-EIO) if device is removed.
3341  *   - others depends on the specific operations implementation.
3342  */
3343 int rte_eth_dev_get_reg_info(uint16_t port_id, struct rte_dev_reg_info *info);
3344
3345 /**
3346  * Retrieve size of device EEPROM
3347  *
3348  * @param port_id
3349  *   The port identifier of the Ethernet device.
3350  * @return
3351  *   - (>=0) EEPROM size if successful.
3352  *   - (-ENOTSUP) if hardware doesn't support.
3353  *   - (-ENODEV) if *port_id* invalid.
3354  *   - (-EIO) if device is removed.
3355  *   - others depends on the specific operations implementation.
3356  */
3357 int rte_eth_dev_get_eeprom_length(uint16_t port_id);
3358
3359 /**
3360  * Retrieve EEPROM and EEPROM attribute
3361  *
3362  * @param port_id
3363  *   The port identifier of the Ethernet device.
3364  * @param info
3365  *   The template includes buffer for return EEPROM data and
3366  *   EEPROM attributes to be filled.
3367  * @return
3368  *   - (0) if successful.
3369  *   - (-ENOTSUP) if hardware doesn't support.
3370  *   - (-ENODEV) if *port_id* invalid.
3371  *   - (-EIO) if device is removed.
3372  *   - others depends on the specific operations implementation.
3373  */
3374 int rte_eth_dev_get_eeprom(uint16_t port_id, struct rte_dev_eeprom_info *info);
3375
3376 /**
3377  * Program EEPROM with provided data
3378  *
3379  * @param port_id
3380  *   The port identifier of the Ethernet device.
3381  * @param info
3382  *   The template includes EEPROM data for programming and
3383  *   EEPROM attributes to be filled
3384  * @return
3385  *   - (0) if successful.
3386  *   - (-ENOTSUP) if hardware doesn't support.
3387  *   - (-ENODEV) if *port_id* invalid.
3388  *   - (-EIO) if device is removed.
3389  *   - others depends on the specific operations implementation.
3390  */
3391 int rte_eth_dev_set_eeprom(uint16_t port_id, struct rte_dev_eeprom_info *info);
3392
3393 /**
3394  * @warning
3395  * @b EXPERIMENTAL: this API may change without prior notice.
3396  *
3397  * Retrieve the type and size of plugin module EEPROM
3398  *
3399  * @param port_id
3400  *   The port identifier of the Ethernet device.
3401  * @param modinfo
3402  *   The type and size of plugin module EEPROM.
3403  * @return
3404  *   - (0) if successful.
3405  *   - (-ENOTSUP) if hardware doesn't support.
3406  *   - (-ENODEV) if *port_id* invalid.
3407  *   - (-EIO) if device is removed.
3408  *   - others depends on the specific operations implementation.
3409  */
3410 int __rte_experimental
3411 rte_eth_dev_get_module_info(uint16_t port_id,
3412                             struct rte_eth_dev_module_info *modinfo);
3413
3414 /**
3415  * @warning
3416  * @b EXPERIMENTAL: this API may change without prior notice.
3417  *
3418  * Retrieve the data of plugin module EEPROM
3419  *
3420  * @param port_id
3421  *   The port identifier of the Ethernet device.
3422  * @param info
3423  *   The template includes the plugin module EEPROM attributes, and the
3424  *   buffer for return plugin module EEPROM data.
3425  * @return
3426  *   - (0) if successful.
3427  *   - (-ENOTSUP) if hardware doesn't support.
3428  *   - (-ENODEV) if *port_id* invalid.
3429  *   - (-EIO) if device is removed.
3430  *   - others depends on the specific operations implementation.
3431  */
3432 int __rte_experimental
3433 rte_eth_dev_get_module_eeprom(uint16_t port_id,
3434                               struct rte_dev_eeprom_info *info);
3435
3436 /**
3437  * Set the list of multicast addresses to filter on an Ethernet device.
3438  *
3439  * @param port_id
3440  *   The port identifier of the Ethernet device.
3441  * @param mc_addr_set
3442  *   The array of multicast addresses to set. Equal to NULL when the function
3443  *   is invoked to flush the set of filtered addresses.
3444  * @param nb_mc_addr
3445  *   The number of multicast addresses in the *mc_addr_set* array. Equal to 0
3446  *   when the function is invoked to flush the set of filtered addresses.
3447  * @return
3448  *   - (0) if successful.
3449  *   - (-ENODEV) if *port_id* invalid.
3450  *   - (-EIO) if device is removed.
3451  *   - (-ENOTSUP) if PMD of *port_id* doesn't support multicast filtering.
3452  *   - (-ENOSPC) if *port_id* has not enough multicast filtering resources.
3453  */
3454 int rte_eth_dev_set_mc_addr_list(uint16_t port_id,
3455                                  struct ether_addr *mc_addr_set,
3456                                  uint32_t nb_mc_addr);
3457
3458 /**
3459  * Enable IEEE1588/802.1AS timestamping for an Ethernet device.
3460  *
3461  * @param port_id
3462  *   The port identifier of the Ethernet device.
3463  *
3464  * @return
3465  *   - 0: Success.
3466  *   - -ENODEV: The port ID is invalid.
3467  *   - -EIO: if device is removed.
3468  *   - -ENOTSUP: The function is not supported by the Ethernet driver.
3469  */
3470 int rte_eth_timesync_enable(uint16_t port_id);
3471
3472 /**
3473  * Disable IEEE1588/802.1AS timestamping for an Ethernet device.
3474  *
3475  * @param port_id
3476  *   The port identifier of the Ethernet device.
3477  *
3478  * @return
3479  *   - 0: Success.
3480  *   - -ENODEV: The port ID is invalid.
3481  *   - -EIO: if device is removed.
3482  *   - -ENOTSUP: The function is not supported by the Ethernet driver.
3483  */
3484 int rte_eth_timesync_disable(uint16_t port_id);
3485
3486 /**
3487  * Read an IEEE1588/802.1AS RX timestamp from an Ethernet device.
3488  *
3489  * @param port_id
3490  *   The port identifier of the Ethernet device.
3491  * @param timestamp
3492  *   Pointer to the timestamp struct.
3493  * @param flags
3494  *   Device specific flags. Used to pass the RX timesync register index to
3495  *   i40e. Unused in igb/ixgbe, pass 0 instead.
3496  *
3497  * @return
3498  *   - 0: Success.
3499  *   - -EINVAL: No timestamp is available.
3500  *   - -ENODEV: The port ID is invalid.
3501  *   - -EIO: if device is removed.
3502  *   - -ENOTSUP: The function is not supported by the Ethernet driver.
3503  */
3504 int rte_eth_timesync_read_rx_timestamp(uint16_t port_id,
3505                 struct timespec *timestamp, uint32_t flags);
3506
3507 /**
3508  * Read an IEEE1588/802.1AS TX timestamp from an Ethernet device.
3509  *
3510  * @param port_id
3511  *   The port identifier of the Ethernet device.
3512  * @param timestamp
3513  *   Pointer to the timestamp struct.
3514  *
3515  * @return
3516  *   - 0: Success.
3517  *   - -EINVAL: No timestamp is available.
3518  *   - -ENODEV: The port ID is invalid.
3519  *   - -EIO: if device is removed.
3520  *   - -ENOTSUP: The function is not supported by the Ethernet driver.
3521  */
3522 int rte_eth_timesync_read_tx_timestamp(uint16_t port_id,
3523                 struct timespec *timestamp);
3524
3525 /**
3526  * Adjust the timesync clock on an Ethernet device.
3527  *
3528  * This is usually used in conjunction with other Ethdev timesync functions to
3529  * synchronize the device time using the IEEE1588/802.1AS protocol.
3530  *
3531  * @param port_id
3532  *   The port identifier of the Ethernet device.
3533  * @param delta
3534  *   The adjustment in nanoseconds.
3535  *
3536  * @return
3537  *   - 0: Success.
3538  *   - -ENODEV: The port ID is invalid.
3539  *   - -EIO: if device is removed.
3540  *   - -ENOTSUP: The function is not supported by the Ethernet driver.
3541  */
3542 int rte_eth_timesync_adjust_time(uint16_t port_id, int64_t delta);
3543
3544 /**
3545  * Read the time from the timesync clock on an Ethernet device.
3546  *
3547  * This is usually used in conjunction with other Ethdev timesync functions to
3548  * synchronize the device time using the IEEE1588/802.1AS protocol.
3549  *
3550  * @param port_id
3551  *   The port identifier of the Ethernet device.
3552  * @param time
3553  *   Pointer to the timespec struct that holds the time.
3554  *
3555  * @return
3556  *   - 0: Success.
3557  */
3558 int rte_eth_timesync_read_time(uint16_t port_id, struct timespec *time);
3559
3560 /**
3561  * Set the time of the timesync clock on an Ethernet device.
3562  *
3563  * This is usually used in conjunction with other Ethdev timesync functions to
3564  * synchronize the device time using the IEEE1588/802.1AS protocol.
3565  *
3566  * @param port_id
3567  *   The port identifier of the Ethernet device.
3568  * @param time
3569  *   Pointer to the timespec struct that holds the time.
3570  *
3571  * @return
3572  *   - 0: Success.
3573  *   - -EINVAL: No timestamp is available.
3574  *   - -ENODEV: The port ID is invalid.
3575  *   - -EIO: if device is removed.
3576  *   - -ENOTSUP: The function is not supported by the Ethernet driver.
3577  */
3578 int rte_eth_timesync_write_time(uint16_t port_id, const struct timespec *time);
3579
3580 /**
3581  * Config l2 tunnel ether type of an Ethernet device for filtering specific
3582  * tunnel packets by ether type.
3583  *
3584  * @param port_id
3585  *   The port identifier of the Ethernet device.
3586  * @param l2_tunnel
3587  *   l2 tunnel configuration.
3588  *
3589  * @return
3590  *   - (0) if successful.
3591  *   - (-ENODEV) if port identifier is invalid.
3592  *   - (-EIO) if device is removed.
3593  *   - (-ENOTSUP) if hardware doesn't support tunnel type.
3594  */
3595 int
3596 rte_eth_dev_l2_tunnel_eth_type_conf(uint16_t port_id,
3597                                     struct rte_eth_l2_tunnel_conf *l2_tunnel);
3598
3599 /**
3600  * Enable/disable l2 tunnel offload functions. Include,
3601  * 1, The ability of parsing a type of l2 tunnel of an Ethernet device.
3602  *    Filtering, forwarding and offloading this type of tunnel packets depend on
3603  *    this ability.
3604  * 2, Stripping the l2 tunnel tag.
3605  * 3, Insertion of the l2 tunnel tag.
3606  * 4, Forwarding the packets based on the l2 tunnel tag.
3607  *
3608  * @param port_id
3609  *   The port identifier of the Ethernet device.
3610  * @param l2_tunnel
3611  *   l2 tunnel parameters.
3612  * @param mask
3613  *   Indicate the offload function.
3614  * @param en
3615  *   Enable or disable this function.
3616  *
3617  * @return
3618  *   - (0) if successful.
3619  *   - (-ENODEV) if port identifier is invalid.
3620  *   - (-EIO) if device is removed.
3621  *   - (-ENOTSUP) if hardware doesn't support tunnel type.
3622  */
3623 int
3624 rte_eth_dev_l2_tunnel_offload_set(uint16_t port_id,
3625                                   struct rte_eth_l2_tunnel_conf *l2_tunnel,
3626                                   uint32_t mask,
3627                                   uint8_t en);
3628
3629 /**
3630 * Get the port id from pci address or device name
3631 * Example:
3632 * - PCIe, 0000:2:00.0
3633 * - SoC, fsl-gmac0
3634 * - vdev, net_pcap0
3635 *
3636 * @param name
3637 *  pci address or name of the device
3638 * @param port_id
3639 *   pointer to port identifier of the device
3640 * @return
3641 *   - (0) if successful and port_id is filled.
3642 *   - (-ENODEV or -EINVAL) on failure.
3643 */
3644 int
3645 rte_eth_dev_get_port_by_name(const char *name, uint16_t *port_id);
3646
3647 /**
3648 * Get the device name from port id
3649 * Example:
3650 * - PCIe Bus:Domain:Function, 0000:02:00.0
3651 * - SoC device name, fsl-gmac0
3652 * - vdev dpdk name, net_[pcap0|null0|tun0|tap0]
3653 *
3654 * @param port_id
3655 *   Port identifier of the device.
3656 * @param name
3657 *   Buffer of size RTE_ETH_NAME_MAX_LEN to store the name.
3658 * @return
3659 *   - (0) if successful.
3660 *   - (-EINVAL) on failure.
3661 */
3662 int
3663 rte_eth_dev_get_name_by_port(uint16_t port_id, char *name);
3664
3665 /**
3666  * Check that numbers of Rx and Tx descriptors satisfy descriptors limits from
3667  * the ethernet device information, otherwise adjust them to boundaries.
3668  *
3669  * @param port_id
3670  *   The port identifier of the Ethernet device.
3671  * @param nb_rx_desc
3672  *   A pointer to a uint16_t where the number of receive
3673  *   descriptors stored.
3674  * @param nb_tx_desc
3675  *   A pointer to a uint16_t where the number of transmit
3676  *   descriptors stored.
3677  * @return
3678  *   - (0) if successful.
3679  *   - (-ENOTSUP, -ENODEV or -EINVAL) on failure.
3680  */
3681 int rte_eth_dev_adjust_nb_rx_tx_desc(uint16_t port_id,
3682                                      uint16_t *nb_rx_desc,
3683                                      uint16_t *nb_tx_desc);
3684
3685 /**
3686  * Test if a port supports specific mempool ops.
3687  *
3688  * @param port_id
3689  *   Port identifier of the Ethernet device.
3690  * @param [in] pool
3691  *   The name of the pool operations to test.
3692  * @return
3693  *   - 0: best mempool ops choice for this port.
3694  *   - 1: mempool ops are supported for this port.
3695  *   - -ENOTSUP: mempool ops not supported for this port.
3696  *   - -ENODEV: Invalid port Identifier.
3697  *   - -EINVAL: Pool param is null.
3698  */
3699 int
3700 rte_eth_dev_pool_ops_supported(uint16_t port_id, const char *pool);
3701
3702 /**
3703  * Get the security context for the Ethernet device.
3704  *
3705  * @param port_id
3706  *   Port identifier of the Ethernet device
3707  * @return
3708  *   - NULL on error.
3709  *   - pointer to security context on success.
3710  */
3711 void *
3712 rte_eth_dev_get_sec_ctx(uint16_t port_id);
3713
3714
3715 #include <rte_ethdev_core.h>
3716
3717 /**
3718  *
3719  * Retrieve a burst of input packets from a receive queue of an Ethernet
3720  * device. The retrieved packets are stored in *rte_mbuf* structures whose
3721  * pointers are supplied in the *rx_pkts* array.
3722  *
3723  * The rte_eth_rx_burst() function loops, parsing the RX ring of the
3724  * receive queue, up to *nb_pkts* packets, and for each completed RX
3725  * descriptor in the ring, it performs the following operations:
3726  *
3727  * - Initialize the *rte_mbuf* data structure associated with the
3728  *   RX descriptor according to the information provided by the NIC into
3729  *   that RX descriptor.
3730  *
3731  * - Store the *rte_mbuf* data structure into the next entry of the
3732  *   *rx_pkts* array.
3733  *
3734  * - Replenish the RX descriptor with a new *rte_mbuf* buffer
3735  *   allocated from the memory pool associated with the receive queue at
3736  *   initialization time.
3737  *
3738  * When retrieving an input packet that was scattered by the controller
3739  * into multiple receive descriptors, the rte_eth_rx_burst() function
3740  * appends the associated *rte_mbuf* buffers to the first buffer of the
3741  * packet.
3742  *
3743  * The rte_eth_rx_burst() function returns the number of packets
3744  * actually retrieved, which is the number of *rte_mbuf* data structures
3745  * effectively supplied into the *rx_pkts* array.
3746  * A return value equal to *nb_pkts* indicates that the RX queue contained
3747  * at least *rx_pkts* packets, and this is likely to signify that other
3748  * received packets remain in the input queue. Applications implementing
3749  * a "retrieve as much received packets as possible" policy can check this
3750  * specific case and keep invoking the rte_eth_rx_burst() function until
3751  * a value less than *nb_pkts* is returned.
3752  *
3753  * This receive method has the following advantages:
3754  *
3755  * - It allows a run-to-completion network stack engine to retrieve and
3756  *   to immediately process received packets in a fast burst-oriented
3757  *   approach, avoiding the overhead of unnecessary intermediate packet
3758  *   queue/dequeue operations.
3759  *
3760  * - Conversely, it also allows an asynchronous-oriented processing
3761  *   method to retrieve bursts of received packets and to immediately
3762  *   queue them for further parallel processing by another logical core,
3763  *   for instance. However, instead of having received packets being
3764  *   individually queued by the driver, this approach allows the caller
3765  *   of the rte_eth_rx_burst() function to queue a burst of retrieved
3766  *   packets at a time and therefore dramatically reduce the cost of
3767  *   enqueue/dequeue operations per packet.
3768  *
3769  * - It allows the rte_eth_rx_burst() function of the driver to take
3770  *   advantage of burst-oriented hardware features (CPU cache,
3771  *   prefetch instructions, and so on) to minimize the number of CPU
3772  *   cycles per packet.
3773  *
3774  * To summarize, the proposed receive API enables many
3775  * burst-oriented optimizations in both synchronous and asynchronous
3776  * packet processing environments with no overhead in both cases.
3777  *
3778  * The rte_eth_rx_burst() function does not provide any error
3779  * notification to avoid the corresponding overhead. As a hint, the
3780  * upper-level application might check the status of the device link once
3781  * being systematically returned a 0 value for a given number of tries.
3782  *
3783  * @param port_id
3784  *   The port identifier of the Ethernet device.
3785  * @param queue_id
3786  *   The index of the receive queue from which to retrieve input packets.
3787  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
3788  *   to rte_eth_dev_configure().
3789  * @param rx_pkts
3790  *   The address of an array of pointers to *rte_mbuf* structures that
3791  *   must be large enough to store *nb_pkts* pointers in it.
3792  * @param nb_pkts
3793  *   The maximum number of packets to retrieve.
3794  * @return
3795  *   The number of packets actually retrieved, which is the number
3796  *   of pointers to *rte_mbuf* structures effectively supplied to the
3797  *   *rx_pkts* array.
3798  */
3799 static inline uint16_t
3800 rte_eth_rx_burst(uint16_t port_id, uint16_t queue_id,
3801                  struct rte_mbuf **rx_pkts, const uint16_t nb_pkts)
3802 {
3803         struct rte_eth_dev *dev = &rte_eth_devices[port_id];
3804         uint16_t nb_rx;
3805
3806 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3807         RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
3808         RTE_FUNC_PTR_OR_ERR_RET(*dev->rx_pkt_burst, 0);
3809
3810         if (queue_id >= dev->data->nb_rx_queues) {
3811                 RTE_ETHDEV_LOG(ERR, "Invalid RX queue_id=%u\n", queue_id);
3812                 return 0;
3813         }
3814 #endif
3815         nb_rx = (*dev->rx_pkt_burst)(dev->data->rx_queues[queue_id],
3816                                      rx_pkts, nb_pkts);
3817
3818 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
3819         if (unlikely(dev->post_rx_burst_cbs[queue_id] != NULL)) {
3820                 struct rte_eth_rxtx_callback *cb =
3821                                 dev->post_rx_burst_cbs[queue_id];
3822
3823                 do {
3824                         nb_rx = cb->fn.rx(port_id, queue_id, rx_pkts, nb_rx,
3825                                                 nb_pkts, cb->param);
3826                         cb = cb->next;
3827                 } while (cb != NULL);
3828         }
3829 #endif
3830
3831         return nb_rx;
3832 }
3833
3834 /**
3835  * Get the number of used descriptors of a rx queue
3836  *
3837  * @param port_id
3838  *  The port identifier of the Ethernet device.
3839  * @param queue_id
3840  *  The queue id on the specific port.
3841  * @return
3842  *  The number of used descriptors in the specific queue, or:
3843  *     (-EINVAL) if *port_id* or *queue_id* is invalid
3844  *     (-ENOTSUP) if the device does not support this function
3845  */
3846 static inline int
3847 rte_eth_rx_queue_count(uint16_t port_id, uint16_t queue_id)
3848 {
3849         struct rte_eth_dev *dev;
3850
3851         RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -EINVAL);
3852         dev = &rte_eth_devices[port_id];
3853         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_queue_count, -ENOTSUP);
3854         if (queue_id >= dev->data->nb_rx_queues)
3855                 return -EINVAL;
3856
3857         return (int)(*dev->dev_ops->rx_queue_count)(dev, queue_id);
3858 }
3859
3860 /**
3861  * Check if the DD bit of the specific RX descriptor in the queue has been set
3862  *
3863  * @param port_id
3864  *  The port identifier of the Ethernet device.
3865  * @param queue_id
3866  *  The queue id on the specific port.
3867  * @param offset
3868  *  The offset of the descriptor ID from tail.
3869  * @return
3870  *  - (1) if the specific DD bit is set.
3871  *  - (0) if the specific DD bit is not set.
3872  *  - (-ENODEV) if *port_id* invalid.
3873  *  - (-ENOTSUP) if the device does not support this function
3874  */
3875 static inline int
3876 rte_eth_rx_descriptor_done(uint16_t port_id, uint16_t queue_id, uint16_t offset)
3877 {
3878         struct rte_eth_dev *dev = &rte_eth_devices[port_id];
3879         RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
3880         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_descriptor_done, -ENOTSUP);
3881         return (*dev->dev_ops->rx_descriptor_done)( \
3882                 dev->data->rx_queues[queue_id], offset);
3883 }
3884
3885 #define RTE_ETH_RX_DESC_AVAIL    0 /**< Desc available for hw. */
3886 #define RTE_ETH_RX_DESC_DONE     1 /**< Desc done, filled by hw. */
3887 #define RTE_ETH_RX_DESC_UNAVAIL  2 /**< Desc used by driver or hw. */
3888
3889 /**
3890  * Check the status of a Rx descriptor in the queue
3891  *
3892  * It should be called in a similar context than the Rx function:
3893  * - on a dataplane core
3894  * - not concurrently on the same queue
3895  *
3896  * Since it's a dataplane function, no check is performed on port_id and
3897  * queue_id. The caller must therefore ensure that the port is enabled
3898  * and the queue is configured and running.
3899  *
3900  * Note: accessing to a random descriptor in the ring may trigger cache
3901  * misses and have a performance impact.
3902  *
3903  * @param port_id
3904  *  A valid port identifier of the Ethernet device which.
3905  * @param queue_id
3906  *  A valid Rx queue identifier on this port.
3907  * @param offset
3908  *  The offset of the descriptor starting from tail (0 is the next
3909  *  packet to be received by the driver).
3910  *
3911  * @return
3912  *  - (RTE_ETH_RX_DESC_AVAIL): Descriptor is available for the hardware to
3913  *    receive a packet.
3914  *  - (RTE_ETH_RX_DESC_DONE): Descriptor is done, it is filled by hw, but
3915  *    not yet processed by the driver (i.e. in the receive queue).
3916  *  - (RTE_ETH_RX_DESC_UNAVAIL): Descriptor is unavailable, either hold by
3917  *    the driver and not yet returned to hw, or reserved by the hw.
3918  *  - (-EINVAL) bad descriptor offset.
3919  *  - (-ENOTSUP) if the device does not support this function.
3920  *  - (-ENODEV) bad port or queue (only if compiled with debug).
3921  */
3922 static inline int
3923 rte_eth_rx_descriptor_status(uint16_t port_id, uint16_t queue_id,
3924         uint16_t offset)
3925 {
3926         struct rte_eth_dev *dev;
3927         void *rxq;
3928
3929 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3930         RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
3931 #endif
3932         dev = &rte_eth_devices[port_id];
3933 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3934         if (queue_id >= dev->data->nb_rx_queues)
3935                 return -ENODEV;
3936 #endif
3937         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->rx_descriptor_status, -ENOTSUP);
3938         rxq = dev->data->rx_queues[queue_id];
3939
3940         return (*dev->dev_ops->rx_descriptor_status)(rxq, offset);
3941 }
3942
3943 #define RTE_ETH_TX_DESC_FULL    0 /**< Desc filled for hw, waiting xmit. */
3944 #define RTE_ETH_TX_DESC_DONE    1 /**< Desc done, packet is transmitted. */
3945 #define RTE_ETH_TX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */
3946
3947 /**
3948  * Check the status of a Tx descriptor in the queue.
3949  *
3950  * It should be called in a similar context than the Tx function:
3951  * - on a dataplane core
3952  * - not concurrently on the same queue
3953  *
3954  * Since it's a dataplane function, no check is performed on port_id and
3955  * queue_id. The caller must therefore ensure that the port is enabled
3956  * and the queue is configured and running.
3957  *
3958  * Note: accessing to a random descriptor in the ring may trigger cache
3959  * misses and have a performance impact.
3960  *
3961  * @param port_id
3962  *  A valid port identifier of the Ethernet device which.
3963  * @param queue_id
3964  *  A valid Tx queue identifier on this port.
3965  * @param offset
3966  *  The offset of the descriptor starting from tail (0 is the place where
3967  *  the next packet will be send).
3968  *
3969  * @return
3970  *  - (RTE_ETH_TX_DESC_FULL) Descriptor is being processed by the hw, i.e.
3971  *    in the transmit queue.
3972  *  - (RTE_ETH_TX_DESC_DONE) Hardware is done with this descriptor, it can
3973  *    be reused by the driver.
3974  *  - (RTE_ETH_TX_DESC_UNAVAIL): Descriptor is unavailable, reserved by the
3975  *    driver or the hardware.
3976  *  - (-EINVAL) bad descriptor offset.
3977  *  - (-ENOTSUP) if the device does not support this function.
3978  *  - (-ENODEV) bad port or queue (only if compiled with debug).
3979  */
3980 static inline int rte_eth_tx_descriptor_status(uint16_t port_id,
3981         uint16_t queue_id, uint16_t offset)
3982 {
3983         struct rte_eth_dev *dev;
3984         void *txq;
3985
3986 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3987         RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
3988 #endif
3989         dev = &rte_eth_devices[port_id];
3990 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
3991         if (queue_id >= dev->data->nb_tx_queues)
3992                 return -ENODEV;
3993 #endif
3994         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->tx_descriptor_status, -ENOTSUP);
3995         txq = dev->data->tx_queues[queue_id];
3996
3997         return (*dev->dev_ops->tx_descriptor_status)(txq, offset);
3998 }
3999
4000 /**
4001  * Send a burst of output packets on a transmit queue of an Ethernet device.
4002  *
4003  * The rte_eth_tx_burst() function is invoked to transmit output packets
4004  * on the output queue *queue_id* of the Ethernet device designated by its
4005  * *port_id*.
4006  * The *nb_pkts* parameter is the number of packets to send which are
4007  * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
4008  * allocated from a pool created with rte_pktmbuf_pool_create().
4009  * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
4010  * up to the number of transmit descriptors available in the TX ring of the
4011  * transmit queue.
4012  * For each packet to send, the rte_eth_tx_burst() function performs
4013  * the following operations:
4014  *
4015  * - Pick up the next available descriptor in the transmit ring.
4016  *
4017  * - Free the network buffer previously sent with that descriptor, if any.
4018  *
4019  * - Initialize the transmit descriptor with the information provided
4020  *   in the *rte_mbuf data structure.
4021  *
4022  * In the case of a segmented packet composed of a list of *rte_mbuf* buffers,
4023  * the rte_eth_tx_burst() function uses several transmit descriptors
4024  * of the ring.
4025  *
4026  * The rte_eth_tx_burst() function returns the number of packets it
4027  * actually sent. A return value equal to *nb_pkts* means that all packets
4028  * have been sent, and this is likely to signify that other output packets
4029  * could be immediately transmitted again. Applications that implement a
4030  * "send as many packets to transmit as possible" policy can check this
4031  * specific case and keep invoking the rte_eth_tx_burst() function until
4032  * a value less than *nb_pkts* is returned.
4033  *
4034  * It is the responsibility of the rte_eth_tx_burst() function to
4035  * transparently free the memory buffers of packets previously sent.
4036  * This feature is driven by the *tx_free_thresh* value supplied to the
4037  * rte_eth_dev_configure() function at device configuration time.
4038  * When the number of free TX descriptors drops below this threshold, the
4039  * rte_eth_tx_burst() function must [attempt to] free the *rte_mbuf*  buffers
4040  * of those packets whose transmission was effectively completed.
4041  *
4042  * If the PMD is DEV_TX_OFFLOAD_MT_LOCKFREE capable, multiple threads can
4043  * invoke this function concurrently on the same tx queue without SW lock.
4044  * @see rte_eth_dev_info_get, struct rte_eth_txconf::offloads
4045  *
4046  * @see rte_eth_tx_prepare to perform some prior checks or adjustments
4047  * for offloads.
4048  *
4049  * @param port_id
4050  *   The port identifier of the Ethernet device.
4051  * @param queue_id
4052  *   The index of the transmit queue through which output packets must be
4053  *   sent.
4054  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
4055  *   to rte_eth_dev_configure().
4056  * @param tx_pkts
4057  *   The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
4058  *   which contain the output packets.
4059  * @param nb_pkts
4060  *   The maximum number of packets to transmit.
4061  * @return
4062  *   The number of output packets actually stored in transmit descriptors of
4063  *   the transmit ring. The return value can be less than the value of the
4064  *   *tx_pkts* parameter when the transmit ring is full or has been filled up.
4065  */
4066 static inline uint16_t
4067 rte_eth_tx_burst(uint16_t port_id, uint16_t queue_id,
4068                  struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
4069 {
4070         struct rte_eth_dev *dev = &rte_eth_devices[port_id];
4071
4072 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4073         RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
4074         RTE_FUNC_PTR_OR_ERR_RET(*dev->tx_pkt_burst, 0);
4075
4076         if (queue_id >= dev->data->nb_tx_queues) {
4077                 RTE_ETHDEV_LOG(ERR, "Invalid TX queue_id=%u\n", queue_id);
4078                 return 0;
4079         }
4080 #endif
4081
4082 #ifdef RTE_ETHDEV_RXTX_CALLBACKS
4083         struct rte_eth_rxtx_callback *cb = dev->pre_tx_burst_cbs[queue_id];
4084
4085         if (unlikely(cb != NULL)) {
4086                 do {
4087                         nb_pkts = cb->fn.tx(port_id, queue_id, tx_pkts, nb_pkts,
4088                                         cb->param);
4089                         cb = cb->next;
4090                 } while (cb != NULL);
4091         }
4092 #endif
4093
4094         return (*dev->tx_pkt_burst)(dev->data->tx_queues[queue_id], tx_pkts, nb_pkts);
4095 }
4096
4097 /**
4098  * @warning
4099  * @b EXPERIMENTAL: this API may change without prior notice
4100  *
4101  * Process a burst of output packets on a transmit queue of an Ethernet device.
4102  *
4103  * The rte_eth_tx_prepare() function is invoked to prepare output packets to be
4104  * transmitted on the output queue *queue_id* of the Ethernet device designated
4105  * by its *port_id*.
4106  * The *nb_pkts* parameter is the number of packets to be prepared which are
4107  * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
4108  * allocated from a pool created with rte_pktmbuf_pool_create().
4109  * For each packet to send, the rte_eth_tx_prepare() function performs
4110  * the following operations:
4111  *
4112  * - Check if packet meets devices requirements for tx offloads.
4113  *
4114  * - Check limitations about number of segments.
4115  *
4116  * - Check additional requirements when debug is enabled.
4117  *
4118  * - Update and/or reset required checksums when tx offload is set for packet.
4119  *
4120  * Since this function can modify packet data, provided mbufs must be safely
4121  * writable (e.g. modified data cannot be in shared segment).
4122  *
4123  * The rte_eth_tx_prepare() function returns the number of packets ready to be
4124  * sent. A return value equal to *nb_pkts* means that all packets are valid and
4125  * ready to be sent, otherwise stops processing on the first invalid packet and
4126  * leaves the rest packets untouched.
4127  *
4128  * When this functionality is not implemented in the driver, all packets are
4129  * are returned untouched.
4130  *
4131  * @param port_id
4132  *   The port identifier of the Ethernet device.
4133  *   The value must be a valid port id.
4134  * @param queue_id
4135  *   The index of the transmit queue through which output packets must be
4136  *   sent.
4137  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
4138  *   to rte_eth_dev_configure().
4139  * @param tx_pkts
4140  *   The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
4141  *   which contain the output packets.
4142  * @param nb_pkts
4143  *   The maximum number of packets to process.
4144  * @return
4145  *   The number of packets correct and ready to be sent. The return value can be
4146  *   less than the value of the *tx_pkts* parameter when some packet doesn't
4147  *   meet devices requirements with rte_errno set appropriately:
4148  *   - -EINVAL: offload flags are not correctly set
4149  *   - -ENOTSUP: the offload feature is not supported by the hardware
4150  *
4151  */
4152
4153 #ifndef RTE_ETHDEV_TX_PREPARE_NOOP
4154
4155 static inline uint16_t
4156 rte_eth_tx_prepare(uint16_t port_id, uint16_t queue_id,
4157                 struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
4158 {
4159         struct rte_eth_dev *dev;
4160
4161 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4162         if (!rte_eth_dev_is_valid_port(port_id)) {
4163                 RTE_ETHDEV_LOG(ERR, "Invalid TX port_id=%u\n", port_id);
4164                 rte_errno = -EINVAL;
4165                 return 0;
4166         }
4167 #endif
4168
4169         dev = &rte_eth_devices[port_id];
4170
4171 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
4172         if (queue_id >= dev->data->nb_tx_queues) {
4173                 RTE_ETHDEV_LOG(ERR, "Invalid TX queue_id=%u\n", queue_id);
4174                 rte_errno = -EINVAL;
4175                 return 0;
4176         }
4177 #endif
4178
4179         if (!dev->tx_pkt_prepare)
4180                 return nb_pkts;
4181
4182         return (*dev->tx_pkt_prepare)(dev->data->tx_queues[queue_id],
4183                         tx_pkts, nb_pkts);
4184 }
4185
4186 #else
4187
4188 /*
4189  * Native NOOP operation for compilation targets which doesn't require any
4190  * preparations steps, and functional NOOP may introduce unnecessary performance
4191  * drop.
4192  *
4193  * Generally this is not a good idea to turn it on globally and didn't should
4194  * be used if behavior of tx_preparation can change.
4195  */
4196
4197 static inline uint16_t
4198 rte_eth_tx_prepare(__rte_unused uint16_t port_id,
4199                 __rte_unused uint16_t queue_id,
4200                 __rte_unused struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
4201 {
4202         return nb_pkts;
4203 }
4204
4205 #endif
4206
4207 /**
4208  * Send any packets queued up for transmission on a port and HW queue
4209  *
4210  * This causes an explicit flush of packets previously buffered via the
4211  * rte_eth_tx_buffer() function. It returns the number of packets successfully
4212  * sent to the NIC, and calls the error callback for any unsent packets. Unless
4213  * explicitly set up otherwise, the default callback simply frees the unsent
4214  * packets back to the owning mempool.
4215  *
4216  * @param port_id
4217  *   The port identifier of the Ethernet device.
4218  * @param queue_id
4219  *   The index of the transmit queue through which output packets must be
4220  *   sent.
4221  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
4222  *   to rte_eth_dev_configure().
4223  * @param buffer
4224  *   Buffer of packets to be transmit.
4225  * @return
4226  *   The number of packets successfully sent to the Ethernet device. The error
4227  *   callback is called for any packets which could not be sent.
4228  */
4229 static inline uint16_t
4230 rte_eth_tx_buffer_flush(uint16_t port_id, uint16_t queue_id,
4231                 struct rte_eth_dev_tx_buffer *buffer)
4232 {
4233         uint16_t sent;
4234         uint16_t to_send = buffer->length;
4235
4236         if (to_send == 0)
4237                 return 0;
4238
4239         sent = rte_eth_tx_burst(port_id, queue_id, buffer->pkts, to_send);
4240
4241         buffer->length = 0;
4242
4243         /* All packets sent, or to be dealt with by callback below */
4244         if (unlikely(sent != to_send))
4245                 buffer->error_callback(&buffer->pkts[sent],
4246                                        (uint16_t)(to_send - sent),
4247                                        buffer->error_userdata);
4248
4249         return sent;
4250 }
4251
4252 /**
4253  * Buffer a single packet for future transmission on a port and queue
4254  *
4255  * This function takes a single mbuf/packet and buffers it for later
4256  * transmission on the particular port and queue specified. Once the buffer is
4257  * full of packets, an attempt will be made to transmit all the buffered
4258  * packets. In case of error, where not all packets can be transmitted, a
4259  * callback is called with the unsent packets as a parameter. If no callback
4260  * is explicitly set up, the unsent packets are just freed back to the owning
4261  * mempool. The function returns the number of packets actually sent i.e.
4262  * 0 if no buffer flush occurred, otherwise the number of packets successfully
4263  * flushed
4264  *
4265  * @param port_id
4266  *   The port identifier of the Ethernet device.
4267  * @param queue_id
4268  *   The index of the transmit queue through which output packets must be
4269  *   sent.
4270  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
4271  *   to rte_eth_dev_configure().
4272  * @param buffer
4273  *   Buffer used to collect packets to be sent.
4274  * @param tx_pkt
4275  *   Pointer to the packet mbuf to be sent.
4276  * @return
4277  *   0 = packet has been buffered for later transmission
4278  *   N > 0 = packet has been buffered, and the buffer was subsequently flushed,
4279  *     causing N packets to be sent, and the error callback to be called for
4280  *     the rest.
4281  */
4282 static __rte_always_inline uint16_t
4283 rte_eth_tx_buffer(uint16_t port_id, uint16_t queue_id,
4284                 struct rte_eth_dev_tx_buffer *buffer, struct rte_mbuf *tx_pkt)
4285 {
4286         buffer->pkts[buffer->length++] = tx_pkt;
4287         if (buffer->length < buffer->size)
4288                 return 0;
4289
4290         return rte_eth_tx_buffer_flush(port_id, queue_id, buffer);
4291 }
4292
4293 #ifdef __cplusplus
4294 }
4295 #endif
4296
4297 #endif /* _RTE_ETHDEV_H_ */