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