lib/librte_ether/rte_ethdev.h

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