lib/librte_ether/rte_ethdev.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2013 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 ierrors;   /**< Total number of erroneous received packets. */
 190         uint64_t oerrors;   /**< Total number of failed transmitted packets. */
 191         uint64_t imcasts;   /**< Total number of multicast received packets. */
 192         uint64_t rx_nombuf; /**< Total number of RX mbuf allocation failures. */
 193         uint64_t fdirmatch; /**< Total number of RX packets matching a filter. */
 194         uint64_t fdirmiss;  /**< Total number of RX packets not matching any filter. */
 195         uint64_t q_ipackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
 196         /**< Total number of queue RX packets. */
 197         uint64_t q_opackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
 198         /**< Total number of queue TX packets. */
 199         uint64_t q_ibytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
 200         /**< Total number of successfully received queue bytes. */
 201         uint64_t q_obytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
 202         /**< Total number of successfully transmitted queue bytes. */
 203         uint64_t q_errors[RTE_ETHDEV_QUEUE_STAT_CNTRS];
 204         /**< Total number of queue packets received that are dropped. */
 205         uint64_t ilbpackets;
 206         /**< Total number of good packets received from loopback,VF Only */
 207         uint64_t olbpackets;
 208         /**< Total number of good packets transmitted to loopback,VF Only */
 209         uint64_t ilbbytes;
 210         /**< Total number of good bytes received from loopback,VF Only */
 211         uint64_t olbbytes;
 212         /**< Total number of good bytes transmitted to loopback,VF Only */
 213 };
 214
 215 /**
 216  * A structure used to retrieve link-level information of an Ethernet port.
 217  */
 218 struct rte_eth_link {
 219         uint16_t link_speed;      /**< ETH_LINK_SPEED_[10, 100, 1000, 10000] */
 220         uint16_t link_duplex;     /**< ETH_LINK_[HALF_DUPLEX, FULL_DUPLEX] */
 221         uint8_t  link_status : 1; /**< 1 -> link up, 0 -> link down */
 222 }__attribute__((aligned(8)));     /**< aligned for atomic64 read/write */
 223
 224 #define ETH_LINK_SPEED_AUTONEG  0       /**< Auto-negotiate link speed. */
 225 #define ETH_LINK_SPEED_10       10      /**< 10 megabits/second. */
 226 #define ETH_LINK_SPEED_100      100     /**< 100 megabits/second. */
 227 #define ETH_LINK_SPEED_1000     1000    /**< 1 gigabits/second. */
 228 #define ETH_LINK_SPEED_10000    10000   /**< 10 gigabits/second. */
 229
 230 #define ETH_LINK_AUTONEG_DUPLEX 0       /**< Auto-negotiate duplex. */
 231 #define ETH_LINK_HALF_DUPLEX    1       /**< Half-duplex connection. */
 232 #define ETH_LINK_FULL_DUPLEX    2       /**< Full-duplex connection. */
 233
 234 /**
 235  * A structure used to configure the ring threshold registers of an RX/TX
 236  * queue for an Ethernet port.
 237  */
 238 struct rte_eth_thresh {
 239         uint8_t pthresh; /**< Ring prefetch threshold. */
 240         uint8_t hthresh; /**< Ring host threshold. */
 241         uint8_t wthresh; /**< Ring writeback threshold. */
 242 };
 243
 244 /**
 245  *  A set of values to identify what method is to be used to route
 246  *  packets to multiple queues.
 247  */
 248 enum rte_eth_rx_mq_mode {
 249         ETH_MQ_RX_NONE = 0,  /**< None of DCB,RSS or VMDQ mode */
 250
 251         ETH_MQ_RX_RSS,       /**< For RX side, only RSS is on */
 252         ETH_MQ_RX_DCB,       /**< For RX side,only DCB is on. */
 253         ETH_MQ_RX_DCB_RSS,   /**< Both DCB and RSS enable */
 254
 255         ETH_MQ_RX_VMDQ_ONLY, /**< Only VMDQ, no RSS nor DCB */
 256         ETH_MQ_RX_VMDQ_RSS,  /**< RSS mode with VMDQ */
 257         ETH_MQ_RX_VMDQ_DCB,  /**< Use VMDQ+DCB to route traffic to queues */
 258         ETH_MQ_RX_VMDQ_DCB_RSS, /**< Enable both VMDQ and DCB in VMDq */
 259 };
 260
 261 /**
 262  * for rx mq mode backward compatible
 263  */
 264 #define ETH_RSS                       ETH_MQ_RX_RSS
 265 #define VMDQ_DCB                      ETH_MQ_RX_VMDQ_DCB
 266 #define ETH_DCB_RX                    ETH_MQ_RX_DCB
 267
 268 /**
 269  * A set of values to identify what method is to be used to transmit
 270  * packets using multi-TCs.
 271  */
 272 enum rte_eth_tx_mq_mode {
 273         ETH_MQ_TX_NONE    = 0,  /**< It is in neither DCB nor VT mode. */
 274         ETH_MQ_TX_DCB,          /**< For TX side,only DCB is on. */
 275         ETH_MQ_TX_VMDQ_DCB,     /**< For TX side,both DCB and VT is on. */
 276         ETH_MQ_TX_VMDQ_ONLY,    /**< Only VT on, no DCB */
 277 };
 278
 279 /**
 280  * for tx mq mode backward compatible
 281  */
 282 #define ETH_DCB_NONE                ETH_MQ_TX_NONE
 283 #define ETH_VMDQ_DCB_TX             ETH_MQ_TX_VMDQ_DCB
 284 #define ETH_DCB_TX                  ETH_MQ_TX_DCB
 285
 286 /**
 287  * A structure used to configure the RX features of an Ethernet port.
 288  */
 289 struct rte_eth_rxmode {
 290         /** The multi-queue packet distribution mode to be used, e.g. RSS. */
 291         enum rte_eth_rx_mq_mode mq_mode;
 292         uint32_t max_rx_pkt_len;  /**< Only used if jumbo_frame enabled. */
 293         uint16_t split_hdr_size;  /**< hdr buf size (header_split enabled).*/
 294         uint8_t header_split : 1, /**< Header Split enable. */
 295                 hw_ip_checksum   : 1, /**< IP/UDP/TCP checksum offload enable. */
 296                 hw_vlan_filter   : 1, /**< VLAN filter enable. */
 297                 hw_vlan_strip    : 1, /**< VLAN strip enable. */
 298                 hw_vlan_extend   : 1, /**< Extended VLAN enable. */
 299                 jumbo_frame      : 1, /**< Jumbo Frame Receipt enable. */
 300                 hw_strip_crc     : 1; /**< Enable CRC stripping by hardware. */
 301 };
 302
 303 /**
 304  * A structure used to configure the Receive Side Scaling (RSS) feature
 305  * of an Ethernet port.
 306  * If not NULL, the *rss_key* pointer of the *rss_conf* structure points
 307  * to an array of 40 bytes holding the RSS key to use for hashing specific
 308  * header fields of received packets.
 309  * Otherwise, a default random hash key is used by the device driver.
 310  *
 311  * The *rss_hf* field of the *rss_conf* structure indicates the different
 312  * types of IPv4/IPv6 packets to which the RSS hashing must be applied.
 313  * Supplying an *rss_hf* equal to zero disables the RSS feature.
 314  */
 315 struct rte_eth_rss_conf {
 316         uint8_t  *rss_key;   /**< If not NULL, 40-byte hash key. */
 317         uint16_t rss_hf;     /**< Hash functions to apply - see below. */
 318 };
 319
 320 #define ETH_RSS_IPV4        0x0001 /**< IPv4 packet. */
 321 #define ETH_RSS_IPV4_TCP    0x0002 /**< IPv4/TCP packet. */
 322 #define ETH_RSS_IPV6        0x0004 /**< IPv6 packet. */
 323 #define ETH_RSS_IPV6_EX     0x0008 /**< IPv6 packet with extension headers.*/
 324 #define ETH_RSS_IPV6_TCP    0x0010 /**< IPv6/TCP packet. */
 325 #define ETH_RSS_IPV6_TCP_EX 0x0020 /**< IPv6/TCP with extension headers. */
 326 /* Intel RSS extensions to UDP packets */
 327 #define ETH_RSS_IPV4_UDP    0x0040 /**< IPv4/UDP packet. */
 328 #define ETH_RSS_IPV6_UDP    0x0080 /**< IPv6/UDP packet. */
 329 #define ETH_RSS_IPV6_UDP_EX 0x0100 /**< IPv6/UDP with extension headers. */
 330 /* Definitions used for redirection table entry size */
 331 #define ETH_RSS_RETA_NUM_ENTRIES 128
 332 #define ETH_RSS_RETA_MAX_QUEUE   16
 333
 334 /* Definitions used for VMDQ and DCB functionality */
 335 #define ETH_VMDQ_MAX_VLAN_FILTERS   64 /**< Maximum nb. of VMDQ vlan filters. */
 336 #define ETH_DCB_NUM_USER_PRIORITIES 8  /**< Maximum nb. of DCB priorities. */
 337 #define ETH_VMDQ_DCB_NUM_QUEUES     128 /**< Maximum nb. of VMDQ DCB queues. */
 338 #define ETH_DCB_NUM_QUEUES          128 /**< Maximum nb. of DCB queues. */
 339
 340 /* DCB capability defines */
 341 #define ETH_DCB_PG_SUPPORT      0x00000001 /**< Priority Group(ETS) support. */
 342 #define ETH_DCB_PFC_SUPPORT     0x00000002 /**< Priority Flow Control support. */
 343
 344 /* Definitions used for VLAN Offload functionality */
 345 #define ETH_VLAN_STRIP_OFFLOAD   0x0001 /**< VLAN Strip  On/Off */
 346 #define ETH_VLAN_FILTER_OFFLOAD  0x0002 /**< VLAN Filter On/Off */
 347 #define ETH_VLAN_EXTEND_OFFLOAD  0x0004 /**< VLAN Extend On/Off */
 348
 349 /* Definitions used for mask VLAN setting */
 350 #define ETH_VLAN_STRIP_MASK   0x0001 /**< VLAN Strip  setting mask */
 351 #define ETH_VLAN_FILTER_MASK  0x0002 /**< VLAN Filter  setting mask*/
 352 #define ETH_VLAN_EXTEND_MASK  0x0004 /**< VLAN Extend  setting mask*/
 353
 354 /**
 355  * A structure used to configure Redirection Table of  the Receive Side
 356  * Scaling (RSS) feature of an Ethernet port.
 357  */
 358 struct rte_eth_rss_reta {
 359         /** First 64 mask bits indicate which entry(s) need to updated/queried. */
 360         uint64_t mask_lo;
 361         /** Second 64 mask bits indicate which entry(s) need to updated/queried. */
 362         uint64_t mask_hi;
 363         uint8_t reta[ETH_RSS_RETA_NUM_ENTRIES];  /**< 128 RETA entries*/
 364 };
 365
 366 /**
 367  * This enum indicates the possible number of traffic classes
 368  * in DCB configratioins
 369  */
 370 enum rte_eth_nb_tcs {
 371         ETH_4_TCS = 4, /**< 4 TCs with DCB. */
 372         ETH_8_TCS = 8  /**< 8 TCs with DCB. */
 373 };
 374
 375 /**
 376  * This enum indicates the possible number of queue pools
 377  * in VMDQ+DCB configurations.
 378  */
 379 enum rte_eth_nb_pools {
 380         ETH_8_POOLS = 8,    /**< 8 VMDq pools. */
 381         ETH_16_POOLS = 16,  /**< 16 VMDq pools. */
 382         ETH_32_POOLS = 32,  /**< 32 VMDq pools. */
 383         ETH_64_POOLS = 64   /**< 64 VMDq pools. */
 384 };
 385
 386 /* This structure may be extended in future. */
 387 struct rte_eth_dcb_rx_conf {
 388         enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs */
 389         uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
 390         /**< Possible DCB queue,4 or 8. */
 391 };
 392
 393 struct rte_eth_vmdq_dcb_tx_conf {
 394         enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools. */
 395         uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
 396         /**< Possible DCB queue,4 or 8. */
 397 };
 398
 399 struct rte_eth_dcb_tx_conf {
 400         enum rte_eth_nb_tcs nb_tcs; /**< possible DCB TCs, 4 or 8 TCs. */
 401         uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
 402         /**< Possible DCB queue,4 or 8. */
 403 };
 404
 405 /**
 406  * A structure used to configure the VMDQ+DCB feature
 407  * of an Ethernet port.
 408  *
 409  * Using this feature, packets are routed to a pool of queues, based
 410  * on the vlan id in the vlan tag, and then to a specific queue within
 411  * that pool, using the user priority vlan tag field.
 412  *
 413  * A default pool may be used, if desired, to route all traffic which
 414  * does not match the vlan filter rules.
 415  */
 416 struct rte_eth_vmdq_dcb_conf {
 417         enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools */
 418         uint8_t enable_default_pool; /**< If non-zero, use a default pool */
 419         uint8_t default_pool; /**< The default pool, if applicable */
 420         uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
 421         struct {
 422                 uint16_t vlan_id; /**< The vlan id of the received frame */
 423                 uint64_t pools;   /**< Bitmask of pools for packet rx */
 424         } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
 425         uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
 426         /**< Selects a queue in a pool */
 427 };
 428
 429 /**
 430  * A structure used to configure the TX features of an Ethernet port.
 431  */
 432 struct rte_eth_txmode {
 433         enum rte_eth_tx_mq_mode mq_mode; /**< TX multi-queues mode. */
 434 };
 435
 436 /**
 437  * A structure used to configure an RX ring of an Ethernet port.
 438  */
 439 struct rte_eth_rxconf {
 440         struct rte_eth_thresh rx_thresh; /**< RX ring threshold registers. */
 441         uint16_t rx_free_thresh; /**< Drives the freeing of RX descriptors. */
 442         uint8_t rx_drop_en; /**< Drop packets if no descriptors are available. */
 443 };
 444
 445 #define ETH_TXQ_FLAGS_NOMULTSEGS 0x0001 /**< nb_segs=1 for all mbufs */
 446 #define ETH_TXQ_FLAGS_NOREFCOUNT 0x0002 /**< refcnt can be ignored */
 447 #define ETH_TXQ_FLAGS_NOMULTMEMP 0x0004 /**< all bufs come from same mempool */
 448 #define ETH_TXQ_FLAGS_NOVLANOFFL 0x0100 /**< disable VLAN offload */
 449 #define ETH_TXQ_FLAGS_NOXSUMSCTP 0x0200 /**< disable SCTP checksum offload */
 450 #define ETH_TXQ_FLAGS_NOXSUMUDP  0x0400 /**< disable UDP checksum offload */
 451 #define ETH_TXQ_FLAGS_NOXSUMTCP  0x0800 /**< disable TCP checksum offload */
 452 #define ETH_TXQ_FLAGS_NOOFFLOADS \
 453                 (ETH_TXQ_FLAGS_NOVLANOFFL | ETH_TXQ_FLAGS_NOXSUMSCTP | \
 454                  ETH_TXQ_FLAGS_NOXSUMUDP  | ETH_TXQ_FLAGS_NOXSUMTCP)
 455 /**
 456  * A structure used to configure a TX ring of an Ethernet port.
 457  */
 458 struct rte_eth_txconf {
 459         struct rte_eth_thresh tx_thresh; /**< TX ring threshold registers. */
 460         uint16_t tx_rs_thresh; /**< Drives the setting of RS bit on TXDs. */
 461         uint16_t tx_free_thresh; /**< Drives the freeing of TX buffers. */
 462         uint32_t txq_flags; /**< Set flags for the Tx queue */
 463 };
 464
 465 /**
 466  * This enum indicates the flow control mode
 467  */
 468 enum rte_eth_fc_mode {
 469         RTE_FC_NONE = 0, /**< Disable flow control. */
 470         RTE_FC_RX_PAUSE, /**< RX pause frame, enable flowctrl on TX side. */
 471         RTE_FC_TX_PAUSE, /**< TX pause frame, enable flowctrl on RX side. */
 472         RTE_FC_FULL      /**< Enable flow control on both side. */
 473 };
 474
 475 /**
 476  * A structure used to configure Ethernet flow control parameter.
 477  * These parameters will be configured into the register of the NIC.
 478  * Please refer to the corresponding data sheet for proper value.
 479  */
 480 struct rte_eth_fc_conf {
 481         uint32_t high_water;  /**< High threshold value to trigger XOFF */
 482         uint32_t low_water;   /**< Low threshold value to trigger XON */
 483         uint16_t pause_time;  /**< Pause quota in the Pause frame */
 484         uint16_t send_xon;    /**< Is XON frame need be sent */
 485         enum rte_eth_fc_mode mode;  /**< Link flow control mode */
 486 };
 487
 488 /**
 489  * A structure used to configure Ethernet priority flow control parameter.
 490  * These parameters will be configured into the register of the NIC.
 491  * Please refer to the corresponding data sheet for proper value.
 492  */
 493 struct rte_eth_pfc_conf {
 494         struct rte_eth_fc_conf fc; /**< General flow control parameter. */
 495         uint8_t priority;          /**< VLAN User Priority. */
 496 };
 497
 498 /**
 499  *  Flow Director setting modes: none (default), signature or perfect.
 500  */
 501 enum rte_fdir_mode {
 502         RTE_FDIR_MODE_NONE      = 0, /**< Disable FDIR support. */
 503         RTE_FDIR_MODE_SIGNATURE,     /**< Enable FDIR signature filter mode. */
 504         RTE_FDIR_MODE_PERFECT,       /**< Enable FDIR perfect filter mode. */
 505 };
 506
 507 /**
 508  *  Memory space that can be configured to store Flow Director filters
 509  *  in the board memory.
 510  */
 511 enum rte_fdir_pballoc_type {
 512         RTE_FDIR_PBALLOC_64K = 0,  /**< 64k. */
 513         RTE_FDIR_PBALLOC_128K,     /**< 128k. */
 514         RTE_FDIR_PBALLOC_256K,     /**< 256k. */
 515 };
 516
 517 /**
 518  *  Select report mode of FDIR hash information in RX descriptors.
 519  */
 520 enum rte_fdir_status_mode {
 521         RTE_FDIR_NO_REPORT_STATUS = 0, /**< Never report FDIR hash. */
 522         RTE_FDIR_REPORT_STATUS, /**< Only report FDIR hash for matching pkts. */
 523         RTE_FDIR_REPORT_STATUS_ALWAYS, /**< Always report FDIR hash. */
 524 };
 525
 526 /**
 527  * A structure used to configure the Flow Director (FDIR) feature
 528  * of an Ethernet port.
 529  *
 530  * If mode is RTE_FDIR_DISABLE, the pballoc value is ignored.
 531  */
 532 struct rte_fdir_conf {
 533         enum rte_fdir_mode mode; /**< Flow Director mode. */
 534         enum rte_fdir_pballoc_type pballoc; /**< Space for FDIR filters. */
 535         enum rte_fdir_status_mode status;  /**< How to report FDIR hash. */
 536         /** Offset of flexbytes field in RX packets (in 16-bit word units). */
 537         uint8_t flexbytes_offset;
 538         /** RX queue of packets matching a "drop" filter in perfect mode. */
 539         uint8_t drop_queue;
 540 };
 541
 542 /**
 543  *  Possible l4type of FDIR filters.
 544  */
 545 enum rte_l4type {
 546         RTE_FDIR_L4TYPE_NONE = 0,       /**< None. */
 547         RTE_FDIR_L4TYPE_UDP,            /**< UDP. */
 548         RTE_FDIR_L4TYPE_TCP,            /**< TCP. */
 549         RTE_FDIR_L4TYPE_SCTP,           /**< SCTP. */
 550 };
 551
 552 /**
 553  *  Select IPv4 or IPv6 FDIR filters.
 554  */
 555 enum rte_iptype {
 556         RTE_FDIR_IPTYPE_IPV4 = 0,     /**< IPv4. */
 557         RTE_FDIR_IPTYPE_IPV6 ,        /**< IPv6. */
 558 };
 559
 560 /**
 561  *  A structure used to define a FDIR packet filter.
 562  */
 563 struct rte_fdir_filter {
 564         uint16_t flex_bytes; /**< Flex bytes value to match. */
 565         uint16_t vlan_id; /**< VLAN ID value to match, 0 otherwise. */
 566         uint16_t port_src; /**< Source port to match, 0 otherwise. */
 567         uint16_t port_dst; /**< Destination port to match, 0 otherwise. */
 568         union {
 569                 uint32_t ipv4_addr; /**< IPv4 source address to match. */
 570                 uint32_t ipv6_addr[4]; /**< IPv6 source address to match. */
 571         } ip_src; /**< IPv4/IPv6 source address to match (union of above). */
 572         union {
 573                 uint32_t ipv4_addr; /**< IPv4 destination address to match. */
 574                 uint32_t ipv6_addr[4]; /**< IPv6 destination address to match */
 575         } ip_dst; /**< IPv4/IPv6 destination address to match (union of above). */
 576         enum rte_l4type l4type; /**< l4type to match: NONE/UDP/TCP/SCTP. */
 577         enum rte_iptype iptype; /**< IP packet type to match: IPv4 or IPv6. */
 578 };
 579
 580 /**
 581  *  A structure used to configure FDIR masks that are used by the device
 582  *  to match the various fields of RX packet headers.
 583  *  @note The only_ip_flow field has the opposite meaning compared to other
 584  *  masks!
 585  */
 586 struct rte_fdir_masks {
 587         /** When set to 1, packet l4type is \b NOT relevant in filters, and
 588            source and destination port masks must be set to zero. */
 589         uint8_t only_ip_flow;
 590         /** If set to 1, vlan_id is relevant in filters. */
 591         uint8_t vlan_id;
 592         /** If set to 1, vlan_prio is relevant in filters. */
 593         uint8_t vlan_prio;
 594         /** If set to 1, flexbytes is relevant in filters. */
 595         uint8_t flexbytes;
 596         /** If set to 1, set the IPv6 masks. Otherwise set the IPv4 masks. */
 597         uint8_t set_ipv6_mask;
 598         /** When set to 1, comparison of destination IPv6 address with IP6AT
 599             registers is meaningful. */
 600         uint8_t comp_ipv6_dst;
 601         /** Mask of Destination IPv4 Address. All bits set to 1 define the
 602             relevant bits to use in the destination address of an IPv4 packet
 603             when matching it against FDIR filters. */
 604         uint32_t dst_ipv4_mask;
 605         /** Mask of Source IPv4 Address. All bits set to 1 define
 606             the relevant bits to use in the source address of an IPv4 packet
 607             when matching it against FDIR filters. */
 608         uint32_t src_ipv4_mask;
 609         /** Mask of Source IPv6 Address. All bits set to 1 define the
 610             relevant BYTES to use in the source address of an IPv6 packet
 611             when matching it against FDIR filters. */
 612         uint16_t dst_ipv6_mask;
 613         /** Mask of Destination IPv6 Address. All bits set to 1 define the
 614             relevant BYTES to use in the destination address of an IPv6 packet
 615             when matching it against FDIR filters. */
 616         uint16_t src_ipv6_mask;
 617         /** Mask of Source Port. All bits set to 1 define the relevant
 618             bits to use in the source port of an IP packets when matching it
 619             against FDIR filters. */
 620         uint16_t src_port_mask;
 621         /** Mask of Destination Port. All bits set to 1 define the relevant
 622             bits to use in the destination port of an IP packet when matching it
 623             against FDIR filters. */
 624         uint16_t dst_port_mask;
 625 };
 626
 627 /**
 628  *  A structure used to report the status of the flow director filters in use.
 629  */
 630 struct rte_eth_fdir {
 631         /** Number of filters with collision indication. */
 632         uint16_t collision;
 633         /** Number of free (non programmed) filters. */
 634         uint16_t free;
 635         /** The Lookup hash value of the added filter that updated the value
 636            of the MAXLEN field */
 637         uint16_t maxhash;
 638         /** Longest linked list of filters in the table. */
 639         uint8_t maxlen;
 640         /** Number of added filters. */
 641         uint64_t add;
 642         /** Number of removed filters. */
 643         uint64_t remove;
 644         /** Number of failed added filters (no more space in device). */
 645         uint64_t f_add;
 646         /** Number of failed removed filters. */
 647         uint64_t f_remove;
 648 };
 649
 650 /**
 651  * A structure used to enable/disable specific device interrupts.
 652  */
 653 struct rte_intr_conf {
 654         /** enable/disable lsc interrupt. 0 (default) - disable, 1 enable */
 655         uint16_t lsc;
 656 };
 657
 658 /**
 659  * A structure used to configure an Ethernet port.
 660  * Depending upon the RX multi-queue mode, extra advanced
 661  * configuration settings may be needed.
 662  */
 663 struct rte_eth_conf {
 664         uint16_t link_speed;
 665         /**< ETH_LINK_SPEED_10[0|00|000], or 0 for autonegotation */
 666         uint16_t link_duplex;
 667         /**< ETH_LINK_[HALF_DUPLEX|FULL_DUPLEX], or 0 for autonegotation */
 668         struct rte_eth_rxmode rxmode; /**< Port RX configuration. */
 669         struct rte_eth_txmode txmode; /**< Port TX configuration. */
 670         union {
 671                 struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
 672                 struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
 673                 /**< Port vmdq+dcb configuration. */
 674                 struct rte_eth_dcb_rx_conf dcb_rx_conf;
 675                 /**< Port dcb RX configuration. */
 676         } rx_adv_conf; /**< Port RX filtering configuration (union). */
 677         union {
 678                 struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
 679                 /**< Port vmdq+dcb TX configuration. */
 680                 struct rte_eth_dcb_tx_conf dcb_tx_conf;
 681                 /**< Port dcb TX configuration. */
 682         } tx_adv_conf; /**< Port TX DCB configuration (union). */
 683         /** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
 684             is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
 685         uint32_t dcb_capability_en;
 686         struct rte_fdir_conf fdir_conf; /**< FDIR configuration. */
 687         struct rte_intr_conf intr_conf; /**< Interrupt mode configuration. */
 688 };
 689
 690 /**
 691  * A structure used to retrieve the contextual information of
 692  * an Ethernet device, such as the controlling driver of the device,
 693  * its PCI context, etc...
 694  */
 695 struct rte_eth_dev_info {
 696         struct rte_pci_device *pci_dev; /**< Device PCI information. */
 697         const char *driver_name; /**< Device Driver name. */
 698         uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
 699         uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
 700         uint16_t max_rx_queues; /**< Maximum number of RX queues. */
 701         uint16_t max_tx_queues; /**< Maximum number of TX queues. */
 702         uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
 703 };
 704
 705 struct rte_eth_dev;
 706
 707 struct rte_eth_dev_callback;
 708 /** @internal Structure to keep track of registered callbacks */
 709 TAILQ_HEAD(rte_eth_dev_cb_list, rte_eth_dev_callback);
 710
 711 /*
 712  * Definitions of all functions exported by an Ethernet driver through the
 713  * the generic structure of type *eth_dev_ops* supplied in the *rte_eth_dev*
 714  * structure associated with an Ethernet device.
 715  */
 716
 717 typedef int  (*eth_dev_configure_t)(struct rte_eth_dev *dev);
 718 /**< @internal Ethernet device configuration. */
 719
 720 typedef int  (*eth_dev_start_t)(struct rte_eth_dev *dev);
 721 /**< @internal Function used to start a configured Ethernet device. */
 722
 723 typedef void (*eth_dev_stop_t)(struct rte_eth_dev *dev);
 724 /**< @internal Function used to stop a configured Ethernet device. */
 725
 726 typedef void (*eth_dev_close_t)(struct rte_eth_dev *dev);
 727 /**< @internal Function used to close a configured Ethernet device. */
 728
 729 typedef void (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev);
 730 /**< @internal Function used to enable the RX promiscuous mode of an Ethernet device. */
 731
 732 typedef void (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev);
 733 /**< @internal Function used to disable the RX promiscuous mode of an Ethernet device. */
 734
 735 typedef void (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
 736 /**< @internal Enable the receipt of all multicast packets by an Ethernet device. */
 737
 738 typedef void (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
 739 /**< @internal Disable the receipt of all multicast packets by an Ethernet device. */
 740
 741 typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
 742                                 int wait_to_complete);
 743 /**< @internal Get link speed, duplex mode and state (up/down) of an Ethernet device. */
 744
 745 typedef void (*eth_stats_get_t)(struct rte_eth_dev *dev,
 746                                 struct rte_eth_stats *igb_stats);
 747 /**< @internal Get global I/O statistics of an Ethernet device. */
 748
 749 typedef void (*eth_stats_reset_t)(struct rte_eth_dev *dev);
 750 /**< @internal Reset global I/O statistics of an Ethernet device to 0. */
 751
 752 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
 753                                              uint16_t queue_id,
 754                                              uint8_t stat_idx,
 755                                              uint8_t is_rx);
 756 /**< @internal Set a queue statistics mapping for a tx/rx queue of an Ethernet device. */
 757
 758 typedef void (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
 759                                     struct rte_eth_dev_info *dev_info);
 760 /**< @internal Get specific informations of an Ethernet device. */
 761
 762 typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
 763                                     uint16_t rx_queue_id,
 764                                     uint16_t nb_rx_desc,
 765                                     unsigned int socket_id,
 766                                     const struct rte_eth_rxconf *rx_conf,
 767                                     struct rte_mempool *mb_pool);
 768 /**< @internal Set up a receive queue of an Ethernet device. */
 769
 770 typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
 771                                     uint16_t tx_queue_id,
 772                                     uint16_t nb_tx_desc,
 773                                     unsigned int socket_id,
 774                                     const struct rte_eth_txconf *tx_conf);
 775 /**< @internal Setup a transmit queue of an Ethernet device. */
 776
 777 typedef void (*eth_queue_release_t)(void *queue);
 778 /**< @internal Release memory resources allocated by given RX/TX queue. */
 779
 780 typedef uint32_t (*eth_rx_queue_count_t)(struct rte_eth_dev *dev,
 781                                          uint16_t rx_queue_id);
 782 /**< @Get number of available descriptors on a receive queue of an Ethernet device. */
 783
 784 typedef int (*eth_rx_descriptor_done_t)(void *rxq, uint16_t offset);
 785 /**< @Check DD bit of specific RX descriptor */
 786
 787 typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
 788                                   uint16_t vlan_id,
 789                                   int on);
 790 /**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */
 791
 792 typedef void (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
 793                                   uint16_t tpid);
 794 /**< @internal set the outer VLAN-TPID by an Ethernet device. */
 795
 796 typedef void (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
 797 /**< @internal set VLAN offload function by an Ethernet device. */
 798
 799 typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
 800                                   uint16_t rx_queue_id,
 801                                   int on);
 802 /**< @internal VLAN stripping enable/disable by an queue of Ethernet device. */
 803
 804 typedef uint16_t (*eth_rx_burst_t)(void *rxq,
 805                                    struct rte_mbuf **rx_pkts,
 806                                    uint16_t nb_pkts);
 807 /**< @internal Retrieve input packets from a receive queue of an Ethernet device. */
 808
 809 typedef uint16_t (*eth_tx_burst_t)(void *txq,
 810                                    struct rte_mbuf **tx_pkts,
 811                                    uint16_t nb_pkts);
 812 /**< @internal Send output packets on a transmit queue of an Ethernet device. */
 813
 814 typedef int (*fdir_add_signature_filter_t)(struct rte_eth_dev *dev,
 815                                            struct rte_fdir_filter *fdir_ftr,
 816                                            uint8_t rx_queue);
 817 /**< @internal Setup a new signature filter rule on an Ethernet device */
 818
 819 typedef int (*fdir_update_signature_filter_t)(struct rte_eth_dev *dev,
 820                                               struct rte_fdir_filter *fdir_ftr,
 821                                               uint8_t rx_queue);
 822 /**< @internal Update a signature filter rule on an Ethernet device */
 823
 824 typedef int (*fdir_remove_signature_filter_t)(struct rte_eth_dev *dev,
 825                                               struct rte_fdir_filter *fdir_ftr);
 826 /**< @internal Remove a  signature filter rule on an Ethernet device */
 827
 828 typedef void (*fdir_infos_get_t)(struct rte_eth_dev *dev,
 829                                  struct rte_eth_fdir *fdir);
 830 /**< @internal Get information about fdir status */
 831
 832 typedef int (*fdir_add_perfect_filter_t)(struct rte_eth_dev *dev,
 833                                          struct rte_fdir_filter *fdir_ftr,
 834                                          uint16_t soft_id, uint8_t rx_queue,
 835                                          uint8_t drop);
 836 /**< @internal Setup a new perfect filter rule on an Ethernet device */
 837
 838 typedef int (*fdir_update_perfect_filter_t)(struct rte_eth_dev *dev,
 839                                             struct rte_fdir_filter *fdir_ftr,
 840                                             uint16_t soft_id, uint8_t rx_queue,
 841                                             uint8_t drop);
 842 /**< @internal Update a perfect filter rule on an Ethernet device */
 843
 844 typedef int (*fdir_remove_perfect_filter_t)(struct rte_eth_dev *dev,
 845                                             struct rte_fdir_filter *fdir_ftr,
 846                                             uint16_t soft_id);
 847 /**< @internal Remove a perfect filter rule on an Ethernet device */
 848
 849 typedef int (*fdir_set_masks_t)(struct rte_eth_dev *dev,
 850                                 struct rte_fdir_masks *fdir_masks);
 851 /**< @internal Setup flow director masks on an Ethernet device */
 852
 853 typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
 854                                 struct rte_eth_fc_conf *fc_conf);
 855 /**< @internal Setup flow control parameter on an Ethernet device */
 856
 857 typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
 858                                 struct rte_eth_pfc_conf *pfc_conf);
 859 /**< @internal Setup priority flow control parameter on an Ethernet device */
 860
 861 typedef int (*reta_update_t)(struct rte_eth_dev *dev,
 862                                 struct rte_eth_rss_reta *reta_conf);
 863 /**< @internal Update RSS redirection table on an Ethernet device */
 864
 865 typedef int (*reta_query_t)(struct rte_eth_dev *dev,
 866                                 struct rte_eth_rss_reta *reta_conf);
 867 /**< @internal Query RSS redirection table on an Ethernet device */
 868
 869 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
 870 /**< @internal Turn on SW controllable LED on an Ethernet device */
 871
 872 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
 873 /**< @internal Turn off SW controllable LED on an Ethernet device */
 874
 875 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
 876 /**< @internal Remove MAC address from receive address register */
 877
 878 typedef void (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
 879                                   struct ether_addr *mac_addr,
 880                                   uint32_t index,
 881                                   uint32_t vmdq);
 882 /**< @internal Set a MAC address into Receive Address Address Register */
 883
 884 /**
 885  * @internal A structure containing the functions exported by an Ethernet driver.
 886  */
 887 struct eth_dev_ops {
 888         eth_dev_configure_t        dev_configure; /**< Configure device. */
 889         eth_dev_start_t            dev_start;     /**< Start device. */
 890         eth_dev_stop_t             dev_stop;      /**< Stop device. */
 891         eth_dev_close_t            dev_close;     /**< Close device. */
 892         eth_promiscuous_enable_t   promiscuous_enable; /**< Promiscuous ON. */
 893         eth_promiscuous_disable_t  promiscuous_disable;/**< Promiscuous OFF. */
 894         eth_allmulticast_enable_t  allmulticast_enable;/**< RX multicast ON. */
 895         eth_allmulticast_disable_t allmulticast_disable;/**< RX multicast OF. */
 896         eth_link_update_t          link_update;   /**< Get device link state. */
 897         eth_stats_get_t            stats_get;     /**< Get device statistics. */
 898         eth_stats_reset_t          stats_reset;   /**< Reset device statistics. */
 899         eth_queue_stats_mapping_set_t queue_stats_mapping_set;
 900         /**< Configure per queue stat counter mapping. */
 901         eth_dev_infos_get_t        dev_infos_get; /**< Get device info. */
 902         vlan_filter_set_t          vlan_filter_set;  /**< Filter VLAN Setup. */
 903         vlan_tpid_set_t            vlan_tpid_set;      /**< Outer VLAN TPID Setup. */
 904         vlan_strip_queue_set_t     vlan_strip_queue_set; /**< VLAN Stripping on queue. */
 905         vlan_offload_set_t         vlan_offload_set; /**< Set VLAN Offload. */
 906         eth_rx_queue_setup_t       rx_queue_setup;/**< Set up device RX queue.*/
 907         eth_queue_release_t        rx_queue_release;/**< Release RX queue.*/
 908         eth_rx_queue_count_t       rx_queue_count; /**< Get Rx queue count. */
 909         eth_rx_descriptor_done_t   rx_descriptor_done;  /**< Check rxd DD bit */
 910         eth_tx_queue_setup_t       tx_queue_setup;/**< Set up device TX queue.*/
 911         eth_queue_release_t        tx_queue_release;/**< Release TX queue.*/
 912         eth_dev_led_on_t           dev_led_on;    /**< Turn on LED. */
 913         eth_dev_led_off_t          dev_led_off;   /**< Turn off LED. */
 914         flow_ctrl_set_t            flow_ctrl_set; /**< Setup flow control. */
 915         priority_flow_ctrl_set_t   priority_flow_ctrl_set; /**< Setup priority flow control.*/
 916         eth_mac_addr_remove_t      mac_addr_remove; /**< Remove MAC address */
 917         eth_mac_addr_add_t         mac_addr_add;  /**< Add a MAC address */
 918
 919         /** Add a signature filter. */
 920         fdir_add_signature_filter_t fdir_add_signature_filter;
 921         /** Update a signature filter. */
 922         fdir_update_signature_filter_t fdir_update_signature_filter;
 923         /** Remove a signature filter. */
 924         fdir_remove_signature_filter_t fdir_remove_signature_filter;
 925         /** Get information about FDIR status. */
 926         fdir_infos_get_t fdir_infos_get;
 927         /** Add a perfect filter. */
 928         fdir_add_perfect_filter_t fdir_add_perfect_filter;
 929         /** Update a perfect filter. */
 930         fdir_update_perfect_filter_t fdir_update_perfect_filter;
 931         /** Remove a perfect filter. */
 932         fdir_remove_perfect_filter_t fdir_remove_perfect_filter;
 933         /** Setup masks for FDIR filtering. */
 934         fdir_set_masks_t fdir_set_masks;
 935         /** Update redirection table. */
 936         reta_update_t reta_update;
 937         /** Query redirection table. */
 938         reta_query_t reta_query;
 939 };
 940
 941 /**
 942  * @internal
 943  * The generic data structure associated with each ethernet device.
 944  *
 945  * Pointers to burst-oriented packet receive and transmit functions are
 946  * located at the beginning of the structure, along with the pointer to
 947  * where all the data elements for the particular device are stored in shared
 948  * memory. This split allows the function pointer and driver data to be per-
 949  * process, while the actual configuration data for the device is shared.
 950  */
 951 struct rte_eth_dev {
 952         eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
 953         eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
 954         struct rte_eth_dev_data *data;  /**< Pointer to device data */
 955         const struct eth_driver *driver;/**< Driver for this device */
 956         struct eth_dev_ops *dev_ops;    /**< Functions exported by PMD */
 957         struct rte_pci_device *pci_dev; /**< PCI info. supplied by probing */
 958         struct rte_eth_dev_cb_list callbacks; /**< User application callbacks */
 959 };
 960
 961 struct rte_eth_dev_sriov {
 962         uint8_t active;               /**< SRIOV is active with 16, 32 or 64 pools */
 963         uint8_t nb_q_per_pool;        /**< rx queue number per pool */
 964         uint16_t def_vmdq_idx;        /**< Default pool num used for PF */
 965         uint16_t def_pool_q_idx;      /**< Default pool queue start reg index */
 966 };
 967 #define RTE_ETH_DEV_SRIOV(dev)         ((dev)->data->sriov)
 968
 969 /**
 970  * @internal
 971  * The data part, with no function pointers, associated with each ethernet device.
 972  *
 973  * This structure is safe to place in shared memory to be common among different
 974  * processes in a multi-process configuration.
 975  */
 976 struct rte_eth_dev_data {
 977         void **rx_queues; /**< Array of pointers to RX queues. */
 978         void **tx_queues; /**< Array of pointers to TX queues. */
 979         uint16_t nb_rx_queues; /**< Number of RX queues. */
 980         uint16_t nb_tx_queues; /**< Number of TX queues. */
 981
 982         struct rte_eth_dev_sriov sriov;    /**< SRIOV data */
 983
 984         void *dev_private;              /**< PMD-specific private data */
 985
 986         struct rte_eth_link dev_link;
 987         /**< Link-level information & status */
 988
 989         struct rte_eth_conf dev_conf;   /**< Configuration applied to device. */
 990         uint16_t max_frame_size;        /**< Default is ETHER_MAX_LEN (1518). */
 991
 992         uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
 993         struct ether_addr* mac_addrs;/**< Device Ethernet Link address. */
 994         uint8_t port_id;           /**< Device [external] port identifier. */
 995         uint8_t promiscuous   : 1, /**< RX promiscuous mode ON(1) / OFF(0). */
 996                 scattered_rx : 1,  /**< RX of scattered packets is ON(1) / OFF(0) */
 997                 all_multicast : 1, /**< RX all multicast mode ON(1) / OFF(0). */
 998                 dev_started : 1;   /**< Device state: STARTED(1) / STOPPED(0). */
 999 };
