lib/librte_ether/rte_ethdev.h

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