ethdev: init all builtin drivers
[dpdk.git] / lib / librte_ether / rte_ethdev.h
1 /*-
2  *   BSD LICENSE
3  * 
4  *   Copyright(c) 2010-2012 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
35 #ifndef _RTE_ETHDEV_H_
36 #define _RTE_ETHDEV_H_
37
38 /**
39  * @file
40  *
41  * RTE Ethernet Device API
42  *
43  * The Ethernet Device API is composed of two parts:
44  *
45  * - The application-oriented Ethernet API that includes functions to setup
46  *   an Ethernet device (configure it, setup its RX and TX queues and start it),
47  *   to get its MAC address, the speed and the status of its physical link,
48  *   to receive and to transmit packets, and so on.
49  *
50  * - The driver-oriented Ethernet API that exports a function allowing
51  *   an Ethernet Poll Mode Driver (PMD) to simultaneously register itself as
52  *   an Ethernet device driver and as a PCI driver for a set of matching PCI
53  *   [Ethernet] devices classes.
54  *
55  * By default, all the functions of the Ethernet Device API exported by a PMD
56  * are lock-free functions which assume to not be invoked in parallel on
57  * different logical cores to work on the same target object.  For instance,
58  * the receive function of a PMD cannot be invoked in parallel on two logical
59  * cores to poll the same RX queue [of the same port]. Of course, this function
60  * can be invoked in parallel by different logical cores on different RX queues.
61  * It is the responsibility of the upper level application to enforce this rule.
62  *
63  * If needed, parallel accesses by multiple logical cores to shared queues
64  * shall be explicitly protected by dedicated inline lock-aware functions
65  * built on top of their corresponding lock-free functions of the PMD API.
66  *
67  * In all functions of the Ethernet API, the Ethernet device is
68  * designated by an integer >= 0 named the device port identifier.
69  *
70  * At the Ethernet driver level, Ethernet devices are represented by a generic
71  * data structure of type *rte_eth_dev*.
72  *
73  * Ethernet devices are dynamically registered during the PCI probing phase
74  * performed at EAL initialization time.
75  * When an Ethernet device is being probed, an *rte_eth_dev* structure and
76  * a new port identifier are allocated for that device. Then, the eth_dev_init()
77  * function supplied by the Ethernet driver matching the probed PCI
78  * device is invoked to properly initialize the device.
79  *
80  * The role of the device init function consists of resetting the hardware,
81  * checking access to Non-volatile Memory (NVM), reading the MAC address
82  * from NVM etc.
83  *
84  * If the device init operation is successful, the correspondence between
85  * the port identifier assigned to the new device and its associated
86  * *rte_eth_dev* structure is effectively registered.
87  * Otherwise, both the *rte_eth_dev* structure and the port identifier are
88  * freed.
89  *
90  * The functions exported by the application Ethernet API to setup a device
91  * designated by its port identifier must be invoked in the following order:
92  *     - rte_eth_dev_configure()
93  *     - rte_eth_tx_queue_setup()
94  *     - rte_eth_rx_queue_setup()
95  *     - rte_eth_dev_start()
96  *
97  * Then, the network application can invoke, in any order, the functions
98  * exported by the Ethernet API to get the MAC address of a given device, to
99  * get the speed and the status of a device physical link, to receive/transmit
100  * [burst of] packets, and so on.
101  *
102  * If the application wants to change the configuration (i.e. call
103  * rte_eth_dev_configure(), rte_eth_tx_queue_setup(), or
104  * rte_eth_rx_queue_setup()), it must call rte_eth_dev_stop() first to stop the
105  * device and then do the reconfiguration before calling rte_eth_dev_start()
106  * again. The tramsit and receive functions should not be invoked when the
107  * device is stopped.
108  *
109  * Please note that some configuration is not stored between calls to
110  * rte_eth_dev_stop()/rte_eth_dev_start(). The following configuration will
111  * be retained:
112  *
113  *     - flow control settings
114  *     - receive mode configuration (promiscuous mode, hardware checksum mode,
115  *       RSS/VMDQ settings etc.)
116  *     - VLAN filtering configuration
117  *     - MAC addresses supplied to MAC address array
118  *     - flow director filtering mode (but not filtering rules)
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  *
124  * Finally, a network application can close an Ethernet device by invoking the
125  * rte_eth_dev_close() function.
126  *
127  * Each function of the application Ethernet API invokes a specific function
128  * of the PMD that controls the target device designated by its port
129  * identifier.
130  * For this purpose, all device-specific functions of an Ethernet driver are
131  * supplied through a set of pointers contained in a generic structure of type
132  * *eth_dev_ops*.
133  * The address of the *eth_dev_ops* structure is stored in the *rte_eth_dev*
134  * structure by the device init function of the Ethernet driver, which is
135  * invoked during the PCI probing phase, as explained earlier.
136  *
137  * In other words, each function of the Ethernet API simply retrieves the
138  * *rte_eth_dev* structure associated with the device port identifier and
139  * performs an indirect invocation of the corresponding driver function
140  * supplied in the *eth_dev_ops* structure of the *rte_eth_dev* structure.
141  *
142  * For performance reasons, the address of the burst-oriented RX and TX
143  * functions of the Ethernet driver are not contained in the *eth_dev_ops*
144  * structure. Instead, they are directly stored at the beginning of the
145  * *rte_eth_dev* structure to avoid an extra indirect memory access during
146  * their invocation.
147  *
148  * RTE ethernet device drivers do not use interrupts for transmitting or
149  * receiving. Instead, Ethernet drivers export Poll-Mode receive and transmit
150  * functions to applications.
151  * Both receive and transmit functions are packet-burst oriented to minimize
152  * their cost per packet through the following optimizations:
153  *
154  * - Sharing among multiple packets the incompressible cost of the
155  *   invocation of receive/transmit functions.
156  *
157  * - Enabling receive/transmit functions to take advantage of burst-oriented
158  *   hardware features (L1 cache, prefetch instructions, NIC head/tail
159  *   registers) to minimize the number of CPU cycles per packet, for instance,
160  *   by avoiding useless read memory accesses to ring descriptors, or by
161  *   systematically using arrays of pointers that exactly fit L1 cache line
162  *   boundaries and sizes.
163  *
164  * The burst-oriented receive function does not provide any error notification,
165  * to avoid the corresponding overhead. As a hint, the upper-level application
166  * might check the status of the device link once being systematically returned
167  * a 0 value by the receive function of the driver for a given number of tries.
168  */
169
170 #ifdef __cplusplus
171 extern "C" {
172 #endif
173
174 #include <stdint.h>
175
176 #include <rte_log.h>
177 #include <rte_interrupts.h>
178 #include <rte_pci.h>
179 #include <rte_mbuf.h>
180 #include "rte_ether.h"
181
182 /**
183  * A structure used to retrieve statistics for an Ethernet port.
184  */
185 struct rte_eth_stats {
186         uint64_t ipackets;  /**< Total number of successfully received packets. */
187         uint64_t opackets;  /**< Total number of successfully transmitted packets.*/
188         uint64_t ibytes;    /**< Total number of successfully received bytes. */
189         uint64_t obytes;    /**< Total number of successfully transmitted bytes. */
190         uint64_t ierrors;   /**< Total number of erroneous received packets. */
191         uint64_t oerrors;   /**< Total number of failed transmitted packets. */
192         uint64_t imcasts;   /**< Total number of multicast received packets. */
193         uint64_t rx_nombuf; /**< Total number of RX mbuf allocation failures. */
194         uint64_t fdirmatch; /**< Total number of RX packets matching a filter. */
195         uint64_t fdirmiss;  /**< Total number of RX packets not matching any filter. */
196 };
197
198 /**
199  * A structure used to retrieve link-level information of an Ethernet port.
200  */
201 struct rte_eth_link {
202         uint16_t link_speed;      /**< ETH_LINK_SPEED_[10, 100, 1000, 10000] */
203         uint16_t link_duplex;     /**< ETH_LINK_[HALF_DUPLEX, FULL_DUPLEX] */
204         uint8_t  link_status : 1; /**< 1 -> link up, 0 -> link down */
205 }__attribute__((aligned(8)));     /**< aligned for atomic64 read/write */
206
207 #define ETH_LINK_SPEED_AUTONEG  0       /**< Auto-negotiate link speed. */
208 #define ETH_LINK_SPEED_10       10      /**< 10 megabits/second. */
209 #define ETH_LINK_SPEED_100      100     /**< 100 megabits/second. */
210 #define ETH_LINK_SPEED_1000     1000    /**< 1 gigabits/second. */
211 #define ETH_LINK_SPEED_10000    10000   /**< 10 gigabits/second. */
212
213 #define ETH_LINK_AUTONEG_DUPLEX 0       /**< Auto-negotiate duplex. */
214 #define ETH_LINK_HALF_DUPLEX    1       /**< Half-duplex connection. */
215 #define ETH_LINK_FULL_DUPLEX    2       /**< Full-duplex connection. */
216
217 /**
218  * A structure used to configure the ring threshold registers of an RX/TX
219  * queue for an Ethernet port.
220  */
221 struct rte_eth_thresh {
222         uint8_t pthresh; /**< Ring prefetch threshold. */
223         uint8_t hthresh; /**< Ring host threshold. */
224         uint8_t wthresh; /**< Ring writeback threshold. */
225 };
226
227 /**
228  *  A set of values to identify what method is to be used to route
229  *  packets to multiple queues.
230  */
231 enum rte_eth_rx_mq_mode {
232         ETH_RSS     = 0,     /**< Default to RSS mode */
233         ETH_VMDQ_DCB         /**< Use VMDQ+DCB to route traffic to queues */
234 };
235
236 /**
237  * A structure used to configure the RX features of an Ethernet port.
238  */
239 struct rte_eth_rxmode {
240         /** The multi-queue packet distribution mode to be used, e.g. RSS. */
241         enum rte_eth_rx_mq_mode mq_mode;
242         uint32_t max_rx_pkt_len;    /**< Only used if jumbo_frame enabled. */
243         uint16_t split_hdr_size;    /**< hdr buf size (header_split enabled).*/
244         uint8_t header_split   : 1, /**< Header Split enable. */
245                 hw_ip_checksum : 1, /**< IP/UDP/TCP checksum offload enable. */
246                 hw_vlan_filter : 1, /**< VLAN filter enable. */
247                 jumbo_frame    : 1, /**< Jumbo Frame Receipt enable. */
248                 hw_strip_crc   : 1; /**< Enable CRC stripping by hardware. */
249 };
250
251 /**
252  * A structure used to configure the Receive Side Scaling (RSS) feature
253  * of an Ethernet port.
254  * If not NULL, the *rss_key* pointer of the *rss_conf* structure points
255  * to an array of 40 bytes holding the RSS key to use for hashing specific
256  * header fields of received packets.
257  * Otherwise, a default random hash key is used by the device driver.
258  *
259  * The *rss_hf* field of the *rss_conf* structure indicates the different
260  * types of IPv4/IPv6 packets to which the RSS hashing must be applied.
261  * Supplying an *rss_hf* equal to zero disables the RSS feature.
262  */
263 struct rte_eth_rss_conf {
264         uint8_t  *rss_key;   /**< If not NULL, 40-byte hash key. */
265         uint16_t rss_hf;     /**< Hash functions to apply - see below. */
266 };
267
268 #define ETH_RSS_IPV4        0x0001 /**< IPv4 packet. */
269 #define ETH_RSS_IPV4_TCP    0x0002 /**< IPv4/TCP packet. */
270 #define ETH_RSS_IPV6        0x0004 /**< IPv6 packet. */
271 #define ETH_RSS_IPV6_EX     0x0008 /**< IPv6 packet with extension headers.*/
272 #define ETH_RSS_IPV6_TCP    0x0010 /**< IPv6/TCP packet. */
273 #define ETH_RSS_IPV6_TCP_EX 0x0020 /**< IPv6/TCP with extension headers. */
274 /* Intel RSS extensions to UDP packets */
275 #define ETH_RSS_IPV4_UDP    0x0040 /**< IPv4/UDP packet. */
276 #define ETH_RSS_IPV6_UDP    0x0080 /**< IPv6/UDP packet. */
277 #define ETH_RSS_IPV6_UDP_EX 0x0100 /**< IPv6/UDP with extension headers. */
278
279 /* Definitions used for VMDQ and DCB functionality */
280 #define ETH_VMDQ_MAX_VLAN_FILTERS   64 /**< Maximum nb. of VMDQ vlan filters. */
281 #define ETH_DCB_NUM_USER_PRIORITIES 8  /**< Maximum nb. of DCB priorities. */
282 #define ETH_VMDQ_DCB_NUM_QUEUES     128 /**< Maximum nb. of VMDQ DCB queues. */
283
284 /**
285  * This enum indicates the possible number of queue pools
286  * in VMDQ+DCB configurations.
287  */
288 enum rte_eth_nb_pools {
289         ETH_16_POOLS = 16, /**< 16 pools with DCB. */
290         ETH_32_POOLS = 32  /**< 32 pools with DCB. */
291 };
292
293 /**
294  * A structure used to configure the VMDQ+DCB feature
295  * of an Ethernet port.
296  *
297  * Using this feature, packets are routed to a pool of queues, based
298  * on the vlan id in the vlan tag, and then to a specific queue within
299  * that pool, using the user priority vlan tag field.
300  *
301  * A default pool may be used, if desired, to route all traffic which
302  * does not match the vlan filter rules.
303  */
304 struct rte_eth_vmdq_dcb_conf {
305         enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools */
306         uint8_t enable_default_pool; /**< If non-zero, use a default pool */
307         uint8_t default_pool; /**< The default pool, if applicable */
308         uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
309         struct {
310                 uint16_t vlan_id; /**< The vlan id of the received frame */
311                 uint64_t pools;   /**< Bitmask of pools for packet rx */
312         } pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
313         uint8_t dcb_queue[ETH_DCB_NUM_USER_PRIORITIES];
314         /**< Selects a queue in a pool */
315 };
316
317 /**
318  * A structure used to configure the TX features of an Ethernet port.
319  * For future extensions.
320  */
321 struct rte_eth_txmode {
322 };
323
324 /**
325  * A structure used to configure an RX ring of an Ethernet port.
326  */
327 struct rte_eth_rxconf {
328         struct rte_eth_thresh rx_thresh; /**< RX ring threshold registers. */
329         uint16_t rx_free_thresh; /**< Drives the freeing of RX descriptors. */
330 };
331
332 /**
333  * A structure used to configure a TX ring of an Ethernet port.
334  */
335 struct rte_eth_txconf {
336         struct rte_eth_thresh tx_thresh; /**< TX ring threshold registers. */
337         uint16_t tx_rs_thresh; /**< Drives the setting of RS bit on TXDs. */
338         uint16_t tx_free_thresh; /**< Drives the freeing of TX buffers. */
339 };
340
341 /**
342  * This enum indicates the flow control mode
343  */
344 enum rte_eth_fc_mode {
345         RTE_FC_NONE = 0, /**< Disable flow control. */
346         RTE_FC_RX_PAUSE, /**< RX pause frame, enable flowctrl on TX side. */
347         RTE_FC_TX_PAUSE, /**< TX pause frame, enable flowctrl on RX side. */
348         RTE_FC_FULL      /**< Enable flow control on both side. */
349 };
350
351 /**
352  * A structure used to configure Ethernet flow control parameter.
353  * These parameters will be configured into the register of the NIC.
354  * Please refer to the corresponding data sheet for proper value.
355  */
356 struct rte_eth_fc_conf {
357         uint32_t high_water;  /**< High threshold value to trigger XOFF */
358         uint32_t low_water;   /**< Low threshold value to trigger XON */
359         uint16_t pause_time;  /**< Pause quota in the Pause frame */
360         uint16_t send_xon;    /**< Is XON frame need be sent */
361         enum rte_eth_fc_mode mode;  /**< Link flow control mode */
362 };
363
364 /**
365  *  Flow Director setting modes: none (default), signature or perfect.
366  */
367 enum rte_fdir_mode {
368         RTE_FDIR_MODE_NONE      = 0, /**< Disable FDIR support. */
369         RTE_FDIR_MODE_SIGNATURE,     /**< Enable FDIR signature filter mode. */
370         RTE_FDIR_MODE_PERFECT,       /**< Enable FDIR perfect filter mode. */
371 };
372
373 /**
374  *  Memory space that can be configured to store Flow Director filters
375  *  in the board memory.
376  */
377 enum rte_fdir_pballoc_type {
378         RTE_FDIR_PBALLOC_64K = 0,  /**< 64k. */
379         RTE_FDIR_PBALLOC_128K,     /**< 128k. */
380         RTE_FDIR_PBALLOC_256K,     /**< 256k. */
381 };
382
383 /**
384  *  Select report mode of FDIR hash information in RX descriptors.
385  */
386 enum rte_fdir_status_mode {
387         RTE_FDIR_NO_REPORT_STATUS = 0, /**< Never report FDIR hash. */
388         RTE_FDIR_REPORT_STATUS, /**< Only report FDIR hash for matching pkts. */
389         RTE_FDIR_REPORT_STATUS_ALWAYS, /**< Always report FDIR hash. */
390 };
391
392 /**
393  * A structure used to configure the Flow Director (FDIR) feature
394  * of an Ethernet port.
395  *
396  * If mode is RTE_FDIR_DISABLE, the pballoc value is ignored.
397  */
398 struct rte_fdir_conf {
399         enum rte_fdir_mode mode; /**< Flow Director mode. */
400         enum rte_fdir_pballoc_type pballoc; /**< Space for FDIR filters. */
401         enum rte_fdir_status_mode status;  /**< How to report FDIR hash. */
402         /* Offset of flexbytes field in RX packets (in 16-bit word units). */
403         uint8_t flexbytes_offset;
404         /* RX queue of packets matching a "drop" filter in perfect mode. */
405         uint8_t drop_queue;
406 };
407
408 /**
409  *  Possible l4type of FDIR filters.
410  */
411 enum rte_l4type {
412         RTE_FDIR_L4TYPE_NONE = 0,       /**< Nnoe. */
413         RTE_FDIR_L4TYPE_UDP,            /**< UDP. */
414         RTE_FDIR_L4TYPE_TCP,            /**< TCP. */
415         RTE_FDIR_L4TYPE_SCTP,           /**< SCTP. */
416 };
417
418 /**
419  *  Select IPv4 or IPv6 FDIR filters.
420  */
421 enum rte_iptype {
422         RTE_FDIR_IPTYPE_IPV4 = 0,     /**< IPv4. */
423         RTE_FDIR_IPTYPE_IPV6 ,        /**< IPv6. */
424 };
425
426 /**
427  *  A structure used to define a FDIR packet filter.
428  */
429 struct rte_fdir_filter {
430         uint16_t flex_bytes; /**< Flex bytes value to match. */
431         uint16_t vlan_id; /**< VLAN ID value to match, 0 otherwise. */
432         uint16_t port_src; /**< Source port to match, 0 otherwise. */
433         uint16_t port_dst; /**< Destination port to match, 0 otherwise. */
434         union {
435                 uint32_t ipv4_addr; /**< IPv4 source address to match. */
436                 uint32_t ipv6_addr[4]; /**< IPv6 source address to match. */
437         } ip_src; /**< IPv4/IPv6 source address to match (union of above). */
438         union {
439                 uint32_t ipv4_addr; /**< IPv4 destination address to match. */
440                 uint32_t ipv6_addr[4]; /**< IPv6 destination address to match */
441         } ip_dst; /**< IPv4/IPv6 destination address to match (union of above). */
442         enum rte_l4type l4type; /**< l4type to match: NONE/UDP/TCP/SCTP. */
443         enum rte_iptype iptype; /**< IP packet type to match: IPv4 or IPv6. */
444 };
445
446 /**
447  *  A structure used to configure FDIR masks that are used by the device
448  *  to match the various fields of RX packet headers.
449  */
450 struct rte_fdir_masks {
451         /** When set to 1, packet l4type is not relevant in filters, and
452            source and destination port masks must be set to zero. */
453         uint8_t only_ip_flow;
454         uint8_t vlan_id; /**< If set to 1, vlan_id is relevant in filters. */
455         uint8_t vlan_prio; /**< If set to 1, vlan_prio is relevant in filters. */
456         uint8_t flexbytes; /**< If set to 1, flexbytes is relevant in filters. */
457         /** Mask of Destination IPv4 Address. All bits set to 1 define the
458            relevant bits to use in the destination address of an IPv4 packet
459            when matching it against FDIR filters. */
460         uint32_t dst_ipv4_mask;
461         /** Mask of Source IPv4 Address. All bits set to 1 define
462            the relevant bits to use in the source address of an IPv4 packet
463            when matching it against FDIR filters. */
464         uint32_t src_ipv4_mask;
465         /** Mask of Source IPv6 Address. All bits set to 1 define the
466            relevant BYTES to use in the source address of an IPv6 packet
467            when matching it against FDIR filters. */
468         uint16_t src_ipv6_mask;
469         /** Mask of Source Port. All bits set to 1 define the relevant
470            bits to use in the source port of an IP packets when matching it
471            against FDIR filters. */
472         uint16_t src_port_mask;
473         /** Mask of Destination Port. All bits set to 1 define the relevant
474            bits to use in the destination port of an IP packet when matching it
475            against FDIR filters. */
476         uint16_t dst_port_mask;
477 };
478
479 /**
480  *  A structure used to report the status of the flow director filters in use.
481  */
482 struct rte_eth_fdir {
483         /** Number of filters with collision indication. */
484         uint16_t collision;
485         /** Number of free (non programmed) filters. */
486         uint16_t free;
487         /** The Lookup hash value of the added filter that updated the value
488            of the MAXLEN field */
489         uint16_t maxhash;
490         /** Longest linked list of filters in the table. */
491         uint8_t maxlen;
492         /** Number of added filters. */
493         uint64_t add;
494         /** Number of removed filters. */
495         uint64_t remove;
496         /** Number of failed added filters (no more space in device). */
497         uint64_t f_add;
498         /** Number of failed removed filters. */
499         uint64_t f_remove;
500 };
501
502 /**
503  * A structure used to enable/disable specific device interrupts.
504  */
505 struct rte_intr_conf {
506         /** enable/disable lsc interrupt. 0 (default) - disable, 1 enable */
507         uint16_t lsc;
508 };
509
510 /**
511  * A structure used to configure an Ethernet port.
512  * Depending upon the RX multi-queue mode, extra advanced
513  * configuration settings may be needed.
514  */
515 struct rte_eth_conf {
516         uint16_t link_speed;
517         /**< ETH_LINK_SPEED_10[0|00|000], or 0 for autonegotation */
518         uint16_t link_duplex;
519         /**< ETH_LINK_[HALF_DUPLEX|FULL_DUPLEX], or 0 for autonegotation */
520         struct rte_eth_rxmode rxmode; /**< Port RX configuration. */
521         struct rte_eth_txmode txmode; /**< Port TX configuration. */
522         union {
523                 struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
524                 struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
525                 /**< Port vmdq+dcb configuration. */
526         } rx_adv_conf; /**< Port RX filtering configuration (union). */
527         struct rte_fdir_conf fdir_conf; /**< FDIR configuration. */
528         struct rte_intr_conf intr_conf; /**< Interrupt mode configuration. */
529 };
530
531 /**
532  * A structure used to retrieve the contextual information of
533  * an Ethernet device, such as the controlling driver of the device,
534  * its PCI context, etc...
535  */
536 struct rte_eth_dev_info {
537         struct rte_pci_device *pci_dev; /**< Device PCI information. */
538         const char *driver_name; /**< Device Driver name. */
539         uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
540         uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
541         uint16_t max_rx_queues; /**< Maximum number of RX queues. */
542         uint16_t max_tx_queues; /**< Maximum number of TX queues. */
543         uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
544 };
545
546 struct rte_eth_dev;
547 struct igb_rx_queue;
548 struct igb_tx_queue;
549
550 struct rte_eth_dev_callback;
551 /** @internal Structure to keep track of registered callbacks */
552 TAILQ_HEAD(rte_eth_dev_cb_list, rte_eth_dev_callback);
553
554 /*
555  * Definitions of all functions exported by an Ethernet driver through the
556  * the generic structure of type *eth_dev_ops* supplied in the *rte_eth_dev*
557  * structure associated with an Ethernet device.
558  */
559
560 typedef int  (*eth_dev_configure_t)(struct rte_eth_dev *dev, uint16_t nb_rx_q,
561                                     uint16_t nb_tx_q);
562 /**< Ethernet device configuration. */
563
564 typedef int  (*eth_dev_start_t)(struct rte_eth_dev *dev);
565 /**< Function used to start a configured Ethernet device. */
566
567 typedef void (*eth_dev_stop_t)(struct rte_eth_dev *dev);
568 /**< Function used to stop a configured Ethernet device. */
569
570 typedef void (*eth_dev_close_t)(struct rte_eth_dev *dev);
571 /**< @internal Function used to close a configured Ethernet device. */
572
573 typedef void (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev);
574 /**< Function used to enable the RX promiscuous mode of an Ethernet device. */
575
576 typedef void (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev);
577 /**< Function used to disable the RX promiscuous mode of an Ethernet device. */
578
579 typedef void (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
580 /**< Enable the receipt of all multicast packets by an Ethernet device. */
581
582 typedef void (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
583 /**< Disable the receipt of all multicast packets by an Ethernet device. */
584
585 typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
586                                 int wait_to_complete);
587 /**< Get link speed, duplex mode and state (up/down) of an Ethernet device. */
588
589 typedef void (*eth_stats_get_t)(struct rte_eth_dev *dev,
590                                 struct rte_eth_stats *igb_stats);
591 /**< Get global I/O statistics of an Ethernet device. */
592
593 typedef void (*eth_stats_reset_t)(struct rte_eth_dev *dev);
594 /**< Reset global I/O statistics of an Ethernet device to 0. */
595
596 typedef void (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
597                                     struct rte_eth_dev_info *dev_info);
598 /**< Get specific informations of an Ethernet device. */
599
600 typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
601                                     uint16_t rx_queue_id,
602                                     uint16_t nb_rx_desc,
603                                     unsigned int socket_id,
604                                     const struct rte_eth_rxconf *rx_conf,
605                                     struct rte_mempool *mb_pool);
606 /**< Set up a receive queue of an Ethernet device. */
607
608 typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
609                                     uint16_t tx_queue_id,
610                                     uint16_t nb_tx_desc,
611                                     unsigned int socket_id,
612                                     const struct rte_eth_txconf *tx_conf);
613 /**< Setup a transmit queue of an Ethernet device. */
614
615 typedef void (*vlan_filter_set_t)(struct rte_eth_dev *dev,
616                                   uint16_t vlan_id,
617                                   int on);
618 /**< Enable/Disable filtering of a VLAN Tag Identifier by an Ethernet device. */
619
620 typedef uint16_t (*eth_rx_burst_t)(struct igb_rx_queue *rxq,
621                                    struct rte_mbuf **rx_pkts,
622                                    uint16_t nb_pkts);
623 /**< Retrieve input packets from a receive queue of an Ethernet device. */
624
625 typedef uint16_t (*eth_tx_burst_t)(struct igb_tx_queue *txq,
626                                    struct rte_mbuf **tx_pkts,
627                                    uint16_t nb_pkts);
628 /**< Send output packets on a transmit queue of an Ethernet device. */
629
630 typedef int (*fdir_add_signature_filter_t)(struct rte_eth_dev *dev,
631                                            struct rte_fdir_filter *fdir_ftr,
632                                            uint8_t rx_queue);
633 /**< Setup a new signature filter rule on an Ethernet device */
634
635 typedef int (*fdir_update_signature_filter_t)(struct rte_eth_dev *dev,
636                                               struct rte_fdir_filter *fdir_ftr,
637                                               uint8_t rx_queue);
638 /**< Update a signature filter rule on an Ethernet device */
639
640 typedef int (*fdir_remove_signature_filter_t)(struct rte_eth_dev *dev,
641                                               struct rte_fdir_filter *fdir_ftr);
642 /**< Remove a  signature filter rule on an Ethernet device */
643
644 typedef void (*fdir_infos_get_t)(struct rte_eth_dev *dev,
645                                  struct rte_eth_fdir *fdir);
646 /**< Get information about fdir status */
647
648 typedef int (*fdir_add_perfect_filter_t)(struct rte_eth_dev *dev,
649                                          struct rte_fdir_filter *fdir_ftr,
650                                          uint16_t soft_id, uint8_t rx_queue,
651                                          uint8_t drop);
652 /**< Setup a new perfect filter rule on an Ethernet device */
653
654 typedef int (*fdir_update_perfect_filter_t)(struct rte_eth_dev *dev,
655                                             struct rte_fdir_filter *fdir_ftr,
656                                             uint16_t soft_id, uint8_t rx_queue,
657                                             uint8_t drop);
658 /**< Update a perfect filter rule on an Ethernet device */
659
660 typedef int (*fdir_remove_perfect_filter_t)(struct rte_eth_dev *dev,
661                                             struct rte_fdir_filter *fdir_ftr,
662                                             uint16_t soft_id);
663 /**< Remove a perfect filter rule on an Ethernet device */
664
665 typedef int (*fdir_set_masks_t)(struct rte_eth_dev *dev,
666                                 struct rte_fdir_masks *fdir_masks);
667 /**< Setup flow director masks on an Ethernet device */
668
669 typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
670                                 struct rte_eth_fc_conf *fc_conf);
671 /**< Setup flow control parameter on an Ethernet device */
672
673 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
674 /**<  Turn on SW controllable LED on an Ethernet device */
675
676 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
677 /**<  Turn off SW controllable LED on an Ethernet device */
678
679 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
680 /**< Remove MAC address from receive address register */
681
682 typedef void (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
683                                   struct ether_addr *mac_addr,
684                                   uint32_t index,
685                                   uint32_t vmdq);
686 /**< Set a MAC address into Receive Address Address Register */
687
688 /**
689  * A structure containing the functions exported by an Ethernet driver.
690  */
691 struct eth_dev_ops {
692         eth_dev_configure_t        dev_configure; /**< Configure device. */
693         eth_dev_start_t            dev_start;     /**< Start device. */
694         eth_dev_stop_t             dev_stop;      /**< Stop device. */
695         eth_dev_close_t            dev_close;     /**< Close device. */
696         eth_promiscuous_enable_t   promiscuous_enable; /**< Promiscuous ON. */
697         eth_promiscuous_disable_t  promiscuous_disable;/**< Promiscuous OFF. */
698         eth_allmulticast_enable_t  allmulticast_enable;/**< RX multicast ON. */
699         eth_allmulticast_disable_t allmulticast_disable;/**< RX multicast OF. */
700         eth_link_update_t          link_update;   /**< Get device link state. */
701         eth_stats_get_t            stats_get;     /**< Get device statistics. */
702         eth_stats_reset_t          stats_reset;   /**< Reset device statistics. */
703         eth_dev_infos_get_t        dev_infos_get; /**< Get device info. */
704         vlan_filter_set_t          vlan_filter_set; /**< Filter VLAN on/off. */
705         eth_rx_queue_setup_t       rx_queue_setup;/**< Set up device RX queue.*/
706         eth_tx_queue_setup_t       tx_queue_setup;/**< Set up device TX queue.*/
707         eth_dev_led_on_t           dev_led_on;    /**< Turn on LED. */
708         eth_dev_led_off_t          dev_led_off;   /**< Turn off LED. */
709         flow_ctrl_set_t            flow_ctrl_set; /**< Setup flow control. */
710         eth_mac_addr_remove_t      mac_addr_remove; /**< Remove MAC address */
711         eth_mac_addr_add_t         mac_addr_add;  /**< Add a MAC address */
712
713         /** Add a signature filter. */
714         fdir_add_signature_filter_t fdir_add_signature_filter;
715         /** Update a signature filter. */
716         fdir_update_signature_filter_t fdir_update_signature_filter;
717         /** Remove a signature filter. */
718         fdir_remove_signature_filter_t fdir_remove_signature_filter;
719         /** Get information about FDIR status. */
720         fdir_infos_get_t fdir_infos_get;
721         /** Add a perfect filter. */
722         fdir_add_perfect_filter_t fdir_add_perfect_filter;
723         /** Update a perfect filter. */
724         fdir_update_perfect_filter_t fdir_update_perfect_filter;
725         /** Remove a perfect filter. */
726         fdir_remove_perfect_filter_t fdir_remove_perfect_filter;
727         /** Setup masks for FDIR filtering. */
728         fdir_set_masks_t fdir_set_masks;
729 };
730
731 /**
732  * The generic data structure associated with each ethernet device.
733  *
734  * Pointers to burst-oriented packet receive and transmit functions are
735  * located at the beginning of the structure, along with the pointer to
736  * where all the data elements for the particular device are stored in shared
737  * memory. This split allows the function pointer and driver data to be per-
738  * process, while the actual configuration data for the device is shared.
739  */
740 struct rte_eth_dev {
741         eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
742         eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
743         struct rte_eth_dev_data *data;  /**< Pointer to device data */
744         const struct eth_driver *driver;/**< Driver for this device */
745         struct eth_dev_ops *dev_ops;    /**< Functions exported by PMD */
746         struct rte_pci_device *pci_dev; /**< PCI info. supplied by probing */
747         struct rte_eth_dev_cb_list callbacks; /**< User application callbacks */
748 };
749
750 /**
751  * The data part, with no function pointers, associated with each ethernet device.
752  *
753  * This structure is safe to place in shared memory to be common among different
754  * processes in a multi-process configuration.
755  */
756 struct rte_eth_dev_data {
757         struct igb_rx_queue **rx_queues; /**< Array of pointers to RX queues. */
758         struct igb_tx_queue **tx_queues; /**< Array of pointers to TX queues. */
759         uint16_t nb_rx_queues; /**< Number of RX queues. */
760         uint16_t nb_tx_queues; /**< Number of TX queues. */
761
762         void *dev_private;              /**< PMD-specific private data */
763
764         struct rte_eth_link dev_link;
765         /**< Link-level information & status */
766
767         struct rte_eth_conf dev_conf;   /**< Configuration applied to device. */
768         uint16_t max_frame_size;        /**< Default is ETHER_MAX_LEN (1518). */
769
770         uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
771         struct ether_addr* mac_addrs;/**< Device Ethernet Link address. */
772         uint8_t port_id;           /**< Device [external] port identifier. */
773         uint8_t promiscuous   : 1, /**< RX promiscuous mode ON(1) / OFF(0). */
774                 scattered_rx : 1,  /**< RX of scattered packets is ON(1) / OFF(0) */
775                 all_multicast : 1, /**< RX all multicast mode ON(1) / OFF(0). */
776                 dev_started : 1;   /**< Device state: STARTED(1) / STOPPED(0). */
777 };
778
779 /**
780  * The pool of *rte_eth_dev* structures. The size of the pool
781  * is configured at compile-time in the <rte_ethdev.c> file.
782  */
783 extern struct rte_eth_dev rte_eth_devices[];
784
785 /**
786  * Get the total number of Ethernet devices that have been successfully
787  * initialized by the [matching] Ethernet driver during the PCI probing phase.
788  * All devices whose port identifier is in the range
789  * [0,  rte_eth_dev_count() - 1] can be operated on by network applications.
790  *
791  * @return
792  *   - The total number of usable Ethernet devices.
793  */
794 extern uint8_t rte_eth_dev_count(void);
795
796 struct eth_driver;
797 /**
798  * Initialization function of an Ethernet driver invoked for each matching
799  * Ethernet PCI device detected during the PCI probing phase.
800  *
801  * @param eth_drv
802  *   The pointer to the [matching] Ethernet driver structure supplied by
803  *   the PMD when it registered itself.
804  * @param eth_dev
805  *   The *eth_dev* pointer is the address of the *rte_eth_dev* structure
806  *   associated with the matching device and which have been [automatically]
807  *   allocated in the *rte_eth_devices* array.
808  *   The *eth_dev* structure is supplied to the driver initialization function
809  *   with the following fields already initialized:
810  *
811  *   - *pci_dev*: Holds the pointers to the *rte_pci_device* structure which
812  *     contains the generic PCI information of the matching device.
813  *
814  *   - *dev_private*: Holds a pointer to the device private data structure.
815  *
816  *   - *max_frame_size*: Contains the default Ethernet maximum frame length
817  *     (1518).
818  *
819  *   - *port_id*: Contains the port index of the device (actually the index
820  *     of the *eth_dev* structure in the *rte_eth_devices* array).
821  *
822  * @return
823  *   - 0: Success, the device is properly initialized by the driver.
824  *        In particular, the driver MUST have set up the *dev_ops* pointer
825  *        of the *eth_dev* structure.
826  *   - <0: Error code of the device initialization failure.
827  */
828 typedef int (*eth_dev_init_t)(struct eth_driver  *eth_drv,
829                               struct rte_eth_dev *eth_dev);
830
831 /**
832  * The structure associated with a PMD Ethernet driver.
833  *
834  * Each Ethernet driver acts as a PCI driver and is represented by a generic
835  * *eth_driver* structure that holds:
836  *
837  * - An *rte_pci_driver* structure (which must be the first field).
838  *
839  * - The *eth_dev_init* function invoked for each matching PCI device.
840  *
841  * - The size of the private data to allocate for each matching device.
842  */
843 struct eth_driver {
844         struct rte_pci_driver pci_drv;    /**< The PMD is also a PCI driver. */
845         eth_dev_init_t eth_dev_init;      /**< Device init function. */
846         unsigned int dev_private_size;    /**< Size of device private data. */
847 };
848
849 /**
850  * A function invoked by the initialization function of an Ethernet driver
851  * to simultaneously register itself as a PCI driver and as an Ethernet
852  * Poll Mode Driver (PMD).
853  *
854  * @param eth_drv
855  *   The pointer to the *eth_driver* structure associated with
856  *   the Ethernet driver.
857  */
858 extern void rte_eth_driver_register(struct eth_driver *eth_drv);
859
860 /**
861  * The initialization function of the driver for
862  * Intel(r) IGB Gigabit Ethernet Controller devices.
863  * This function is invoked once at EAL start time.
864  * @return
865  *   0 on success
866  */
867 extern int rte_igb_pmd_init(void);
868
869 /**
870  * The initialization function of the driver for
871  * Intel(r) EM Gigabit Ethernet Controller devices.
872  * This function is invoked once at EAL start time.
873  * @return
874  *   0 on success
875  */
876 extern int rte_em_pmd_init(void);
877
878 /**
879  * The initialization function of the driver for 1Gbps Intel IGB_VF
880  * Ethernet devices.
881  * Invoked once at EAL start time.
882  * @return
883  *   0 on success
884  */
885 extern int rte_igbvf_pmd_init(void);
886
887 /**
888  * The initialization function of the driver for 10Gbps Intel IXGBE
889  * Ethernet devices.
890  * Invoked once at EAL start time.
891  * @return
892  *   0 on success
893  */
894 extern int rte_ixgbe_pmd_init(void);
895
896 /**
897  * The initialization function of the driver for 10Gbps Intel IXGBE_VF
898  * Ethernet devices.
899  * Invoked once at EAL start time.
900  * @return
901  *   0 on success
902  */
903 extern int rte_ixgbevf_pmd_init(void);
904
905 /**
906  * The initialization function of *all* supported and enabled drivers.
907  * Right now, the following PMDs are supported:
908  *  - igb
909  *  - igbvf
910  *  - em
911  *  - ixgbe
912  *  - ixgbevf
913  * This function is invoked once at EAL start time.
914  * @return
915  *   0 on success.
916  *   Error code of the device initialization failure,
917  *   -ENODEV if there are no drivers available
918  *   (e.g. if all driver config options are = n).
919  */
920 static inline
921 int rte_pmd_init_all(void)
922 {
923         int ret = -ENODEV;
924
925 #ifdef RTE_LIBRTE_IGB_PMD
926         if ((ret = rte_igb_pmd_init()) != 0) {
927                 RTE_LOG(ERR, PMD, "Cannot init igb PMD\n");
928                 return (ret);
929         }
930         if ((ret = rte_igbvf_pmd_init()) != 0) {
931                 RTE_LOG(ERR, PMD, "Cannot init igbvf PMD\n");
932                 return (ret);
933         }
934 #endif /* RTE_LIBRTE_IGB_PMD */
935
936 #ifdef RTE_LIBRTE_EM_PMD
937         if ((ret = rte_em_pmd_init()) != 0) {
938                 RTE_LOG(ERR, PMD, "Cannot init em PMD\n");
939                 return (ret);
940         }
941 #endif /* RTE_LIBRTE_EM_PMD */
942
943 #ifdef RTE_LIBRTE_IXGBE_PMD
944         if ((ret = rte_ixgbe_pmd_init()) != 0) {
945                 RTE_LOG(ERR, PMD, "Cannot init ixgbe PMD\n");
946                 return (ret);
947         }
948         if ((ret = rte_ixgbevf_pmd_init()) != 0) {
949                 RTE_LOG(ERR, PMD, "Cannot init ixgbevf PMD\n");
950                 return (ret);
951         }
952 #endif /* RTE_LIBRTE_IXGBE_PMD */
953
954         if (ret == -ENODEV)
955                 RTE_LOG(ERR, PMD, "No PMD(s) are configured\n");
956         return (ret);
957 }
958
959 /**
960  * Configure an Ethernet device.
961  * This function must be invoked first before any other function in the
962  * Ethernet API. This function can also be re-invoked when a device is in the
963  * stopped state.
964  *
965  * @param port_id
966  *   The port identifier of the Ethernet device to configure.
967  * @param nb_rx_queue
968  *   The number of receive queues to set up for the Ethernet device.
969  * @param nb_tx_queue
970  *   The number of transmit queues to set up for the Ethernet device.
971  * @param eth_conf
972  *   The pointer to the configuration data to be used for the Ethernet device.
973  *   The *rte_eth_conf* structure includes:
974  *     -  the hardware offload features to activate, with dedicated fields for
975  *        each statically configurable offload hardware feature provided by
976  *        Ethernet devices, such as IP checksum or VLAN tag stripping for
977  *        example.
978  *     - the Receive Side Scaling (RSS) configuration when using multiple RX
979  *         queues per port.
980  *
981  *   Embedding all configuration information in a single data structure
982  *   is the more flexible method that allows the addition of new features
983  *   without changing the syntax of the API.
984  * @return
985  *   - 0: Success, device configured.
986  *   - <0: Error code returned by the driver configuration function.
987  */
988 extern int rte_eth_dev_configure(uint8_t port_id,
989                                  uint16_t nb_rx_queue,
990                                  uint16_t nb_tx_queue,
991                                  const struct rte_eth_conf *eth_conf);
992
993 /**
994  * Allocate and set up a receive queue for an Ethernet device.
995  *
996  * The function allocates a contiguous block of memory for *nb_rx_desc*
997  * receive descriptors from a memory zone associated with *socket_id*
998  * and initializes each receive descriptor with a network buffer allocated
999  * from the memory pool *mb_pool*.
1000  *
1001  * @param port_id
1002  *   The port identifier of the Ethernet device.
1003  * @param rx_queue_id
1004  *   The index of the receive queue to set up.
1005  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
1006  *   to rte_eth_dev_configure().
1007  * @param nb_rx_desc
1008  *   The number of receive descriptors to allocate for the receive ring.
1009  * @param socket_id
1010  *   The *socket_id* argument is the socket identifier in case of NUMA.
1011  *   The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1012  *   the DMA memory allocated for the receive descriptors of the ring.
1013  * @param rx_conf
1014  *   The pointer to the configuration data to be used for the receive queue.
1015  *   The *rx_conf* structure contains an *rx_thresh* structure with the values
1016  *   of the Prefetch, Host, and Write-Back threshold registers of the receive
1017  *   ring.
1018  * @param mb_pool
1019  *   The pointer to the memory pool from which to allocate *rte_mbuf* network
1020  *   memory buffers to populate each descriptor of the receive ring.
1021  * @return
1022  *   - 0: Success, receive queue correctly set up.
1023  *   - -EINVAL: The size of network buffers which can be allocated from the
1024  *      memory pool does not fit the various buffer sizes allowed by the
1025  *      device controller.
1026  *   - -ENOMEM: Unable to allocate the receive ring descriptors or to
1027  *      allocate network memory buffers from the memory pool when
1028  *      initializing receive descriptors.
1029  */
1030 extern int rte_eth_rx_queue_setup(uint8_t port_id, uint16_t rx_queue_id,
1031                                   uint16_t nb_rx_desc, unsigned int socket_id,
1032                                   const struct rte_eth_rxconf *rx_conf,
1033                                   struct rte_mempool *mb_pool);
1034
1035 /**
1036  * Allocate and set up a transmit queue for an Ethernet device.
1037  *
1038  * @param port_id
1039  *   The port identifier of the Ethernet device.
1040  * @param tx_queue_id
1041  *   The index of the transmit queue to set up.
1042  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
1043  *   to rte_eth_dev_configure().
1044  * @param nb_tx_desc
1045  *   The number of transmit descriptors to allocate for the transmit ring.
1046  * @param socket_id
1047  *   The *socket_id* argument is the socket identifier in case of NUMA.
1048  *   Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for
1049  *   the DMA memory allocated for the transmit descriptors of the ring.
1050  * @param tx_conf
1051  *   The pointer to the configuration data to be used for the transmit queue.
1052  *   The *tx_conf* structure contains the following data:
1053  *   - The *tx_thresh* structure with the values of the Prefetch, Host, and
1054  *     Write-Back threshold registers of the transmit ring.
1055  *     When setting Write-Back threshold to the value greater then zero,
1056  *     *tx_rs_thresh* value should be explicitly set to one.
1057  *   - The *tx_free_thresh* value indicates the [minimum] number of network
1058  *     buffers that must be pending in the transmit ring to trigger their
1059  *     [implicit] freeing by the driver transmit function.
1060  *   - The *tx_rs_thresh* value indicates the [minimum] number of transmit
1061  *     descriptors that must be pending in the transmit ring before setting the
1062  *     RS bit on a descriptor by the driver transmit function.
1063  *     The *tx_rs_thresh* value should be less or equal then
1064  *     *tx_free_thresh* value, and both of them should be less then
1065  *     *nb_tx_desc* - 3.
1066  *
1067  *     Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces
1068  *     the transmit function to use default values.
1069  * @return
1070  *   - 0: Success, the transmit queue is correctly set up.
1071  *   - -ENOMEM: Unable to allocate the transmit ring descriptors.
1072  */
1073 extern int rte_eth_tx_queue_setup(uint8_t port_id, uint16_t tx_queue_id,
1074                                   uint16_t nb_tx_desc, unsigned int socket_id,
1075                                   const struct rte_eth_txconf *tx_conf);
1076
1077 /**
1078  * Start an Ethernet device.
1079  *
1080  * The device start step is the last one and consists of setting the configured
1081  * offload features and in starting the transmit and the receive units of the
1082  * device.
1083  * On success, all basic functions exported by the Ethernet API (link status,
1084  * receive/transmit, and so on) can be invoked.
1085  *
1086  * @param port_id
1087  *   The port identifier of the Ethernet device.
1088  * @return
1089  *   - 0: Success, Ethernet device started.
1090  *   - <0: Error code of the driver device start function.
1091  */
1092 extern int rte_eth_dev_start(uint8_t port_id);
1093
1094 /**
1095  * Stop an Ethernet device. The device can be restarted with a call to
1096  * rte_eth_dev_start()
1097  *
1098  * @param port_id
1099  *   The port identifier of the Ethernet device.
1100  */
1101 extern void rte_eth_dev_stop(uint8_t port_id);
1102
1103 /**
1104  * Close an Ethernet device. The device cannot be restarted!
1105  *
1106  * @param port_id
1107  *   The port identifier of the Ethernet device.
1108  */
1109 extern void rte_eth_dev_close(uint8_t port_id);
1110
1111 /**
1112  * Enable receipt in promiscuous mode for an Ethernet device.
1113  *
1114  * @param port_id
1115  *   The port identifier of the Ethernet device.
1116  */
1117 extern void rte_eth_promiscuous_enable(uint8_t port_id);
1118
1119 /**
1120  * Disable receipt in promiscuous mode for an Ethernet device.
1121  *
1122  * @param port_id
1123  *   The port identifier of the Ethernet device.
1124  */
1125 extern void rte_eth_promiscuous_disable(uint8_t port_id);
1126
1127 /**
1128  * Return the value of promiscuous mode for an Ethernet device.
1129  *
1130  * @param port_id
1131  *   The port identifier of the Ethernet device.
1132  * @return
1133  *   - (1) if promiscuous is enabled
1134  *   - (0) if promiscuous is disabled.
1135  *   - (-1) on error
1136  */
1137 extern int rte_eth_promiscuous_get(uint8_t port_id);
1138
1139 /**
1140  * Enable the receipt of any multicast frame by an Ethernet device.
1141  *
1142  * @param port_id
1143  *   The port identifier of the Ethernet device.
1144  */
1145 extern void rte_eth_allmulticast_enable(uint8_t port_id);
1146
1147 /**
1148  * Disable the receipt of all multicast frames by an Ethernet device.
1149  *
1150  * @param port_id
1151  *   The port identifier of the Ethernet device.
1152  */
1153 extern void rte_eth_allmulticast_disable(uint8_t port_id);
1154
1155 /**
1156  * Return the value of allmulticast mode for an Ethernet device.
1157  *
1158  * @param port_id
1159  *   The port identifier of the Ethernet device.
1160  * @return
1161  *   - (1) if allmulticast is enabled
1162  *   - (0) if allmulticast is disabled.
1163  *   - (-1) on error
1164  */
1165 extern int rte_eth_allmulticast_get(uint8_t port_id);
1166
1167 /**
1168  * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
1169  * or FULL-DUPLEX) of the physical link of an Ethernet device. It might need
1170  * to wait up to 9 seconds in it.
1171  *
1172  * @param port_id
1173  *   The port identifier of the Ethernet device.
1174  * @param link
1175  *   A pointer to an *rte_eth_link* structure to be filled with
1176  *   the status, the speed and the mode of the Ethernet device link.
1177  */
1178 extern void rte_eth_link_get(uint8_t port_id, struct rte_eth_link *link);
1179
1180 /**
1181  * Retrieve the status (ON/OFF), the speed (in Mbps) and the mode (HALF-DUPLEX
1182  * or FULL-DUPLEX) of the physical link of an Ethernet device. It is a no-wait
1183  * version of rte_eth_link_get().
1184  *
1185  * @param port_id
1186  *   The port identifier of the Ethernet device.
1187  * @param link
1188  *   A pointer to an *rte_eth_link* structure to be filled with
1189  *   the status, the speed and the mode of the Ethernet device link.
1190  */
1191 extern void rte_eth_link_get_nowait(uint8_t port_id,
1192                                 struct rte_eth_link *link);
1193
1194 /**
1195  * Retrieve the general I/O statistics of an Ethernet device.
1196  *
1197  * @param port_id
1198  *   The port identifier of the Ethernet device.
1199  * @param stats
1200  *   A pointer to a structure of type *rte_eth_stats* to be filled with
1201  *   the values of device counters for the following set of statistics:
1202  *   - *ipackets* with the total of successfully received packets.
1203  *   - *opackets* with the total of successfully transmitted packets.
1204  *   - *ibytes*   with the total of successfully received bytes.
1205  *   - *obytes*   with the total of successfully transmitted bytes.
1206  *   - *ierrors*  with the total of erroneous received packets.
1207  *   - *oerrors*  with the total of failed transmitted packets.
1208  */
1209 extern void rte_eth_stats_get(uint8_t port_id, struct rte_eth_stats *stats);
1210
1211 /**
1212  * Reset the general I/O statistics of an Ethernet device.
1213  *
1214  * @param port_id
1215  *   The port identifier of the Ethernet device.
1216  */
1217 extern void rte_eth_stats_reset(uint8_t port_id);
1218
1219 /**
1220  * Retrieve the Ethernet address of an Ethernet device.
1221  *
1222  * @param port_id
1223  *   The port identifier of the Ethernet device.
1224  * @param mac_addr
1225  *   A pointer to a structure of type *ether_addr* to be filled with
1226  *   the Ethernet address of the Ethernet device.
1227  */
1228 extern void rte_eth_macaddr_get(uint8_t port_id, struct ether_addr *mac_addr);
1229
1230 /**
1231  * Retrieve the contextual information of an Ethernet device.
1232  *
1233  * @param port_id
1234  *   The port identifier of the Ethernet device.
1235  * @param dev_info
1236  *   A pointer to a structure of type *rte_eth_dev_info* to be filled with
1237  *   the contextual information of the Ethernet device.
1238  */
1239 extern void rte_eth_dev_info_get(uint8_t port_id,
1240                                  struct rte_eth_dev_info *dev_info);
1241
1242 /**
1243  * Enable/Disable hardware filtering by an Ethernet device of received
1244  * VLAN packets tagged with a given VLAN Tag Identifier.
1245  *
1246  * @param port_id
1247  *   The port identifier of the Ethernet device.
1248  * @param vlan_id
1249  *   The VLAN Tag Identifier whose filtering must be enabled or disabled.
1250  * @param on
1251  *   If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*.
1252  *   Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*.
1253  * @return
1254  *   - (0) if successful.
1255  *   - (-ENOSUP) if hardware-assisted VLAN filtering not configured.
1256  *   - (-ENODEV) if *port_id* invalid.
1257  *   - (-ENOSYS) if VLAN filtering on *port_id* disabled.
1258  *   - (-EINVAL) if *vlan_id* > 4095.
1259  */
1260 extern int rte_eth_dev_vlan_filter(uint8_t port_id, uint16_t vlan_id, int on);
1261
1262 /**
1263  *
1264  * Retrieve a burst of input packets from a receive queue of an Ethernet
1265  * device. The retrieved packets are stored in *rte_mbuf* structures whose
1266  * pointers are supplied in the *rx_pkts* array.
1267  *
1268  * The rte_eth_rx_burst() function loops, parsing the RX ring of the
1269  * receive queue, up to *nb_pkts* packets, and for each completed RX
1270  * descriptor in the ring, it performs the following operations:
1271  *
1272  * - Initialize the *rte_mbuf* data structure associated with the
1273  *   RX descriptor according to the information provided by the NIC into
1274  *   that RX descriptor.
1275  *
1276  * - Store the *rte_mbuf* data structure into the next entry of the
1277  *   *rx_pkts* array.
1278  *
1279  * - Replenish the RX descriptor with a new *rte_mbuf* buffer
1280  *   allocated from the memory pool associated with the receive queue at
1281  *   initialization time.
1282  *
1283  * When retrieving an input packet that was scattered by the controller
1284  * into multiple receive descriptors, the rte_eth_rx_burst() function
1285  * appends the associated *rte_mbuf* buffers to the first buffer of the
1286  * packet.
1287  *
1288  * The rte_eth_rx_burst() function returns the number of packets
1289  * actually retrieved, which is the number of *rte_mbuf* data structures
1290  * effectively supplied into the *rx_pkts* array.
1291  * A return value equal to *nb_pkts* indicates that the RX queue contained
1292  * at least *rx_pkts* packets, and this is likely to signify that other
1293  * received packets remain in the input queue. Applications implementing
1294  * a "retrieve as much received packets as possible" policy can check this
1295  * specific case and keep invoking the rte_eth_rx_burst() function until
1296  * a value less than *nb_pkts* is returned.
1297  *
1298  * This receive method has the following advantages:
1299  *
1300  * - It allows a run-to-completion network stack engine to retrieve and
1301  *   to immediately process received packets in a fast burst-oriented
1302  *   approach, avoiding the overhead of unnecessary intermediate packet
1303  *   queue/dequeue operations.
1304  *
1305  * - Conversely, it also allows an asynchronous-oriented processing
1306  *   method to retrieve bursts of received packets and to immediately
1307  *   queue them for further parallel processing by another logical core,
1308  *   for instance. However, instead of having received packets being
1309  *   individually queued by the driver, this approach allows the invoker
1310  *   of the rte_eth_rx_burst() function to queue a burst of retrieved
1311  *   packets at a time and therefore dramatically reduce the cost of
1312  *   enqueue/dequeue operations per packet.
1313  *
1314  * - It allows the rte_eth_rx_burst() function of the driver to take
1315  *   advantage of burst-oriented hardware features (CPU cache,
1316  *   prefetch instructions, and so on) to minimize the number of CPU
1317  *   cycles per packet.
1318  *
1319  * To summarize, the proposed receive API enables many
1320  * burst-oriented optimizations in both synchronous and asynchronous
1321  * packet processing environments with no overhead in both cases.
1322  *
1323  * The rte_eth_rx_burst() function does not provide any error
1324  * notification to avoid the corresponding overhead. As a hint, the
1325  * upper-level application might check the status of the device link once
1326  * being systematically returned a 0 value for a given number of tries.
1327  *
1328  * @param port_id
1329  *   The port identifier of the Ethernet device.
1330  * @param queue_id
1331  *   The index of the receive queue from which to retrieve input packets.
1332  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
1333  *   to rte_eth_dev_configure().
1334  * @param rx_pkts
1335  *   The address of an array of pointers to *rte_mbuf* structures that
1336  *   must be large enough to store *nb_pkts* pointers in it.
1337  * @param nb_pkts
1338  *   The maximum number of packets to retrieve.
1339  * @return
1340  *   The number of packets actually retrieved, which is the number
1341  *   of pointers to *rte_mbuf* structures effectively supplied to the
1342  *   *rx_pkts* array.
1343  */
1344 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
1345 extern uint16_t rte_eth_rx_burst(uint8_t port_id, uint16_t queue_id,
1346                                  struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
1347 #else
1348 static inline uint16_t
1349 rte_eth_rx_burst(uint8_t port_id, uint16_t queue_id,
1350                  struct rte_mbuf **rx_pkts, uint16_t nb_pkts)
1351 {
1352         struct rte_eth_dev *dev;
1353
1354         dev = &rte_eth_devices[port_id];
1355         return (*dev->rx_pkt_burst)(dev->data->rx_queues[queue_id], rx_pkts, nb_pkts);
1356 }
1357 #endif
1358
1359 /**
1360  * Send a burst of output packets on a transmit queue of an Ethernet device.
1361  *
1362  * The rte_eth_tx_burst() function is invoked to transmit output packets
1363  * on the output queue *queue_id* of the Ethernet device designated by its
1364  * *port_id*.
1365  * The *nb_pkts* parameter is the number of packets to send which are
1366  * supplied in the *tx_pkts* array of *rte_mbuf* structures.
1367  * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
1368  * up to the number of transmit descriptors available in the TX ring of the
1369  * transmit queue.
1370  * For each packet to send, the rte_eth_tx_burst() function performs
1371  * the following operations:
1372  *
1373  * - Pick up the next available descriptor in the transmit ring.
1374  *
1375  * - Free the network buffer previously sent with that descriptor, if any.
1376  *
1377  * - Initialize the transmit descriptor with the information provided
1378  *   in the *rte_mbuf data structure.
1379  *
1380  * In the case of a segmented packet composed of a list of *rte_mbuf* buffers,
1381  * the rte_eth_tx_burst() function uses several transmit descriptors
1382  * of the ring.
1383  *
1384  * The rte_eth_tx_burst() function returns the number of packets it
1385  * actually sent. A return value equal to *nb_pkts* means that all packets
1386  * have been sent, and this is likely to signify that other output packets
1387  * could be immediately transmitted again. Applications that implement a
1388  * "send as many packets to transmit as possible" policy can check this
1389  * specific case and keep invoking the rte_eth_tx_burst() function until
1390  * a value less than *nb_pkts* is returned.
1391  *
1392  * It is the responsibility of the rte_eth_tx_burst() function to
1393  * transparently free the memory buffers of packets previously sent.
1394  * This feature is driven by the *tx_free_thresh* value supplied to the
1395  * rte_eth_dev_configure() function at device configuration time.
1396  * When the number of previously sent packets reached the "minimum transmit
1397  * packets to free" threshold, the rte_eth_tx_burst() function must
1398  * [attempt to] free the *rte_mbuf*  buffers of those packets whose
1399  * transmission was effectively completed.
1400  *
1401  * @param port_id
1402  *   The port identifier of the Ethernet device.
1403  * @param queue_id
1404  *   The index of the transmit queue through which output packets must be
1405  *   sent.
1406  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
1407  *   to rte_eth_dev_configure().
1408  * @param tx_pkts
1409  *   The address of an array of *nb_pkts* pointers to *rte_mbuf* structures
1410  *   which contain the output packets.
1411  * @param nb_pkts
1412  *   The maximum number of packets to transmit.
1413  * @return
1414  *   The number of output packets actually stored in transmit descriptors of
1415  *   the transmit ring. The return value can be less than the value of the
1416  *   *tx_pkts* parameter when the transmit ring is full or has been filled up.
1417  */
1418 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
1419 extern uint16_t rte_eth_tx_burst(uint8_t port_id, uint16_t queue_id,
1420                                  struct rte_mbuf **tx_pkts, uint16_t nb_pkts);
1421 #else
1422 static inline uint16_t
1423 rte_eth_tx_burst(uint8_t port_id, uint16_t queue_id,
1424                  struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
1425 {
1426         struct rte_eth_dev *dev;
1427
1428         dev = &rte_eth_devices[port_id];
1429         return (*dev->tx_pkt_burst)(dev->data->tx_queues[queue_id], tx_pkts, nb_pkts);
1430 }
1431 #endif
1432
1433 /**
1434  * Setup a new signature filter rule on an Ethernet device
1435  *
1436  * @param port_id
1437  *   The port identifier of the Ethernet device.
1438  * @param fdir_filter
1439  *   The pointer to the fdir filter structure describing the signature filter
1440  *   rule.
1441  *   The *rte_fdir_filter* structure includes the values of the different fields
1442  *   to match: source and destination IP addresses, vlan id, flexbytes, source
1443  *   and destination ports, and so on.
1444  * @param rx_queue
1445  *   The index of the RX queue where to store RX packets matching the added
1446  *   signature filter defined in fdir_filter.
1447  * @return
1448  *   - (0) if successful.
1449  *   - (-ENOTSUP) if hardware doesn't support flow director mode.
1450  *   - (-ENODEV) if *port_id* invalid.
1451  *   - (-ENOSYS) if the FDIR mode is not configured in signature mode
1452  *               on *port_id*.
1453  *   - (-EINVAL) if the fdir_filter information is not correct.
1454  */
1455 int rte_eth_dev_fdir_add_signature_filter(uint8_t port_id,
1456                                           struct rte_fdir_filter *fdir_filter,
1457                                           uint8_t rx_queue);
1458
1459 /**
1460  * Update a signature filter rule on an Ethernet device.
1461  * If the rule doesn't exits, it is created.
1462  *
1463  * @param port_id
1464  *   The port identifier of the Ethernet device.
1465  * @param fdir_ftr
1466  *   The pointer to the structure describing the signature filter rule.
1467  *   The *rte_fdir_filter* structure includes the values of the different fields
1468  *   to match: source and destination IP addresses, vlan id, flexbytes, source
1469  *   and destination ports, and so on.
1470  * @param rx_queue
1471  *   The index of the RX queue where to store RX packets matching the added
1472  *   signature filter defined in fdir_ftr.
1473  * @return
1474  *   - (0) if successful.
1475  *   - (-ENOTSUP) if hardware doesn't support flow director mode.
1476  *   - (-ENODEV) if *port_id* invalid.
1477  *   - (-ENOSYS) if the flow director mode is not configured in signature mode
1478  *     on *port_id*.
1479  *   - (-EINVAL) if the fdir_filter information is not correct.
1480  */
1481 int rte_eth_dev_fdir_update_signature_filter(uint8_t port_id,
1482                                              struct rte_fdir_filter *fdir_ftr,
1483                                              uint8_t rx_queue);
1484
1485 /**
1486  * Remove a signature filter rule on an Ethernet device.
1487  *
1488  * @param port_id
1489  *   The port identifier of the Ethernet device.
1490  * @param fdir_ftr
1491  *   The pointer to the structure describing the signature filter rule.
1492  *   The *rte_fdir_filter* structure includes the values of the different fields
1493  *   to match: source and destination IP addresses, vlan id, flexbytes, source
1494  *   and destination ports, and so on.
1495  * @return
1496  *   - (0) if successful.
1497  *   - (-ENOTSUP) if hardware doesn't support flow director mode.
1498  *   - (-ENODEV) if *port_id* invalid.
1499  *   - (-ENOSYS) if the flow director mode is not configured in signature mode
1500  *     on *port_id*.
1501  *   - (-EINVAL) if the fdir_filter information is not correct.
1502  */
1503 int rte_eth_dev_fdir_remove_signature_filter(uint8_t port_id,
1504                                              struct rte_fdir_filter *fdir_ftr);
1505
1506 /**
1507  * Retrieve the flow director information of an Ethernet device.
1508  *
1509  * @param port_id
1510  *   The port identifier of the Ethernet device.
1511  * @param fdir
1512  *   A pointer to a structure of type *rte_eth_dev_fdir* to be filled with
1513  *   the flow director information of the Ethernet device.
1514  * @return
1515  *   - (0) if successful.
1516  *   - (-ENOTSUP) if hardware doesn't support flow director mode.
1517  *   - (-ENODEV) if *port_id* invalid.
1518  *   - (-ENOSYS) if the flow director mode is not configured on *port_id*.
1519  */
1520 int rte_eth_dev_fdir_get_infos(uint8_t port_id, struct rte_eth_fdir *fdir);
1521
1522 /**
1523  * Add a new perfect filter rule on an Ethernet device.
1524  *
1525  * @param port_id
1526  *   The port identifier of the Ethernet device.
1527  * @param fdir_filter
1528  *   The pointer to the structure describing the perfect filter rule.
1529  *   The *rte_fdir_filter* structure includes the values of the different fields
1530  *   to match: source and destination IP addresses, vlan id, flexbytes, source
1531  *   and destination ports, and so on.
1532  *   IPv6 are not supported.
1533  * @param soft_id
1534  *    The 16-bit value supplied in the field hash.fdir.id of mbuf for RX
1535  *    packets matching the perfect filter.
1536  * @param rx_queue
1537  *   The index of the RX queue where to store RX packets matching the added
1538  *   perfect filter defined in fdir_filter.
1539  * @param drop
1540  *    If drop is set to 1, matching RX packets are stored into the RX drop
1541  *    queue defined in the rte_fdir_conf.
1542  * @return
1543  *   - (0) if successful.
1544  *   - (-ENOTSUP) if hardware doesn't support flow director mode.
1545  *   - (-ENODEV) if *port_id* invalid.
1546  *   - (-ENOSYS) if the flow director mode is not configured in perfect mode
1547  *               on *port_id*.
1548  *   - (-EINVAL) if the fdir_filter information is not correct.
1549  */
1550 int rte_eth_dev_fdir_add_perfect_filter(uint8_t port_id,
1551                                         struct rte_fdir_filter *fdir_filter,
1552                                         uint16_t soft_id, uint8_t rx_queue,
1553                                         uint8_t drop);
1554
1555 /**
1556  * Update a perfect filter rule on an Ethernet device.
1557  * If the rule doesn't exits, it is created.
1558  *
1559  * @param port_id
1560  *   The port identifier of the Ethernet device.
1561  * @param fdir_filter
1562  *   The pointer to the structure describing the perfect filter rule.
1563  *   The *rte_fdir_filter* structure includes the values of the different fields
1564  *   to match: source and destination IP addresses, vlan id, flexbytes, source
1565  *   and destination ports, and so on.
1566  *   IPv6 are not supported.
1567  * @param soft_id
1568  *    The 16-bit value supplied in the field hash.fdir.id of mbuf for RX
1569  *    packets matching the perfect filter.
1570  * @param rx_queue
1571  *   The index of the RX queue where to store RX packets matching the added
1572  *   perfect filter defined in fdir_filter.
1573  * @param drop
1574  *    If drop is set to 1, matching RX packets are stored into the RX drop
1575  *    queue defined in the rte_fdir_conf.
1576  * @return
1577  *   - (0) if successful.
1578  *   - (-ENOTSUP) if hardware doesn't support flow director mode.
1579  *   - (-ENODEV) if *port_id* invalid.
1580  *   - (-ENOSYS) if the flow director mode is not configured in perfect mode
1581  *      on *port_id*.
1582  *   - (-EINVAL) if the fdir_filter information is not correct.
1583  */
1584 int rte_eth_dev_fdir_update_perfect_filter(uint8_t port_id,
1585                                            struct rte_fdir_filter *fdir_filter,
1586                                            uint16_t soft_id, uint8_t rx_queue,
1587                                            uint8_t drop);
1588
1589 /**
1590  * Remove a perfect filter rule on an Ethernet device.
1591  *
1592  * @param port_id
1593  *   The port identifier of the Ethernet device.
1594  * @param fdir_filter
1595  *   The pointer to the structure describing the perfect filter rule.
1596  *   The *rte_fdir_filter* structure includes the values of the different fields
1597  *   to match: source and destination IP addresses, vlan id, flexbytes, source
1598  *   and destination ports, and so on.
1599  *   IPv6 are not supported.
1600  * @param soft_id
1601  *    The soft_id value provided when adding/updating the removed filter.
1602  * @return
1603  *   - (0) if successful.
1604  *   - (-ENOTSUP) if hardware doesn't support flow director mode.
1605  *   - (-ENODEV) if *port_id* invalid.
1606  *   - (-ENOSYS) if the flow director mode is not configured in perfect mode
1607  *      on *port_id*.
1608  *   - (-EINVAL) if the fdir_filter information is not correct.
1609  */
1610 int rte_eth_dev_fdir_remove_perfect_filter(uint8_t port_id,
1611                                            struct rte_fdir_filter *fdir_filter,
1612                                            uint16_t soft_id);
1613 /**
1614  * Configure globally the masks for flow director mode for an Ethernet device.
1615  * For example, the device can match packets with only the first 24 bits of
1616  * the IPv4 source address.
1617  *
1618  * The following fields can be masked: IPv4 addresses and L4 port numbers.
1619  * The following fields can be either enabled or disabled completely for the
1620  * matching functionality: VLAN ID tag; VLAN Priority + CFI bit; Flexible 2-byte
1621  * tuple.
1622  * IPv6 masks are not supported.
1623  *
1624  * All filters must comply with the masks previously configured.
1625  * For example, with a mask equal to 255.255.255.0 for the source IPv4 address,
1626  * all IPv4 filters must be created with a source IPv4 address that fits the
1627  * "X.X.X.0" format.
1628  *
1629  * This function flushes all filters that have been previously added in
1630  * the device.
1631  *
1632  * @param port_id
1633  *   The port identifier of the Ethernet device.
1634  * @param fdir_mask
1635  *   The pointer to the fdir mask structure describing relevant headers fields
1636  *   and relevant bits to use when matching packets addresses and ports.
1637  *   IPv6 masks are not supported.
1638  * @return
1639  *   - (0) if successful.
1640  *   - (-ENOTSUP) if hardware doesn't support flow director mode.
1641  *   - (-ENODEV) if *port_id* invalid.
1642  *   - (-ENOSYS) if the flow director mode is not configured in perfect
1643  *      mode on *port_id*.
1644  *   - (-EINVAL) if the fdir_filter information is not correct
1645  */
1646 int rte_eth_dev_fdir_set_masks(uint8_t port_id,
1647                                struct rte_fdir_masks *fdir_mask);
1648
1649 /**
1650  * The eth device event type for interrupt, and maybe others in the future.
1651  */
1652 enum rte_eth_event_type {
1653         RTE_ETH_EVENT_UNKNOWN,  /**< unknown event type */
1654         RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
1655         RTE_ETH_EVENT_MAX       /**< max value of this enum */
1656 };
1657
1658 typedef void (*rte_eth_dev_cb_fn)(uint8_t port_id, \
1659                 enum rte_eth_event_type event, void *cb_arg);
1660 /**< user application callback to be registered for interrupts */
1661
1662
1663
1664 /**
1665  * Register a callback function for specific port id.
1666  *
1667  * @param port_id
1668  *  Port id.
1669  * @param event
1670  *  Event interested.
1671  * @param cb_fn
1672  *  User supplied callback function to be called.
1673  * @param cb_arg
1674  *  Pointer to the parameters for the registered callback.
1675  *
1676  * @return
1677  *  - On success, zero.
1678  *  - On failure, a negative value.
1679  */
1680 int rte_eth_dev_callback_register(uint8_t port_id,
1681                         enum rte_eth_event_type event,
1682                 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
1683
1684 /**
1685  * Unregister a callback function for specific port id.
1686  *
1687  * @param port_id
1688  *  Port id.
1689  * @param event
1690  *  Event interested.
1691  * @param cb_fn
1692  *  User supplied callback function to be called.
1693  * @param cb_arg
1694  *  Pointer to the parameters for the registered callback. -1 means to
1695  *  remove all for the same callback address and same event.
1696  *
1697  * @return
1698  *  - On success, zero.
1699  *  - On failure, a negative value.
1700  */
1701 int rte_eth_dev_callback_unregister(uint8_t port_id,
1702                         enum rte_eth_event_type event,
1703                 rte_eth_dev_cb_fn cb_fn, void *cb_arg);
1704
1705 /**
1706  * @internal Executes all the user application registered callbacks for
1707  * the specific device. It is for DPDK internal user only. User
1708  * application should not call it directly.
1709  *
1710  * @param dev
1711  *  Pointer to struct rte_eth_dev.
1712  * @param event
1713  *  Eth device interrupt event type.
1714  *
1715  * @return
1716  *  void
1717  */
1718 void _rte_eth_dev_callback_process(struct rte_eth_dev *dev,
1719                                 enum rte_eth_event_type event);
1720
1721 /**
1722  * Turn on the LED on the Ethernet device.
1723  * This function turns on the LED on the Ethernet device.
1724  *
1725  * @param port_id
1726  *   The port identifier of the Ethernet device.
1727  * @return
1728  *   - (0) if successful.
1729  *   - (-ENOTSUP) if underlying hardware OR driver doesn't support
1730  *     that operation.
1731  *   - (-ENODEV) if *port_id* invalid.
1732  */
1733 int  rte_eth_led_on(uint8_t port_id);
1734
1735 /**
1736  * Turn off the LED on the Ethernet device.
1737  * This function turns off the LED on the Ethernet device.
1738  *
1739  * @param port_id
1740  *   The port identifier of the Ethernet device.
1741  * @return
1742  *   - (0) if successful.
1743  *   - (-ENOTSUP) if underlying hardware OR driver doesn't support
1744  *     that operation.
1745  *   - (-ENODEV) if *port_id* invalid.
1746  */
1747 int  rte_eth_led_off(uint8_t port_id);
1748
1749 /**
1750  * Configure the Ethernet link flow control for Ethernet device
1751  *
1752  * @param port_id
1753  *   The port identifier of the Ethernet device.
1754  * @param fc_conf
1755  *   The pointer to the structure of the flow control parameters.
1756  * @return
1757  *   - (0) if successful.
1758  *   - (-ENOTSUP) if hardware doesn't support flow director mode.
1759  *   - (-ENODEV)  if *port_id* invalid.
1760  *   - (-EINVAL)  if bad parameter
1761  *   - (-EIO)     if flow control setup failure
1762  */
1763 int rte_eth_dev_flow_ctrl_set(uint8_t port_id,
1764                                 struct rte_eth_fc_conf *fc_conf);
1765
1766 /**
1767  * Add a MAC address to an internal array of addresses used to enable whitelist
1768  * filtering to accept packets only if the destination MAC address matches.
1769  *
1770  * @param port
1771  *   The port identifier of the Ethernet device.
1772  * @param mac_addr
1773  *   The MAC address to add.
1774  * @param pool
1775  *   VMDq pool index to associate address with (if VMDq is enabled). If VMDq is
1776  *   not enabled, this should be set to 0.
1777  * @return
1778  *   - (0) if successfully added or *mac_addr" was already added.
1779  *   - (-ENOTSUP) if hardware doesn't support this feature.
1780  *   - (-ENODEV) if *port* is invalid.
1781  *   - (-ENOSPC) if no more MAC addresses can be added.
1782  *   - (-EINVAL) if MAC address is invalid.
1783  */
1784 int rte_eth_dev_mac_addr_add(uint8_t port, struct ether_addr *mac_addr,
1785                                 uint32_t pool);
1786
1787 /**
1788  * Remove a MAC address from the internal array of addresses.
1789  *
1790  * @param port
1791  *   The port identifier of the Ethernet device.
1792  * @param mac_addr
1793  *   MAC address to remove.
1794  * @return
1795  *   - (0) if successful, or *mac_addr* didn't exist.
1796  *   - (-ENOTSUP) if hardware doesn't support.
1797  *   - (-ENODEV) if *port* invalid.
1798  *   - (-EADDRINUSE) if attempting to remove the default MAC address
1799  */
1800 int rte_eth_dev_mac_addr_remove(uint8_t port, struct ether_addr *mac_addr);
1801
1802
1803 #ifdef __cplusplus
1804 }
1805 #endif
1806
1807 #endif /* _RTE_ETHDEV_H_ */