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