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