lib/librte_ether/rte_ethdev.h

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