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