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