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