lib/librte_ether/rte_ethdev.h

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