lib/librte_ether/rte_ethdev.h

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