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