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