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