lib/librte_ethdev/rte_ethdev.h

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