1000
1001 /**
1002  * @internal
1003  * The pool of *rte_eth_dev* structures. The size of the pool
1004  * is configured at compile-time in the <rte_ethdev.c> file.
1005  */
1006 extern struct rte_eth_dev rte_eth_devices[];
1007
1008 /**
1009  * Get the total number of Ethernet devices that have been successfully
1010  * initialized by the [matching] Ethernet driver during the PCI probing phase.
1011  * All devices whose port identifier is in the range
1012  * [0,  rte_eth_dev_count() - 1] can be operated on by network applications.
1013  *
1014  * @return
1015  *   - The total number of usable Ethernet devices.
1016  */
1017 extern uint8_t rte_eth_dev_count(void);
1018
1019 struct eth_driver;
1020 /**
1021  * @internal
1022  * Initialization function of an Ethernet driver invoked for each matching
1023  * Ethernet PCI device detected during the PCI probing phase.
1024  *
1025  * @param eth_drv
1026  *   The pointer to the [matching] Ethernet driver structure supplied by
1027  *   the PMD when it registered itself.
1028  * @param eth_dev
1029  *   The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1030  *   associated with the matching device and which have been [automatically]
1031  *   allocated in the *rte_eth_devices* array.
1032  *   The *eth_dev* structure is supplied to the driver initialization function
1033  *   with the following fields already initialized:
1034  *
1035  *   - *pci_dev*: Holds the pointers to the *rte_pci_device* structure which
1036  *     contains the generic PCI information of the matching device.
1037  *
1038  *   - *dev_private*: Holds a pointer to the device private data structure.
1039  *
1040  *   - *max_frame_size*: Contains the default Ethernet maximum frame length
1041  *     (1518).
1042  *
1043  *   - *port_id*: Contains the port index of the device (actually the index
1044  *     of the *eth_dev* structure in the *rte_eth_devices* array).
1045  *
1046  * @return
1047  *   - 0: Success, the device is properly initialized by the driver.
1048  *        In particular, the driver MUST have set up the *dev_ops* pointer
1049  *        of the *eth_dev* structure.
1050  *   - <0: Error code of the device initialization failure.
1051  */
1052 typedef int (*eth_dev_init_t)(struct eth_driver  *eth_drv,
1053                               struct rte_eth_dev *eth_dev);
1054
1055 /**
1056  * @internal
1057  * The structure associated with a PMD Ethernet driver.
1058  *
1059  * Each Ethernet driver acts as a PCI driver and is represented by a generic
1060  * *eth_driver* structure that holds:
1061  *
1062  * - An *rte_pci_driver* structure (which must be the first field).
1063  *
1064  * - The *eth_dev_init* function invoked for each matching PCI device.
1065  *
1066  * - The size of the private data to allocate for each matching device.
1067  */
1068 struct eth_driver {
1069         struct rte_pci_driver pci_drv;    /**< The PMD is also a PCI driver. */
1070         eth_dev_init_t eth_dev_init;      /**< Device init function. */
1071         unsigned int dev_private_size;    /**< Size of device private data. */
1072 };
1073
1074 /**
1075  * @internal
1076  * A function invoked by the initialization function of an Ethernet driver
1077  * to simultaneously register itself as a PCI driver and as an Ethernet
1078  * Poll Mode Driver (PMD).
1079  *
1080  * @param eth_drv
1081  *   The pointer to the *eth_driver* structure associated with
1082  *   the Ethernet driver.
1083  */
1084 extern void rte_eth_driver_register(struct eth_driver *eth_drv);
1085
1086 /**
1087  * The initialization function of the driver for
1088  * Intel(r) IGB Gigabit Ethernet Controller devices.
1089  * This function is invoked once at EAL start time.
1090  * @return
1091  *   0 on success
1092  */
1093 extern int rte_igb_pmd_init(void);
1094
1095 /**
1096  * The initialization function of the driver for
1097  * Intel(r) EM Gigabit Ethernet Controller devices.
1098  * This function is invoked once at EAL start time.
1099  * @return
1100  *   0 on success
1101  */
1102 extern int rte_em_pmd_init(void);
1103
1104 /**
1105  * The initialization function of the driver for 1Gbps Intel IGB_VF
1106  * Ethernet devices.
1107  * Invoked once at EAL start time.
1108  * @return
1109  *   0 on success
1110  */
1111 extern int rte_igbvf_pmd_init(void);
1112
1113 /**
1114  * The initialization function of the driver for 10Gbps Intel IXGBE
1115  * Ethernet devices.
1116  * Invoked once at EAL start time.
1117  * @return
1118  *   0 on success
1119  */
1120 extern int rte_ixgbe_pmd_init(void);
1121
1122 /**
1123  * The initialization function of the driver for 10Gbps Intel IXGBE_VF
1124  * Ethernet devices.
1125  * Invoked once at EAL start time.
1126  * @return
1127  *   0 on success
1128  */
1129 extern int rte_ixgbevf_pmd_init(void);
1130
1131 /**
1132  * The initialization function of *all* supported and enabled drivers.
1133  * Right now, the following PMDs are supported:
1134  *  - igb
1135  *  - igbvf
1136  *  - em
1137  *  - ixgbe
1138  *  - ixgbevf
1139  * This function is invoked once at EAL start time.
1140  * @return
1141  *   0 on success.
1142  *   Error code of the device initialization failure,
1143  *   -ENODEV if there are no drivers available
1144  *   (e.g. if all driver config options are = n).
1145  */
1146 static inline
1147 int rte_pmd_init_all(void)
1148 {
1149         int ret = -ENODEV;
1150
1151 #ifdef RTE_LIBRTE_IGB_PMD
1152         if ((ret = rte_igb_pmd_init()) != 0) {
1153                 RTE_LOG(ERR, PMD, "Cannot init igb PMD\n");
1154                 return (ret);
1155         }
1156         if ((ret = rte_igbvf_pmd_init()) != 0) {
1157                 RTE_LOG(ERR, PMD, "Cannot init igbvf PMD\n");
1158                 return (ret);
1159         }
1160 #endif /* RTE_LIBRTE_IGB_PMD */
1161
1162 #ifdef RTE_LIBRTE_EM_PMD
1163         if ((ret = rte_em_pmd_init()) != 0) {
1164                 RTE_LOG(ERR, PMD, "Cannot init em PMD\n");
1165                 return (ret);
1166         }
1167 #endif /* RTE_LIBRTE_EM_PMD */
1168
1169 #ifdef RTE_LIBRTE_IXGBE_PMD
1170         if ((ret = rte_ixgbe_pmd_init()) != 0) {
1171                 RTE_LOG(ERR, PMD, "Cannot init ixgbe PMD\n");
1172                 return (ret);
1173         }
1174         if ((ret = rte_ixgbevf_pmd_init()) != 0) {
1175                 RTE_LOG(ERR, PMD, "Cannot init ixgbevf PMD\n");
1176                 return (ret);
1177         }
1178 #endif /* RTE_LIBRTE_IXGBE_PMD */
1179
1180         if (ret == -ENODEV)
1181                 RTE_LOG(ERR, PMD, "No PMD(s) are configured\n");
1182         return (ret);
1183 }
1184
1185 /**
1186  * Configure an Ethernet device.
1187  * This function must be invoked first before any other function in the
1188  * Ethernet API. This function can also be re-invoked when a device is in the
1189  * stopped state.
1190  *
1191  * @param port_id
1192  *   The port identifier of the Ethernet device to configure.
1193  * @param nb_rx_queue
1194  *   The number of receive queues to set up for the Ethernet device.
1195  * @param nb_tx_queue
1196  *   The number of transmit queues to set up for the Ethernet device.
1197  * @param eth_conf
1198  *   The pointer to the configuration data to be used for the Ethernet device.
1199  *   The *rte_eth_conf* structure includes:
1200  *     -  the hardware offload features to activate, with dedicated fields for
1201  *        each statically configurable offload hardware feature provided by
1202  *        Ethernet devices, such as IP checksum or VLAN tag stripping for
1203  *        example.
1204  *     - the Receive Side Scaling (RSS) configuration when using multiple RX
1205  *         queues per port.
1206  *
1207  *   Embedding all configuration information in a single data structure
1208  *   is the more flexible method that allows the addition of new features
1209  *   without changing the syntax of the API.
1210  * @return
1211  *   - 0: Success, device configured.
1212  *   - <0: Error code returned by the driver configuration function.
1213  */
1214 extern int rte_eth_dev_configure(uint8_t port_id,
1215                                  uint16_t nb_rx_queue,
1216                                  uint16_t nb_tx_queue,
1217                                  const struct rte_eth_conf *eth_conf);
1218
1219 /**
1220  * Allocate and set up a receive queue for an Ethernet device.
1221  *
1222  * The function allocates a contiguous block of memory for *nb_rx_desc*
1223  * receive descriptors from a memory zone associated with *socket_id*
1224  * and initializes each receive descriptor with a network buffer allocated
1225  * from the memory pool *mb_pool*.
1226  *
1227  * @param port_id
1228  *   The port identifier of the Ethernet device.
1229  * @param rx_queue_id
1230  *   The index of the receive queue to set up.
1231  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
1232  *   to rte_eth_dev_configure().
1233  * @param nb_rx_desc
1234  *   The number of receive descriptors to allocate for the receive ring.
1235  * @param socket_id
1236  *   The *socket_id* argument is the socket identifier in case of NUMA.
1237  *   The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1238  *   the DMA memory allocated for the receive descriptors of the ring.
1239  * @param rx_conf
1240  *   The pointer to the configuration data to be used for the receive queue.
1241  *   The *rx_conf* structure contains an *rx_thresh* structure with the values
1242  *   of the Prefetch, Host, and Write-Back threshold registers of the receive
1243  *   ring.
1244  * @param mb_pool
1245  *   The pointer to the memory pool from which to allocate *rte_mbuf* network
1246  *   memory buffers to populate each descriptor of the receive ring.
1247  * @return
1248  *   - 0: Success, receive queue correctly set up.
1249  *   - -EINVAL: The size of network buffers which can be allocated from the
1250  *      memory pool does not fit the various buffer sizes allowed by the
1251  *      device controller.
1252  *   - -ENOMEM: Unable to allocate the receive ring descriptors or to
1253  *      allocate network memory buffers from the memory pool when
1254  *      initializing receive descriptors.
1255  */
1256 extern int rte_eth_rx_queue_setup(uint8_t port_id, uint16_t rx_queue_id,
1257                                   uint16_t nb_rx_desc, unsigned int socket_id,
1258                                   const struct rte_eth_rxconf *rx_conf,
1259                                   struct rte_mempool *mb_pool);
1260
1261 /**
1262  * Allocate and set up a transmit queue for an Ethernet device.
1263  *
1264  * @param port_id
1265  *   The port identifier of the Ethernet device.
1266  * @param tx_queue_id
1267  *   The index of the transmit queue to set up.
1268  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
1269  *   to rte_eth_dev_configure().
1270  * @param nb_tx_desc
1271  *   The number of transmit descriptors to allocate for the transmit ring.
1272  * @param socket_id
1273  *   The *socket_id* argument is the socket identifier in case of NUMA.
1274  *   Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1275  *   the DMA memory allocated for the transmit descriptors of the ring.
1276  * @param tx_conf
1277  *   The pointer to the configuration data to be used for the transmit queue.
1278  *   The *tx_conf* structure contains the following data:
1279  *   - The *tx_thresh* structure with the values of the Prefetch, Host, and
1280  *     Write-Back threshold registers of the transmit ring.
1281  *     When setting Write-Back threshold to the value greater then zero,
1282  *     *tx_rs_thresh* value should be explicitly set to one.
1283  *   - The *tx_free_thresh* value indicates the [minimum] number of network
1284  *     buffers that must be pending in the transmit ring to trigger their
1285  *     [implicit] freeing by the driver transmit function.
1286  *   - The *tx_rs_thresh* value indicates the [minimum] number of transmit
1287  *     descriptors that must be pending in the transmit ring before setting the
1288  *     RS bit on a descriptor by the driver transmit function.
1289  *     The *tx_rs_thresh* value should be less or equal then
1290  *     *tx_free_thresh* value, and both of them should be less then
1291  *     *nb_tx_desc* - 3.
1292  *   - The *txq_flags* member contains flags to pass to the TX queue setup
1293  *     function to configure the behavior of the TX queue. This should be set
1294  *     to 0 if no special configuration is required.
1295  *
1296  *     Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces
1297  *     the transmit function to use default values.
1298  * @return
1299  *   - 0: Success, the transmit queue is correctly set up.
1300  *   - -ENOMEM: Unable to allocate the transmit ring descriptors.
1301  */
1302 extern int rte_eth_tx_queue_setup(uint8_t port_id, uint16_t tx_queue_id,
1303                                   uint16_t nb_tx_desc, unsigned int socket_id,
1304                                   const struct rte_eth_txconf *tx_conf);
1305
1306 /*
1307  * Return the NUMA socket to which an Ethernet device is connected
1308  *
1309  * @param port_id
1310  *   The port identifier of the Ethernet device
1311  * @return
1312  *   The NUMA socket id to which the Ethernet device is connected or
1313  *   a default of zero if the socket could not be determined.
1314  *   -1 is returned is the port_id value is out of range.
1315  */
1316 extern int rte_eth_dev_socket_id(uint8_t port_id);
1317
1318
1319 /**
1320  * Start an Ethernet device.
1321  *
1322  * The device start step is the last one and consists of setting the configured
1323  * offload features and in starting the transmit and the receive units of the
1324  * device.
1325  * On success, all basic functions exported by the Ethernet API (link status,
1326  * receive/transmit, and so on) can be invoked.
1327  *
1328  * @param port_id
1329  *   The port identifier of the Ethernet device.
1330  * @return
1331  *   - 0: Success, Ethernet device started.
1332  *   - <0: Error code of the driver device start function.
1333  */
1334 extern int rte_eth_dev_start(uint8_t port_id);
1335
1336 /**
1337  * Stop an Ethernet device. The device can be restarted with a call to
1338  * rte_eth_dev_start()
1339  *
1340  * @param port_id
1341  *   The port identifier of the Ethernet device.
1342  */
1343 extern void rte_eth_dev_stop(uint8_t port_id);
1344
1345 /**
1346  * Close an Ethernet device. The device cannot be restarted!
1347  *
1348  * @param port_id
1349  *   The port identifier of the Ethernet device.
1350  */
1351 extern void rte_eth_dev_close(uint8_t port_id);
1352
1353 /**
1354  * Enable receipt in promiscuous mode for an Ethernet device.
1355  *
1356  * @param port_id
1357  *   The port identifier of the Ethernet device.
1358  */
1359 extern void rte_eth_promiscuous_enable(uint8_t port_id);
1360
1361 /**
1362  * Disable receipt in promiscuous mode for an Ethernet device.
1363  *
1364  * @param port_id
1365  *   The port identifier of the Ethernet device.
1366  */
1367 extern void rte_eth_promiscuous_disable(uint8_t port_id);
1368
1369 /**
1370  * Return the value of promiscuous mode for an Ethernet device.
1371  *
1372  * @param port_id
1373  *   The port identifier of the Ethernet device.
1374  * @return
1375  *   - (1) if promiscuous is enabled
1376  *   - (0) if promiscuous is disabled.
1377  *   - (-1) on error
1378  */
1379 extern int rte_eth_promiscuous_get(uint8_t port_id);
1380
1381 /**
1382  * Enable the receipt of any multicast frame by an Ethernet device.
1383  *
1384  * @param port_id
1385  *   The port identifier of the Ethernet device.
1386  */
1387 extern void rte_eth_allmulticast_enable(uint8_t port_id);
1388
1389 /**
1390  * Disable the receipt of all multicast frames by an Ethernet device.
1391  *
1392  * @param port_id
1393  *   The port identifier of the Ethernet device.
1394  */
1395 extern void rte_eth_allmulticast_disable(uint8_t port_id);
1396
1397 /**
1398  * Return the value of allmulticast mode for an Ethernet device.
1399  *
1400  * @param port_id
1401  *   The port identifier of the Ethernet device.
1402  * @return
1403  *   - (1) if allmulticast is enabled
1404  *   - (0) if allmulticast is disabled.
1405  *   - (-1) on error
1406  */
1407 extern int rte_eth_allmulticast_get(uint8_t port_id);
1408
1409 /**
1410  * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
1411  * or FULL-DUPLEX) of the physical link of an Ethernet device. It might need
1412  * to wait up to 9 seconds in it.
1413  *
1414  * @param port_id
1415  *   The port identifier of the Ethernet device.
1416  * @param link
1417  *   A pointer to an *rte_eth_link* structure to be filled with
1418  *   the status, the speed and the mode of the Ethernet device link.
1419  */
1420 extern void rte_eth_link_get(uint8_t port_id, struct rte_eth_link *link);
1421
1422 /**
1423  * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
1424  * or FULL-DUPLEX) of the physical link of an Ethernet device. It is a no-wait
1425  * version of rte_eth_link_get().
1426  *
1427  * @param port_id
1428  *   The port identifier of the Ethernet device.
1429  * @param link
1430  *   A pointer to an *rte_eth_link* structure to be filled with
1431  *   the status, the speed and the mode of the Ethernet device link.
1432  */
1433 extern void rte_eth_link_get_nowait(uint8_t port_id,
1434                                 struct rte_eth_link *link);
1435
1436 /**
1437  * Retrieve the general I/O statistics of an Ethernet device.
1438  *
1439  * @param port_id
1440  *   The port identifier of the Ethernet device.
1441  * @param stats
1442  *   A pointer to a structure of type *rte_eth_stats* to be filled with
1443  *   the values of device counters for the following set of statistics:
1444  *   - *ipackets* with the total of successfully received packets.
1445  *   - *opackets* with the total of successfully transmitted packets.
1446  *   - *ibytes*   with the total of successfully received bytes.
1447  *   - *obytes*   with the total of successfully transmitted bytes.
1448  *   - *ierrors*  with the total of erroneous received packets.
1449  *   - *oerrors*  with the total of failed transmitted packets.
1450  */
1451 extern void rte_eth_stats_get(uint8_t port_id, struct rte_eth_stats *stats);
1452
1453 /**
1454  * Reset the general I/O statistics of an Ethernet device.
1455  *
1456  * @param port_id
1457  *   The port identifier of the Ethernet device.
1458  */
1459 extern void rte_eth_stats_reset(uint8_t port_id);
1460
1461 /**
1462  *  Set a mapping for the specified transmit queue to the specified per-queue
1463  *  statistics counter.
1464  *
1465  * @param port_id
1466  *   The port identifier of the Ethernet device.
1467  * @param tx_queue_id
1468  *   The index of the transmit queue for which a queue stats mapping is required.
1469  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
1470  *   to rte_eth_dev_configure().
1471  * @param stat_idx
1472  *   The per-queue packet statistics functionality number that the transmit
1473  *   queue is to be assigned.
1474  *   The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
1475  * @return
1476  *   Zero if successful. Non-zero otherwise.
1477  */
1478 extern int rte_eth_dev_set_tx_queue_stats_mapping(uint8_t port_id,
1479                                                   uint16_t tx_queue_id,
1480                                                   uint8_t stat_idx);
1481
1482 /**
1483  *  Set a mapping for the specified receive queue to the specified per-queue
1484  *  statistics counter.
1485  *
1486  * @param port_id
1487  *   The port identifier of the Ethernet device.
1488  * @param rx_queue_id
1489  *   The index of the receive queue for which a queue stats mapping is required.
1490  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
1491  *   to rte_eth_dev_configure().
1492  * @param stat_idx
1493  *   The per-queue packet statistics functionality number that the receive
1494  *   queue is to be assigned.
1495  *   The value must be in the range [0, RTE_MAX_ETHPORT_QUEUE_STATS_MAPS - 1].
1496  * @return
1497  *   Zero if successful. Non-zero otherwise.
1498  */
1499 extern int rte_eth_dev_set_rx_queue_stats_mapping(uint8_t port_id,
1500                                                   uint16_t rx_queue_id,
1501                                                   uint8_t stat_idx);
1502
1503 /**
1504  * Retrieve the Ethernet address of an Ethernet device.
1505  *
1506  * @param port_id
1507  *   The port identifier of the Ethernet device.
1508  * @param mac_addr
1509  *   A pointer to a structure of type *ether_addr* to be filled with
1510  *   the Ethernet address of the Ethernet device.
1511  */
1512 extern void rte_eth_macaddr_get(uint8_t port_id, struct ether_addr *mac_addr);
1513
1514 /**
1515  * Retrieve the contextual information of an Ethernet device.
1516  *
1517  * @param port_id
1518  *   The port identifier of the Ethernet device.
1519  * @param dev_info
1520  *   A pointer to a structure of type *rte_eth_dev_info* to be filled with
1521  *   the contextual information of the Ethernet device.
1522  */
1523 extern void rte_eth_dev_info_get(uint8_t port_id,
1524                                  struct rte_eth_dev_info *dev_info);
1525
1526 /**
1527  * Enable/Disable hardware filtering by an Ethernet device of received
1528  * VLAN packets tagged with a given VLAN Tag Identifier.
1529  *
1530  * @param port_id
1531  *   The port identifier of the Ethernet device.
1532  * @param vlan_id
1533  *   The VLAN Tag Identifier whose filtering must be enabled or disabled.
1534  * @param on
1535  *   If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*.
1536  *   Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*.
1537  * @return
1538  *   - (0) if successful.
1539  *   - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
1540  *   - (-ENODEV) if *port_id* invalid.
1541  *   - (-ENOSYS) if VLAN filtering on *port_id* disabled.
1542  *   - (-EINVAL) if *vlan_id* > 4095.
1543  */
1544 extern int rte_eth_dev_vlan_filter(uint8_t port_id, uint16_t vlan_id , int on);
1545
1546 /**
1547  * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
1548  * 82599/X540 can support VLAN stripping at the rx queue level
1549  *
1550  * @param port_id
1551  *   The port identifier of the Ethernet device.
1552  * @param rx_queue_id
1553  *   The index of the receive queue for which a queue stats mapping is required.
1554  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
1555  *   to rte_eth_dev_configure().
1556  * @param on
1557  *   If 1, Enable VLAN Stripping of the receive queue of the Ethernet port.
1558  *   If 0, Disable VLAN Stripping of the receive queue of the Ethernet port.
1559  * @return
1560  *   - (0) if successful.
1561  *   - (-ENOSUP) if hardware-assisted VLAN stripping not configured.
1562  *   - (-ENODEV) if *port_id* invalid.
1563  *   - (-EINVAL) if *rx_queue_id* invalid.
1564  */
1565 extern int rte_eth_dev_set_vlan_strip_on_queue(uint8_t port_id,
1566                 uint16_t rx_queue_id, int on);
1567
1568 /**
1569  * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
1570  * the VLAN Header. This is a register setup available on some Intel NIC, not
1571  * but all, please check the data sheet for availability.
1572  *
1573  * @param port_id
1574  *   The port identifier of the Ethernet device.
1575  * @param tag_type
1576  *   The Tag Protocol ID
1577  * @return
1578  *   - (0) if successful.
1579  *   - (-ENOSUP) if hardware-assisted VLAN TPID setup is not supported.
1580  *   - (-ENODEV) if *port_id* invalid.
1581  */
1582 extern int rte_eth_dev_set_vlan_ether_type(uint8_t port_id, uint16_t tag_type);
1583
1584 /**
1585  * Set VLAN offload configuration on an Ethernet device
1586  * Enable/Disable Extended VLAN by an Ethernet device, This is a register setup
1587  * available on some Intel NIC, not but all, please check the data sheet for
1588  * availability.
1589  * Enable/Disable VLAN Strip can be done on rx queue for certain NIC, but here
1590  * the configuration is applied on the port level.
1591  *
1592  * @param port_id
1593  *   The port identifier of the Ethernet device.
1594  * @param offload_mask
1595  *   The VLAN Offload bit mask can be mixed use with "OR"
1596  *       ETH_VLAN_STRIP_OFFLOAD
1597  *       ETH_VLAN_FILTER_OFFLOAD
1598  *       ETH_VLAN_EXTEND_OFFLOAD
1599  * @return
1600  *   - (0) if successful.
1601  *   - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
1602  *   - (-ENODEV) if *port_id* invalid.
1603  */
1604 extern int rte_eth_dev_set_vlan_offload(uint8_t port_id, int offload_mask);
1605
1606 /**
1607  * Read VLAN Offload configuration from an Ethernet device
1608  *
1609  * @param port_id
1610  *   The port identifier of the Ethernet device.
1611  * @return
1612  *   - (>0) if successful. Bit mask to indicate
1613  *       ETH_VLAN_STRIP_OFFLOAD
1614  *       ETH_VLAN_FILTER_OFFLOAD
1615  *       ETH_VLAN_EXTEND_OFFLOAD
1616  *   - (-ENODEV) if *port_id* invalid.
1617  */
1618 extern int rte_eth_dev_get_vlan_offload(uint8_t port_id);
1619
1620 /**
1621  *
1622  * Retrieve a burst of input packets from a receive queue of an Ethernet
1623  * device. The retrieved packets are stored in *rte_mbuf* structures whose
1624  * pointers are supplied in the *rx_pkts* array.
1625  *
1626  * The rte_eth_rx_burst() function loops, parsing the RX ring of the
1627  * receive queue, up to *nb_pkts* packets, and for each completed RX
1628  * descriptor in the ring, it performs the following operations:
1629  *
1630  * - Initialize the *rte_mbuf* data structure associated with the
1631  *   RX descriptor according to the information provided by the NIC into
1632  *   that RX descriptor.
1633  *
1634  * - Store the *rte_mbuf* data structure into the next entry of the
1635  *   *rx_pkts* array.
1636  *
1637  * - Replenish the RX descriptor with a new *rte_mbuf* buffer
1638  *   allocated from the memory pool associated with the receive queue at
1639  *   initialization time.
1640  *
1641  * When retrieving an input packet that was scattered by the controller
1642  * into multiple receive descriptors, the rte_eth_rx_burst() function
1643  * appends the associated *rte_mbuf* buffers to the first buffer of the
1644  * packet.
1645  *
1646  * The rte_eth_rx_burst() function returns the number of packets
1647  * actually retrieved, which is the number of *rte_mbuf* data structures
1648  * effectively supplied into the *rx_pkts* array.
1649  * A return value equal to *nb_pkts* indicates that the RX queue contained
1650  * at least *rx_pkts* packets, and this is likely to signify that other
1651  * received packets remain in the input queue. Applications implementing
1652  * a "retrieve as much received packets as possible" policy can check this
1653  * specific case and keep invoking the rte_eth_rx_burst() function until
1654  * a value less than *nb_pkts* is returned.
1655  *
1656  * This receive method has the following advantages:
1657  *
1658  * - It allows a run-to-completion network stack engine to retrieve and
1659  *   to immediately process received packets in a fast burst-oriented
1660  *   approach, avoiding the overhead of unnecessary intermediate packet
1661  *   queue/dequeue operations.
1662  *
1663  * - Conversely, it also allows an asynchronous-oriented processing
1664  *   method to retrieve bursts of received packets and to immediately
1665  *   queue them for further parallel processing by another logical core,
1666  *   for instance. However, instead of having received packets being
1667  *   individually queued by the driver, this approach allows the invoker
1668  *   of the rte_eth_rx_burst() function to queue a burst of retrieved
1669  *   packets at a time and therefore dramatically reduce the cost of
1670  *   enqueue/dequeue operations per packet.
1671  *
1672  * - It allows the rte_eth_rx_burst() function of the driver to take
1673  *   advantage of burst-oriented hardware features (CPU cache,
1674  *   prefetch instructions, and so on) to minimize the number of CPU
1675  *   cycles per packet.
1676  *
1677  * To summarize, the proposed receive API enables many
1678  * burst-oriented optimizations in both synchronous and asynchronous
1679  * packet processing environments with no overhead in both cases.
1680  *
1681  * The rte_eth_rx_burst() function does not provide any error
1682  * notification to avoid the corresponding overhead. As a hint, the
1683  * upper-level application might check the status of the device link once
1684  * being systematically returned a 0 value for a given number of tries.
1685  *
1686  * @param port_id
1687  *   The port identifier of the Ethernet device.
1688  * @param queue_id
1689  *   The index of the receive queue from which to retrieve input packets.
1690  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
1691  *   to rte_eth_dev_configure().
1692  * @param rx_pkts
1693  *   The address of an array of pointers to *rte_mbuf* structures that
1694  *   must be large enough to store *nb_pkts* pointers in it.
1695  * @param nb_pkts
1696  *   The maximum number of packets to retrieve.
1697  * @return
1698  *   The number of packets actually retrieved, which is the number
1699  *   of pointers to *rte_mbuf* structures effectively supplied to the
1700  *   *rx_pkts* array.
1701  */
1702 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
1703 extern uint16_t rte_eth_rx_burst(uint8_t port_id, uint16_t queue_id,
1704                                  struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
1705 #else
1706 static inline uint16_t
1707 rte_eth_rx_burst(uint8_t port_id, uint16_t queue_id,
1708                  struct rte_mbuf **rx_pkts, uint16_t nb_pkts)
1709 {
1710         struct rte_eth_dev *dev;
1711
1712         dev = &rte_eth_devices[port_id];
1713         return (*dev->rx_pkt_burst)(dev->data->rx_queues[queue_id], rx_pkts, nb_pkts);
1714 }
1715 #endif
1716
1717 /**
1718  * Get the number of used descriptors in a specific queue
1719  *
1720  * @param port_id
1721  *  The port identifier of the Ethernet device.
1722  * @param queue_id
1723  *  The queue id on the specific port.
1724  * @return
1725  *  The number of used descriptors in the specific queue.
1726  */
1727 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
1728 extern uint32_t rte_eth_rx_queue_count(uint8_t port_id, uint16_t queue_id);
1729 #else
1730 static inline uint32_t
1731 rte_eth_rx_queue_count(uint8_t port_id, uint16_t queue_id)
1732 {
1733         struct rte_eth_dev *dev;
1734
1735         dev = &rte_eth_devices[port_id];
1736         return (*dev->dev_ops->rx_queue_count)(dev, queue_id);
1737 }
1738 #endif
1739
1740 /**
1741  * Check if the DD bit of the specific RX descriptor in the queue has been set
1742  *
1743  * @param port_id
1744  *  The port identifier of the Ethernet device.
1745  * @param queue_id
1746  *  The queue id on the specific port.
1747  * @offset
1748  *  The offset of the descriptor ID from tail.
1749  * @return
1750  *  - (1) if the specific DD bit is set.
1751  *  - (0) if the specific DD bit is not set.
1752  *  - (-ENODEV) if *port_id* invalid.
1753  */
1754 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
1755 extern int rte_eth_rx_descriptor_done(uint8_t port_id,
1756                                       uint16_t queue_id,
1757                                       uint16_t offset);
1758 #else
1759 static inline int
1760 rte_eth_rx_descriptor_done(uint8_t port_id, uint16_t queue_id, uint16_t offset)
1761 {
1762         struct rte_eth_dev *dev;
1763
1764         dev = &rte_eth_devices[port_id];
1765         return (*dev->dev_ops->rx_descriptor_done)( \
1766                 dev->data->rx_queues[queue_id], offset);
1767 }
1768 #endif
1769
1770 /**
1771  * Send a burst of output packets on a transmit queue of an Ethernet device.
1772  *
1773  * The rte_eth_tx_burst() function is invoked to transmit output packets
1774  * on the output queue *queue_id* of the Ethernet device designated by its
1775  * *port_id*.
1776  * The *nb_pkts* parameter is the number of packets to send which are
1777  * supplied in the *tx_pkts* array of *rte_mbuf* structures.
1778  * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
1779  * up to the number of transmit descriptors available in the TX ring of the
1780  * transmit queue.
1781  * For each packet to send, the rte_eth_tx_burst() function performs
1782  * the following operations:
1783  *
1784  * - Pick up the next available descriptor in the transmit ring.
1785  *
1786  * - Free the network buffer previously sent with that descriptor, if any.
1787  *
1788  * - Initialize the transmit descriptor with the information provided
1789  *   in the *rte_mbuf data structure.
1790  *
1791  * In the case of a segmented packet composed of a list of *rte_mbuf* buffers,
1792  * the rte_eth_tx_burst() function uses several transmit descriptors
1793  * of the ring.
1794  *
1795  * The rte_eth_tx_burst() function returns the number of packets it
1796  * actually sent. A return value equal to *nb_pkts* means that all packets
1797  * have been sent, and this is likely to signify that other output packets
1798  * could be immediately transmitted again. Applications that implement a
1799  * "send as many packets to transmit as possible" policy can check this
1800  * specific case and keep invoking the rte_eth_tx_burst() function until
1801  * a value less than *nb_pkts* is returned.
1802  *
1803  * It is the responsibility of the rte_eth_tx_burst() function to
1804  * transparently free the memory buffers of packets previously sent.
1805  * This feature is driven by the *tx_free_thresh* value supplied to the
1806  * rte_eth_dev_configure() function at device configuration time.
1807  * When the number of previously sent packets reached the "minimum transmit
1808  * packets to free" threshold, the rte_eth_tx_burst() function must
1809  * [attempt to] free the *rte_mbuf*  buffers of those packets whose
1810  * transmission was effectively completed.
1811  *
1812  * @param port_id
1813  *   The port identifier of the Ethernet device.
1814  * @param queue_id
1815  *   The index of the transmit queue through which output packets must be
1816  *   sent.
1817  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
1818  *   to rte_eth_dev_configure().
1819  * @param tx_pkts
1820  *   The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
1821  *   which contain the output packets.
1822  * @param nb_pkts
1823  *   The maximum number of packets to transmit.
1824  * @return
1825  *   The number of output packets actually stored in transmit descriptors of
1826  *   the transmit ring. The return value can be less than the value of the
1827  *   *tx_pkts* parameter when the transmit ring is full or has been filled up.
1828  */
1829 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
1830 extern uint16_t rte_eth_tx_burst(uint8_t port_id, uint16_t queue_id,
1831                                  struct rte_mbuf **tx_pkts, uint16_t nb_pkts);
1832 #else
1833 static inline uint16_t
1834 rte_eth_tx_burst(uint8_t port_id, uint16_t queue_id,
1835                  struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
1836 {
1837         struct rte_eth_dev *dev;
1838
1839         dev = &rte_eth_devices[port_id];
1840         return (*dev->tx_pkt_burst)(dev->data->tx_queues[queue_id], tx_pkts, nb_pkts);
1841 }
1842 #endif
1843
1844 /**
1845  * Setup a new signature filter rule on an Ethernet device
1846  *
1847  * @param port_id
1848  *   The port identifier of the Ethernet device.
1849  * @param fdir_filter
1850  *   The pointer to the fdir filter structure describing the signature filter
1851  *   rule.
1852  *   The *rte_fdir_filter* structure includes the values of the different fields
1853  *   to match: source and destination IP addresses, vlan id, flexbytes, source
1854  *   and destination ports, and so on.
1855  * @param rx_queue
1856  *   The index of the RX queue where to store RX packets matching the added
1857  *   signature filter defined in fdir_filter.
1858  * @return
1859  *   - (0) if successful.
1860  *   - (-ENOTSUP) if hardware doesn't support flow director mode.
1861  *   - (-ENODEV) if *port_id* invalid.
1862  *   - (-ENOSYS) if the FDIR mode is not configured in signature mode
1863  *               on *port_id*.
1864  *   - (-EINVAL) if the fdir_filter information is not correct.
1865  */
1866 int rte_eth_dev_fdir_add_signature_filter(uint8_t port_id,
1867                                           struct rte_fdir_filter *fdir_filter,
1868                                           uint8_t rx_queue);
1869
1870 /**
1871  * Update a signature filter rule on an Ethernet device.
1872  * If the rule doesn't exits, it is created.
1873  *
1874  * @param port_id
1875  *   The port identifier of the Ethernet device.
1876  * @param fdir_ftr
1877  *   The pointer to the structure describing the signature filter rule.
1878  *   The *rte_fdir_filter* structure includes the values of the different fields
1879  *   to match: source and destination IP addresses, vlan id, flexbytes, source
1880  *   and destination ports, and so on.
1881  * @param rx_queue
1882  *   The index of the RX queue where to store RX packets matching the added
1883  *   signature filter defined in fdir_ftr.
1884  * @return
1885  *   - (0) if successful.
1886  *   - (-ENOTSUP) if hardware doesn't support flow director mode.
1887  *   - (-ENODEV) if *port_id* invalid.
1888  *   - (-ENOSYS) if the flow director mode is not configured in signature mode
1889  *     on *port_id*.
1890  *   - (-EINVAL) if the fdir_filter information is not correct.
1891  */
1892 int rte_eth_dev_fdir_update_signature_filter(uint8_t port_id,
1893                                              struct rte_fdir_filter *fdir_ftr,
1894                                              uint8_t rx_queue);
1895
1896 /**
1897  * Remove a signature filter rule on an Ethernet device.
1898  *
1899  * @param port_id
1900  *   The port identifier of the Ethernet device.
1901  * @param fdir_ftr
1902  *   The pointer to the structure describing the signature filter rule.
1903  *   The *rte_fdir_filter* structure includes the values of the different fields
1904  *   to match: source and destination IP addresses, vlan id, flexbytes, source
1905  *   and destination ports, and so on.
1906  * @return
1907  *   - (0) if successful.
1908  *   - (-ENOTSUP) if hardware doesn't support flow director mode.
1909  *   - (-ENODEV) if *port_id* invalid.
1910  *   - (-ENOSYS) if the flow director mode is not configured in signature mode
1911  *     on *port_id*.
1912  *   - (-EINVAL) if the fdir_filter information is not correct.
1913  */
1914 int rte_eth_dev_fdir_remove_signature_filter(uint8_t port_id,
1915                                              struct rte_fdir_filter *fdir_ftr);
1916
1917 /**
1918  * Retrieve the flow director information of an Ethernet device.
1919  *
1920  * @param port_id
1921  *   The port identifier of the Ethernet device.
1922  * @param fdir
1923  *   A pointer to a structure of type *rte_eth_dev_fdir* to be filled with
1924  *   the flow director information of the Ethernet device.
1925  * @return
1926  *   - (0) if successful.
1927  *   - (-ENOTSUP) if hardware doesn't support flow director mode.
1928  *   - (-ENODEV) if *port_id* invalid.
1929  *   - (-ENOSYS) if the flow director mode is not configured on *port_id*.
1930  */
1931 int rte_eth_dev_fdir_get_infos(uint8_t port_id, struct rte_eth_fdir *fdir);
1932
1933 /**
1934  * Add a new perfect filter rule on an Ethernet device.
1935  *
1936  * @param port_id
1937  *   The port identifier of the Ethernet device.
1938  * @param fdir_filter
1939  *   The pointer to the structure describing the perfect filter rule.
1940  *   The *rte_fdir_filter* structure includes the values of the different fields
1941  *   to match: source and destination IP addresses, vlan id, flexbytes, source
1942  *   and destination ports, and so on.
1943  *   IPv6 are not supported.
1944  * @param soft_id
1945  *    The 16-bit value supplied in the field hash.fdir.id of mbuf for RX
1946  *    packets matching the perfect filter.
1947  * @param rx_queue
1948  *   The index of the RX queue where to store RX packets matching the added
1949  *   perfect filter defined in fdir_filter.
1950  * @param drop
1951  *    If drop is set to 1, matching RX packets are stored into the RX drop
1952  *    queue defined in the rte_fdir_conf.
1953  * @return
1954  *   - (0) if successful.
1955  *   - (-ENOTSUP) if hardware doesn't support flow director mode.
1956  *   - (-ENODEV) if *port_id* invalid.
1957  *   - (-ENOSYS) if the flow director mode is not configured in perfect mode
1958  *               on *port_id*.
1959  *   - (-EINVAL) if the fdir_filter information is not correct.
1960  */
1961 int rte_eth_dev_fdir_add_perfect_filter(uint8_t port_id,
1962                                         struct rte_fdir_filter *fdir_filter,
1963                                         uint16_t soft_id, uint8_t rx_queue,
1964                                         uint8_t drop);
1965
1966 /**
1967  * Update a perfect filter rule on an Ethernet device.
1968  * If the rule doesn't exits, it is created.
1969  *
1970  * @param port_id
1971  *   The port identifier of the Ethernet device.
1972  * @param fdir_filter
1973  *   The pointer to the structure describing the perfect filter rule.
1974  *   The *rte_fdir_filter* structure includes the values of the different fields
1975  *   to match: source and destination IP addresses, vlan id, flexbytes, source
1976  *   and destination ports, and so on.
1977  *   IPv6 are not supported.
1978  * @param soft_id
1979  *    The 16-bit value supplied in the field hash.fdir.id of mbuf for RX
1980  *    packets matching the perfect filter.
1981  * @param rx_queue
1982  *   The index of the RX queue where to store RX packets matching the added
1983  *   perfect filter defined in fdir_filter.
1984  * @param drop
1985  *    If drop is set to 1, matching RX packets are stored into the RX drop
1986  *    queue defined in the rte_fdir_conf.
1987  * @return
1988  *   - (0) if successful.
1989  *   - (-ENOTSUP) if hardware doesn't support flow director mode.
1990  *   - (-ENODEV) if *port_id* invalid.
1991  *   - (-ENOSYS) if the flow director mode is not configured in perfect mode
1992  *      on *port_id*.
1993  *   - (-EINVAL) if the fdir_filter information is not correct.
1994  */
1995 int rte_eth_dev_fdir_update_perfect_filter(uint8_t port_id,
1996                                            struct rte_fdir_filter *fdir_filter,
1997                                            uint16_t soft_id, uint8_t rx_queue,
1998                                            uint8_t drop);
1999
2000 /**
2001  * Remove a perfect filter rule on an Ethernet device.
2002  *
2003  * @param port_id
2004  *   The port identifier of the Ethernet device.
2005  * @param fdir_filter
2006  *   The pointer to the structure describing the perfect filter rule.
2007  *   The *rte_fdir_filter* structure includes the values of the different fields
2008  *   to match: source and destination IP addresses, vlan id, flexbytes, source
2009  *   and destination ports, and so on.
2010  *   IPv6 are not supported.
2011  * @param soft_id
2012  *    The soft_id value provided when adding/updating the removed filter.
2013  * @return
2014  *   - (0) if successful.
2015  *   - (-ENOTSUP) if hardware doesn't support flow director mode.
2016  *   - (-ENODEV) if *port_id* invalid.
2017  *   - (-ENOSYS) if the flow director mode is not configured in perfect mode
2018  *      on *port_id*.
2019  *   - (-EINVAL) if the fdir_filter information is not correct.
2020  */
2021 int rte_eth_dev_fdir_remove_perfect_filter(uint8_t port_id,
2022                                            struct rte_fdir_filter *fdir_filter,
2023                                            uint16_t soft_id);
2024 /**
2025  * Configure globally the masks for flow director mode for an Ethernet device.
2026  * For example, the device can match packets with only the first 24 bits of
2027  * the IPv4 source address.
2028  *
2029  * The following fields can be masked: IPv4 addresses and L4 port numbers.
2030  * The following fields can be either enabled or disabled completely for the
2031  * matching functionality: VLAN ID tag; VLAN Priority + CFI bit; Flexible 2-byte
2032  * tuple.
2033  * IPv6 masks are not supported.
2034  *
2035  * All filters must comply with the masks previously configured.
2036  * For example, with a mask equal to 255.255.255.0 for the source IPv4 address,
2037  * all IPv4 filters must be created with a source IPv4 address that fits the
2038  * "X.X.X.0" format.
2039  *
2040  * This function flushes all filters that have been previously added in
2041  * the device.
2042  *
2043  * @param port_id
2044  *   The port identifier of the Ethernet device.
2045  * @param fdir_mask
2046  *   The pointer to the fdir mask structure describing relevant headers fields
2047  *   and relevant bits to use when matching packets addresses and ports.
2048  *   IPv6 masks are not supported.
2049  * @return
2050  *   - (0) if successful.
2051  *   - (-ENOTSUP) if hardware doesn't support flow director mode.
2052  *   - (-ENODEV) if *port_id* invalid.
2053  *   - (-ENOSYS) if the flow director mode is not configured in perfect
2054  *      mode on *port_id*.
2055  *   - (-EINVAL) if the fdir_filter information is not correct
2056  */
2057 int rte_eth_dev_fdir_set_masks(uint8_t port_id,
2058                                struct rte_fdir_masks *fdir_mask);
2059
2060 /**
2061  * The eth device event type for interrupt, and maybe others in the future.
2062  */
2063 enum rte_eth_event_type {
2064         RTE_ETH_EVENT_UNKNOWN,  /**< unknown event type */
2065         RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
2066         RTE_ETH_EVENT_MAX       /**< max value of this enum */
2067 };
2068
2069 typedef void (*rte_eth_dev_cb_fn)(uint8_t port_id, \
2070                 enum rte_eth_event_type event, void *cb_arg);
2071 /**< user application callback to be registered for interrupts */
2072
2073
2074
2075 /**
2076  * Register a callback function for specific port id.
2077  *
2078  * @param port_id
2079  *  Port id.
2080  * @param event
2081  *  Event interested.
2082  * @param cb_fn
2083  *  User supplied callback function to be called.
2084  * @param cb_arg
2085  *  Pointer to the parameters for the registered callback.
2086  *
2087  * @return
2088  *  - On success, zero.
2089  *  - On failure, a negative value.
2090  */
2091 int rte_eth_dev_callback_register(uint8_t port_id,
2092                         enum rte_eth_event_type event,
2093                 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
2094
2095 /**
2096  * Unregister a callback function for specific port id.
2097  *
2098  * @param port_id
2099  *  Port id.
2100  * @param event
2101  *  Event interested.
2102  * @param cb_fn
2103  *  User supplied callback function to be called.
2104  * @param cb_arg
2105  *  Pointer to the parameters for the registered callback. -1 means to
2106  *  remove all for the same callback address and same event.
2107  *
2108  * @return
2109  *  - On success, zero.
2110  *  - On failure, a negative value.
2111  */
2112 int rte_eth_dev_callback_unregister(uint8_t port_id,
2113                         enum rte_eth_event_type event,
2114                 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
2115
2116 /**
2117  * @internal Executes all the user application registered callbacks for
2118  * the specific device. It is for DPDK internal user only. User
2119  * application should not call it directly.
2120  *
2121  * @param dev
2122  *  Pointer to struct rte_eth_dev.
2123  * @param event
2124  *  Eth device interrupt event type.
2125  *
2126  * @return
2127  *  void
2128  */
2129 void _rte_eth_dev_callback_process(struct rte_eth_dev *dev,
2130                                 enum rte_eth_event_type event);
2131
2132 /**
2133  * Turn on the LED on the Ethernet device.
2134  * This function turns on the LED on the Ethernet device.
2135  *
2136  * @param port_id
2137  *   The port identifier of the Ethernet device.
2138  * @return
2139  *   - (0) if successful.
2140  *   - (-ENOTSUP) if underlying hardware OR driver doesn't support
2141  *     that operation.
2142  *   - (-ENODEV) if *port_id* invalid.
2143  */
2144 int  rte_eth_led_on(uint8_t port_id);
2145
2146 /**
2147  * Turn off the LED on the Ethernet device.
2148  * This function turns off the LED on the Ethernet device.
2149  *
2150  * @param port_id
2151  *   The port identifier of the Ethernet device.
2152  * @return
2153  *   - (0) if successful.
2154  *   - (-ENOTSUP) if underlying hardware OR driver doesn't support
2155  *     that operation.
2156  *   - (-ENODEV) if *port_id* invalid.
2157  */
2158 int  rte_eth_led_off(uint8_t port_id);
2159
2160 /**
2161  * Configure the Ethernet link flow control for Ethernet device
2162  *
2163  * @param port_id
2164  *   The port identifier of the Ethernet device.
2165  * @param fc_conf
2166  *   The pointer to the structure of the flow control parameters.
2167  * @return
2168  *   - (0) if successful.
2169  *   - (-ENOTSUP) if hardware doesn't support flow control mode.
2170  *   - (-ENODEV)  if *port_id* invalid.
2171  *   - (-EINVAL)  if bad parameter
2172  *   - (-EIO)     if flow control setup failure
2173  */
2174 int rte_eth_dev_flow_ctrl_set(uint8_t port_id,
2175                                 struct rte_eth_fc_conf *fc_conf);
2176
2177 /**
2178  * Configure the Ethernet priority flow control under DCB environment
2179  * for Ethernet device.
2180  *
2181  * @param port_id
2182  * The port identifier of the Ethernet device.
2183  * @param pfc_conf
2184  * The pointer to the structure of the priority flow control parameters.
2185  * @return
2186  *   - (0) if successful.
2187  *   - (-ENOTSUP) if hardware doesn't support priority flow control mode.
2188  *   - (-ENODEV)  if *port_id* invalid.
2189  *   - (-EINVAL)  if bad parameter
2190  *   - (-EIO)     if flow control setup failure
2191  */
2192 int rte_eth_dev_priority_flow_ctrl_set(uint8_t port_id,
2193                                 struct rte_eth_pfc_conf *pfc_conf);
2194
2195 /**
2196  * Add a MAC address to an internal array of addresses used to enable whitelist
2197  * filtering to accept packets only if the destination MAC address matches.
2198  *
2199  * @param port
2200  *   The port identifier of the Ethernet device.
2201  * @param mac_addr
2202  *   The MAC address to add.
2203  * @param pool
2204  *   VMDq pool index to associate address with (if VMDq is enabled). If VMDq is
2205  *   not enabled, this should be set to 0.
2206  * @return
2207  *   - (0) if successfully added or *mac_addr" was already added.
2208  *   - (-ENOTSUP) if hardware doesn't support this feature.
2209  *   - (-ENODEV) if *port* is invalid.
2210  *   - (-ENOSPC) if no more MAC addresses can be added.
2211  *   - (-EINVAL) if MAC address is invalid.
2212  */
2213 int rte_eth_dev_mac_addr_add(uint8_t port, struct ether_addr *mac_addr,
2214                                 uint32_t pool);
2215
2216 /**
2217  * Remove a MAC address from the internal array of addresses.
2218  *
2219  * @param port
2220  *   The port identifier of the Ethernet device.
2221  * @param mac_addr
2222  *   MAC address to remove.
2223  * @return
2224  *   - (0) if successful, or *mac_addr* didn't exist.
2225  *   - (-ENOTSUP) if hardware doesn't support.
2226  *   - (-ENODEV) if *port* invalid.
2227  *   - (-EADDRINUSE) if attempting to remove the default MAC address
2228  */
2229 int rte_eth_dev_mac_addr_remove(uint8_t port, struct ether_addr *mac_addr);
2230
2231 /**
2232  * Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
2233  *
2234  * @param port
2235  *   The port identifier of the Ethernet device.
2236  * @param reta_conf
2237  *    RETA to update.
2238  * @return
2239  *   - (0) if successful.
2240  *   - (-ENOTSUP) if hardware doesn't support.
2241  *   - (-EINVAL) if bad parameter.
2242  */
2243 int rte_eth_dev_rss_reta_update(uint8_t port,
2244                         struct rte_eth_rss_reta *reta_conf);
2245
2246  /**
2247  * Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device.
2248  *
2249  * @param port
2250  *   The port identifier of the Ethernet device.
2251  * @param reta_conf
2252  *   RETA to query.
2253  * @return
2254  *   - (0) if successful.
2255  *   - (-ENOTSUP) if hardware doesn't support.
2256  *   - (-EINVAL) if bad parameter.
2257  */
2258 int rte_eth_dev_rss_reta_query(uint8_t port,
2259                         struct rte_eth_rss_reta *reta_conf);
2260
2261 #ifdef __cplusplus
2262 }
2263 #endif
2264
2265 #endif /* _RTE_ETHDEV_H_ */