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