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