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