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