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