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