lib/librte_ether/rte_ethdev.h

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