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