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