lib/librte_ether/rte_ethdev.h

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