lib/librte_ethdev/rte_ethdev.h

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