lib/librte_ether/rte_ethdev.h

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