lib/librte_ether/rte_ethdev.h

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