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