lib/librte_ether/rte_ethdev.h

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