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